Cloud

rpk cloud byoc

Manage a Redpanda Cloud BYOC agent.

Redpanda installs an agent service in your BYOC cluster. The agent then provisions infrastructure and, eventually, a full Redpanda cluster. The command downloads the byoc plugin from Redpanda Cloud.

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.

To create a BYOC cluster, use the Cloud API or the Redpanda Cloud UI. The UI contains the parameters necessary to run rpk cloud byoc apply with your cloud provider.

Usage

rpk cloud byoc [command] [flags]

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.

-h, --help

-

Help for byoc.

--redpanda-id

string

The redpanda ID of the cluster you are creating.

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