Skip to content

docs: Improve clarity and consistency of GitOps principles #96

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Improve clarity and consistency of GitOps principles #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions PRINCIPLES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
GitOps is a set of principles for operating and managing software systems.
These principles are derived from modern software operations, but are also rooted in pre-existing and widely adopted best practices.

The [desired state](./GLOSSARY.md#desired-state) of a GitOps managed system must be:
The [desired state](./GLOSSARY.md#desired-state) must be:

1. ## Declarative

A [system](./GLOSSARY.md#software-system) managed by GitOps must have its desired state expressed [declaratively](./GLOSSARY.md#declarative-description).
Desired state must be expressed [declaratively](./GLOSSARY.md#declarative-description).

2. ## Versioned and Immutable

Desired state is [stored](./GLOSSARY.md#state-store) in a way that enforces immutability, versioning and retains a complete version history.
Desired state must be [stored](./GLOSSARY.md#state-store) with immutability, versioning, and history.

3. ## Pulled Automatically

Software agents automatically [pull](./GLOSSARY.md#pull) the desired state declarations from the source.
Software agents must automatically [pull](./GLOSSARY.md#pull) the desired state declarations from the source.

4. ## Continuously Reconciled

Software agents [continuously](./GLOSSARY.md#continuous) observe actual system state and [attempt to apply](./GLOSSARY.md#reconciliation) the desired state.
Software agents must [continuously](./GLOSSARY.md#continuous) observe actual system state and [attempt to apply](./GLOSSARY.md#reconciliation) the desired state.