Skip to content

Commit 0443d12

Browse files
committed
Incorporate feedback from @jbutler
Co-authored-by: Jesse Butler <[email protected]> Signed-off-by: Scott Rigby <[email protected]>
1 parent 0b4f646 commit 0443d12

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

PRINCIPLES.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,30 +31,30 @@ These principles were derived from modern software operations but are rooted in
3131

3232
- ### Break Glass
3333

34-
The temporary suspension of GitOps principles, most often pausing automated _Reconciliation_.
35-
While these principles apply to "regular operations," it may sometimes be necessary to pause or sidestep them during an emergency such as incident management.
36-
In these cases, other modes of operations should be considered (e.g. manual intervention), followed by any necessary updates to the desired state declarations, and finally resuming reconciliation of the manually changed system with the updated declarations again.
34+
The temporary suspension of GitOps principles, often accomplished by pausing automated _Reconciliation_.
35+
While these principles apply to typical operations, it may at times be necessary to temporarily pause reconciliation, for example during incident management activities.
36+
In these cases, other modes of operations should be considered (e.g. manual intervention), followed by any necessary updates to the desired state declarations, and finally resuming reconciliation of the system with the updated declarations.
3737
Pragmatic exceptions to these guiding principles are expected from time to time during the journey toward a system being fully managed by GitOps.
3838

3939
- ### Continuous
4040

41-
By "continuous" we adopt the industry standard term to mean _Reconciliation_ continues to happen, not that it must be instantaneous.
41+
By "continuous" we adopt the industry standard to mean that _Reconciliation_ continues to happen, not that it must be instantaneous.
4242

4343
- ### Declarative Description
4444

45-
Describing the desired state or behavior of a system without specifying how that state will be achieved, thereby separating between configuration (the desired state) and implementation (the commands, API calls, scripts etc.) that actually achieves the desired state described in the declarative description.
45+
Describing the desired state or behavior of a system without specifying how that state will be achieved, thereby separating configuration (the desired state) from the implementation (commands, API calls, scripts etc.) that actually achieves the desired state described in the declarative description.
4646

4747
- ### Desired State
4848

4949
The aggregate of all configuration data for a system form its _Desired State_ which is defined as data sufficient to recreate the system so that instances of the system are behaviourally indistinguishable.
5050

5151
- ### Drift
5252

53-
When a system's _Actual State_ changes for any reason other than its versioned _Desired State_ declarations having changed, we say that the system has drifted from it's _Desired State_.
53+
When a system's _Actual State_ changes for any reason other than its versioned _Desired State_ declarations having changed, we say that the system has drifted from its _Desired State_.
5454

5555
- ### Reconciliation
5656

57-
The process of ensuring that the _Actual State_ of a sytem matches it's versioned _Desired State_ declarations.
57+
The process of ensuring that the _Actual State_ of a sytem matches its versioned _Desired State_ declarations.
5858
Contrary to CIops, any divergence between the two will trigger reconciliation, regardless of where changes occured.
5959
Divergence could be due to the actual state unintentionally _Drifting_ from the desired state declarations, or a new desired state declaration version having been changed intentionally.
6060

@@ -70,5 +70,5 @@ These principles were derived from modern software operations but are rooted in
7070

7171
A system for storing immutable versions of _Desired State_ declarations.
7272
This state store should provide access control and auditing on the changes to the Desired State.
73-
Git is most often used as this State Store, but other systems may be used.
74-
In all cases these must be properly configured, and special precautions must be taken, to comply with requirements set out in the GitOps Principles.
73+
Git is the canonical example used as this State Store, and where GitOps derived its name, but but any other system that meets this criteria may be used.
74+
In all cases these must be properly configured, and special precautions must be taken to comply with requirements set out in the GitOps Principles.

0 commit comments

Comments
 (0)