CodeForPhilly / CodeForPhilly/codeforphilly-ng

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

未关闭 适合新手
#50 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
TypeScript
星标
1
派生
1
平均合并
5 天 3 小时
30 天内合并 PR
9

描述

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

Per specs/api/saml.md, 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.

贡献指南

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

从这里开始

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

调研方向

创建 docs/operations/update-saml2-certificate.md。首先从 specs/api/saml.md#cert--key-rotation 开始,并检查 repository 中的 API secrets backend 和 SAML settings;参考 PR #49 了解上下文。完成标准是 runbook 包含可运行的 openssl 命令、Slack 管理 UI 链接、secret 更新步骤、API 重启步骤以及三年轮换周期。

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

评估

技术栈
typescript
领域
api, documentation, security
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
冷清
描述清晰度
基本清楚
新手友好度
74/100

把新 issue 发到你的邮箱

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