Cloud

rpk cloud byoc

Manage a Redpanda Cloud BYOC agent.

For BYOC, Redpanda installs an agent service in your owned cluster. The agent then proceeds to provision further infrastructure and eventually, a full Redpanda cluster.

The BYOC command runs Terraform to create and start the agent. You first need a redpanda-id (or cluster ID); this is used to get the details of how your agent should be provisioned. You can create a BYOC cluster in our cloud UI and then come back to this command to complete the process.

rpk runs the BYOC plugin version that is pinned to your cluster, and downloads it if needed. The validate subcommand (rpk cloud byoc aws validate, and the same for gcp and azure) does not need --redpanda-id. Because it has no cluster to pin to, it uses the latest plugin version.

To skip the version check and run the installed plugin as is, set RPK_CLOUD_SKIP_VERSION_CHECK=1 (or true). This applies only when a plugin is already installed. If no plugin is installed, rpk still downloads one.

Usage

rpk cloud byoc [flags]

Subcommands

Command Description

rpk cloud byoc install

Install the BYOC plugin. This command downloads the BYOC managed plugin if necessary.

rpk cloud byoc uninstall

Uninstall the BYOC plugin. This command deletes your locally downloaded BYOC managed plugin if it exists.

Flags

Value Type Description

--client-id

string

Client ID of the Redpanda Cloud service account.

--client-secret

string

Client secret of the Redpanda Cloud service account.

--redpanda-id

string

The Redpanda ID of the cluster you are creating.

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.