Create dedicated documentation page on upgrade procedures

Open

#773 opened on Aug 14, 2025 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty: 4/5
Estimated time: 3-5 days
Newbie friendliness: 35/100

Issue type: Documentation
Clarity: Mostly clear
Activity status: Stale
Tech stack: helm, kubernetes
Domain: devops, documentation

Research direction

Start by locating the existing upgrade and release-note documentation in the Antora repository, then review the platform, product, CRD, operator, Helm, and OpenShift procedures described in the issue. Add a dedicated page covering the upgrade sequence, optional reconciliation pauses, custom images, pod restarts, CRD limitations, and relevant release notes. Done means each listed scenario and caution is documented clearly in one discoverable page.

Written by the indexing model from the issue text.

Description

customer-request

Our documentation should contain a dedicated page on our possible upgrade scenarios.

Upgrades of the platform can be done in multiple steps:

Optional: Set reconciliationPaused to true for some or all of your products
Update CRDs
Update Operators
Optional: Set reconciliationPaused to false

Then we also have the product updates

Upgrade productVersion

There are a few extra things we should document or take into consideration:

Extra steps/caution needed when using custom images
Document that (and why) pods will restart after an operator upgrade
Document the fact that Helm can't manage CRDs: https://helm.sh/docs/chart_best_practices/custom_resource_definitions/
Document OpenShift upgrade procedure
Hint at platform release notes
Hint at always having to check the release notes of the underlying products

Dominant language: CSS
Stars: 13
Forks: 14
Avg merge: 4d 8h
Merged PRs (30d): 10

Contributor guide

No contributing guide indexed for this repository

First steps

Read the whole issue, then the project's contributing guide.
Comment on the issue to say you are picking it up — it saves two people doing the same work.
Fork the repository and make your change on a branch.
Open a pull request that references the issue number.

Similar issues

[Bug]: Coverage merge cannot download pull-request diff on HTTP 503 Open

kind/bug needs-triage

Difficulty 1/5 Under an hour Newbie friendliness 72/100

matrixorigin/matrixone#29223 · Opened Sep 22, 2026
Show actual screenshot artifact expiry in PR evidence Open

Difficulty 2/5 1-3 hours Newbie friendliness 84/100

copse-dev/agent-pane#2953 · Opened Sep 22, 2026
[Bug]: ready & merge CI, Simple · Other Test, AssertionError: assert Counter({<Env...nternal'>: 2}) == {<Environment...ic'>: 59, ...} Open

bug ci-failure high priority

Difficulty 2/5 1-3 hours Newbie friendliness 74/100

vllm-project/vllm-omni#7972 · 1 comment · Opened Sep 22, 2026
The `numpy: 1` legs of the CI matrix never run `test_create_table_numpy` (it needs pandas, only numpy is installed) Open

Difficulty 2/5 1-3 hours Newbie friendliness 90/100

simonw/sqlite-utils#872 · Opened Sep 22, 2026
/mcp/ and /stats/ with a trailing slash show Vercel's 404 page Open

bug good first issue

Difficulty 1/5 Under an hour Newbie friendliness 88/100

amponce/archive-movie-browser#166 · Opened Sep 22, 2026

More DevOps issues