ork connections

The ork connections commands manage Connection resources through the Workspace registry API. A connection stores endpoint and authentication details for an external Pulsar cluster, Kafka cluster, or generic system, so functions, sources, sinks, and Kafka Connect connectors can reference it by name. 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.

ork connections
├── list      List connections
├── get       Get one connection
├── create    Create a connection
├── validate  Validate a connection without storing it
├── update    Update a connection
├── delete    Delete a connection
└── test      Test connection health

ork connections list

List the connections in the Workspace.

ork connections list [flags]

ork connections list \
  --registry-url "$ORCA_REGISTRY_URL" \
  --access-token "$ORCA_ACCESS_TOKEN" \
  --output json

The text output lists each connection's name, type, phase, and whether it is internal.

ork connections get

Get one connection by name.

ork connections get [name] [flags]

ork connections get my-kafka -o yaml

ork connections create

Create a connection. The --name and --type flags are required. The remaining flags depend on the connection type - Pulsar flags apply only to --type pulsar, Kafka flags only to --type kafka, and generic ("other") flags only to --type other. Mixing flags across types fails validation.

ork connections create --name <name> --type <type> [flags]

Common flags

Pulsar flags (--type pulsar)

A Pulsar connection requires at least one of --pulsar-service-url or --pulsar-admin-url.

Kafka flags (--type kafka)

A Kafka connection requires --kafka-bootstrap-servers.

Generic flags (--type other)

A generic connection requires --other-endpoint.

Examples

ork connections create \
  --registry-url "$ORCA_REGISTRY_URL" \
  --access-token "$ORCA_ACCESS_TOKEN" \
  --name my-kafka \
  --type kafka \
  --kafka-bootstrap-servers broker:9092

With -o text (the default), create prints a confirmation. With -o json or -o yaml, it fetches and renders the created connection.

ork connections validate

Validate a connection configuration without storing it. validate accepts the same --name, --type, and type-specific flags as create. It prints a confirmation when the Cloud extension accepts the configuration.

ork connections validate \
  --name my-kafka \
  --type kafka \
  --kafka-bootstrap-servers broker:9092 \
  --kafka-auth-type none

ork connections update

Update an existing connection. The --name flag is required and identifies the connection to change. The CLI reads the current configuration, then merges changed flags. To change the connection type, pass --type with the new value and its required endpoint flags.

ork connections update --name <name> [flags]

update accepts the same type-specific flags as create. The --name flag is required; --type is optional and defaults to the existing connection's type.

ork connections update \
  --registry-url "$ORCA_REGISTRY_URL" \
  --access-token "$ORCA_ACCESS_TOKEN" \
  --name my-kafka \
  --kafka-bootstrap-servers broker-1:9092,broker-2:9092

To disable Pulsar TLS, pass --pulsar-tls-enabled=false without any TLS sub-flags:

ork connections update --name my-pulsar --pulsar-auth-type none --pulsar-tls-enabled=false

ork connections delete

Delete a connection by name.

ork connections delete [name]

ork connections delete my-kafka \
  --registry-url "$ORCA_REGISTRY_URL" \
  --access-token "$ORCA_ACCESS_TOKEN"

ork connections test

Test a connection's health. The CLI reports whether the connection is healthy, its phase, the last test time, and any message.

ork connections test [name] [flags]

ork connections test my-kafka -o json \
  --registry-url "$ORCA_REGISTRY_URL" \
  --access-token "$ORCA_ACCESS_TOKEN"

What's next