This is the template YAML connector file. To make it useful, it needs to be
populated. In the next section we will go over the different sections of the connector configuration file.
# connector.yaml# Version of the schema of the connector config# Valid value is `0.1.0`apiVersion:0.1.0meta:name:version:type:topic:# optionalproducer:# optionallinger:# optionalbatch-size:# optionalcompression:# optionalconsumer:# optionalpartition:# optionalmax_bytes:# optionalsecrets:- name:secret_1# optionaltransforms:- uses:smartmodule_namewith:param_name:param_value# Type specific configs# key depends on connector# <custom_key>:# foo: bar## eg.# http:# endpoint: https://example.com
Connector apiVersion configuration
The apiVersion is the version of the connector API that the connector uses to parse the configuration file. The current only accepted version is 0.1.0.
Connector meta configuration
The meta section contains the metadata for the connector:
The name is the name of the connector. e.g. my-connector.
The type is the type of the connector. e.g. http-source, http-sink, mqtt-source.
See the Connectors section in the navigation for the full list of connectors supported.
The version is the version of the connector. e.g. 0.2.0.
The topic is the topic that the connector will connect to. e.g. my-topic. The topic will be created automatically if it does not exist.
The secrets(optional) is a list of secrets that the connector will use. This accepts a list of objects with the key name.
The producer(optional) is the producer configuration for the connector. Currently, this is only used for source/inbound connectors. The current supported configurations are linger, compression and batch_size. All configurations are optional. See examples to a list of valid values for each configuration.
The consumer(optional) is the consumer configuration for the connector. Currently, this is only used for sink/outbound connectors. The current supported configurations are partition and max_bytes. Both configurations are optional. See examples to a list of valid values for each configuration.
An example with all the keys filled for a http-source connector:
apiVersion:0.1.0meta:name:my-http-source-connectortype:http-sourceversion:0.2.0topic:my-topicproducer:linger:1msbatch_size:"44.0 MB"# possible values: `none`, `gzip`, `snappy` and `lz4`compression:gzipsecrets:- name:MY_SECRET
An example with all the keys filled for a http-sink connector: