Cloud

rpk cloud byoc install

Install the BYOC plugin.

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.

This command downloads the BYOC managed plugin, if necessary. The plugin is installed by default if you run a non-install command. This command exists if you want to download the plugin ahead of time.

To define your client_id and client_secret use the -X flag.

Example

rpk cloud byoc install -X cloud.client_id=<your-client-id> -X cloud.client_secret=<your-client-secret>

Usage

rpk cloud byoc install [flags]

Flags

Value Type Description

-h, --help

-

Help for install.

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