Browse Source

address review comments, update heading in introduction.md

Daniel Holbach 2 years ago
parent
commit
bb3804fb98
2 changed files with 16 additions and 31 deletions
  1. 15
    30
      README.md
  2. 1
    1
      site/introduction.md

+ 15
- 30
README.md View File

@@ -7,48 +7,33 @@ We believe in GitOps:
7 7
   monitoring and everything else.
8 8
 - **What can be described can be automated.** Use YAMLs to enforce
9 9
   conformance of the system. You don't need to run `kubectl`, all changes go
10
-  through git. This allows you to diff against the observed
11
-  state.
10
+  through git. Use diff tools to detect divergence between observed and
11
+  desired state and get notifications.
12 12
 - **You push code not containers.** Everything is controlled through
13
-  pull requests. Instant deployments. No learning curve for new devs, just
14
-  use git. This allows you to recover from any snapshot as you have
15
-  an atomic sequence of transactions.
13
+  pull requests. There is no learning curve for new devs, they just use
14
+  your standard git PR process. The history in git allows you to recover
15
+  from any snapshot as you have an sequence of transactions. It is much
16
+  more transparent to make operational changes by pull request, e.g.
17
+  fix a production issue via a pull request instead of making changes to
18
+  the running system.
16 19
 
17 20
 Flux is a tool that automatically ensures that the state of a cluster
18 21
 matches the config in git. It uses an operator in the cluster to trigger
19
-deployments inside Kubernetes, which means you don't need a separate CD tool,
20
-because it's cloud-native. It monitors all relevant image repositories, detects
21
-new images, triggers deployments and updates the desired running configuration
22
-based on that (and a configurable policy).
22
+deployments inside Kubernetes, which means you don't need a separate CD tool.
23
+It monitors all relevant image repositories, detects new images, triggers
24
+deployments and updates the desired running configuration based on that
25
+(and a configurable policy).
23 26
 
24 27
 The benefits are: you don't need to grant your CI access to the cluster, every
25 28
 change is atomic and transactional, git has your audit log. Each transaction
26
-either fails or succeeds cleanly. You're entirely code centric and don't new
27
-infrastructure.
29
+either fails or succeeds cleanly. You're entirely code centric and don't need
30
+new infrastructure.
28 31
 
29 32
 ![Deployment Pipeline](site/images/deployment-pipeline.png)
30 33
 
31 34
 [![CircleCI](https://circleci.com/gh/weaveworks/flux.svg?style=svg)](https://circleci.com/gh/weaveworks/flux)
32 35
 [![GoDoc](https://godoc.org/github.com/weaveworks/flux?status.svg)](https://godoc.org/github.com/weaveworks/flux)
33 36
 
34
-## GitOps
35
-
36
-Git has moved the state of the art forward in development. A decade
37
-of best practices says that config is code, and code should be stored
38
-in version control. Now it is paying that benefit forward to Ops. It
39
-is much more transparent to fix a production issue via a pull request,
40
-than to make changes to the running system.
41
-
42
-At its core the GitOps pattern encourages you to
43
-
44
-- Make all provisioning and deployment configuration declarative
45
-- Keep the entire system state under version control and described in
46
-  a single Git repository
47
-- Make operational changes by pull request (plus build & release pipelines)
48
-- Let diff tools detect any divergence and notify you; and use
49
-  sync tools enable convergence
50
-- Get audit logs via Git
51
-
52 37
 ## What Flux does
53 38
 
54 39
 Flux is most useful when used as a deployment tool at the end of a
@@ -58,7 +43,7 @@ container images and config changes are propagated to the cluster.
58 43
 Among its features are:
59 44
 
60 45
 - [Automated git → cluster synchronisation](/site/introduction.md#automated-git-cluster-synchronisation)
61
-- [Automated deployment of new containers](/site/introduction.md#automated-deployment-of-new-containers)
46
+- [Automated deployment of new container images](/site/introduction.md#automated-deployment-of-new-container-images)
62 47
 - [Integrations with other devops tools](/site/introduction.md#integrations-with-other-devops-tools) ([Helm](site/helm/helm-integration.md) and more)
63 48
 - No additional service or infrastructure needed - Flux lives inside your
64 49
   cluster

+ 1
- 1
site/introduction.md View File

@@ -36,7 +36,7 @@ This is a simple, but dramatic improvement on current state of the art.
36 36
 - End to end, code to production pipelines become not only possible, but
37 37
   easy.
38 38
 
39
-## Automated deployment of new containers
39
+## Automated deployment of new container images
40 40
 
41 41
 Another feature is the automated deployment of containers. It will
42 42
 continuously monitor a range of container registries and deploy new

Loading…
Cancel
Save