rpk shadow update

Update a Shadow Link.

By default, this command opens your default editor with the current Shadow Link configuration. Update the fields you want to change, save the file, and close the editor.

Alternatively, use the --config-file flag to apply a configuration file directly without opening an editor, which is useful for scripted workflows.

In both modes the submitted configuration replaces the entire Shadow Link configuration: any field omitted is reset to its default value. The modes differ only in where the configuration comes from; the editor is seeded with the current configuration, while a configuration file is applied as-is. The name in the configuration file must match LINK_NAME.

Set passwords appear in the editor as the placeholder '<redacted>'; leave the placeholder untouched to keep the existing password, or replace it to set a new one.

You cannot change the Shadow Link name. If you need to rename a Shadow Link, delete it and create a new one with the desired name.

The editor respects your EDITOR environment variable. If EDITOR is not set, the command uses vi on Unix-like systems.

Usage

rpk shadow update <link_name> [flags]

Examples

This section provides examples of how to use rpk shadow update.

Update a shadow link configuration.

rpk shadow update my-shadow-link

Flags

Value Type Description

-c, --config-file

string

Path to a configuration file that replaces the entire Shadow Link configuration; use --help for details. (New in v26.2.2)

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.