docs: explain GitOps concept and flux's role #1104
Conversation
Explain the concept of GitOps in the main README.md and detail flux's role in this. Add a diagram to illustrate. Spell out the benefits of using flux more clearly. Add links to discussion of specific features. Reflow documentation links. Point to #flux Slack channel instead of #general.
README.md
Outdated
| through git. This allows you to diff against the observed | ||
| state. | ||
| - **You push code not containers.** Everything is controlled through | ||
| pull requests. Instant deployments. No learning curve for new devs, just |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
README.md
Outdated
| - **You push code not containers.** Everything is controlled through | ||
| pull requests. Instant deployments. No learning curve for new devs, just | ||
| use git. This allows you to recover from any snapshot as you have | ||
| an atomic sequence of transactions. |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
README.md
Outdated
| [extra features](/site/how-it-works.md)). | ||
| matches the config in git. It uses an operator in the cluster to trigger | ||
| deployments inside Kubernetes, which means you don't need a separate CD tool, | ||
| because it's cloud-native. It monitors all relevant image repositories, detects |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
README.md
Outdated
| container images and config changes are propagated to the cluster. | ||
| The benefits are: you don't need to grant your CI access to the cluster, every | ||
| change is atomic and transactional, git has your audit log. Each transaction | ||
| either fails or succeeds cleanly. You're entirely code centric and don't new |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
README.md
Outdated
|
|
||
| [](https://circleci.com/gh/weaveworks/flux) | ||
| [](https://godoc.org/github.com/weaveworks/flux) | ||
|
|
||
| Get started by browsing through the documentation below. | ||
| ## GitOps |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
README.md
Outdated
|
|
||
| [Installing Flux](/site/installing.md) | ||
| - [Automated git → cluster synchronisation](/site/introduction.md#automated-git-cluster-synchronisation) | ||
| - [Automated deployment of new containers](/site/introduction.md#automated-deployment-of-new-containers) |
This comment was marked as abuse.
This comment was marked as abuse.
Sorry, something went wrong.
|
Thanks @squaremo for the review. I addressed your comments and updated the heading in |
|
@dholbach I would change the repo description from |
|
@squaremo Can you comment on @stefanprodan's suggestion? I like it and happy to make the change in this PR. |
|
The change has to be done in Github UI since the description is not part of the readme. |
|
Nevermind then. You go on without me. :-) |
Good suggestion! I also added |
Explain the concept of GitOps in the main README.md and detail flux's
role in this. Add a diagram to illustrate. Spell out the benefits of
using flux more clearly.
Add links to discussion of specific features.
Reflow documentation links.
Point to
#fluxSlack channel instead of#general.