From 203e7a8d5651ddf4c63e3f30266885552075f823 Mon Sep 17 00:00:00 2001 From: lloydchang Date: Sat, 23 Oct 2021 11:32:23 -0700 Subject: [PATCH] docs(GLOSSARY.md): reintroduce Break Glass MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit • reintroduce Break Glass from RC1 at https://github.com/open-gitops/documents/pull/21 • prepend with · · · — — — · · · 🆘 which: 1. make this idiom/analogy more accessible for a global audience 2. alphabetize to the bottom of glossary Signed-off-by: lloydchang --- GLOSSARY.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/GLOSSARY.md b/GLOSSARY.md index 53ab9da..8a04999 100644 --- a/GLOSSARY.md +++ b/GLOSSARY.md @@ -44,3 +44,9 @@ This glossary accompanies the [GitOps Principles](./PRINCIPLES.md), and other su Open GitOps follows [control-theory](https://en.wikipedia.org/wiki/Control_theory) and operates in a closed-loop. In control theory, feedback represents how previous attempts to apply a desired state have affected the actual state. For example if the desired state requires more resources than exist in a system, the software agent may make attempts to add resources, to automatically rollback to a previous version, or to send alerts to human operators. +- ## · · · — — — · · · 🆘 Break Glass + + The temporary suspension of GitOps principles, often accomplished by pausing automated [reconciliation](#reconciliation). + While these principles apply to typical operations, it may at times be necessary to temporarily pause reconciliation, for example during incident management activities. + 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. + Pragmatic exceptions to these guiding principles are expected from time to time during the journey toward a system being fully managed by GitOps.