README
¶
GitOps Engine
Various GitOps operators address different use-cases and provide different user experiences but all have similar set of core features. The teams behind Argo CD and Flux CD have implemented a reusable library that implements core GitOps features:
- Kubernetes resource cache ✅
- Resources reconciliation ✅
- Sync Planning ✅
- Access to Git repositories
- Manifest Generation
Proposals, specifications and ideas
Do you want to propose one more feature and want to enhance the existing one?
Proposals and ideas are in markdown docs in the specs/ directory.
To create a new proposal, simply copy the spec template,
name the file corresponding to the title of your proposal, and place it in the
specs/ directory.
A good starting point to understand the structure is the GitOps Engine Design spec.
We tried to answer frequently asked question in a separate FAQ document.
Governance
This project is licensed under the Apache 2 license.
The GitOps Engine follows the CNCF Code of Conduct.
Get involved
If you are as excited about GitOps and one common engine for it as much as we are, please get in touch. If you want to write code that's great, if you want to share feedback, ideas and use-cases, that's great too.
Find us on the [#gitops channel][gitops-slack] on Kubernetes Slack (get an [invite here][kube-slack]).
Meetings
The developer team meets regularly, every 1st and 3rd Tuesday of the month, 16:00 UTC. Instructions, agenda and minutes can be found in the meeting doc. The meetings will be recorded and added to this Youtube playlist.
We look forward to seeing you at our meetings and hearing about your feedback and ideas there!
Contributing to the effort
At this stage we are interested in feedback, use-cases and help on the GitOps Engine.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
cache
Package cache implements lightweight Kubernetes cluster caching that stores only resource references and ownership references.
|
Package cache implements lightweight Kubernetes cluster caching that stores only resource references and ownership references. |
|
diff
The package provide functions that allows to compare set of Kubernetes resources using the logic equivalent to `kubectl diff`.
|
The package provide functions that allows to compare set of Kubernetes resources using the logic equivalent to `kubectl diff`. |
|
sync
Package implements Kubernetes resources synchronization and provides the following main features: - basic syncing - resource pruning - resource hooks - sync waves - sync options Basic Syncing Executes equivalent of `kubectl apply` for each specified resource.
|
Package implements Kubernetes resources synchronization and provides the following main features: - basic syncing - resource pruning - resource hooks - sync waves - sync options Basic Syncing Executes equivalent of `kubectl apply` for each specified resource. |
|
utils/kube
Package kube provides helper utilities common for kubernetes
|
Package kube provides helper utilities common for kubernetes |