Repository navigation
docs(diagrams): add the delivery and lifecycle sequence diagrams - #54
Merged
Merged
Conversation
The repository described the platform's structure and nothing of its flows. Six sequence diagrams now cover what a reader could not reconstruct from the structure alone: how a commit becomes a signed image, how a digest reaches production, what the canary does when the analysis fails, why a rollback is a revert, how a profile goes down and comes back, and how a secret reaches a pod without ever entering Git. Each one describes what is implemented today, and the lifecycle diagram names the gate that ops T016 is meant to replace. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FBKgNvuubj1frjRjLwhpsr
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes
docs/Sequence diagrams.mdis new and carries six diagrams: a commit becoming a signed image, a digest reaching production, the production canary and its metrics gate, rollback by revert, a profile going down and coming back, and a secret reaching a pod.docs/Architecture diagrams.mdlinks to it from its Delivery section.Why
The repository documented structure and none of the flows. Three diagrams existed — application, platform, delivery — and all three are block diagrams; the two PNGs are the retired 2025 Azure design. Nothing anywhere showed the order of events in the delivery path, which is the part a newcomer cannot reconstruct from the manifests, and the part this project spent the year building.
Mermaid rather than a drawing tool, because these change with the code: they live beside the manifests they describe, and a reviewer sees the diff. The two infrastructure posters stay in Eraser, now in English and updated for the
lex-mtsrebuild.Tasks
No task register covers documentation in this repository. The activities live on microservice-app-docs#52, whose diagram list this pull request delivers five items of: the CI sequence, the promotion sequence, the canary sequence, the GitOps and rollback sequence, and the profile lifecycle sequence. The secrets flow is the sixth, also on that list.
Neither box applies literally: this repository has no
tasks.md, and nothing is ticked here. microservice-app-docs#52 is updated with what landed.How it is verified
Every step drawn was read out of the implementation, not recalled:
MicroTodoSuite/.github/.github/workflows/ci.ymland the publisher rolelex-mts-shd-role-ecrpublish.promote.yml— theCosign verifystep,scripts/bump-image.sh, and thegate-prodenvironment.infrastructure/argo-rollouts/cluster-analysis-template.yaml(isNaN(result[0]) || result[0] <= 0.05) and theconsecutiveErrorLimitdefault of four, which aborts on the fifth failing measurement.scripts/aws-profile-lifecycle.sh,verify_gitops_revisionat lines 147-154 andverify_volume_recordat 417-439.infrastructure/external-secrets/and the IRSA roles inaws/modules/environment-foundation/.The six blocks were checked for balanced
alt/endand for parentheses in participant aliases, which some Mermaid versions reject. Rendering is GitHub's.Markdown only; no Terraform, tfvars, or Kubernetes manifest changes.
Risk and rollback
None to the running system. Revert the commit.
What this PR does not do
It does not refresh the three existing Mermaid diagrams, does not remove the two 2025 PNGs, which are labelled as design history, and does not touch the Eraser workspaces, which are outside Git. It does not draw the observability flow or the namespace isolation view; both remain on microservice-app-docs#52.
🤖 Generated with Claude Code
https://claude.ai/code/session_01FBKgNvuubj1frjRjLwhpsr