Skip to main content

​
Prerequisites

Install the Control Plane CLI. See Installation.
Install Helm (v3 or later).

​
Install a Template

1

Choose a Template

Download the templates repo and browse for the template and version you wish to deploy.
2

Configure Values

Create or edit a values file to customize the template for your environment. This can include settings such as resource limits, replica counts, and any template-specific options.
Your values file must follow the same structure and format as the template’s default values file.
3

Install the Release

Run the following command to install the template as a release:
cpln helm install <RELEASE_NAME> <TEMPLATE> -f <VALUES_FILE> --tag cpln/marketplace=true --tag cpln/marketplace-template=<TEMPLATE_NAME> --tag cpln/marketplace-template-version=<TEMPLATE_VERSION> --org <ORG_NAME> --gvc <GVC_NAME>
Replace:
  • <RELEASE_NAME> — A unique name for this installation.
  • <TEMPLATE> — The path to the template chart (example: /cockroachdb/versions/1.1.0).
  • <VALUES_FILE> — The path to your configured values file. If using the existing values.yaml file in the same path as <TEMPLATE>, this can be omitted.
  • <TEMPLATE_NAME> - The name of the template (example: cockroachdb).
  • <TEMPLATE_VERSION> - The version number of the template (example: 1.1.0)
  • <ORG_NAME> - The name of the org to deploy to.
  • <GVC_NAME> — The GVC to deploy to. If the template creates its own GVC, this may be set in the values file instead.

​
Manage a Template

​
View Releases

List all installed releases in your organization: 
cpln helm list

​
Release Details

View full details for a specific release, including the manifest, values, and notes: 
cpln helm get all <RELEASE_NAME>
You can also retrieve individual pieces of release information: 
# View the rendered manifest
cpln helm get manifest <RELEASE_NAME>

# View the configured values
cpln helm get values <RELEASE_NAME> --all

# View release notes
cpln helm get notes <RELEASE_NAME>

​
Upgrade

To upgrade a release with new values or a new template version: 
cpln helm upgrade <RELEASE_NAME> <TEMPLATE> -f <VALUES_FILE> --org <ORG_NAME> --gvc <GVC_NAME>
Any workloads affected by the change will roll out new deployments. Unchanged items will not be redeployed.

​
Template Preview

Generate a preview of the resources that will be created without deploying: 
cpln helm template <RELEASE_NAME> <TEMPLATE> -f <VALUES_FILE> --org <ORG_NAME> --gvc <GVC_NAME>

​
Revisions

View the revision history for a release: 
cpln helm history <RELEASE_NAME>
Roll back to a previous revision: 
# Roll back to the previous revision
cpln helm rollback <RELEASE_NAME>

# Roll back to a specific revision
cpln helm rollback <RELEASE_NAME> <REVISION_NUMBER>

​
Uninstall a Template

Remove all resources created by the release and delete the release state: 
cpln helm uninstall <RELEASE_NAME>

Manage Helm Releases

Deploy and manage Control Plane resources using Helm charts with the cpln helm command.