OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Migration Service

V4.0.0Community Edition
  • OMS Documentation
  • What's new
  • OMS Community Edition Introduction
    • What is OMS Community Edition?
    • Limits
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Terms
  • Quick Start
    • Data migration process
    • Data synchronization process
  • Deploy OMS Community Edition
    • Deployment type
    • System and network requirements
    • Memory and disk requirements
    • Prepare the environment
    • Deploy OMS Community Edition on a single node
    • Deploy OMS Community Edition on multiple nodes in a single region
    • Deploy OMS Community Edition on multiple nodes in multiple regions
    • Scale-out and deployment
    • Check the deployment
    • Deploy a time-series database (Optional)
  • OMS Community Edition console
    • Log on to the OMS console
    • Overview
    • User center
      • Configure user information
      • Change your logon password
      • Log off
  • Data migration
    • Data migration overview
    • Migrate data from a MySQL database to OceanBase Community Edition
    • Migrate data from OceanBase Community Edition to a MySQL database
    • Migrate data within OceanBase Community Edition
    • Migrate data within OceanBase Community Edition in active-active disaster recovery scenarios
    • Migrate data from a TiDB database to OceanBase Community Edition
    • Migrate data from a PostgreSQL database to OceanBase Community Edition
    • Manage data migration projects
      • View details of a data migration project
      • View and modify migration objects
      • Use tags to manage data migration projects
      • Download and import the settings of migration objects
      • Start, pause, and resume a data migration project
      • Release and delete a data migration project
    • Schema migration mechanisms
    • Supported DDL operations in incremental migration and limits
      • Supported DDL operations in incremental migration from a MySQL database to OceanBase Community Edition and limits
      • Supported DDL operations in incremental migration from OceanBase Community Edition to a MySQL database and limits
      • Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database
    • Configure matching rules for migration objects
  • Data synchronization
    • Data synchronization overview
    • Create a project to synchronize data from OceanBase Database Community Edition to a Kafka instance
    • Create a project to synchronize data from OceanBase Database Community Edition to a RocketMQ instance
    • Manage data synchronization projects
      • View details of a data synchronization project
      • View and modify synchronization objects
      • Use tags to manage data synchronization projects
      • Download and import the settings of synchronization objects
      • Start, pause, and resume a data synchronization project
      • Release and delete a data synchronization project
    • Data formats
  • Create and manage data sources
    • Create data sources
      • Create an OceanBase-CE data source
      • Create a MySQL data source
      • Create a TiDB data source
      • Create a Kafka data source
      • Create a RocketMQ data source
      • Create a PostgreSQL data source
    • Manage data sources
      • View data source information
      • Copy a data source
      • Edit a data source
      • Delete a data source
    • Create a database user
    • User privileges
    • Enable binlogs for the MySQL database
  • OPS & Monitoring
    • O&M overview
    • Go to the overview page
    • Server
      • View server information
      • Update quotas
      • View server logs
    • Components
      • Store
        • Create a store
        • View details of a store
        • Update the configurations of a store
        • Start and pause a store
        • Destroy a store
      • Connector
        • View details of a connector
        • Start and pause a connector
        • Migrate a connector
        • Update the configurations of a connector
        • Batch O\&M
        • Delete a connector
      • JDBCWriter
        • View details of a JDBCWriter
        • Start and pause a JDBCWriter
        • Migrate a JDBCWriter
        • Update the configurations of a JDBCWriter
        • Batch O\&M
        • Delete a JDBCWriter
      • Checker
        • View the information about a checker
        • Start and pause a checker
        • Rerun and reverify a checker
        • Update the configurations of a checker
        • Delete a checker
    • O&M tickets
      • View details of an O\&M ticket
      • Skip a ticket or sub-ticket
      • Retry a ticket or sub-ticket
  • System management
    • Permission Management
      • Overview
      • Manage users
      • Manage departments
    • Alert center
      • View project alerts
      • View system alerts
      • Manage alert settings
    • Associate with OCP
    • System parameters
      • Modify system parameters
      • Modify HA configurations
  • OMS Community Edition O&M
    • Manage OMS services
    • OMS logs
    • O&M operations for the Store component
    • Store parameters
      • Parameters of a MySQL store
      • Parameters of an OceanBase store
    • O&M operations for the Supervisor component
    • Parameters of the Supervisor component
    • O&M operations for the Connector component
    • Connector parameters
      • Parameters of a destination RocketMQ instance
      • Parameters of a DataflowSink instance
      • Parameters in the destination Kafka instance
      • Parameters of the source database in full migration
      • Parameters of the source database in incremental data synchronization
      • Parameters for intermediate-layer synchronization
    • Checker parameters
    • JDBCWriter parameters
    • Parameters of the CM component
  • Reference Guide
    • API Reference
      • Obtain the status of a migration project
      • Obtain the status of a synchronization project
    • OMS error codes
    • Alert Reference
      • oms_host_down
      • oms_host_down_migrate_resource
      • oms_host_threshold
      • oms_migration_failed
      • oms_migration_delay
      • oms_sync_failed
      • oms_sync_status_inconsistent
      • oms_sync_delay
  • Upgrade Guide
    • Overview
    • Upgrade OMS in single-node deployment mode
    • Upgrade OMS in multi-node deployment mode
    • FAQ
  • FAQ
    • General O&M
      • How do I modify the resource quotas of an OMS container?
      • How do I troubleshoot the OMS server down issue?
    • Project diagnostics
      • What do I do when a store does not have data of the timestamp requested by the downstream?
      • What do I do when OceanBase Store failed to access an OceanBase cluster through RPC?
    • OPS & monitoring
      • What are the alert rules?
    • Data synchronization
      • FAQ about synchronization to a message queue
        • What are the strategies for ensuring the message order in incremental data synchronization to Kafka
    • Data migration
      • Full migration
        • FAQ about full migration
          • How do I query the ID of a checker?
          • How do I query log files of the Checker component of OMS?
          • How do I query the verification result files of the Checker component of OMS?
          • What do I do if the destination table does not exist?
      • Incremental synchronization
        • How do I skip DDL statements?
        • How do I update the configurations of a JDBCWriter?
        • How do I start or stop a JDBCWriter?
        • How do I update whitelists and blacklists?
        • What are the application scope and limits of ETL?
    • Installation and deployment
      • How do I download an image?
      • How do I upgrade Store?

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Migration Service
  3. V4.0.0

Create a Kafka data source

Last Updated:2026-09-04 08:14:02

Limits
Prerequisites
Background
Procedure

You must configure data sources before you create a data migration project. To migrate data to a Kafka instance, you must create the Kafka instance as the destination data source. This topic describes how to create a Kafka data source in OceanBase Migration Service (OMS) Community Edition.

Limits

OMS Community Edition allows you to create only a Kafka instance as the destination for data synchronization.

Prerequisites

You have obtained the endpoint of the self-managed Kafka instance.

Background

Data security is a major concern throughout service connectivity verification, link creation, and data transmission. Based on the security system provided by the Kafka service, OMS Community Edition can meet most security requirements in data encryption and user authentication.

Kafka authentication methods supported by OMS Community Edition:

  • GSS-API

    GSS-API is short for Generic Security Services Application Program Interface. GSS-API is a framework that provides general security services to callers. It supports the Kerberos protocol.

  • PLAIN

    PLAIN authentication is simple and does not support dynamic change of users. In this authentication mode, usernames and passwords are configured in plaintext, resulting in low security.

  • SCRAM-SHA-256

    Salted Challenge Response Authentication Mechanism (SCRAM) authenticates users by username and password. SCRAM-SHA-256 can be used together with Transport Layer Security (TLS) for security authentication.

    In this authentication method, users can be dynamically changed, and the user data is stored in Zookeeper. Before a broker is started, a user for communication between the broker and Zookeeper must be created. However, usernames and passwords are configured in plaintext in this authentication method.

  • SCRAM-SHA-512

    SCRAM-SHA-512 can be used together with TLS for security authentication.

Procedure

  1. Log on to the OMS Community Edition console.

  2. In the left-side navigation pane, click Data Source Management .

  3. On the Data Sources page, click New Data Source in the upper-right corner.

  4. In the New Data Source dialog box, select Kafka for Data Source Type.

  5. Specify the following parameters.

    Parameter
    Description
    Data Source Identifier The name of the data source. The name must be 1 to 32 characters in length and can contain Chinese characters, digits, and case-sensitive letters.
    Region Select the region where the data source resides from the drop-down list. The region is the value you set for the cm_region parameter when you deploy OMS Community Edition.
    Notice:
    • This parameter is displayed only when multiple regions are available.
    • Make sure that the regions specified for the data source and configured in OMS Community Edition are the same. Otherwise, the migration and synchronization performance may be poor.
    Kafka Endpoint The endpoint of the self-managed Kafka cluster, which is in the IP address:port number format.
    Enable SSL Choose whether to enable SSL based on the business needs. To enable SSL, click Upload File and upload an SSL certificate suffixed with .jks.
    Enable Authentication Choose whether to enable authentication based on business needs. Kafka provides data encryption and multiple identity authentication mechanisms to ensure the security of user data and services.
    Authentication Method If authentication is enabled, you must specify the authentication method. OMS Community Edition supports the following authentication methods: GSS-API, PLAIN, SCRAM-SHA-256, and SCRAM-SHA-512.
    KDC Server Address The IP address or domain name of the Kerberos Key Distribution Center (KDC) server. This parameter is displayed only when you set Authentication Method to GSS-API.
    User Entity Enter the username. This parameter is displayed only when you set Authentication Method to GSS-API.
    SSL Certificate Click Upload File and upload a key file suffixed with .keytab. This parameter is displayed only when you set Authentication Method to GSS-API.
    Username The username of the account used for data migration or synchronization. This parameter is not displayed when you set Authentication Method to GSS-API.
    Password The password of the account used for data migration or synchronization. This parameter is not displayed when you set Authentication Method to GSS-API.
    Remarks (optional) Additional information about the data source.
  6. Click Test Connection to test the network connection between OMS Community Edition and the self-managed Kafka instance.

  7. After the connection test succeeds, click OK.

Previous topic

Create a TiDB data source
Last

Next topic

Create a RocketMQ data source
Next
on this page
Limits
Prerequisites
Background
Procedure