CodeForPhilly / CodeForPhilly/codeforphilly-ng
ops: write docs/operations/update-saml2-certificate.md
- Vorherrschende Sprache
- TypeScript
- Sterne
- 1
- Forks
- 1
- Ø Merge
- 5 T. 3 Std.
- Gemergte PRs (30 T.)
- 9
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Erstelle docs/operations/update-saml2-certificate.md. Beginne mit specs/api/saml.md#cert--key-rotation und untersuche das Repository auf das API secrets backend und die SAML settings; verwende PR #49 als Kontext. Als erledigt gilt die Aufgabe, wenn das Runbook ausführbare openssl-Befehle, den Link zur Slack-Admin-UI, Schritte zum Aktualisieren des Secrets, einen Schritt zum Neustart der API und den dreijährigen Rotationszyklus enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- api, documentation, security
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 74/100