Skip to main content

Deploy Baseshift Resources

To create a Dub, you need to deploy the Baseshift agent and replication server within your network:

  • The agent subscribes to the source database to receive transactions.
  • The replication server manages the clones.
  • Both components are installed on-premises - your data stays within your network.

Installation is done using AWS CloudFormation:

Wizard Stage 4
  • Enter a name for the Dub.
  • If you don't want to create Docker-based clones, uncheck Allow running clones locally.
  • Click "Connect to AWS CloudFormation" - a new tab will open in the AWS Console. Review and update the parameters before launching the stack.

Fill out the following parameters according to your setup:

ParameterDescription
Encryption PasswordOptional. An additional key used to encrypt data in Docker clones for enhanced security.
Server Key PairThe key pair used to access the replication server EC2 instance.
Server Instance TypeThe instance type for the replication server EC2.
Server Volume Size (GB)The volume size (in GB) for the replication server EC2.

The rest of the parameters are prefilled - review and adjust if necessary:

ParameterDescription
VPC of the source databaseThe VPC where the components will be installed. This must match the source database's VPC.
Subnet of the Dubhub ServerA private subnet for the replication server. Must have outbound internet access.
Agent SubnetA private subnet for the agent. Must also have outbound internet access.
RDS Security GroupThe security group of the source database. The stack creates a new security group for the agent and adds an inbound rule allowing it to connect to the database.
Source Database PortThe port number of the source database. Common values: 5432 (PostgreSQL), 3306 (MySQL), 27017 (MongoDB).
Database AWS Secret ARN(Optional) The ARN of the AWS Secrets Manager secret containing database credentials, if provided in stage 2.
Server Shared Memory AllocationConfigures the shared memory size allocated to the replication server.
  • Scroll down and check the box labeled "I acknowledge that AWS CloudFormation might create IAM resources with custom names".
  • Click on "Create stack".
  • After the stack is created, return to Baseshift. The yellow dot will turn green once the agent and replication server are successfully registered.
  • Click Next to continue.