Cloud

rpk shadow config generate

Generate a configuration file for creating a shadow link.

By default, this command creates a sample configuration file with placeholder values that you customize for your environment.

Use the --for-cloud flag when generating your configuration.

Use the --print-template flag to generate a configuration template with detailed field documentations.

By default, this command prints the configuration to standard output. Use the --output flag to save the configuration to a file.

After you generate the configuration file, update the placeholder values with your actual connection details and settings. Then use rpk shadow create to create the shadow link.

Usage

rpk shadow config generate [flags]

Examples

Generate a sample configuration and print it to standard output:

rpk shadow config generate

Generate a configuration template with all the field documentation:

rpk shadow config generate --print-template

Save the sample configuration to a file:

rpk shadow config generate -o shadow-link.yaml

Save the template with documentation to a file:

rpk shadow config generate --print-template -o shadow-link.yaml

Flags

Value Type Description

--for-cloud

-

Generate configuration suitable for Cloud deployments.

-o, --output

string

File path identifying where to save the generated configuration file. If not specified, prints to standard output.

--print-template

-

Generate a configuration template with field documentation instead of a sample configuration.

-h, --help

-

Help for generate.

--config

string

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

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.