forked from argoproj/argo-cd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from dholbach/more-info
add some explanation about what this project tries to do
- Loading branch information
Showing
1 changed file
with
17 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,26 @@ | ||
# gitops-engine | ||
# GitOps Engine | ||
|
||
A place to put: | ||
Two of the biggest GitOps projects are joining forces. [Argo CD](https://github.com/argoproj/argo-cd) and [Flux CD](https://github.com/fluxcd/flux) have been out there for years, making the lives of operators and organisations easier. Now the teams are building the best possible GitOps solution together. The first step on this journey is the GitOps Engine. | ||
|
||
* shared and refactored code from the ArgoCD and CNCF Flux projects | ||
* specifications and ideas | ||
Argo and Flux already have similar sets of functionality, soon they will start sharing code using the GitOps Engine. The GitOps Engine will be responsible for the following functionality: | ||
|
||
- Access to Git repositories | ||
- Kubernetes resource cache | ||
- Manifest Generation | ||
- Resources reconciliation | ||
- Sync Planning | ||
|
||
Over time, this might be useful to other projects too. | ||
|
||
## Proposals, specifications and ideas | ||
|
||
Proposals and ideas are in markdown docs in the [`specs/`](specs/) directory. | ||
To create a new proposal, simply copy the spec [`template`](specs/template.md), | ||
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](specs/design.md). | ||
|
||
## 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. |