Set up CircleCI releases
Visualise and control deployments to your Kubernetes cluster or SageMaker service with CircleCI releases. The steps outlined on this page guide you to set up CircleCI releases using the CircleCI web app onboarding process. Alternatively, once you have set up an environment integration, you can follow the guides linked below to install the release agent and configure components manually.
Introduction
In this tutorial you will set up an integration between CircleCI and your environment (Kubernetes cluster or SageMaker). Once configured, release status can be reported to the CircleCI web app, and the following commands can be executed in your cluster or service by the release agent via controls in the CircleCI UI:
-
Restore a version
-
Scale a version
-
Restart a version
-
Retry a release (when using Argo Rollouts)
-
Promote a release (when using Argo Rollouts)
-
Cancel a release (when using Argo Rollouts)
Prerequisites
Before setting up your environment integration with CircleCI, run through the following prerequisites:
-
A CircleCI account connected to your code. You can sign up for free.
-
A Kubernetes cluster or Amazon SageMaker service
-
A project building on CircleCI that deploys to your Kubernetes cluster or SageMaker service. See the Create a project page for steps.
-
You must have write access to the project associated with the component being deployed. For full details of roles and permissions for GitLab and GitHub App integrations, see the Roles and permissions overview. If your integration is through Bitbucket or the GitHub OAuth app, you will need to be an org admin in Bitbucket/GitHub respectively. To find out which GitHub integration you have, see the GitHub App integration page.
The following versions of Kubernetes, Helm, and Argo Rollouts have been tested and proven to work. Older versions may work but are not guaranteed:
| Tool | Tested versions |
|---|---|
Kubernetes | 1.29.0 |
Helm | 3.12.0 |
Argo Rollouts (optional) | 1.6.0 |
Set up releases
Next steps
In this tutorial you have integrated your Kubernetes cluster with CircleCI. You can now: