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
|
|
|
Package db embeds Kargo's database schema migrations so that the binary that runs against a schema is the same one that can migrate it.
|
Package db embeds Kargo's database schema migrations so that the binary that runs against a schema is the same one that can migrate it. |
|
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/dbsync
Package dbsync mirrors Kubernetes identities into PostgreSQL.
|
Package dbsync mirrors Kubernetes identities into PostgreSQL. |
|
controller/management/dbsync/internal/syncapi
Package syncapi defines the contract for mirroring a Kubernetes resource kind.
|
Package syncapi defines the contract for mirroring a Kubernetes resource kind. |
|
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. |
|
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. |
|
gitprovider/bitbucket/datacenter
Package datacenter provides primitives to interact with the openapi HTTP API.
|
Package datacenter 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. |
|
reconciler
Package reconciler is a small engine for level-triggered controllers whose resources live anywhere: in the database, in Kubernetes, or in both.
|
Package reconciler is a small engine for level-triggered controllers whose resources live anywhere: in the database, in Kubernetes, or in both. |
|
reconciler/kube
Package kube is the Kubernetes implementation of a reconciler.Source: a controller-runtime cache watched for changes to objects of one kind.
|
Package kube is the Kubernetes implementation of a reconciler.Source: a controller-runtime cache watched for changes to objects of one kind. |
|
reconciler/list
Package list is the simplest reconciler.Source: a function that returns every request that may need work, called when the controller starts and then on an interval.
|
Package list is the simplest reconciler.Source: a function that returns every request that may need work, called when the controller starts and then on an interval. |
|
reconciler/nats
Package nats is the NATS implementation of a reconciler.Source: a topic watched for events about resources.
|
Package nats is the NATS implementation of a reconciler.Source: a topic watched for events about resources. |
|
server/auth/authn
Package authn resolves the bearer tokens presented to the Kargo API server to the identities behind them.
|
Package authn resolves the bearer tokens presented to the Kargo API server to the identities behind them. |
|
server/auth/can
Package can describes the operations the API server asks permission for, so that a permission check reads as the question it asks:
|
Package can describes the operations the API server asks permission for, so that a permission check reads as the question it asks: |
|
server/middleware
Package middleware holds the Gin middleware the Kargo API server composes its REST router from.
|
Package middleware holds the Gin middleware the Kargo API server composes its REST router from. |
|
server/user
Package user describes who a request to the Kargo API server is from.
|
Package user describes who a request to the Kargo API server is from. |
|
telemetry
Package telemetry wires the OpenTelemetry SDK into Kargo's long-running components.
|
Package telemetry wires the OpenTelemetry SDK into Kargo's long-running components. |
|
client/generated
module
|
|
|
x/client/generated
module
|
Click to show internal directories.
Click to hide internal directories.