Create dedicated documentation page on upgrade procedures

Abierto
#773 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
helm, kubernetes
Área
devops, documentation

Línea de trabajo

Comienza localizando la documentación existente sobre actualizaciones y notas de la versión en el repositorio de Antora; después, revisa los procedimientos de plataforma, producto, CRD, operador, Helm y OpenShift descritos en el issue. Añade una página específica que cubra la secuencia de actualización, las pausas opcionales de reconciliación, las imágenes personalizadas, los reinicios de pods, las limitaciones de CRD y las notas de la versión pertinentes. La tarea estará terminada cuando cada escenario y precaución enumerados estén documentados claramente en una única página fácil de encontrar.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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
Lenguaje dominante
CSS
Estrellas
13
Forks
14
Merge medio
4 d 8 h
PR fusionados (30 d)
10

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de stackabletech/documentation

Todos los issues de stackabletech/documentation

Issues similares

Más issues de DevOps

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.