Skip to main content

​
Prerequisites

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

​
Install a Template

1

Choose a Template

Browse the Template Catalog to find the template you want to deploy.
  • Each template page includes a full configuration reference and a snippet of the default values.yaml file.
2

Configure Values

Create a values.yaml 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> oci://ghcr.io/controlplane-com/templates/<TEMPLATE_NAME> \
  --version <VERSION> \
  -f values.yaml
Replace:
  • <RELEASE_NAME> — A unique name for this installation.
  • <TEMPLATE_NAME> — The name of the template (example: postgres).
  • <VERSION> — The version to install (example: 3.2.0). Omitting --version defaults to the latest version.
Omitting -f values.yaml will deploy the template using its default values.
Example — install PostgreSQL v3.2.0 with custom values:
cpln helm install my-postgres oci://ghcr.io/controlplane-com/templates/postgres \
  --version 3.2.0 \
  -f values.yaml

​
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> oci://ghcr.io/controlplane-com/templates/<TEMPLATE_NAME> \
  --version <VERSION> \
  -f values.yaml
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> oci://ghcr.io/controlplane-com/templates/<TEMPLATE_NAME> \
  --version <VERSION> \
  -f values.yaml

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

Templates Repository

Source files, default values, and chart definitions for all templates.

Template Packages

OCI packages for all templates, hosted on the GitHub Container Registry.

Manage Helm Releases

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