legacy_redpanda_migrator_offsets

Available in: Cloud, Self-Managed

Deprecated in 4.67.5

This component is deprecated and will be removed in the next major version release. Please consider moving onto the unified redpanda_migrator input and redpanda_migrator output components. For migration instructions, see Migrate to the Unified Redpanda Migrator.

Migrates offset data to a Redpanda cluster. To achieve this, pair the legacy_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.

Introduced in version 4.37.0.

Common
Advanced

outputs:
  label: ""
  legacy_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 }

outputs:
  label: ""
  legacy_redpanda_migrator_offsets:
    seed_brokers: [] # No default (required)
    client_id: benthos
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs:
        cert: ""
        key: ""
        cert_file: ""
        key_file: ""
        password: ""
    sasl:
      mechanism: "" # No default (required)
      username: ""
      password: ""
      token: ""
      extensions: "" # No default (optional)
      aws:
        region: "" # No default (optional)
        endpoint: "" # No default (optional)
        credentials:
          profile: "" # No default (optional)
          id: "" # No default (optional)
          secret: "" # No default (optional)
          token: "" # No default (optional)
          from_ec2_role: "" # No default (optional)
          role: "" # No default (optional)
          role_external_id: "" # No default (optional)
    metadata_max_age: 5m
    request_timeout_overhead: 10s
    conn_idle_timeout: 20s
    offset_topic: ${! @kafka_offset_topic }
    offset_topic_prefix: ""
    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 time intervals between retry attempts.

Type: object

`backoff.initial_interval`

The initial period to wait between retry attempts.

Type: string

Default: 1s

`backoff.max_elapsed_time`

The maximum period to wait before retry attempts are abandoned. If zero then no limit is used.

Type: string

Default: 30s

`backoff.max_interval`

The maximum period to wait between retry attempts.

Type: string

Default: 5s

`broker_write_max_bytes`

The upper bound for the number of bytes written 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`

The rough amount of time to allow connections to idle before they are closed.

Type: string

Default: 20s

`is_high_watermark`

Indicates if the update represents the high watermark of the Kafka topic partition.

This field supports interpolation functions.

Type: string

Default: ${! @kafka_is_high_watermark }

`max_message_bytes`

The maximum space in bytes than an individual message may take, messages larger than this value will be 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 zero there is no discrete limit.

Type: int

Default: 0

`metadata_max_age`

The maximum age of metadata before it is refreshed. This interval also controls how frequently regex topic patterns are re-evaluated to discover new matching topics.

Type: string

Default: 5m

`offset_commit_timestamp`

Kafka offset commit timestamp.

This field supports interpolation functions.

Type: string

Default: ${! @kafka_offset_commit_timestamp }

`offset_group`

Kafka offset group.

This field supports interpolation functions.

Type: string

Default: ${! @kafka_offset_group }

`offset_metadata`

Kafka offset metadata value.

This field supports interpolation functions.

Type: string

Default: ${! @kafka_offset_metadata }

`offset_partition`

Kafka offset partition.

This field supports interpolation functions.

Type: string

Default: ${! @kafka_offset_partition }

`offset_topic`

Kafka offset topic.

This field supports interpolation functions.

Type: string

Default: ${! @kafka_offset_topic }

`offset_topic_prefix`

Kafka offset topic prefix.

This field supports interpolation functions.

Type: string

Default: ""

`request_timeout_overhead`

The request time overhead. Uses the given time as overhead while deadlining requests. Roughly equivalent to request.timeout.ms, but grants additional time to requests that have timeout fields.

Type: string

Default: 10s

`sasl[]`

Specify one or more methods of SASL authentication. SASL is tried in order; if the broker supports the first mechanism, all connections will use that mechanism. If the first mechanism fails, the client will pick the first supported mechanism. If the broker does not support any client mechanisms, connections will fail.

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.

Requires version 4.2.0 or later.

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 Secrets.

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

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

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 Secrets.

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 in order to establish connections. If an item of the list contains commas it will be expanded into multiple addresses.

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

Type: string

Default: 10s

`tls`

Custom TLS settings can be used to override system defaults.

Type: object

`tls.client_certs[]`

A list of client certificates to use. For each certificate either the fields cert and key, or cert_file and key_file should be specified, but not both.

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 Secrets.

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 Secrets.

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.

Requires version 3.45.0 or later.

Type: bool

Default: false

`tls.enabled`

Whether custom TLS settings are enabled.

Type: bool

Default: false

`tls.root_cas`

An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to 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 Secrets.

Type: string

Default: ""

# Examples:
root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

`tls.root_cas_file`

An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to 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

Was this helpful?

group Ask in the community

mail Share your feedback

group_add Make a contribution

What do you think of this page?

Let us know more:

Let us contact you about your feedback:

legacy_redpanda_migrator_offsets

Fields

backoff

backoff.initial_interval

backoff.max_elapsed_time

backoff.max_interval

broker_write_max_bytes

client_id

conn_idle_timeout

is_high_watermark

max_message_bytes

max_retries

metadata_max_age

offset_commit_timestamp

offset_group

offset_metadata

offset_partition

offset_topic

offset_topic_prefix

request_timeout_overhead

sasl[]

sasl[].aws

sasl[].aws.credentials

sasl[].aws.credentials.from_ec2_role

sasl[].aws.credentials.id

sasl[].aws.credentials.profile

sasl[].aws.credentials.role

sasl[].aws.credentials.role_external_id

sasl[].aws.credentials.secret

sasl[].aws.credentials.token

sasl[].aws.endpoint

sasl[].aws.region

sasl[].extensions

sasl[].mechanism

sasl[].password

sasl[].token

sasl[].username

seed_brokers[]

timeout

tls

tls.client_certs[]

tls.client_certs[].cert

tls.client_certs[].cert_file

tls.client_certs[].key

tls.client_certs[].key_file

tls.client_certs[].password

tls.enable_renegotiation

tls.enabled

tls.root_cas

tls.root_cas_file

tls.skip_cert_verify

Simple online edits

Contribution guide

`backoff`

`backoff.initial_interval`

`backoff.max_elapsed_time`

`backoff.max_interval`

`broker_write_max_bytes`

`client_id`

`conn_idle_timeout`

`is_high_watermark`

`max_message_bytes`

`max_retries`

`metadata_max_age`

`offset_commit_timestamp`

`offset_group`

`offset_metadata`

`offset_partition`

`offset_topic`

`offset_topic_prefix`

`request_timeout_overhead`

`sasl[]`

`sasl[].aws`

`sasl[].aws.credentials`

`sasl[].aws.credentials.from_ec2_role`

`sasl[].aws.credentials.id`

`sasl[].aws.credentials.profile`

`sasl[].aws.credentials.role`

`sasl[].aws.credentials.role_external_id`

`sasl[].aws.credentials.secret`

`sasl[].aws.credentials.token`

`sasl[].aws.endpoint`

`sasl[].aws.region`

`sasl[].extensions`

`sasl[].mechanism`

`sasl[].password`

`sasl[].token`

`sasl[].username`

`seed_brokers[]`

`timeout`

`tls`

`tls.client_certs[]`

`tls.client_certs[].cert`

`tls.client_certs[].cert_file`

`tls.client_certs[].key`

`tls.client_certs[].key_file`

`tls.client_certs[].password`

`tls.enable_renegotiation`

`tls.enabled`

`tls.root_cas`

`tls.root_cas_file`

`tls.skip_cert_verify`