stackabletech / stackabletech/documentation
Create dedicated documentation page on upgrade procedures
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- CSS
- Estrellas
- 13
- Forks
- 14
- Merge medio
- 4 d 8 h
- PR fusionados (30 d)
- 10
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
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.
Evaluación
- Stack tecnológico
- helm, kubernetes
- Área
- devops, documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100