Get started with Gluesync Integration

Get your first data integration up and running with Gluesync in minutes. This guide will walk you through the essential steps to connect your databases and start replicating data.

Prerequisites

Before you begin, ensure you have:

For the fastest setup, consider using our automated installation scripts that handle both Docker installation and Gluesync deployment in one go. Check out the automated installation options.

New to Gluesync? Check our introduction to learn about its capabilities.

Quick start steps

1. Access the Control Plane

  1. Launch Gluesync Control Plane

  2. Open your browser and navigate to https://gluesync-host-address (for Docker/Podman deployments, Kubernetes) or http://localhost:1717 (for other deployments)

  3. Log in with your credentials

2. Create your first pipeline

  1. Go to "Pipelines"

  2. Click "New +"

  3. Begin by selecting the source agent from the list

    If the required source or target agents aren’t available in the selection, you’ll need to add them first. See our Adding agents guide for instructions on deploying new agents using the Gluesync Conductor module.

3. Configure your source

  1. From the "Sources" section in the navigation menu

  2. Select "Add New Source"

  3. Choose your source database type

  4. Enter connection details:

    • Host and port

    • Authentication credentials

    • Database name

  5. Test the connection

  6. Save your configuration

4. Setup your target

  1. From the "Targets" section in the navigation menu

  2. Click "Add New Target"

  3. Select your target platform, if none is available you’ll need to deploy a target agent first using the Adding agents guide

  4. Configure connection parameters

  5. Verify the connection

  6. Save the target configuration

5. Configure replication entities

  1. From the Objects Browser section, select the tables/collections to replicate: these are your Entities

  2. Review and save according to your replication strategy

6. Review and finalize

  1. Review your pipeline configuration (name, description)

  2. Confirm source and target settings

  3. Validate replication strategy

  4. Save and deploy the pipeline

7. Start replication

  1. Select your pipeline from the dashboard

  2. When ready, click on "Play" to configure replication options for one or more entities

  3. Choose:

    • Real-time CDC or snapshot for continuous replication

    • Snapshot only for one-time data transfer

    • Re-sync to reset and restart replication from the beginning

      Use this handy guide to understand replication options and their implications: for detailed information on each option, see the Managing Snapshot tasks documentation.

  4. Monitor the replication progress using the monitoring tools in the dashboard, see Monitoring for details

  5. Check data consistency and integrity using the validation reports and logs

Next steps

After your first integration is running, you can:

Action Description

Monitor Performance

Track replication metrics and system health

Troubleshoot

Learn about common issues and their solutions

Best Practices

Discover tips for optimal performance

Common use cases

Here are some popular integration scenarios:

  • Real-time Analytics: Replicate transactional data to analytics platforms

  • Data Warehousing: Consolidate data from multiple sources

  • Cloud Migration: Move data from on-premise to cloud databases

  • Event Streaming: Connect databases with messaging systems

Need Help?

If you encounter any issues or need assistance:

Video tutorial

Replicate data from Sybase to Couchbase

For detailed information about specific database setups, check our Agents documentation.