Create dedicated documentation page on upgrade procedures

Aperta
#773 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
helm, kubernetes
Ambito
devops, documentation

Direzione di ricerca

Inizia individuando la documentazione esistente sull'upgrade e sulle release note nel repository Antora, quindi esamina le procedure relative a piattaforma, prodotto, CRD, operatore, Helm e OpenShift descritte nell'issue. Aggiungi una pagina dedicata che tratti la sequenza di upgrade, le pause facoltative della riconciliazione, le immagini personalizzate, i riavvii dei pod, le limitazioni di CRD e le release note pertinenti. Il lavoro è completato quando ogni scenario e ogni avvertenza elencati sono documentati chiaramente in un'unica pagina facilmente individuabile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
CSS
Stelle
13
Fork
14
Merge medio
4g 8h
PR unite (30g)
10

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stackabletech/documentation

Tutte le issue di stackabletech/documentation

Issue simili

Altre issue su DevOps

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.