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

Simplify first sentence of each principle, for easy memorization #9

Closed
wants to merge 4 commits into from
Closed

Simplify first sentence of each principle, for easy memorization #9

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9afb379
An attempt to simplify the language for the principles.
todaywasawesome Jun 16, 2021
0f8c5e9
Try different structure to break up repetitive "use"
todaywasawesome Jun 16, 2021
18de31a
Correct typo in principle 3
rjbell4 Jun 22, 2021
c090c77
Merge pull request #10 from rjbell4/todaywasawesome-simplify
todaywasawesome Jun 30, 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
8 changes: 4 additions & 4 deletions PRINCIPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Copy link

Choose a reason for hiding this comment

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

Since "infrastructure" can be seen in the context of physical infrastructure. I would explore different word for this.

"Use declarative pattern" or or "approach" or "model"

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe it's just "Use Declarative State" or "Define State Declaratively"

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated


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**
Copy link

Choose a reason for hiding this comment

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

What about "Use immutable, versioned declaration" (to map to principle 4)

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe "Store declarations in an immutable version control system"

It's long but I think the weakness of what I have in the PR is it sounds almost like a recommendation about what kind of storage your running infra should use which doesn't make sense.

This rephrasing feels like it emphasizes the declaration.


_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.

Expand Down