Skip to content

docs(operator): enhance upgrade guide with manual CRD update instructions#5892

Open
sandromodarelli wants to merge 2 commits into
mainfrom
operator/improving-upgrade-guide
Open

docs(operator): enhance upgrade guide with manual CRD update instructions#5892
sandromodarelli wants to merge 2 commits into
mainfrom
operator/improving-upgrade-guide

Conversation

@sandromodarelli

Copy link
Copy Markdown
Contributor

Description

Fixes #issue

Preview Links

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

Copilot AI review requested due to automatic review settings July 9, 2026 08:51
@sandromodarelli sandromodarelli requested a review from a team as a code owner July 9, 2026 08:51
@netlify

netlify Bot commented Jul 9, 2026

Copy link
Copy Markdown

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 5e7336f
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/6a4f724c12d4790008412392
😎 Deploy Preview https://deploy-preview-5892--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Operator upgrade reference guide to provide a safer, more explicit Helm upgrade procedure, including the required manual CRD update steps that Helm does not perform automatically.

Changes:

  • Reworks the upgrade guide into a step-by-step flow (prep, CRD update, Helm upgrade, validation, rollback).
  • Adds explicit manual CRD upgrade instructions for both Operator CRDs and (optionally) Gateway API CRDs.
  • Adds versioning guidance, migration notes, and a dedicated rollback section.

Comment thread app/operator/dataplanes/upgrade/operator.md Outdated
Comment thread app/operator/dataplanes/upgrade/operator.md Outdated
Comment thread app/operator/dataplanes/upgrade/operator.md Outdated
Comment thread app/operator/dataplanes/upgrade/operator.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.

2 participants