Skip to content

Commit

Permalink
Move continuous caveat from notes to glossary
Browse files Browse the repository at this point in the history
Per last Principles Committee meeting. Also anchor glossary items

Signed-off-by: Scott Rigby <scott@r6by.com>
  • Loading branch information
scottrigby committed May 15, 2021
1 parent 6f9ffc3 commit aa5d669
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions PRINCIPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,33 @@ These principles were derived from modern software operations but are rooted in

- These differences could be due to the actual state drifting from the desired state, or the desired state changing intentionally.
- The source of drift doesn't matter. Contrary to CIops, _any_ drift will trigger a reconciliation
- By "continuous" we adopt the industry standard term to mean reconcilation continues to happen, not that it must be instantaneous

### Principle 4 Notes

- We talk here about "regular operations". In an emergency also other mode of operation, e.g. manual intervention, should be considered - followed by a reconsiliation of the "tainted" system with the declared state. → resolve the conflict between "GitOps principle" and "I need to deal with problems that GitOps doesn't cover"

## Glossary

- **State Store**
- ### Continuous

A system for storing versioned, immutable Desired States that provides access control and auditing on the changes to the Desired State. Git may be configured as a State Store, but [special precautions must be taken](recipes/SETTING_UP_GIT.md).
By "continuous" we adopt the industry standard term to mean reconcilation continues to happen, not that it must be instantaneous.

- ### Declarative Description

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 ... that actually achieve the desired state described in the declarative description.

- **Desired State**
- ### Desired State

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.

- **Software System**
- ### Software System

One or more Runtime environments consisting of resources under management.
In each Runtime, management Agents to act on resources according to security policies.
One or more software Repositories for storing deployable artifacts that may be loaded into the runtime environments, eg. configuration files, code, binaries and packages.
One or more Administrators who are responsible for operating the runtime environments ie. installing, starting, stopping and updating software, code, configuration, etc.
A set of policies controlling access and management of repositories, deployments, runtimes.

- **Declarative Description**
- #### State Store

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 ... that actually achieve the desired state described in the declarative description.
A system for storing versioned, immutable Desired States that provides access control and auditing on the changes to the Desired State. Git may be configured as a State Store, but [special precautions must be taken](recipes/SETTING_UP_GIT.md).

0 comments on commit aa5d669

Please sign in to comment.