Streaming

rpk connect run

Run a Redpanda Connect pipeline from a configuration file. The pipeline streams data between inputs and outputs with optional processing.

Usage

rpk connect run [flags]

Flags

Value Type Description

--log.level

string

Logging level: OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, ALL. Default is INFO.

-s, --set

strings

Override a configuration field. Format: path=value. Can be used multiple times.

-r, --resources

strings

Additional resource configuration files containing caches, rate limits, or other shared components.

--chilled

bool

Continue to execute a config containing linter errors.

-w, --watcher

bool

EXPERIMENTAL: Watch config files for changes and automatically apply them.

--secrets

strings

Attempt to load secrets from a provided URN. If more than one entry is specified they will be attempted in order until a value is found. Environment variable lookups are specified with the URN env:, which by default is the only entry. In order to disable all secret lookups specify a single entry of none:.

--redpanda-license

string

Provide an explicit Redpanda License, which enables enterprise functionality. By default licenses found at the path /etc/redpanda/redpanda.license are applied.

--chroot

string

Chroot into the provided directory after parsing configuration. Common /etc/ files are copied to the chroot directory, and the directory is made read-only. This flag is only supported on Linux.

--chroot-passthrough

strings

Specify additional files to be copied into the chroot directory. This flag can be used multiple times. It is only supported when --chroot is used.

--disable-telemetry

bool

Disable anonymous telemetry from being emitted by this Connect instance.

--telemetry-deployment-type

string

Tags telemetry payloads with the deployment type. Expected values: self-hosted, byoc, serverless. When unset the field is omitted from the payload.

--telemetry-tenant-id

string

Tags telemetry payloads with an opaque tenant identifier (typically the Redpanda Cloud organization ID for cloud-managed deployments). When unset the field is omitted from the payload.

--rpc-plugins

strings

Plugins to load over the RPC interface. This flag should point to manifest files containing the plugin definitions. Globs are also supported.

-e, --env-file

strings

Import environment variables from a dotenv file.

-t, --templates

strings

EXPERIMENTAL: Import Redpanda Connect templates. This supports glob patterns (requires quotes).

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.