Create dedicated documentation page on upgrade procedures
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- helm, kubernetes
- Bereich
- devops, documentation
Rechercherichtung
Beginne damit, die vorhandene Dokumentation zu Upgrades und Release Notes im Antora-Repository zu lokalisieren, und prüfe anschließend die im Issue beschriebenen Verfahren für Plattform, Produkt, CRD, Operator, Helm und OpenShift. Füge eine eigene Seite hinzu, die die Upgrade-Sequenz, optionale Pausen der Reconcilierung, benutzerdefinierte Images, Neustarts von Pods, Einschränkungen von CRDs und relevante Release Notes abdeckt. Die Aufgabe ist abgeschlossen, wenn jedes aufgeführte Szenario und jeder Hinweis klar auf einer einzigen auffindbaren Seite dokumentiert ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Our documentation should contain a dedicated page on our possible upgrade scenarios.
Upgrades of the platform can be done in multiple steps:
- Optional: Set
reconciliationPausedtotruefor some or all of your products - Update CRDs
- Update Operators
- Optional: Set
reconciliationPausedtofalse
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
- Vorherrschende Sprache
- CSS
- Sterne
- 13
- Forks
- 14
- Ø Merge
- 4 T. 8 Std.
- Gemergte PRs (30 T.)
- 10
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus stackabletech/documentation
-
Withdraw ADR018 Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 68/100
stackabletech/documentation#734 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
stackabletech/documentation#779 ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
stackabletech/documentation#754 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 25/100
stackabletech/documentation#753 ·
-
priority/low
stackabletech/documentation#752 · 1 Kommentar · 1 zugewiesene Person ·
Alle Issues in stackabletech/documentation
Ähnliche Issues
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
Azure/PSRule.Rules.Azure#3929 · 1 Kommentar ·
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Mintplex-Labs/anything-llm#6490 ·
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100