From ef4dcd6c122ffa40c44dde42f4fef11133b6af76 Mon Sep 17 00:00:00 2001 From: Daniel Holbach Date: Wed, 23 Oct 2019 15:01:40 +0200 Subject: [PATCH] add some explanation about what this project tries to do --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 62e5ffe2c0d14..f824567b0be06 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,16 @@ -# 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 @@ -11,3 +18,9 @@ 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.