Docs Cloud Redpanda Connect Components Outputs redpanda_migrator_offsets redpanda_migrator_offsets Type: OutputInput Available in: Cloud, Self-Managed Migrates offset data to a Redpanda cluster. To achieve this, pair the redpanda_migrator_offsets output with a matching redpanda_migrator_bundle input. Alternatively, use the redpanda_migrator_bundle input and output to complete the migration of topics, messages, and schemas to a Redpanda cluster. This output uses the Franz Kafka client library. Common Advanced # Common configuration fields, showing default values output: label: "" redpanda_migrator_offsets: seed_brokers: [] # No default (required) offset_topic: ${! @kafka_offset_topic } offset_group: ${! @kafka_offset_group } offset_partition: ${! @kafka_offset_partition } offset_commit_timestamp: ${! @kafka_offset_commit_timestamp } offset_metadata: ${! @kafka_offset_metadata } is_high_watermark: ${! @kafka_is_high_watermark } # All configuration fields, showing default values output: label: "" redpanda_migrator_offsets: seed_brokers: [] # No default (required) client_id: benthos tls: enabled: false skip_cert_verify: false enable_renegotiation: false root_cas: "" # Optional root_cas_file: "" # Optional client_certs: [] # Optional sasl: [] # No default (optional) metadata_max_age: 5m request_timeout_overhead: 10s conn_idle_timeout: 20s offset_topic: ${! @kafka_offset_topic } offset_topic_prefix: source. # No default (optional) offset_group: ${! @kafka_offset_group } offset_partition: ${! @kafka_offset_partition } offset_commit_timestamp: ${! @kafka_offset_commit_timestamp } offset_metadata: ${! @kafka_offset_metadata } is_high_watermark: ${! @kafka_is_high_watermark } timeout: 10s max_message_bytes: 1MiB broker_write_max_bytes: 100MiB max_retries: 0 backoff: initial_interval: 1s max_interval: 5s max_elapsed_time: 30s Fields backoff Control the time intervals between retry attempts. Type: object backoff.initial_interval The initial amount of time to wait between retry attempts. This value increases for each failed attempt up to the backoff.max_interval value. Type: string Default: 1s backoff.max_elapsed_time The maximum amount of time to wait before retry attempts are abandoned. If set to 0, there is no waiting period. Type: string Default: 30s backoff.max_interval The maximum amount of time to wait between retry attempts. Type: string Default: 5s broker_write_max_bytes The maximum number of bytes this output can write to a broker connection in a single write. This field corresponds to Kafka’s socket.request.max.bytes. Type: string Default: 100MiB # Examples: broker_write_max_bytes: 128MB broker_write_max_bytes: 50mib client_id An identifier for the client connection. Type: string Default: benthos conn_idle_timeout Define how long connections can remain idle before they are closed. Type: string Default: 20s is_high_watermark Indicates whether the processed message is the high watermark, which is the offset of the last fully replicated message in the Kafka topic partition. This field supports interpolation functions. Type: string Default: ${! @kafka_is_high_watermark } max_message_bytes The maximum number of bytes that an individual message may use. Messages larger than this value are rejected. This field corresponds to Kafka’s max.message.bytes. Type: string Default: 1MiB # Examples: max_message_bytes: 100MB max_message_bytes: 50mib max_retries The maximum number of retries before giving up on the request. If set to 0, there is no discrete limit. Type: int Default: 0 metadata_max_age The maximum period of time after which metadata is refreshed. Type: string Default: 5m offset_commit_timestamp The Kafka offset commit timestamp to process. This field supports interpolation functions. Type: string Default: ${! @kafka_offset_commit_timestamp } offset_group The name of the Kafka offset consumer group to process. This field supports interpolation functions. Type: string Default: ${! @kafka_offset_group } offset_metadata The Kafka offset metadata value to process. This field supports interpolation functions. Type: string Default: ${! @kafka_offset_metadata } offset_partition The Kafka offset partition ID to process. This field supports interpolation functions. Type: string Default: ${! @kafka_offset_partition } offset_topic The name of the Kafka offset topic to process. This field supports interpolation functions. Type: string Default: ${! @kafka_offset_topic } offset_topic_prefix Adds the specified prefix to the name of each migrated Kafka offset topic. This field supports interpolation functions. Type: string Default: "" request_timeout_overhead Grants an additional buffer or overhead to requests that have timeout fields defined. This field is based on the behavior of Apache Kafka’s request.timeout.ms parameter, but with the option to extend the timeout deadline. Type: string Default: 10s sasl[] Specify one or more methods of SASL authentication, which are attempted in order. If the broker supports the first mechanism, all connections use that mechanism. If the first mechanism fails, the client picks the first supported mechanism. Connections fail if the broker does not support any client mechanisms. Type: object # Examples: sasl: - mechanism: SCRAM-SHA-512 password: bar username: foo sasl[].aws Contains AWS specific fields for when the mechanism is set to AWS_MSK_IAM. Type: object sasl[].aws.credentials Optional manual configuration of AWS credentials to use. More information can be found in Amazon Web Services. Type: object sasl[].aws.credentials.from_ec2_role Use the credentials of a host EC2 machine configured to assume an IAM role associated with the instance. Type: bool sasl[].aws.credentials.id The ID of credentials to use. Type: string sasl[].aws.credentials.profile A profile from ~/.aws/credentials to use. Type: string sasl[].aws.credentials.role A role ARN to assume. Type: string sasl[].aws.credentials.role_external_id An external ID to provide when assuming a role. Type: string sasl[].aws.credentials.secret The secret for the credentials being used. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string sasl[].aws.credentials.token The token for the credentials being used, required when using short term credentials. Type: string sasl[].aws.endpoint Allows you to specify a custom endpoint for the AWS API. Type: string sasl[].aws.region The AWS region to target. Type: string sasl[].extensions Key/value pairs to add to OAUTHBEARER authentication requests. Type: string sasl[].mechanism The SASL mechanism to use. Type: string Option Summary AWS_MSK_IAM AWS IAM based authentication as specified by the 'aws-msk-iam-auth' java library. OAUTHBEARER OAuth Bearer based authentication. PLAIN Plain text authentication. SCRAM-SHA-256 SCRAM based authentication as specified in RFC5802. SCRAM-SHA-512 SCRAM based authentication as specified in RFC5802. none Disable sasl authentication sasl[].password A password to provide for PLAIN or SCRAM-* authentication. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" sasl[].token The token to use for a single session’s OAUTHBEARER authentication. Type: string Default: "" sasl[].username A username to provide for PLAIN or SCRAM-* authentication. Type: string Default: "" seed_brokers[] A list of broker addresses to connect to. Use commas to separate multiple addresses in a single list item. Type: array # Examples: seed_brokers: - "localhost:9092" - "foo:9092" - "bar:9092" - "foo:9092,bar:9092" timeout The maximum period of time to wait for message sends before abandoning the request and retrying it. Type: string Default: 10s tls Override system defaults with custom TLS settings. Type: object tls.client_certs[] A list of client certificates to use. For each certificate, specify values for either the cert and key, or cert_file and key_file fields. Type: object Default: [] # Examples: client_certs: - cert: foo key: bar - cert_file: ./example.pem key_file: ./example.key tls.client_certs[].cert A plain text certificate to use. Type: string Default: "" tls.client_certs[].cert_file The path of a certificate to use. Type: string Default: "" tls.client_certs[].key A plain text certificate key to use. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" tls.client_certs[].key_file The path of a certificate key to use. Type: string Default: "" tls.client_certs[].password A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format. Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" # Examples: password: foo password: ${KEY_PASSWORD} tls.enable_renegotiation Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you’re seeing the error message local error: tls: no renegotiation. Type: bool Default: false tls.enabled Whether custom TLS settings are enabled. Type: bool Default: false tls.root_cas Specify a certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Manage Secrets before adding it to your configuration. Type: string Default: "" # Examples: root_cas: |- -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- tls.root_cas_file Specify the path to a root certificate authority file (optional). This is a file, often with a .pem extension, which contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate. Type: string Default: "" # Examples: root_cas_file: ./root_cas.pem tls.skip_cert_verify Whether to skip server-side certificate verification. Type: bool Default: false Back to top × Simple online edits For simple changes, such as fixing a typo, you can edit the content directly on GitHub. Edit on GitHub Or, open an issue to let us know about something that you want us to change. Open an issue Contribution guide For extensive content updates, or if you prefer to work locally, read our contribution guide . Was this helpful? thumb_up thumb_down group Ask in the community mail Share your feedback group_add Make a contribution 🎉 Thanks for your feedback! redpanda_migrator_bundle reject