Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Create dedicated documentation page on upgrade procedures

Ouverte
#773 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
helm, kubernetes
Domaine
devops, documentation

Piste de recherche

Commencez par localiser la documentation existante sur les mises à niveau et les notes de version dans le dépôt Antora, puis examinez les procédures relatives à la plateforme, au produit, à CRD, à l’opérateur, à Helm et à OpenShift décrites dans l’issue. Ajoutez une page dédiée couvrant la séquence de mise à niveau, les pauses facultatives de la réconciliation, les images personnalisées, les redémarrages de pods, les limitations de CRD et les notes de version pertinentes. Le travail est terminé lorsque chaque scénario et chaque mise en garde listés sont documentés clairement sur une seule page facile à trouver.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

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
Langage dominant
CSS
Étoiles
13
Forks
14
Merge moyen
4 j 8 h
PR mergées (30 j)
10

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de stackabletech/documentation

Toutes les issues de stackabletech/documentation

Issues similaires

Plus d'issues DevOps

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.