Streaming

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

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.