Google CloudSQL Postgres Source Setup Guide
Supported Postgres versions
Anything on or after Postgres 12
Enable Logical Replication
You don’t need to follow the below steps if the settings cloudsql. logical_decoding
is on and wal_sender_timeout
is 0. These settings should mostly be pre-configured if you are migrating from another data replication tool.
- Click on Edit button on the Overview page.
Edit Button in CloudSQL Postgres
- Go to Flags and change
cloudsql.logical_decoding
to on andwal_sender_timeout
to 0. These changes will need restarting your Postgres server.
Change cloudsql.logical_decoding to on
Changed cloudsql.logical_decoding and wal_sender_timeout
Restart Server
Add PeerDB Cloud IPs to Firewall
If you are using PeerDB Cloud, please follow the below steps to add PeerDB IPs to your network.
- Go to Connections section
CloudSQL Connection Connection Section
- Go to the Networking subsection
Networking Sub Section in the Conenction Section
Add PeerDB Networks
PeerDB Networks Added
Creating PeerDB User and Granting permissions
Connect to your CloudSQL Postgres through the admin user and run the below commands:
-
Create a Postgres user for exclusively PeerDB.
-
CREATE USER peerdb_user PASSWORD 'some-password';
-
-
Provide read-only access to the schema from which you are replicating tables to the
peerdb-user
. Below example shows setting up permissions for thepublic
schema. If you want to grant access to multiple schemas, you can run these three commands for each schema.-
GRANT USAGE ON SCHEMA "public" TO peerdb_user; GRANT SELECT ON ALL TABLES IN SCHEMA "public" TO peerdb_user; ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT SELECT ON TABLES TO peerdb_user;
-
-
Grant replication access to this user:
-
ALTER ROLE peerdb_user REPLICATION;
-
-
Create publication that you’ll be using for creating the MIRROR (replication) in future.
-
CREATE PUBLICATION peerdb_publication FOR ALL TABLES;
-
PeerDB SSH Tunneling Guide (Optional)
Sometimes to connect to your Postgres database you need to use an SSH tunnel. This is typically used when your database is not publicly accessible and you need to connect to it a jump server in your VPC. This is done by creating an SSH tunnel to the jump server and then connecting to the database through the tunnel.
Generate a key-pair
Generate a key-pair using the following command:
ssh-keygen -t rsa -b 4096 -C "peerdb-ssh-tunnel" -f peerdb_key.pem
This will generate a private key (peerdb_key.pem
) and a public key (peerdb_key.pub
).
Add public key to your jump server
Add the public key to your jump server. This can be done by adding the public key to the ~/.ssh/authorized_keys
file on the jump server.
# On the jump server
cat peerdb_key.pub >> ~/.ssh/authorized_keys
Add private key to the connection
When creating a Postgres peer you can specify the option to use an SSH tunnel. There you will be able to provide the private key you generated in the first step along with the jump server details.
Create CloudSQL Postgres Peer in PeerDB
Through the PeerDB UI, create the CloudSQL Peer using the peerdb_user
that you created in the previous step.
Choose PostgreSQL Peer
Peer Creation and Validation
Created Peer