Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Group iteration on simplifying principle wording #14

Closed
wants to merge 4 commits into from
Closed

Group iteration on simplifying principle wording #14

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d59305d
Group iteration on simplifying principle wording
scottrigby Jul 7, 2021
e60fbe4
Updates from July 21 Principles meeting and GitHub review comments
scottrigby Jul 26, 2021
c3fa5f9
Remove redundancy from principle 3
scottrigby Jul 26, 2021
e2e424c
Bump version
scottrigby Jul 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions PRINCIPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GitOps Principles v0.1.0
# GitOps Principles v0.2.0

## Summary

Expand All @@ -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. **Desired System State Is Declarative**
scottrigby marked this conversation as resolved.
Show resolved Hide resolved

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. **Declarations Are Versioned and Immutable**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. **Declarations Are Versioned and Immutable**
2. **Declarations are Versioned and Immutable**

Typographic Suggestion:
Are -> are
to align with
https://user-images.githubusercontent.com/407675/126000898-eb81abd1-a947-40e4-b313-107fd45b7ad7.png
Thanks @scottrigby

Copy link
Member Author

@scottrigby scottrigby Jul 26, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lloydchang Yeah I wasn't sure about which title case style we want to adopt. I would recommend not getting too caught up in this question, and that we follow some existing style guide. For now I just chose AP style AP style Title Case so I didn't have to think about it.

If interested though, this is a fun tool to see how the different standards look https://titlecaseconverter.com/

Note "Is" is capitalized in every style. "Through" varies across the standards.


_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 Continuous**
scottrigby marked this conversation as resolved.
Show resolved Hide resolved

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.
Software agents continuously, and automatically, compare a system's state to its _Desired State_.
If these states differ for any reason, automated actions to reconcile them are initiated.

4. **The principle of operations through declaration**
4. **Intentional Changes Only Through Versioning**
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about 4. Actualizations to Declarations are versioned

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: Not sure if these are interchangeable in this context Actualizations to Declarations... vs Updates to Declarations... vs Changes to Declarations...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To address grammar:

Suggested change
4. **Intentional Changes Only Through Versioning**
4. **Intentional Changes are Only Through Versioning**

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔

This comment was marked as outdated.

Sign in to view


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

Expand Down