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.

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

The client ID of the organization in Redpanda Cloud.

--client-secret

string

The client secret of the organization in Redpanda Cloud.

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