rpk connect lint

Check a Redpanda Connect configuration file for syntax errors and potential issues without running it.

This command exits with status code 1 if any linting errors are detected.

Usage

rpk connect lint [flags]

Examples

This section provides examples of how to use rpk connect lint.

Lint a specific file.

rpk connect lint target.yaml

Lint all YAML files in a directory.

rpk connect lint ./configs/*.yaml

Lint with resource imports.

rpk connect lint -r ./foo.yaml ./bar.yaml

Lint all files in a directory tree.

rpk connect lint ./configs/...

Flags

Value Type Description

--deprecated

bool

Print linting errors for the presence of deprecated fields.

--labels

bool

Print linting errors when components do not have labels.

--skip-env-var-check

bool

Do not produce lint errors when environment interpolations exist without defaults within configs but aren’t defined.

--verbose

bool

Print the lint result for each target file.

-r, --resources

strings

pull in extra resources from a file, which can be referenced the same as resources defined in the main config, supports glob patterns (requires quotes).

-e, --env-file

strings

import environment variables from a dotenv file.

-t, --templates

strings

EXPERIMENTAL: import Redpanda Connect templates, supports glob patterns (requires quotes).

--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.

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.