CodeForPhilly / CodeForPhilly/codeforphilly-ng

ops: write docs/operations/update-saml2-certificate.md

Đang mở Phù hợp với người mới
#50 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
TypeScript
Star
1
Fork
1
Merge trung bình
5 ngày 3 giờ
Pull request đã merge (30 ngày)
9

Mô tả

SAML IdP cert rotation procedure to parallel laddr's legacy doc.

Per [specs/api/saml.md](specs/api/saml.md#cert--key-rotation), the rotation steps are:

1. Generate new key + cert
2. Update Slack's admin UI with the new public cert
3. Update the API's SAML_PRIVATE_KEY / SAML_CERTIFICATE secrets
4. Restart the API

The doc should expand these into runnable commands (openssl invocation, Slack admin UI link, our secrets backend), and include the cadence (3 years). Surfaced by the saml-idp plan's closeout (PR #49) — the runbook step isn't owned by any other planned work.

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

Hướng nghiên cứu

Tạo docs/operations/update-saml2-certificate.md. Bắt đầu với specs/api/saml.md#cert--key-rotation và kiểm tra repository để tìm API secrets backend và các thiết lập SAML; sử dụng PR #49 làm ngữ cảnh. Hoàn tất khi runbook bao gồm các lệnh openssl có thể chạy được, liên kết đến Slack admin UI, các bước cập nhật secret, một bước khởi động lại API và chu kỳ xoay vòng ba năm.

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

Đánh giá

Công nghệ
typescript
Lĩnh vực
api, documentation, security
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
74/100

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.