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 and can execute many operations.
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 the Redpanda Cloud UI
and then come back to this command to complete the process.
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>
Flags
Value | Type | Description |
---|---|---|
|
- |
Help for install. |
|
string |
The redpanda ID of the cluster you are creating. |
|
string |
Redpanda or rpk config file; default search paths are |
|
stringArray |
Override |
|
string |
Profile to use. See |
|
- |
Enable verbose logging. |