README
¶
Kargo builds upon GitOps principles to manage and automate the promotion of software artifacts through the many stages of their lifecycle.
Getting Started
Read about Kargo in our docs, get hands-on right away with our Quickstart tutorial, or watch the Multi-Stage Deployment Pipelines the GitOps Way talk presented by Jesse Suen & Kent Rancourt of Akuity at GitOpsCon EU 2024:
Support & Feedback
To report a bug or request a feature, please open an issue. For general questions, please start a discussion instead.
Please also feel free to join fellow users in discussions in our Discord Community!
If you are interested in enterprise-scale Kargo hosted, managed, and professionally supported by Akuity, inquire at https://akuity.io/kargo-enterprise.
Contributing
The Kargo project accepts contributions via GitHub pull requests. If you wish to implement a bug fix or new feature, please engage our maintainers by opening an issue first.
Visit our Kargo Contributor Guide for more info on how to start hacking on Kargo quickly and easily.
Code of Conduct
Participation in the Kargo project is governed by the Contributor Covenant Code of Conduct.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
cmd
|
|
|
cli
command
|
|
|
controlplane
command
|
|
|
credential-helper
command
|
|
|
governance-bot
command
|
|
|
hack
|
|
|
best-releases
command
|
|
|
testing/promo-gater
command
promo-gater starts an HTTP server that gates Kargo promotion steps.
|
promo-gater starts an HTTP server that gates Kargo promotion steps. |
|
test/e2e
module
|
|
|
test/e2e/envfuncs
module
|
|
|
pkg
module
|
|
|
controller/argocd/api/v1alpha1
+kubebuilder:object:generate=true +groupName=argoproj.io
|
+kubebuilder:object:generate=true +groupName=argoproj.io |
|
controller/management/legacysecrets
Package legacysecrets contains a one-time startup cleanup for a hazard left behind by the removal (in v1.12.0) of the automatic Secret migration that used to bridge the deprecated global.clusterSecretsNamespace and controller.globalCredentials.namespaces settings to their replacements, global.systemResources.namespace and global.sharedResources.namespace.
|
Package legacysecrets contains a one-time startup cleanup for a hazard left behind by the removal (in v1.12.0) of the automatic Secret migration that used to bridge the deprecated global.clusterSecretsNamespace and controller.globalCredentials.namespaces settings to their replacements, global.systemResources.namespace and global.sharedResources.namespace. |
|
controller/metrics
Package metrics defines the Prometheus metrics exported by Kargo's controller.
|
Package metrics defines the Prometheus metrics exported by Kargo's controller. |
|
controller/promotionrequests
Package promotionrequests contains the PromotionRequest reconciler.
|
Package promotionrequests contains the PromotionRequest reconciler. |
|
credentials/ssh
TODO(v1.13.0): Remove this package when SSH support is removed.
|
TODO(v1.13.0): Remove this package when SSH support is removed. |
|
gitprovider/bitbucket/cloud
Package cloud provides primitives to interact with the openapi HTTP API.
|
Package cloud provides primitives to interact with the openapi HTTP API. |
|
heartbeat
Package heartbeat manages per-controller liveness reporting for Kargo controllers.
|
Package heartbeat manages per-controller liveness reporting for Kargo controllers. |
|
heartbeat/heartbeattest
Package heartbeattest provides helpers for tests that need to seed the heartbeat package's underlying storage.
|
Package heartbeattest provides helpers for tests that need to seed the heartbeat package's underlying storage. |
|
metrics
Package metrics is a small helper package containing constants and other shared behaviors for Kargo metrics.
|
Package metrics is a small helper package containing constants and other shared behaviors for Kargo metrics. |
|
promotion/metrics
Package metrics defines the Prometheus metrics exported by Kargo's controller.
|
Package metrics defines the Prometheus metrics exported by Kargo's controller. |
|
client/generated
module
|
|
|
x/client/generated
module
|