Installation

The Control Plane CLI (cpln) can be installed by using npm, homebrew or by downloading the specific binary package for the target operating system.

Execute the following command to install the CLI:

npm install -g @controlplane/cli

Autocomplete

After installing the CLI, enabling autocomplete will help the user quickly iterate through the commands by entering the first few letters of a command and pressing the Tab key.

cpln misc install-completion

If you wish to enable auto-completion in the zsh shell, make sure you have the following commands at the beginning of your ~/.zshrc file:

autoload -U compinit
compinit

Autocomplete workaround for users of Cygwin:

After executing the cpln misc install-completion command:

  1. Copy the cpln.bash file from C:/Users/<username>/.config/tabtab/cpln.bash to C:/cygwin64/home/<username>/.config/tabtab/cpln.bash
  2. Edit or create a new .bashrc file at C:/cygwin64/home/<username>/.bashrc
  3. Add the following line to the .bashrc file: . C:/cygwin64/home/<username>/.config/tabtab/cpln.bash

Commands

The Control Plane CLI is executed by running:

cpln COMMAND SUBCOMMAND [OPTIONS]

The following commands are available (viewable by running cpln --help):

cpln <command>

Commands:
  cpln account         Manage accounts
  cpln agent           Manage agents
  cpln apply           Create or update a resource using an input file
  cpln auditctx        Manage audit contexts
  cpln cloudaccount    Manage cloud accounts
  cpln convert         Convert k8s files to cpln files
  cpln delete          Delete resources from files
  cpln domain          Manage custom domains
  cpln group           Manage groups
  cpln gvc             Manage global virtual clouds
  cpln helm            Manage helm releases on cpln
  cpln identity        Manage identities within a global virtual cloud  [aliases: id]
  cpln image           Manage images and configure Docker login
  cpln location        Manage locations  [aliases: loc]
  cpln login [ref]     Create a profile named "default" and launch a browser to begin the interactive login process
  cpln logs <query>    Show logs
  cpln misc            Miscellaneous helper commands
  cpln mk8s            Manage an mk8s cluster
  cpln org             Manage organizations
  cpln policy          Manage access policies
  cpln profile         Manage local profiles
  cpln quota           Show quotas
  cpln rest            Submit REST requests against the API
  cpln secret          Manage secrets
  cpln serviceaccount  Manage service accounts  [aliases: sa]
  cpln stack           manage docker-compose files  [aliases: compose]
  cpln task            Manage pending tasks
  cpln user            Manage users
  cpln volumeset       Manage a persistent volumeset within a global virtual cloud
  cpln workload        Manage workloads within a global virtual cloud  [aliases: w]

Options:
  --help     Show help  [boolean]
  --version  Show version number  [boolean]

© 2024 Control Plane Corporation

Each command and associated subcommands are described below.

The referenced objects in the subcommands follow this pattern:

[ref]: Optional object

[ref…]: One or more optional objects

<ref>: Required object

<ref…>: One or more required objects

If the response from a command is truncated, use the following options to view the complete response:

  • In JSON: --output json or -o json
  • In YAML: --output yaml or -o yaml

Most of the commands require that the org and/or the GVC be referred to using the --org and/or --gvc options.

In order to avoid entering these options for each command, the default profile can be updated to refer to a default org and/or GVC using the cpln profile update command.

Example: cpln profile update default --org demo-cpln-organization --gvc demo-cpln-gvc

This command will update the default profile to use the demo-cpln-organization org and the demo-cpln-gvc GVC when executing a command that requires an org and/or GVC. The --org and --gvc will not longer be required.


account

Manage accounts

cpln account [SUBCOMMAND]
Commands:
  cpln account get [ref...]  Get accounts by id or list accounts

Options:
  --help  Show help  [boolean]

account Subcommands


account get

Get accounts by id or list accounts

Usage

cpln account get [ref...] [OPTIONS]

An empty reference will return all references


agent

Manage agents

For a detailed overview, please visit the agent’s reference page.

cpln agent [SUBCOMMAND]
Commands:
  cpln agent access-report <ref>  Show the access report for the referenced agent
  cpln agent create               Create a new agent
  cpln agent delete <ref...>      Delete one or more referenced agents
  cpln agent edit <ref>           Edit the referenced agent, as YAML, within an editor
  cpln agent eventlog <ref>       Show the event log of the referenced agent  [aliases: log]
  cpln agent get [ref...]         Retrieve one or more referenced agents
  cpln agent info <ref>           Get info about an agent
  cpln agent manifest             Generate a manifest for running an agent in K8S
  cpln agent patch <ref>          Update the referenced agent's metadata using an input file
  cpln agent permissions          Show the grantable permissions for an agent object type
  cpln agent query                Find all the agents based on the given query
  cpln agent tag <ref...>         Manage the tags belonging to one or more referenced agents
  cpln agent up                   Run an agent within a local Docker instance
  cpln agent update <ref>         Update properties of the referenced agent

Options:
  --help  Show help  [boolean]

agent Subcommands


agent access-report

Show the access report for the referenced agent

Usage

cpln agent access-report <ref> [OPTIONS]

agent create

Create a new agent

Usage

cpln agent create --name AGENT_NAME [OPTIONS]

agent delete

Delete one or more referenced agents

Usage

cpln agent delete <ref...> [OPTIONS]

agent edit

Edit the referenced agent, as YAML, within an editor

Usage

cpln agent edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.


agent eventlog

Show the event log of the referenced agent

Usage

cpln agent eventlog <ref> [OPTIONS]

agent get

Retrieve one or more referenced agents

Usage

cpln agent get [ref...] [OPTIONS]

An empty reference will return all references


agent info

Get info about an agent

Usage

cpln agent info <ref> [OPTIONS]

agent manifest

Generate a manifest for running an agent in K8S

Usage

cpln agent manifest --bootstrap-file FILE_NAME --namespace NAME_SPACE [OPTIONS]

agent patch

Update the referenced agent’s metadata using an input file

Usage

cpln agent patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).


agent permissions

Show the grantable permissions for an agent object type

Usage

cpln agent permissions [OPTIONS]

agent query

Find all the agents based on the given query

Usage

cpln agent query QUERY_OPTIONS [OPTIONS]

agent tag

Manage the tags belonging to one or more referenced agents

Usage

cpln agent tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.


agent up

Run an agent within a local Docker instance

Usage

cpln agent up --bootstrap-file FILE_NAME [--background] [OPTIONS]

agent update

Update properties of the referenced agent

Usage

cpln agent update <ref> --set UPDATE_PROPERTY [OPTIONS]

apply

Create or update a resource using an input file.

Refer to the cpln apply guide for additional details.

Usage

cpln apply [OPTIONS]

auditctx

Manage audit contexts

For a detailed overview, please visit the audit context’s reference page.

cpln auditctx [SUBCOMMAND]
Commands:
  cpln auditctx access-report <ref>  Show the access report for the referenced audit context
  cpln auditctx clone <ref>          Create a clone of the referenced audit context; this will only duplicate its spec.  [aliases: copy]
  cpln auditctx create               Create a new audit context
  cpln auditctx edit <ref>           Edit the referenced audit context, as YAML, within an editor
  cpln auditctx eventlog <ref>       Show the event log of the referenced audit context  [aliases: log]
  cpln auditctx get [ref...]         Retrieve one or more referenced audit contexts
  cpln auditctx patch <ref>          Update the referenced audit context's metadata using an input file
  cpln auditctx permissions          Show the grantable permissions for an audit context object type
  cpln auditctx query                Find all the audit contexts based on the given query
  cpln auditctx tag <ref...>         Manage the tags belonging to one or more referenced audit contexts
  cpln auditctx update <ref>         Update properties of the referenced audit context

Options:
  --help  Show help  [boolean]

auditctx Subcommands


auditctx access-report

Show the access report for the referenced audit context

Usage

cpln auditctx access-report <ref> [OPTIONS]

auditctx clone

Create a clone of the referenced audit context; this will only duplicate its spec.

Usage

cpln auditctx clone <ref> --name CLONE_NAME [OPTIONS]

auditctx create

Create a new audit context

Usage

cpln auditctx create --name NAME [OPTIONS]

auditctx edit

Edit the referenced audit context, as YAML, within an editor

Usage

cpln auditctx edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.


auditctx eventlog

Show the event log of the referenced audit context

Usage

cpln auditctx eventlog <ref> [OPTIONS]

auditctx get

Retrieve one or more referenced audit contexts

Usage

cpln auditctx get [ref...] [OPTIONS]

An empty reference will return all references


auditctx patch

Update the referenced audit context’s metadata using an input file

Usage

cpln auditctx patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).


auditctx permissions

Show the grantable permissions for an audit context object type

Usage

cpln auditctx permissions [OPTIONS]

auditctx query

Find all the audit contexts based on the given query

Usage

cpln auditctx query QUERY_OPTIONS [OPTIONS]

auditctx tag

Manage the tags belonging to one or more referenced audit contexts

Usage

cpln auditctx tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.


auditctx update

Update properties of the referenced audit context

Usage

cpln auditctx update <ref> --set UPDATE_PROPERTY [OPTIONS]

cloudaccount

Manage cloud accounts

For a detailed overview, please visit the cloud account’s reference page.

cpln cloudaccount [SUBCOMMAND]
Commands:
  cpln cloudaccount access-report <ref>  Show the access report for the referenced cloud account
  cpln cloudaccount create-aws           Create an AWS cloud account
  cpln cloudaccount create-azure         Create an Azure cloud account
  cpln cloudaccount create-gcp           Create a GCP cloud account
  cpln cloudaccount create-ngs           Create a NGS cloud account
  cpln cloudaccount delete <ref...>      Delete one or more referenced cloud accounts
  cpln cloudaccount edit <ref>           Edit the referenced cloud account, as YAML, within an editor
  cpln cloudaccount eventlog <ref>       Show the event log of the referenced cloud account  [aliases: log]
  cpln cloudaccount get [ref...]         Retrieve one or more referenced cloud accounts
  cpln cloudaccount patch <ref>          Update the referenced cloud account's metadata using an input file
  cpln cloudaccount permissions          Show the grantable permissions for a cloud account object type
  cpln cloudaccount query                Find all the cloud accounts based on the given query
  cpln cloudaccount tag <ref...>         Manage the tags belonging to one or more referenced cloud accounts

Options:
  --help  Show help  [boolean]

cloudaccount Subcommands


cloudaccount access-report

Show the access report for the referenced cloud account

Usage

cpln cloudaccount access-report <ref> [OPTIONS]

cloudaccount create-aws

Create an AWS cloud account

Usage

cpln cloudaccount create-aws --name ACCOUNT_NAME --role-arn ROLE_ARN [OPTIONS]

By defining an AWS cloud account, you enable workloads to consume services from a specific AWS account. The Control Plane CLI (cpln) provides account-specific instructions for registering an AWS cloud account with Control Plane. Simply execute cpln cloudaccount create-aws --how to obtain step-by-step instructions. The instructions emitted are specific to the organization for the currently logged-on cpln user. To override the organization, pass the --org ORG_NAME option.


cloudaccount create-azure

Create an Azure cloud account

Usage

cpln cloudaccount create-azure --name ACCOUNT_NAME --secret AZURE_SECRET [OPTIONS]

By defining an Azure cloud account, you enable workloads to consume services from a specific Azure account. The Control Plane CLI (cpln) provides account-specific instructions for registering an Azure cloud account with Control Plane. Simply execute cpln cloudaccount create-azure --how to obtain step-by-step instructions. The instructions emitted are specific to the organization for the currently logged-on cpln user. To override the organization, pass the --org ORG_NAME option.


cloudaccount create-gcp

Create a GCP cloud account

Usage

cpln cloudaccount create-gcp --name ACCOUNT_NAME --project-id PROJECT_ID [OPTIONS]

By defining a GCP cloud account, you enable workloads to consume services from a specific GCP account. The Control Plane CLI (cpln) provides account-specific instructions for registering a GCP cloud account with Control Plane. Simply execute cpln cloudaccount create-gcp --how to obtain step-by-step instructions. The instructions emitted are specific to the organization for the currently logged-on cpln user. To override the organization, pass the --org ORG_NAME option.


cloudaccount create-ngs

Create a NGS cloud account

Usage

cpln cloudaccount create-ngs --name ACCOUNT_NAME --secret SECRET_REFERENCE [OPTIONS]

cloudaccount delete

Delete one or more referenced cloud accounts

Usage

cpln cloudaccount delete <ref...> [OPTIONS]

Deleting a cloud account will not remove any configuration at the associated cloud provider


cloudaccount edit

Edit the referenced cloud account, as YAML, within an editor

Usage

cpln cloudaccount edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.


cloudaccount eventlog

Show the event log of the referenced cloud account

Usage

cpln cloudaccount eventlog <ref> [OPTIONS]

cloudaccount get

Retrieve one or more referenced cloud accounts

Usage

cpln cloudaccount get [ref...] [OPTIONS]

An empty reference will return all references


cloudaccount patch

Update the referenced cloud account’s metadata using an input file

Usage

cpln cloudaccount patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).


cloudaccount permissions

Show the grantable permissions for a cloud account object type

Usage

cpln cloudaccount permissions [OPTIONS]

cloudaccount query

Find all the cloud accounts based on the given query

Usage

cpln cloudaccount query QUERY_OPTIONS [OPTIONS]

cloudaccount tag

Manage the tags belonging to one or more referenced cloud accounts

Usage

cpln cloudaccount tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.


convert

Convert k8s files to cpln files

Refer to the cpln convert guide for additional details.

Usage

cpln convert [OPTIONS]

delete

Delete resources from files

Refer to the cpln delete guide for additional details.

Usage

cpln delete [OPTIONS]

domain

Manage custom domains

For a detailed overview, please visit the domain’s reference page.

cpln domain [SUBCOMMAND]
Commands:
  cpln domain access-report <ref>  Show the access report for the referenced domain
  cpln domain create               Create a new domain
  cpln domain delete <ref...>      Delete one or more referenced domains
  cpln domain edit <ref>           Edit the referenced domain, as YAML, within an editor
  cpln domain eventlog <ref>       Show the event log of the referenced domain  [aliases: log]
  cpln domain get [ref...]         Retrieve one or more referenced domains
  cpln domain patch <ref>          Update the referenced domain's metadata using an input file
  cpln domain permissions          Show the grantable permissions for a domain object type
  cpln domain query                Find all the domains based on the given query
  cpln domain tag <ref...>         Manage the tags belonging to one or more referenced domains

Options:
  --help  Show help  [boolean]

domain Subcommands


domain access-report

Show the access report for the referenced domain

Usage

cpln domain access-report <ref> [OPTIONS]

domain create

Create a new domain

Usage

cpln domain create --name DOMAIN_NAME [OPTIONS]

Ownership of the referenced domain is required by setting a TXT DNS entry.

Please review the instructions here.


domain delete

Delete one or more referenced domains

Usage

cpln domain delete <ref...> [OPTIONS]

domain edit

Edit the referenced domain, as YAML, within an editor

Usage

cpln domain edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.


domain eventlog

Show the event log of the referenced domain

Usage

cpln domain eventlog <ref> [OPTIONS]

domain get

Retrieve one or more referenced domains

Usage

cpln domain get [ref...] [OPTIONS]

An empty reference will return all references


domain patch

Update the referenced domain’s metadata using an input file

Usage

cpln domain patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).


domain permissions

Show the grantable permissions for a domain object type

Usage

cpln domain permissions [OPTIONS]

domain query

Find all the domains based on the given query

Usage

cpln domain query QUERY_OPTIONS [OPTIONS]

domain tag

Manage the tags belonging to one or more referenced domains

Usage

cpln domain tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.


group

Manage groups

For a detailed overview, please visit the group’s reference page.

cpln group [SUBCOMMAND]
Commands:
  cpln group access-report <ref>  Show the access report for the referenced group
  cpln group add-member <ref>     Add members to the referenced group
  cpln group clone <ref>          Create a clone of the referenced group; this will only duplicate its spec.  [aliases: copy]
  cpln group create               Create a new group
  cpln group delete <ref...>      Delete one or more referenced groups
  cpln group edit <ref>           Edit the referenced group, as YAML, within an editor
  cpln group eventlog <ref>       Show the event log of the referenced group  [aliases: log]
  cpln group get [ref...]         Retrieve one or more referenced groups
  cpln group patch <ref>          Update the referenced group's metadata using an input file
  cpln group permissions          Show the grantable permissions for a group object type
  cpln group query                Find all the groups based on the given query
  cpln group remove-member <ref>  Remove members from the referenced group
  cpln group tag <ref...>         Manage the tags belonging to one or more referenced groups
  cpln group update <ref>         Update properties of the referenced group

Options:
  --help  Show help  [boolean]

group Subcommands


group access-report

Show the access report for the referenced group

Usage

cpln group access-report <ref> [OPTIONS]

group add-member

Add members to the referenced group

Usage

cpln group add-member <ref> --email USER_EMAIL [OPTIONS]

cpln group add-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]

group clone

Create a clone of the referenced group; this will only duplicate its spec.

Usage

cpln group clone <ref> --name CLONE_NAME [OPTIONS]

group create

Create a new group

Usage

cpln group create --name GROUP_NAME [OPTIONS]

After creating a new group, use the subcommand add-member to populate the group with users and/or service accounts.


group delete

Delete one or more referenced groups

Usage

cpln group delete <ref...> [OPTIONS]

group edit

Edit the referenced group, as YAML, within an editor

Usage

cpln group edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.


group eventlog

Show the event log of the referenced group

Usage

cpln group eventlog <ref> [OPTIONS]

group get

Retrieve one or more referenced groups

Usage

cpln group get [ref...] [OPTIONS]

An empty reference will return all references


group patch

Update the referenced group’s metadata using an input file

Usage

cpln group patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).


group permissions

Show the grantable permissions for a group object type

Usage

cpln group permissions [OPTIONS]

group query

Find all the groups based on the given query

Usage

cpln group query QUERY_OPTIONS [OPTIONS]

group remove-member

Remove members from the referenced group

Usage

cpln group remove-member <ref> --email USER_EMAIL [OPTIONS]

cpln group remove-member <ref> --serviceaccount SERVICE_ACCOUNT [OPTIONS]

group tag

Manage the tags belonging to one or more referenced groups

Usage

cpln group tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.


group update

Update properties of the referenced group

Usage

cpln group update <ref> --set UPDATE_PROPERTY [OPTIONS]

gvc

Manage global virtual clouds

For a detailed overview, please visit the gvc’s reference page.

cpln gvc [SUBCOMMAND]
Commands:
  cpln gvc access-report <ref>         Show the access report for the referenced global virtual cloud
  cpln gvc add-location <ref>          Add one or more locations to the referenced global virtual cloud
  cpln gvc clone <ref>                 Create a clone of the referenced global virtual cloud; this will only duplicate its spec.  [aliases: copy]
  cpln gvc create                      Create a new global virtual cloud
  cpln gvc delete <ref...>             Delete GVCs by name
  cpln gvc delete-all-workloads <ref>  Delete all workloads for the referenced global virtual cloud
  cpln gvc edit <ref>                  Edit the referenced global virtual cloud, as YAML, within an editor
  cpln gvc eventlog <ref>              Show the event log of the referenced global virtual cloud  [aliases: log]
  cpln gvc get [ref...]                Retrieve one or more referenced global virtual clouds
  cpln gvc patch <ref>                 Update the referenced global virtual cloud's metadata using an input file
  cpln gvc permissions                 Show the grantable permissions for a global virtual cloud object type
  cpln gvc query                       Find all the global virtual clouds based on the given query
  cpln gvc remove-location <ref>       Remove one or more locations from the referenced global virtual cloud
  cpln gvc tag <ref...>                Manage the tags belonging to one or more referenced global virtual clouds
  cpln gvc update <ref>                Update properties of the referenced global virtual cloud

Options:
  --help  Show help  [boolean]

gvc Subcommands


gvc access-report

Show the access report for the referenced global virtual cloud

Usage

cpln gvc access-report <ref> [OPTIONS]

gvc add-location

Add one or more locations to the referenced global virtual cloud

Usage

cpln gvc add-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]

gvc clone

Create a clone of the referenced global virtual cloud; this will only duplicate its spec.

Usage

cpln gvc clone <ref> --name CLONE_NAME [OPTIONS]

gvc create

Create a new global virtual cloud

Usage

cpln gvc create --name GVC_NAME --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]

gvc delete

Delete GVCs by name

Usage

cpln gvc delete <ref...> [OPTIONS]

Deleting a gvc will remove all associated resources (workloads, etc.)


gvc delete-all-workloads

Delete all workloads for the referenced global virtual cloud

Usage

cpln gvc delete-all-workloads <ref> [OPTIONS]

Deleting all the associated workloads will remove all associated resources (containers, etc.)


gvc edit

Edit the referenced global virtual cloud, as YAML, within an editor

Usage

cpln gvc edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.


gvc eventlog

Show the event log of the referenced global virtual cloud

Usage

cpln gvc eventlog <ref> [OPTIONS]

gvc get

Retrieve one or more referenced global virtual clouds

Usage

cpln gvc get [ref...] [OPTIONS]

An empty reference will return all references


gvc patch

Update the referenced global virtual cloud’s metadata using an input file

Usage

cpln gvc patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).


gvc permissions

Show the grantable permissions for a global virtual cloud object type

Usage

cpln gvc permissions [OPTIONS]

gvc query

Find all the global virtual clouds based on the given query

Usage

cpln gvc query QUERY_OPTIONS [OPTIONS]

gvc remove-location

Remove one or more locations from the referenced global virtual cloud

Usage

cpln gvc remove-location <ref...> --location {aws-eu-central-1|aws-us-west-2|azure-eastus2|gcp-us-east1} [OPTIONS]

gvc tag

Manage the tags belonging to one or more referenced global virtual clouds

Usage

cpln gvc tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.


gvc update

Update properties of the referenced global virtual cloud

Usage

cpln gvc update <ref> --set UPDATE_PROPERTY [OPTIONS]

helm

Manage helm releases on cpln

Refer to the cpln helm guide for additional details.

cpln helm [SUBCOMMAND]
Commands:
  cpln helm history <release>              Fetch release history
  cpln helm install [release] [chart]      Install a release  [aliases: apply]
  cpln helm list                           Show a list of releases
  cpln helm rollback <release> [revision]  Roll back a release to a previous revision
  cpln helm show <release>                 Show state of a release
  cpln helm template [release] [chart]     Generate cpln resources from a template
  cpln helm uninstall <release>            Uninstall a release  [aliases: destroy, del, delete, un]
  cpln helm upgrade [release] [chart]      Upgrade a release  [aliases: apply]

Options:
  --help  Show help  [boolean]

helm Subcommands


helm history

Fetch release history

Usage

cpln helm history <release> [OPTIONS]

helm install

Install a release

Usage

cpln helm install [release] [chart] [OPTIONS]

helm list

Show a list of releases

Usage

cpln helm list [OPTIONS]

helm rollback

Roll back a release to a previous revision

Usage

cpln helm rollback <release> [revision] [OPTIONS]

helm show

Show state of a release

Usage

cpln helm show <release> [OPTIONS]

helm template

Generate cpln resources from a template

Usage

cpln helm template [release] [chart] [OPTIONS]

helm uninstall

Uninstall a release

Usage

cpln helm uninstall <release> [OPTIONS]

helm upgrade

Upgrade a release

Usage

cpln helm upgrade [release] [chart] [OPTIONS]

identity

Manage identities within a global virtual cloud

For a detailed overview, please visit the identity’s reference page.

cpln identity [SUBCOMMAND]
Commands:
  cpln identity access-report <ref>  Show the access report for the referenced identity
  cpln identity create               Create a new identity
  cpln identity delete <ref...>      Delete one or more referenced identities
  cpln identity edit <ref>           Edit the referenced identity, as YAML, within an editor
  cpln identity eventlog <ref>       Show the event log of the referenced identity  [aliases: log]
  cpln identity get [ref...]         Retrieve one or more referenced identities
  cpln identity patch <ref>          Update the referenced identity's metadata using an input file
  cpln identity permissions          Show the grantable permissions for an identity object type
  cpln identity query                Find all the identities based on the given query
  cpln identity tag <ref...>         Manage the tags belonging to one or more referenced identities
  cpln identity update <ref>         Update properties of the referenced identity

Options:
  --help  Show help  [boolean]

identity Subcommands


identity access-report

Show the access report for the referenced identity

Usage

cpln identity access-report <ref> [OPTIONS]

identity create

Create a new identity

Usage

cpln identity create --name IDENTITY_NAME [OPTIONS]

identity delete

Delete one or more referenced identities

Usage

cpln identity delete <ref...> [OPTIONS]

identity edit

Edit the referenced identity, as YAML, within an editor

Usage

cpln identity edit <ref> [OPTIONS]

The default editor can be set by using the EDITOR environment variable.


identity eventlog

Show the event log of the referenced identity

Usage

cpln identity eventlog <ref> [OPTIONS]

identity get

Retrieve one or more referenced identities

Usage

cpln identity get [ref...] [OPTIONS]

An empty reference will return all references


identity patch

Update the referenced identity’s metadata using an input file

Usage

cpln identity patch <ref> --file FILE_NAME [OPTIONS]

Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).


identity permissions

Show the grantable permissions for an identity object type

Usage

cpln identity permissions [OPTIONS]

identity query

Find all the identities based on the given query

Usage

cpln identity query QUERY_OPTIONS [OPTIONS]

identity tag

Manage the tags belonging to one or more referenced identities

Usage

cpln identity tag <ref...> --tag KEY=VALUE [OPTIONS]

Built-in tags, which begin with cpln/*, can’t be modified.


identity update

Update properties of the referenced identity

Usage

cpln identity update <ref> --set UPDATE_PROPERTY [OPTIONS]

image

Manage images and configure Docker login

For a detailed overview, please visit the image’s reference page.

cpln image [SUBCOMMAND]
Commands:
  cpln image access-report <ref>  Show the access report for the referenced image
  cpln image build                Build and containerize an application into an image. If using buildpacks, everything after -- will be passed down to the pack executable.
  cpln image copy <ref>           Copy an image from one org to another. This will make sure that docker-login has been run against the source and destination org, then will pull, tag and push the image to the destination org.
  cpln image delete <ref...>      Delete one or more referenced images
  cpln image docker-login         Perform a Docker login to the organization's private registry
  cpln image edit <ref>           Edit the referenced image, as YAML, within an editor
  cpln image get [ref...]         Retrieve one or more referenced images
  cpln image patch <ref>          Update the referenced image's metadata using an input file
  cpln image permissions          Show the grantable permissions for an image object type
  cpln image query                Find all the images based on the given query
  cpln image tag <ref...>         Manage the tags belonging to one or more referenced images

Options:
  --help  Show help  [boolean]

image Subcommands


image access-report

Show the access report for the referenced image

Usage

cpln image access-report <ref> [OPTIONS]

image build

Build and containerize an application into an image. If using buildpacks, everything after — will be passed down to the pack executable.

Usage

cpln image build --name IMAGE_NAME:TAG [OPTIONS]

To push an image using this command, the docker-credential-cpln executable must be installed if the CLI was not installed using npm.

The option