Skip to content

docs(diagrams): draw both profiles as designed - #58

Merged
EstebanGZam merged 1 commit into
mainfrom
docs/diagrams-as-designed
Sep 21, 2026
Merged

EstebanGZam merged 1 commit into
mainfrom
docs/diagrams-as-designed

Conversation

@EstebanGZam

Copy link
Copy Markdown
Contributor

What changes

Both pages of docs/assets/MicroTodoSuite infrastructure.drawio now draw the architecture as designed. Every status marker is removed — "PLANNED, not built" on add-ons, "nothing built" on Azure, the runtime-down note, "as built" and "target" in the titles — and the components the first draft missed are added. docs/Architecture diagrams.md says the pages show the design and points to its Current state section for status.

Why

The maintainer's direction: these diagrams present the technical proposal, not the delivery status of the moment. Status already has a home, the Current state section, and a diagram that mixes the two goes stale every time a stage lands.

The first draft was also wrong on the facts it claimed. It labelled Istio, Kiali, Karpenter, the AWS Load Balancer Controller, ECK, Chaos Mesh and OpenCost as not built, reading that from the open spec 009 tasks T083, T084, T086 and T087. The desired state for every one of them is vendored under infrastructure/ in microservice-app-gitops, added between 2026-09-11 and 2026-09-13 (for example e4a20ed feat(us3): vendor istio and kiali for the full-topology mesh, dce9617 feat(us3): vendor aws load balancer controller and karpenter (#117)). What none of them has had is an activation on a full cluster, which is a status, not a design fact.

Tasks

No task register covers documentation in this repository; the work is microservice-app-docs#52, updated with what landed.

  • The task register is updated in this pull request
  • Every task ticked here was verified by locating its artifact

Neither box applies literally: nothing is ticked here. One discrepancy found on the way, and not resolved here: spec 009 T083, T084, T086 and T087 are unchecked although their vendored directories exist. Either the tasks ask for more than the directories deliver, or the register is stale; that needs checking task by task against their text, not ticking from this finding.

How it is verified

The component lists come from the cluster roots, not from memory:

$ gh api .../clusters/eks-dev/activation-infrastructure.yaml?ref=26eb4f7   # economical, live on 2026-09-14
keda cert-manager external-secrets kyverno argo-rollouts ebs-csi-driver prometheus grafana
jaeger loki falco kube-bench kube-hunter trivy-operator aws-load-balancer-controller

$ gh api .../clusters/eks-full-prod/planned-inventory.yaml                  # full, reviewed at bootstrap
keda cert-manager external-secrets karpenter aws-load-balancer-controller kyverno argo-rollouts
ebs-csi-driver prometheus grafana jaeger loki falco trivy-operator kube-bench kube-hunter

The full page adds the US3 components vendored after that inventory — Istio, Kiali, Chaos Mesh, OpenCost, and ECK with Elasticsearch, Kibana, Logstash and Filebeat — and draws ECK rather than Loki, because the plan makes ELK the full-profile logging and Loki the economical substitution.

The geometry check from the previous pull request, run in the authoring session and not committed, reports no issue on either page, and no status wording remains in the file:

== Economical profile: 0 issue(s)
== Full profile: 0 issue(s)
$ grep -ciE 'planned|not built|as built|nothing built|status 2026|down since' "...drawio"
0

On its first run this revision failed with five findings — the new cluster labels were too wide for their VPC and collided — which were fixed before committing.

  • Infrastructure changes: the documentation consulted through the required MCP servers is listed above

No Terraform, tfvars, or Kubernetes manifest changes here.

Risk and rollback

None to the running system. Revert the commit.

What this PR does not do

It does not tick or amend spec 009 T083, T084, T086 or T087, and does not change the Current state section, which remains the place for status.

🤖 Generated with Claude Code

The draw.io pages mixed the design with its delivery status: add-ons marked
"planned, not built", Azure marked "nothing built", a runtime-down note. The
maintainer's direction is that these diagrams present the technical proposal,
and the status belongs in the Current state section, so every status marker is
gone.

The label was also wrong on the facts. Istio, Kiali, Karpenter, the AWS Load
Balancer Controller, ECK with Elasticsearch, Kibana, Logstash and Filebeat,
Chaos Mesh and OpenCost are all vendored under infrastructure/ in
microservice-app-gitops since 2026-09-11 to 2026-09-13.

The pages now carry every component the design names. The economical page adds
what its activation list ran on 2026-09-14 and the first draft missed: the EBS
CSI driver, the AWS Load Balancer Controller that creates the shared ALB,
Falco, the Trivy Operator, kube-bench and kube-hunter. The full page groups the
fprd platform into platform, mesh-ingress-security-cost, and observability, with
ECK in place of Loki as the plan's full-profile logging.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@EstebanGZam
EstebanGZam merged commit fe8198c into main Sep 21, 2026
1 check passed
@EstebanGZam
EstebanGZam deleted the docs/diagrams-as-designed branch September 21, 2026 20:29
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