From d59305d769268e88169d939474f021cf18caeabc Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Wed, 7 Jul 2021 16:30:28 -0400 Subject: [PATCH 1/4] Group iteration on simplifying principle wording During GitOps Working Group Principles Committee meeting today. Signed-off-by: Scott Rigby Co-authored-by: Jesse Butler Co-authored-by: William Caban Co-authored-by: Christian Hernandez Co-authored-by: Moshe Immerman Co-authored-by: Scott Rigby Co-authored-by: Chris Sanders --- PRINCIPLES.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index bca5371..6928347 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -10,22 +10,22 @@ These principles were derived from modern software operations but are rooted in ## Principles -1. **The principle of declarative desired state** +1. **The system's desired state is described declaratively** A system managed by GitOps must have its _Desired State_ expressed declaratively as data in a format writable and readable by both humans and machines. -2. **The principle of immutable desired state versions** +2. **State declarations are stored as immutable versions** _Desired State_ is stored in a way that supports versioning, immutability of versions, and retains a complete version history. -3. **The principle of continuous state reconciliation** +3. **State reconciliation is automated and continuous** - Software agents continuously, and automatically, compare a system's _Actual State_ to its _Desired State_. + Software agents continuously, and automatically, compare a system's state to its _Desired State_. If the actual and desired states differ for any reason, automated actions to reconcile them are initiated. -4. **The principle of operations through declaration** +4. **Intentional change happens only through changing state declarations** - The only mechanism through which the system is intentionally operated on is through these principles. + The only mechanism through which the system is intentionally changed is through new versions of the _Desired State_. ## Notes From e60fbe41d87437a8c97ba5562fb6558d002533ef Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Mon, 26 Jul 2021 00:41:07 -0400 Subject: [PATCH 2/4] Updates from July 21 Principles meeting and GitHub review comments Signed-off-by: Scott Rigby Co-authored-by: Jesse Butler Co-authored-by: William Caban Co-authored-by: Lloyd Chang Co-authored-by: Dan Garfield Co-authored-by: Florian Heubeck Co-authored-by: Leonardo Murillo Co-authored-by: Scott Rigby Co-authored-by: Chris Sanders Co-authored-by: Daniel Warner --- PRINCIPLES.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index 6928347..3b04b55 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -10,20 +10,20 @@ These principles were derived from modern software operations but are rooted in ## Principles -1. **The system's desired state is described declaratively** +1. **Desired System State Is Declarative** A system managed by GitOps must have its _Desired State_ expressed declaratively as data in a format writable and readable by both humans and machines. -2. **State declarations are stored as immutable versions** +2. **Declarations Are Versioned and Immutable** _Desired State_ is stored in a way that supports versioning, immutability of versions, and retains a complete version history. -3. **State reconciliation is automated and continuous** +3. **State Reconciliation Is Continuous** Software agents continuously, and automatically, compare a system's state to its _Desired State_. If the actual and desired states differ for any reason, automated actions to reconcile them are initiated. -4. **Intentional change happens only through changing state declarations** +4. **Intentional Changes Only Through Versioning** The only mechanism through which the system is intentionally changed is through new versions of the _Desired State_. From c3fa5f981a5b7f9dcfefab4c76202114dbb83e01 Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Mon, 26 Jul 2021 00:44:59 -0400 Subject: [PATCH 3/4] Remove redundancy from principle 3 Signed-off-by: Scott Rigby Co-authored-by: Lloyd Chang --- PRINCIPLES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index 3b04b55..85d9a4a 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -21,7 +21,7 @@ These principles were derived from modern software operations but are rooted in 3. **State Reconciliation Is Continuous** Software agents continuously, and automatically, compare a system's state to its _Desired State_. - If the actual and desired states differ for any reason, automated actions to reconcile them are initiated. + If these states differ for any reason, automated actions to reconcile them are initiated. 4. **Intentional Changes Only Through Versioning** From e2e424cf1fa633ab46127e48c9503833709d1893 Mon Sep 17 00:00:00 2001 From: Scott Rigby Date: Mon, 26 Jul 2021 01:02:11 -0400 Subject: [PATCH 4/4] Bump version Signed-off-by: Scott Rigby --- PRINCIPLES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index 85d9a4a..6600302 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -1,4 +1,4 @@ -# GitOps Principles v0.1.0 +# GitOps Principles v0.2.0 ## Summary