docs: add Ignore Field Drift guide#53
Open
sapphirew wants to merge 2 commits into
Open
Conversation
Document the services.k8s.aws/ignore-field-drift annotation and the SelectiveReconciliation feature gate (Alpha, disabled by default): - New guide guides/ignore-field-drift.md — what it does, usage, the IAM tags motivating case (community#2367), non-destructive removal (incl. the not-immediate caveat), and limitations (whole-field only, syntactic path validation, log-only observability). - Register the guide in the Managing Resources sidebar section. - Add the SelectiveReconciliation row + link to the Feature Gates guide. Docusaurus build passes (no broken links).
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: sapphirew The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a user guide for the
services.k8s.aws/ignore-field-driftannotation and itsIgnoreFieldDriftfeature gate (Alpha, disabled by default). This annotation lets a user tell ACK to stop reconciling drift on specific spec fields while still creating and managing the rest of the resource — the motivating case being IAM role tags applied by org tooling that ACK would otherwise keep trying to remove (community#2367).Changes
guides/ignore-field-drift.md— what the annotation does, usage with examples, the #2367 IAM-tags scenario, non-destructive removal (including the "not immediate" caveat: an annotation-only edit doesn't trigger a reconcile), and limitations (whole-field only, syntactic-only path validation, log-only observability).IgnoreFieldDriftrow to the table and a Next Steps link.Modeled on the existing
readonly.mdguide for structure and tone.Verification
npm run buildpasses with no broken-link warnings.npm run start; sidebar placement, the feature-gate callout, examples, and cross-links render correctly.Related PRs (feature implementation)
Note for reviewers
The feature is not yet released — the implementation PRs above are still open. This guide describes the feature in the present tense. Maintainers may prefer to hold this until the runtime + code-generator changes land and release, or I can add an "unreleased / requires runtime vX.Y" note if that's preferred.