ork kafka-connect

Manage Kafka Connect connectors, plugins, and offsets in your Orca Workspace with the ork kafka-connect commands.

The ork kafka-connect commands manage Kafka Connect resources through the Workspace registry API. Use them to inspect the Connect cluster, apply connector configurations, control connector lifecycle, and manage offsets. These commands require the cloud.sn.io extension and are unavailable on a self-hosted engine.

Commands read --registry-url / ORCA_REGISTRY_URL and exactly one credential: --access-token / ORCA_ACCESS_TOKEN or --api-key / ORCA_API_KEY. See ork CLI for setup.

Kafka Connect commands with -o / --output accept text, json, and yaml. ork kafka-connect apply --config-file also parses JSON or YAML configuration files.

ork kafka-connect
├── info                          Cluster information
├── health                        Worker health
├── available-connectors          Built-in connector catalog
├── config-definition <name>      Built-in connector field definitions
├── get
│   ├── connectors                List connectors
│   ├── plugins                   List plugins
│   ├── plugin-catalog            List installed connector definitions
│   ├── config <connector>        Get raw connector configuration
│   ├── status <connector>        Get connector runtime status
│   ├── tasks <connector>         Get task configurations
│   ├── task-status <connector> <id>
│   ├── tasks-config <connector>  Deprecated; use tasks
│   ├── topics <connector>        Get active topics
│   └── offsets <connector>       Get committed offsets
├── describe
│   ├── connector <connector>     Connector detail
│   └── plugin <plugin-class>     Plugin config definitions
├── apply                         Create or update from a config file
├── patch
│   ├── connector <connector>     Modify connector config
│   └── offsets <connector>       Alter offsets
├── restart
│   ├── connector <connector>     Restart a connector
│   └── task <connector> <id>     Restart a task
├── pause <connector>             Pause a connector
├── resume <connector>            Resume a connector
├── stop <connector>              Stop a connector
├── reset
│   └── topics <connector>        Reset active-topic tracking
└── delete
    ├── connector <connector>     Delete a connector
    └── offsets <connector>       Reset offsets

ork kafka-connect info

Display Kafka Connect cluster information: version, commit, and Kafka cluster ID.

ork kafka-connect info [flags]

Flag	Shorthand	Default	Description
`--output`	`-o`	`text`	Output format: `text`, `json`, or `yaml`.

ork kafka-connect info \
  --registry-url "$ORCA_REGISTRY_URL" \
  --access-token "$ORCA_ACCESS_TOKEN"

Kafka Connect health and catalog

Check worker health, list built-in connectors, or inspect a connector's field definitions.

ork kafka-connect health [flags]
ork kafka-connect available-connectors [flags]
ork kafka-connect config-definition [connector-name] [flags]

Each command accepts -o / --output with text, json, or yaml.

ork kafka-connect get

List connectors and plugins, inspect raw connector data, or read committed offsets. Every get subcommand accepts -o / --output with text, json, or yaml.

ork kafka-connect get connectors

List connector names.

ork kafka-connect get connectors [flags]

Flag	Shorthand	Default	Description
`--output`	`-o`	`text`	Output format: `text`, `json`, or `yaml`.

ork kafka-connect get plugins

List available connector plugins with class, type, and version.

ork kafka-connect get plugins [flags]

Flag	Shorthand	Default	Description
`--output`	`-o`	`text`	Output format: `text`, `json`, or `yaml`.
`--connectors-only`		`true`	List only connector plugins.

ork kafka-connect get offsets

Get the committed offsets for a connector.

ork kafka-connect get offsets [connector-name] [flags]

Flag	Shorthand	Default	Description
`--output`	`-o`	`text`	Output format: `text`, `json`, or `yaml`.

ork kafka-connect get offsets my-sink-connector -o json

Other get commands

ork kafka-connect get plugin-catalog [flags]
ork kafka-connect get config [connector-name] [flags]
ork kafka-connect get status [connector-name] [flags]
ork kafka-connect get tasks [connector-name] [flags]
ork kafka-connect get task-status [connector-name] [task-id] [flags]
ork kafka-connect get topics [connector-name] [flags]

ork kafka-connect get tasks-config [connector-name] remains available for compatibility but is deprecated; use get tasks instead.

ork kafka-connect describe

Show detailed information about one connector or plugin.

ork kafka-connect describe connector

Display a connector's type, state, configuration, and tasks.

ork kafka-connect describe connector [connector-name] [flags]

Flag	Shorthand	Default	Description
`--output`	`-o`	`text`	Output format: `text`, `json`, or `yaml`.

ork kafka-connect describe plugin

Display a plugin's configuration definitions.

ork kafka-connect describe plugin [plugin-class] [flags]

Flag	Shorthand	Default	Description
`--output`	`-o`	`text`	Output format: `text`, `json`, or `yaml`.

ork kafka-connect describe plugin io.confluent.connect.s3.S3SinkConnector

ork kafka-connect apply

Create or update a connector from a config file. If the connector already exists, its configuration is updated; otherwise it is created. The connector must resolve a Workspace connection through sn.connection - supply it with --connection, --use-connection, or in the config file.

ork kafka-connect apply --config-file <path> [flags]

Flag	Shorthand	Default	Description
`--config-file`	`-f`		Connector config file in JSON or YAML. Required.
`--dry-run`		`false`	Validate the connector configuration without applying changes.
`--connection`			Kafka connection name written to config key `sn.connection`.
`--use-connection`		`false`	Interactively select a Kafka connection for `sn.connection`.
`--output`	`-o`	`text`	Output format: `text`, `json`, or `yaml`.

The config file has a name, an optional initial_state (RUNNING, PAUSED, or STOPPED), and a config map. The config must include connector.class. --dry-run performs local checks only; it does not call server-side validation. sn.connection cannot change after a connector exists.

ork kafka-connect apply \
  --registry-url "$ORCA_REGISTRY_URL" \
  --access-token "$ORCA_ACCESS_TOKEN" \
  --config-file connector.yaml \
  --connection my-kafka

ork kafka-connect patch

Modify a connector's configuration or alter its offsets.

ork kafka-connect patch connector

Connector configuration patching is not implemented by the current Java runtime. The command exits with an error before sending a request:

ork kafka-connect patch connector [connector-name]

Use ork kafka-connect apply --config-file <path> with the complete desired config instead.

ork kafka-connect patch offsets

Alter offsets for a connector. Provide either the sink offset flags (--kafka-topic, --kafka-partition, --kafka-offset) or the source offset flags (--source-partition, --source-offset), but not both. The command prompts for confirmation unless --force is set.

ork kafka-connect patch offsets [connector-name] [flags]

Flag	Default	Description
`--kafka-topic`		Kafka topic name for sink connector offsets.
`--kafka-partition`	`0`	Kafka partition for sink connector offsets.
`--kafka-offset`	`0`	Kafka offset for sink connector offsets.
`--source-partition`		Source partition as JSON.
`--source-offset`		Source offset as JSON.
`--force`	`false`	Skip the confirmation prompt.

ork kafka-connect patch offsets my-sink-connector \
  --kafka-topic events --kafka-partition 0 --kafka-offset 100 \
  --force

ork kafka-connect restart

Restart a connector or one of its tasks.

ork kafka-connect restart connector

ork kafka-connect restart connector [connector-name] [flags]

Flag	Default	Description
`--include-tasks`	`false`	Restart connector tasks too.
`--only-failed`	`false`	Restart only failed connector or tasks.
`--output`	`text`	Output format: `text`, `json`, or `yaml`.

ork kafka-connect restart task

ork kafka-connect restart task [connector-name] [task-id]

ork kafka-connect restart task my-sink-connector 0

ork kafka-connect pause, resume, stop

Control a connector's lifecycle. Each takes the connector name as a positional argument.

ork kafka-connect pause [connector-name]
ork kafka-connect resume [connector-name]
ork kafka-connect stop [connector-name]

ork kafka-connect pause my-sink-connector
ork kafka-connect resume my-sink-connector

ork kafka-connect reset

Reset a connector's active-topic tracking.

ork kafka-connect reset topics [connector-name]

ork kafka-connect delete

Delete a connector or reset its offsets.

ork kafka-connect delete connector

ork kafka-connect delete connector [connector-name]

ork kafka-connect delete offsets

Reset a connector's offsets. Prompts for confirmation unless --force is set.

ork kafka-connect delete offsets [connector-name] [flags]

Flag	Default	Description
`--force`	`false`	Skip the confirmation prompt.

ork kafka-connect delete offsets my-sink-connector --force