Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
"reference/auditctx",
"reference/cloudaccount",
"reference/domain",
"reference/external-secret-syncer",
"reference/group",
"reference/gvc",
"reference/identity",
Expand Down Expand Up @@ -217,6 +216,33 @@
}
]
},
{
"tab": "Template Catalog",
"groups": [
{
"group": "Template Catalog",
"pages": [
"template-catalog/overview",
{
"group": "Install & Manage",
"pages": [
"template-catalog/install-manage/ui",
"template-catalog/install-manage/cli",
"template-catalog/install-manage/terraform",
"template-catalog/install-manage/pulumi"
]
}
]
},
{
"group": "Templates",
"pages": [
"template-catalog/templates/cockroachdb",
"template-catalog/templates/external-secret-syncer"
]
}
]
},
{
"tab": "Managed Kubernetes",
"groups": [
Expand Down
123 changes: 0 additions & 123 deletions reference/external-secret-syncer.mdx

This file was deleted.

123 changes: 123 additions & 0 deletions template-catalog/install-manage/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
---
title: Install and Manage using the CLI
sidebarTitle: CLI
---

## Prerequisites

<AccordionGroup>
<Accordion title="CLI installed">
Install the Control Plane CLI. See [Installation](/cli-reference/installation).
</Accordion>

<Accordion title="Helm installed">
Install [Helm](https://helm.sh/docs/intro/install/) (v3 or later).
</Accordion>
</AccordionGroup>

## Install a Template

<Steps>
<Step title="Choose a Template">
Download the [template repo](https://github.com/controlplane-com/templates) and browse for the template and version you wish to deploy.
</Step>
<Step title="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.
<Note>
Your values file must follow the same structure and format as the template's default values file.
</Note>
</Step>
<Step title="Install the Release">
Run the following command to install the template as a release:

```bash
cpln helm install <RELEASE_NAME> <TEMPLATE> -f <VALUES_FILE> --org <ORG_NAME> --gvc <GVC_NAME>
```

Replace:
- `<RELEASE_NAME>` — A unique name for this installation.
- `<TEMPLATE>` — The path to the template Chart.yaml file (e.g., `/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.
- `<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.
</Step>
</Steps>

## Manage a Template

### View Releases

List all template releases in your organization:

```bash
cpln helm list
```

### Release Details

View full details for a specific release, including the manifest, values, and notes:

```bash
cpln helm get all <RELEASE_NAME>
```

You can also retrieve individual pieces of release information:

```bash
# 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:

```bash
cpln helm upgrade <RELEASE_NAME> <TEMPLATE> -f <VALUES_FILE> --org <ORG_NAME> --gvc <GVC_NAME>
```

Replace `<TEMPLATE>` or `<VALUES_FILE>` with updated paths.

<Note>
Any workloads affected by the change will roll out new deployments. Unchanged items will not be redeployed.
</Note>

### Template Preview

Generate a preview of the resources that will be created without deploying:

```bash
cpln helm template <RELEASE_NAME> <TEMPLATE> -f <VALUES_FILE> --org <ORG_NAME> --gvc <GVC_NAME>
```

### Revisions

View the revision history for a release:

```bash
cpln helm history <RELEASE_NAME>
```

Roll back to a previous revision:

```bash
# 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:

```bash
cpln helm uninstall <RELEASE_NAME>
```
Loading