Automated Continuous Confluence Replication to Apache Kafka



Use CData Sync for automated, continuous, customizable Confluence replication to Apache Kafka.

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live Confluence data into your Apache Kafka instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure Apache Kafka as a Replication Destination

Using CData Sync, you can replicate Confluence data to Apache Kafka. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select the Destinations tab and locate the Apache Kafka connector.
  3. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Apache Kafka connector. For more information about installing new connectors, see Connections in the Help documentation.
  4. To connect to Apache Kafka, set the following connection properties:
    • Connection Name: Enter a connection name of your choice for the Apache Kafka connection.
    • Bootstrap Servers: Enter the address of the Apache Kafka Bootstrap servers to which you want to connect.
    • Auth Scheme: Select the authentication scheme. Plain is the default setting. For this setting, specify your login credentials:
    • User: Enter the username that you use to authenticate to Apache Kafka.
    • Password: Enter the password that you use to authenticate to Apache Kafka.
    • Type Detection Scheme: Specify the detection-scheme type (None, RowScan, SchemaRegistry, or MessageOnly) that you want to use. The default type is None.
    • Registry Url: Enter the URL to the server for the schema registry.
    • Registry Service: Select the Schema Registry service that you want to use for working with topic schemas.
    • Registry Auth Scheme: Select the scheme that you want to use to authenticate to the schema registry.
    • Use SSL: Specify whether you want to use the Secure Sockets Layer (SSL) protocol. The default value is False.
  5. Once connected, click Create & Test to create, test and save the connection.

You are now connected to Apache Kafka and can use it as both a source and a destination.

NOTE: You can use the Label feature to add a label for a source or a destination.

In this article, we will demonstrate how to load Confluence data into Apache Kafka and utilize it as a destination.

Configure the Confluence Connection

You can configure a connection to Confluence from the Connections tab. To add a connection to your Confluence account, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select a source (Confluence).
  3. Configure the connection properties.

    Obtaining an API Token

    An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

    Connect Using a Confluence Cloud Account

    To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

    • User: The user which will be used to authenticate with the Confluence server.
    • APIToken: The API Token associated with the currently authenticated user.
    • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

    Connect Using a Confluence Server Instance

    To connect to a Server instance, provide the following:

    • User: The user which will be used to authenticate with the Confluence instance.
    • Password: The password which will be used to authenticate with the Confluence server.
    • Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.
  4. Click Connect to Confluence to ensure that the connection is configured properly.
  5. Click Save & Test to save the changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

Replicate Entire Tables

To replicate an entire table, navigate to the Task tab in the Job, click Add Tasks, choose the table(s) from the list of Confluence tables you wish to replicate into Apache Kafka, and click Add Tasks again.

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication with the help of SQL queries.

Schedule Your Replication

Select the Overview tab in the Job, and click Configure under Schedule. You can schedule a job to run automatically by configuring it to run at specified intervals, ranging from once every 10 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your Confluence data to Apache Kafka.

Run the Replication Job

Once all the required configurations are made for the job, select the Confluence table you wish to replicate and click Run. After the replication completes successfully, a notification appears, showing the time taken to run the job and the number of rows replicated.

Free Trial & More Information

Now that you have seen how to replicate Confluence data into Apache Kafka, visit our CData Sync page to explore more about CData Sync and download a free 30-day trial. Start consolidating your enterprise data today!

As always, our world-class Support Team is ready to answer any questions you may have.

Ready to get started?

Learn more or sign up for a free trial:

CData Sync