rpk connect dry-run

Test pipeline configurations by performing a dry run. A dry run parses each config and tests the connections of its components.

For a config file or a glob, this command does not lint, so a misspelled field passes. To check fields, use rpk connect lint.

A directory argument is read as a resource repository. Templates in templates/ are registered. Resources in resources/inputs, resources/caches, resources/processors, and resources/outputs are linted as they load and then tested, so a misspelled field in a resource file fails the command. Pipeline config files in the directory are not tested. To test pipeline configs, pass the files or a glob.

The command exits with status code 1 if any connection test fails.

Usage

rpk connect dry-run [flags]

Example

This section provides examples of how to use rpk connect dry-run.

Example.

rpk connect dry-run ./pipeline.yaml

To disable all secret lookups.

rpk connect dry-run --secrets none: ./pipeline.yaml

To test every pipeline config in a directory, pass a glob.

rpk connect dry-run './pipelines/*.yaml'

Flags

Value Type Description

--verbose

bool

Print a pass or fail result for each target and list components that do not support connection tests.

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

-e, --env-file

strings

import environment variables from a dotenv file.

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

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.