Skip to content

docs(ops): operational doc updates that were dropped from #62#63

Merged
themightychris merged 1 commit into
mainfrom
docs/retire-helm-operational-docs
May 18, 2026
Merged

docs(ops): operational doc updates that were dropped from #62#63
themightychris merged 1 commit into
mainfrom
docs/retire-helm-operational-docs

Conversation

@themightychris
Copy link
Copy Markdown
Member

Summary

PR #62 was supposed to ship five operational-doc updates alongside the chart + workflow deletions, but only the deletions made it into the commit (my edits weren't staged). This catches the docs up.

Same content the #62 PR description described:

  • docs/operations/deploy.md — rewrite around Kustomize + GitOps. Preserves the still-useful sections (image build with the --platform=linux/amd64 Apple-Silicon note, boot sequence with entrypoint reconciliation, probes, env-var reference, bucket reqs, rollback semantics).
  • docs/operations/runbook.md — replace helm history|rollback|upgrade recovery commands with GitOps deploy-PR revert + kubectl set image hotfix; reword the CFP_DATA_REMOTE boot-failure row to point at the SealedSecret.
  • docs/operations/secrets.md — describe the SealedSecret flow that populates the cluster's env Secret + deploy-key Secret; drop the trailing helm-install example.
  • docs/operations/monitoring.md, cutover.md — small touch-ups removing Helm references.

plans/deploy.md left untouched per the plans protocol.

Test plan

  • CI green (doc-only change; nothing in the build path)

🤖 Generated with Claude Code

The Helm chart and the Helm-based GHA workflows were deleted in #62, but
my doc edits in the same change-set never made it into that commit (only
the `git rm` deletions were staged when I committed). Catching the rest up:

- docs/operations/deploy.md — rewrite around the Kustomize manifests +
  GitOps via cfp-sandbox-cluster. Preserves the still-useful sections:
  image build (with `--platform=linux/amd64` note for Apple Silicon),
  boot sequence (with entrypoint reconciliation), probes, env-var
  reference, bucket-provisioning reqs, rollback semantics.
- docs/operations/runbook.md — replace `helm history/rollback/upgrade`
  recovery with GitOps deploy-PR revert + `kubectl set image` hotfix;
  reword the CFP_DATA_REMOTE boot-failure row to point at the
  SealedSecret.
- docs/operations/secrets.md — describe the SealedSecret flow that
  actually populates the cluster's env Secret + deploy-key Secret.
- docs/operations/monitoring.md, cutover.md — small touch-ups removing
  Helm references.

plans/deploy.md left untouched per the plans protocol (frozen at
status: done).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@themightychris themightychris merged commit 3a200e8 into main May 18, 2026
1 check passed
@themightychris themightychris deleted the docs/retire-helm-operational-docs branch May 18, 2026 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant