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 can customize for your environment. If you are generating a
Shadow Link for Redpanda Cloud, use the --for-cloud flag.
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.
Use the --for-cloud flag when generating your configuration.
Examples
This section provides examples of how to use rpk shadow config generate.
Generate a sample configuration and print it to standard output:
rpk shadow config generateGenerate a configuration template with all the field documentation:
rpk shadow config generate --print-templateSave 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 |
|---|---|---|
|
bool |
Generate configuration suitable for Redpanda Cloud. |
|
string |
File path to save the generated configuration file. If not specified, prints to standard output. |
|
bool |
Generate a configuration template with field descriptions instead of a sample configuration. |
Global flags
| Value | Type | Description |
|---|---|---|
|
string |
Redpanda or |
|
stringArray |
Override |
|
bool |
Ignore |
|
string |
|
|
bool |
Enable verbose logging. |
