actions/fluxcd-flux2
3
0
Fork 0
mirror of https://github.com/fluxcd/flux2.git synced 2026-02-09 01:07:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added section for breaking changes related to version skew and suspend

Browse source 
using cli.

Signed-off-by: Travis Mattera <travis@mattera.io>
This commit is contained in:
Travis Mattera 2023-11-06 10:52:19 -08:00
parent 1ba44502c8
commit 5240376d17
No known key found for this signature in database
GPG key ID: DD12726C40FD5AFD
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
rfcs/0006-alternative-suspend-control/README.md
View file

@ -135,6 +135,22 @@ The suspend annotation would by default be set to a generic value. An optional
cli flag (eg `--message`) would support setting the suspended annotation value
to a user-specified string.
## Breaking Changes - Version Skew and Suspend Honoring
An edge case exists under these proposed changes with regard to suspending
objects using a new version of the cli while the controllers are running older
versions. Specifically, the user suspends the object with the cli which adds
the suspend annotation but leaves the `.spec.suspend` field unmodified. The
user sees the object is suspended by the cli output. The controllers however do
not recognize the object is suspended.
A potential scenario where this case becomes very damaging is during git repo
refactoring where users suspend objects, relocate the manifest sources and
related references, and resume. The operation is meant to be a no-op. However
with such a version skew and `Kustomizations` set with `.spec.prune` enabled
major workload disruption could occur.
## Implementation History
tbd