This is an example connector template. Templates are written using yaml syntax.

# connector.yaml

# Version of the schema of the connector config
# Valid value is `0.1.0`
apiVersion: 0.1.0

meta:
 name:
 version:
 type:
 topic:

 # optional
 producer:
   # optional
   linger:
   # optional
   batch-size:
   # optional
   compression:

 # optional
 consumer:
   # optional
   partition:
   # optional
   max_bytes:

 # optional
 secrets:
   - name: secret_1

# optional
transforms:
 - uses: smartmodule_name
   with:
     param_name: param_value
# Type specific configs
# key depends on connector
# <custom_key>:
#   foo: bar
#
# eg.
# http:
#   endpoint: https://example.com

required

Provide a name for your connector

required

The kind of Inbound or Outbound connector

required

This version corresponds to the type of Inbound of Outbound connector. See the individual Inbound or Outbound connector page for valid version numbers.

required

This is the name of the topic that sends or recieves records

Default: info

This configures the logging for your connector

Choices:

• off
• info
• warn
• error
• debug
• trace

Default: 0

Select the partition for Outbound connector to watch

Default: 100ms

The maximum time an Inbound connector spends collecting data before sending to topic. Can be combined with batch-size

Default: none

Choices:

• none
• gzip
• snappy
• lz4

Default: 16KB

The maximum size of the Inbound connector producer batch size before sending to topic. Can be combined with linger

This is a list that configures the order of execution of SmartModules against your record data.

This takes a single value, which is the name of your SmartModule

This takes multiple key: value pass to your SmartModule

See individual connector for more details about the available parameters or secrets

In this section is where the unique configuration per connector will be described

parameters:
    example: true
    message: "hello"

Pass sensitive configuration details to your connector

secrets:
    my-secret: secret-value
    A_SECRET: 12345