Skip to content

docs: add resource upgrades topic page#2043

Open
kovan wants to merge 1 commit intohelm:mainfrom
kovan:docs/resource-upgrades
Open

docs: add resource upgrades topic page#2043
kovan wants to merge 1 commit intohelm:mainfrom
kovan:docs/resource-upgrades

Conversation

@kovan
Copy link
Copy Markdown

@kovan kovan commented Mar 14, 2026

Summary

  • Moves the three-way strategic merge patch examples from the Helm 2 vs 3 FAQ into a dedicated topics page at topics/resource_upgrades.md
  • Adds new documentation for CRD/JSON merge patch fallback — explains that CRDs and unstructured objects use JSON merge patch (which replaces arrays wholesale), so injected list items are lost on upgrade
  • Adds documentation for the --force flag — explains it performs full resource replacement, not patching, with caveats about immutable fields
  • Trims the FAQ to retain the introductory Helm 2 vs 3 explanation and cross-references the new page

Fixes #1448
Continues the work from #1473 (by @gjenkins8, who noted the CRD/jsonpatch behavior should be documented but never returned to finish)

Test plan

  • Verify page renders correctly in Docusaurus
  • Verify cross-reference link from FAQ works
  • Verify sidebar picks up the new page (uses autogenerated sidebar)

Move the three-way merge patch examples from the Helm 2 vs 3 FAQ into
a dedicated topics page. Add documentation for CRD/JSON merge patch
fallback behavior and the --force flag.

The FAQ retains the introductory explanation and cross-references the
new page for details.

Fixes helm#1448
Continues the work from helm#1473

Signed-off-by: kovan <xaum.io@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document helm resource upgrade process(es)

1 participant