Create dedicated documentation page on upgrade procedures

未关闭
#773 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
helm, kubernetes
领域
devops, documentation

调研方向

首先在 Antora 仓库中找到现有的升级和发行说明文档，然后查看 issue 中描述的平台、产品、CRD、operator、Helm 和 OpenShift 操作流程。添加一个专门的页面，涵盖升级顺序、可选的 reconciliation 暂停、自定义镜像、pod 重启、CRD 限制以及相关发行说明。完成的标准是：列出的每个场景和注意事项都在一个易于发现的页面中得到清晰记录。

由索引模型根据 Issue 内容生成。

描述

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
主要语言
CSS
星标
13
派生
14
平均合并
4 天 8 小时
30 天内合并 PR
10

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

stackabletech/documentation 的其他 Issue

查看 stackabletech/documentation 的全部 Issue

相似的 Issue

更多 DevOps Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。