From 9afb3799ff981c954944c259a5d235fbde889d06 Mon Sep 17 00:00:00 2001 From: Dan Garfield Date: Wed, 16 Jun 2021 13:10:44 -0600 Subject: [PATCH 1/3] An attempt to simplify the language for the principles. Signed-off-by: Dan Garfield The "Use" is repetitive but declarative. They can be taken as axioms this way instead of a descriptor of a longer principle beneath. I think the principle should be a short line and the additional text should clarify and expand the principle. --- PRINCIPLES.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index bca5371..e956564 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 principle of declarative desired state** +1. **Use declarative infrastructure** 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. **Use immutable, versioned storage** _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. **Use continuous state reconciliation** Software agents continuously, and automatically, compare a system's _Actual 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. **Use declaration as the sole way of operating a system** The only mechanism through which the system is intentionally operated on is through these principles. From 0f8c5e9d297ee9fc09c38d0eafcc57f3cfea74b6 Mon Sep 17 00:00:00 2001 From: Dan Garfield Date: Wed, 16 Jun 2021 13:32:46 -0600 Subject: [PATCH 2/3] Try different structure to break up repetitive "use" Signed-off-by: Dan Garfield --- PRINCIPLES.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index e956564..ad5322c 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -10,7 +10,7 @@ These principles were derived from modern software operations but are rooted in ## Principles -1. **Use declarative infrastructure** +1. **Define state 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. @@ -18,7 +18,7 @@ These principles were derived from modern software operations but are rooted in _Desired State_ is stored in a way that supports versioning, immutability of versions, and retains a complete version history. -3. **Use continuous state reconciliation** +3. **Reconcile state continiously** Software agents continuously, and automatically, compare a system's _Actual State_ to its _Desired State_. If the actual and desired states differ for any reason, automated actions to reconcile them are initiated. From 18de31a309b4106203aadfeba06fb6148baa8fda Mon Sep 17 00:00:00 2001 From: Bob Bell <375968+rjbell4@users.noreply.github.com> Date: Tue, 22 Jun 2021 13:50:31 -0400 Subject: [PATCH 3/3] Correct typo in principle 3 Signed-off-by: Bob Bell <375968+rjbell4@users.noreply.github.com> --- PRINCIPLES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PRINCIPLES.md b/PRINCIPLES.md index ad5322c..2b6f917 100644 --- a/PRINCIPLES.md +++ b/PRINCIPLES.md @@ -18,7 +18,7 @@ These principles were derived from modern software operations but are rooted in _Desired State_ is stored in a way that supports versioning, immutability of versions, and retains a complete version history. -3. **Reconcile state continiously** +3. **Reconcile state continuously** Software agents continuously, and automatically, compare a system's _Actual State_ to its _Desired State_. If the actual and desired states differ for any reason, automated actions to reconcile them are initiated.