Accessing CAEPE with the CLI↑

This guide shows you how to manage CAEPE resources in a terminal using the CAEPE CLI tool.

Installation↑

TBD.

Authentication and configuration↑

To authenticate and connect to your CAEPE instance you need to set the following arguments:

• --auth-token: Your personal authentication token. You can find it…
• --hostname: The hostname of your CAEPE instance.
• --organization: The CAEPE organization you want to manage.

For example, to connect to the CAEPE instance hosted at "demo.biqmind.sh" and manage the "biqmind" organization, use the following command:

caepe --organization biqmind --hostname demo.biqmind.sh --auth-token <token>

Generate autocompletion↑

To generate autocompletion scripts for your shell, use the caepe completion command followed by your shell. The generation script includes support for the following shells:

• bash
• zsh
• fish
• powershell

For example, to generate autocompletion scripts for zsh, use the following command:

caepe-cli completion zsh

Then save the output to a .sh file in the completion directory for the shell you use. This location varies depending on your OS and how you installed your shell.

Managing resources↑

To use the CAEPE CLI tool, use the command caepe followed by the resource you want to manage. The available resources are the following.

cluster↑

You can create, list, update and delete clusters using the CLI. You can also fetch the namespaces and persistent volumes of clusters.

For more information use the caepe cluster --help command or read the autogenerated documentation.

deployment↑

You can create, list, update and delete deployments using the CLI. You can also rollout and get the status of deployment rollouts.

For more information use the caepe deployment --help command or read the autogenerated documentation.

smoketest↑

You can create, list, update and delete smoke tests using the CLI. You can also execute and callback smoke test jobs.

For more information use the caepe smoketest --help command or read the autogenerated documentation.

snapshot↑

snapshot definition↑

You can create, list, update and delete snapshot definitions using the CLI.

For more information use the caepe snapshot definition --help command or read the autogenerated documentation.

snapshot deployment↑

You can create, list, and delete snapshot deployments using the CLI.

For more information use the caepe snapshot deployment --help command or read the autogenerated documentation.

snapshot instance↑

You can create, list, and delete snapshot instances using the CLI.

For more information use the caepe snapshot instance --help command or read the autogenerated documentation.

Other arguments↑

• --debug: To debug commands, use the --debug argument.

For example, to debug what happens when creating a deployment:

caepe-cli --debug deployment create --deploymentPost.application warehouse --deploymentPost.cluster ware-clusters --deploymentPost.name warehouse --organization biqmind --deploymentPost.release.branch main --deploymentPost.release.message ware-app-deployment --hostname demo.biqmind.sh --deploymentPost.namespace warehouse --scheme https

• --dry-run: To see the result of running commands without executing them, use the --dry-run argument.

For example, to debug what happens when creating a deployment:

caepe-cli --dry-run deployment create --deploymentPost.application warehouse --deploymentPost.cluster ware-clusters --deploymentPost.name warehouse --organization biqmind --deploymentPost.release.branch main --deploymentPost.release.message ware-app-deployment --hostname demo.biqmind.sh --deploymentPost.namespace warehouse --scheme https