Create dedicated documentation page on upgrade procedures

Đang mở
#773 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
helm, kubernetes
Lĩnh vực
devops, documentation

Hướng nghiên cứu

Bắt đầu bằng cách tìm tài liệu hiện có về nâng cấp và release note trong repository Antora, sau đó xem lại các quy trình về platform, product, CRD, operator, Helm và OpenShift được mô tả trong issue. Thêm một trang riêng bao quát trình tự nâng cấp, các lần tạm dừng reconciliation tùy chọn, image tùy chỉnh, việc khởi động lại pod, các giới hạn của CRD và các release note liên quan. Công việc được coi là hoàn tất khi mọi kịch bản và lưu ý được liệt kê đều được ghi lại rõ ràng trên một trang duy nhất, dễ tìm.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
CSS
Star
13
Fork
14
Merge trung bình
4 ngày 8 giờ
Pull request đã merge (30 ngày)
10

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stackabletech/documentation

Tất cả issue của stackabletech/documentation

Issue tương tự

Thêm issue về DevOps

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.