Guides
Step-by-step tasks with convoy.
Each guide does one task from start to end. The manifests in the guides come from the validated
examples of this site. The commands use kubectl and the kubectl convoy plugin.
- Deploy a Helm chart
Deploy the podinfo Helm chart from a HelmRegistry, and from an OCIRegistry as a variant.
- Deploy from Git
Deploy plain manifests, a kustomization and a Helm chart with values layers from a GitRepository.
- Deploy to a remote cluster
Connect convoy to a second cluster with a kubeconfig Secret, and deploy a Release to it.
- Connect to private sources
Give a GitRepository, HelmRegistry or OCIRegistry the credentials to read a private source.
- Add health rules to a Release
Select health rule sets for a Release, and read the health result.
- Order resources with sync waves
Apply resources and Releases in a fixed order, with health gates between the waves.
- Run a database migration and a smoke test with lifecycle hooks
Run a migration Job before convoy applies a render, and a smoke test after the Release is healthy.
- Change rendered objects for each cluster with mutations
Add the region of the target cluster to a Deployment, change its replicas, and check the result before convoy applies it.
- Roll back a Release
Return a Release to an earlier render with a pin, or let convoy roll back a failed rollout automatically.