Skip to content

docs: Document that changes-ignored is intended for missing ConfigMaps/Secrets - #474

Open
sbernauer wants to merge 1 commit into
mainfrom
docs/restarter-changes-ignored
Open

sbernauer wants to merge 1 commit into
mainfrom
docs/restarter-changes-ignored

Conversation

@sbernauer

Copy link
Copy Markdown
Member

Description

Related to #410

I first though this is a bug, but once you think about it, it makes sense. Now we document that it's intended.

The restarter sets the Pod template annotation to changes-ignored not only for excluded objects, but also for referenced ConfigMaps/Secrets that don't exist (yet), e.g. because the StatefulSet was created before a mounted Secret. This is intended, but was confusing, so document it in the code and docs.

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

  • Changes are OpenShift compatible
  • CRD changes approved
  • CRD documentation for all fields, following the style guide.
  • Helm chart can be installed and deployed operator works
  • Integration tests passed (for non trivial changes)
  • Changes need to be "offline" compatible
  • Links to generated (nightly) docs added
  • Release note snippet added

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • Changelog updated
  • Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

  • Feature Tracker has been updated
  • Proper release label has been added
  • Links to generated (nightly) docs added
  • Release note snippet added
  • Add type/deprecation label & add to the deprecation schedule
  • Add type/experimental label & add to the experimental features tracker

…s/Secrets

The restarter sets the Pod template annotation to "changes-ignored" not only for
excluded objects, but also for referenced ConfigMaps/Secrets that don't exist
(yet), e.g. because the StatefulSet was created before a mounted Secret. This is
intended, but was confusing, so document it in the code and docs.
@sbernauer
sbernauer requested review from a team and siegfriedweber November 9, 2026 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant