Document configurable field ownership for Operations

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#1,158 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, yaml
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc trước danh sách đầu dòng của issue — về cơ bản đó là dàn ý cho phần tài liệu mới. Định vị các trang Operations hiện có trong cây nội dung Hugo (các tham chiếu WatchOperation và CronOperation) cùng phần triển khai/PR crossplane/crossplane#7911 để xác nhận tên trường cuối cùng và hành vi của nó. Thêm một phần cùng với ví dụ YAML template cho spec.operationTemplate.spec.fieldManager trên cả hai kiểu operation, nằm dưới release chứa thay đổi API; hoàn thành có nghĩa là trang đã render hiển thị manager dựa trên UID mặc định, ví dụ manager dùng chung và các ghi chú về thêm/dọn dẹp finalizer.

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

Mô tả

What's Missing?

Track user documentation for the optional Operation.spec.fieldManager proposed in crossplane/crossplane#7911. This lets successive Operations share SSA ownership so cleanup can remove a finalizer added by an earlier execution.

Once the implementation is accepted, document:

  • The default manager remains ops.crossplane.io/operation/<operation UID>.
  • Set spec.operationTemplate.spec.fieldManager on a WatchOperation or CronOperation to give its child Operations a shared manager; no manager is derived automatically from the parent.
  • Use a unique manager per workflow, and include all fields that the workflow intends to retain in each desired resource.
  • A later execution can relinquish a finalizer owned by that manager while preserving finalizers owned by other managers.
  • Setting a shared manager does not migrate ownership from previous UID-based managers.

Include a WatchOperation finalizer add/cleanup example and the equivalent CronOperation template configuration. Target the release that includes the API change.

Ngôn ngữ chính
SCSS
Star
61
Fork
163
Merge trung bình
16 giờ 30 phút
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

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 crossplane/docs

Tất cả issue của crossplane/docs

Issue tương tự

Thêm issue về Documentation

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.