Skip to main content

schema_registry

Publishes schemas to SchemaRegistry.

# Common config fields, showing default values
output:
  label: ""
  schema_registry:
    url: "" # No default (required)
    subject: "" # No default (required)
    max_in_flight: 64

Performance​

This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field max_in_flight.

Examples​

Write schemas​

Write schemas to a Schema Registry instance and log errors for schemas which already exist.

output:
  fallback:
    - schema_registry:
        url: http://localhost:8082
        subject: ${! @schema_registry_subject }
        subject_compatibility_level: ${! @schema_registry_subject_compatibility_level }
    - switch:
        cases:
          - check: '@fallback_error == "request returned status: 422"'
            output:
              drop: {}
              processors:
                - log:
                    message: |
                      Subject '${! @schema_registry_subject }' version ${! @schema_registry_version } already has schema: ${! content() }
          - output:
              reject: ${! @fallback_error }

Fields​

url​

The base URL of the schema registry service.

Type: string

subject​

Subject.

This field supports interpolation functions.

Type: string

subject_compatibility_level​

The compatibility level for the subject. Can be one of BACKWARD, BACKWARD_TRANSITIVE, FORWARD, FORWARD_TRANSITIVE, FULL, FULL_TRANSITIVE, NONE.

This field supports interpolation functions.

Type: string

backfill_dependencies​

Backfill schema references and previous versions.

Type: bool
Default: true

translate_ids​

Translate schema IDs.

Type: bool
Default: false

normalize​

Normalize schemas.

Type: bool
Default: true

remove_metadata​

Remove metadata from schemas.

Type: bool
Default: true

remove_rule_set​

Remove rule set from schemas.

Type: bool
Default: true

input_resource​

The label of the schema_registry input from which to read source schemas.

Type: string
Default: "schema_registry_input"

tls​

Custom TLS settings can be used to override system defaults.

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​

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.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

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

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: array of object
Default: []

tls.client_certs[].cert​

A plain text certificate to use.

Type: string
Default: ""

tls.client_certs[].key​

A plain text certificate key to use.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

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.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

max_in_flight​

The maximum number of messages to have in flight at a given time. Increase this to improve throughput.

Type: int
Default: 64

oauth​

Allows you to specify open authentication via OAuth version 1.

Type: object

oauth.enabled​

Whether to use OAuth version 1 in requests.

Type: bool
Default: false

oauth.consumer_key​

A value used to identify the client to the service provider.

Type: string
Default: ""

oauth.consumer_secret​

A secret used to establish ownership of the consumer key.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

oauth.access_token​

A value used to gain access to the protected resources on behalf of the user.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

oauth.access_token_secret​

A secret provided in order to establish ownership of a given access token.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

basic_auth​

Allows you to specify basic authentication.

Type: object

basic_auth.enabled​

Whether to use basic authentication in requests.

Type: bool
Default: false

basic_auth.username​

A username to authenticate as.

Type: string
Default: ""

basic_auth.password​

A password to authenticate with.

Secret

This field contains sensitive information. Use a secret reference rather than a literal value.

Type: string
Default: ""

jwt​

BETA: Allows you to specify JWT authentication.

Type: object

jwt.enabled​

Whether to use JWT authentication in requests.

Type: bool
Default: false

jwt.private_key_file​

A file with the PEM encoded via PKCS1 or PKCS8 as private key.

Type: string
Default: ""

jwt.signing_method​

A method used to sign the token such as RS256, RS384, RS512 or EdDSA.

Type: string
Default: ""

jwt.claims​

A value used to identify the claims that issued the JWT.

Type: map of unknown
Default: {}

jwt.headers​

Add optional key/value headers to the JWT.

Type: map of unknown
Default: {}