Kafka Connect

Deploy and operate Kafka Connect connectors in Orca Agent Engine on StreamNative Cloud.

Kafka Connect runs source and sink connector plugins against a managed Connect worker. The Workspace registry exposes worker health, plugin discovery, connector configuration, lifecycle, tasks, topics, and offsets.

This resource is a StreamNative Cloud capability served under /apis/cloud.sn.io/v1. A self-hosted engine does not advertise the cloud.sn.io extension group. The ork CLI and TypeScript SDK check GET /apis and report that the capability is unavailable before sending the resource request.

Get your registry endpoint

Registry endpoint

Examples on this page target your registry endpoint - the deployment host root, with no path suffix. For CLI, set ORCA_REGISTRY_URL and exactly one of ORCA_ACCESS_TOKEN (Bearer) or ORCA_API_KEY (x-api-key). For TypeScript SDK, set ORCA_BASE_URL / ORCA_API_KEY (Bearer). To find the endpoint, see Connect to the registry.

Connector configuration fields

Field	Type	Required	Description
`name`	string	Yes	Connector name.
`config`	object	Yes	String-to-string Kafka Connect configuration. Must include `connector.class`.
`config.sn.connection`	string	Yes	Workspace Kafka connection.
`initial_state`	enum	No	`RUNNING`, `PAUSED`, or `STOPPED`.

Connector plugins define the rest of the config map. Inspect the installed plugin list and config definition before applying a connector.

Discover plugins

ork kafka-connect get plugins -o json
ork kafka-connect describe plugin io.confluent.connect.s3.S3SinkConnector -o json

Create or update a connector

The CLI apply command creates the connector when it does not exist and replaces its configuration when it does. --connection writes sn.connection into the config before sending it.

connector.json

{
  "name": "event-archive",
  "initial_state": "RUNNING",
  "config": {
    "connector.class": "io.confluent.connect.s3.S3SinkConnector",
    "tasks.max": "2",
    "topics": "events"
  }
}

ork kafka-connect apply \
  --config-file connector.json \
  --connection events-kafka \
  -o json

To replace an existing connector's configuration through the SDK, call orca.cloud.connectors.kafka.connectors.updateConfig(name, completeConfig). The raw route is PUT /apis/cloud.sn.io/v1/connectors/kafka/connectors/{name}/config.

Operate Kafka Connect

Capability	CLI	TypeScript
Worker health/info	`ork kafka-connect health`, `info`	`.kafka.health()`, `.kafka.serverInfo()`
List/retrieve/delete connectors	`get connectors`, `describe connector`, `delete connector`	`.connectors.list()`, `.retrieve()`, `.delete()`
Config	`apply`, `patch connector`	`.retrieveConfig()`, `.updateConfig()`
Status and tasks	`get status`, `get tasks`, `get task-status`	`.retrieveStatus()`, `.listTasks()`, `.retrieveTaskStatus()`
Lifecycle	`pause`, `resume`, `stop`, `restart`	`.pause()`, `.resume()`, `.stop()`, `.restart()`
Offsets	`get offsets`, `patch offsets`, `delete offsets`	`.retrieveOffsets()`, `.updateOffsets()`, `.resetOffsets()`
Active topics	`get topics`, `reset topics`	`.retrieveActiveTopics()`, `.resetActiveTopics()`

The CLI reference documents config patching, task restart options, offset formats, and confirmation behavior.

Connector plugin config validation is not implemented. The Cloud OpenAPI operation declares no successful response, the TypeScript SDK deliberately omits it, and the CLI does not expose it. Inspect the plugin definition, then apply the complete config and use the returned API error to correct invalid fields.

Get your registry endpoint

Connector configuration fields

Discover plugins

Create or update a connector

Operate Kafka Connect

Permissions

What's next

Connections

Sources

Sinks

CLI reference

On this page