redpanda_migrator_offsets

Beta

Use the redpanda_migrator_offsets output in conjunction with the kafka_franz input that is configured to read the __consumer_offsets topic. This output uses the Franz Kafka client library.

  • Common

  • Advanced

# Common config fields, showing default values
output:
  label: ""
  redpanda_migrator_offsets:
    seed_brokers: [] # No default (required)
    kafka_key: ${! @kafka_key }
    max_in_flight: 1
# All config fields, showing default values
output:
  label: ""
  redpanda_migrator_offsets:
    seed_brokers: [] # No default (required)
    kafka_key: ${! @kafka_key }
    client_id: benthos
    max_in_flight: 1
    timeout: 10s
    max_message_bytes: 1MB
    broker_write_max_bytes: 100MB
    tls:
      enabled: false
      skip_cert_verify: false
      enable_renegotiation: false
      root_cas: ""
      root_cas_file: ""
      client_certs: []
    sasl: [] # No default (optional)
    max_retries: 0
    backoff:
      initial_interval: 1s
      max_interval: 5s
      max_elapsed_time: 30s

Fields

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

seed_brokers:
  - foo:9092
  - bar:9092

seed_brokers:
  - foo:9092,bar:9092

kafka_key

Kafka key.

This field supports interpolation functions.

Type: string

Default: "${! @kafka_key }"

client_id

An identifier for the client connection.

Type: string

Default: "benthos"

max_in_flight

The maximum number of batches to send parallel at any given time.

Type: int

Default: 1

timeout

The maximum period of time to wait for message sends before abandoning the request and retrying

Type: string

Default: "10s"

max_message_bytes

The maximum space in 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: "1MB"

# Examples

max_message_bytes: 100MB

max_message_bytes: 50mib

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: "100MB"

# Examples

broker_write_max_bytes: 128MB

broker_write_max_bytes: 50mib

tls

Override system defaults with custom TLS settings.

Type: object

tls.enabled

Whether custom TLS settings are enabled.

Type: bool

Default: false

tls.skip_cert_verify

Whether to skip server-side certificate verification.

Type: bool

Default: false

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.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. Review your cluster security 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.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: array

Default: []

# Examples

client_certs:
  - cert: foo
    key: bar

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

tls.client_certs[].cert

A plain text certificate to use.

Type: string

Default: ""

tls.client_certs[].key

A plain text certificate key to use.

This field contains sensitive information. Review your cluster security before adding it to your configuration.

Type: string

Default: ""

tls.client_certs[].cert_file

The path of a certificate to use.

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. Review your cluster security before adding it to your configuration.

Type: string

Default: ""

# Examples

password: foo

password: ${KEY_PASSWORD}

sasl

Specify one or more methods of SASL authentication. SASL mechanisms are tried 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: array

# Examples

sasl:
  - mechanism: SCRAM-SHA-512
    password: bar
    username: foo

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[].username

A username to provide for PLAIN or SCRAM-* authentication.

Type: string

Default: ""

sasl[].password

A password to provide for PLAIN or SCRAM-* authentication.

This field contains sensitive information. Review your cluster security 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[].extensions

Key/value pairs to add to OAUTHBEARER authentication requests.

Type: object

sasl[].aws

Contains AWS specific fields for when the mechanism is set to AWS_MSK_IAM.

Type: object

sasl[].aws.region

The AWS region to target.

Type: string

Default: ""

sasl[].aws.endpoint

Specify a custom endpoint for the AWS API.

Type: string

Default: ""

sasl[].aws.credentials

Manual configuration of AWS credentials to use (optional). For more information, see Amazon Web Services.

Type: object

sasl[].aws.credentials.profile

A profile from ~/.aws/credentials to use.

Type: string

Default: ""

sasl[].aws.credentials.id

The ID of credentials to use.

Type: string

Default: ""

sasl[].aws.credentials.secret

The secret for the credentials being used.

This field contains sensitive information. Review your cluster security before adding it to your configuration.

Type: string

Default: ""

sasl[].aws.credentials.token

The token for the credentials being used, required when using short-term credentials.

Type: string

Default: ""

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

Default: false

sasl[].aws.credentials.role

A role ARN to assume.

Type: string

Default: ""

sasl[].aws.credentials.role_external_id

An external ID to provide when assuming a role.

Type: string

Default: ""

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

backoff

Control the time intervals between retry attempts.

Type: object

backoff.initial_interval

The initial period to wait between retry attempts.

Type: string

Default: "1s"

backoff.max_interval

The maximum period to wait between retry attempts.

Type: string

Default: "5s"

backoff.max_elapsed_time

The maximum period to wait before retry attempts are abandoned. If set to 0, there is no waiting period.

Type: string

Default: "30s"