{
"request": "Triage Jira ticket MZCLD-3838: Add READMEs documenting the argo/ folder structure in global-platform-admin",
"references": [
"https://mozilla-hub.atlassian.net/browse/MZCLD-3838"
],
"sourceContext": {
"issue": "MZCLD-3838"
}
}MZCLD-3838 is a well-scoped documentation task (currently in Backlog, no comments yet) asking for a set of README files to be added/expanded under the argo/ folder of the global-platform-admin repo. The ticket is self-contained: it enumerates the current state of each README (missing, empty, or too sparse), lists the specific files to create/update, and gives clear content guidance (index README, structure sections, per-component READMEs, and a tf/README.md), while explicitly deferring narrative/how-it-works content to the Confluence Admin Guide. No runbook or Confluence page is directly linked in the ticket (only a reference to related ticket MZCLD-1281 about mirroring GitHub READMEs into Confluence, which was not accessible for this triage). This looks ready for scheduling/estimation rather than needing clarification.
Triage notes: This ticket is clearly scoped and ready to be estimated/prioritized — it enumerates the exact README files to add or expand (argo/README.md index, argo/k8s/argocd-bootstrap/README.md structure section, six bootstrap-component READMEs to fill in, and argo/tf/README.md) with concrete content guidance for each. Two small suggestions before work starts: (1) please add the specific Confluence Admin Guide page link(s) to this ticket so all new READMEs reference the same canonical page(s); (2) worth a quick check-in with MZCLD-1281 (GitHub→Confluence README mirroring) to confirm this doc format/location won't need rework once that lands. No blockers otherwise — recommend moving to the next sprint/backlog-refinement pass for sizing.
[
{
"capability": "jira.issue.read",
"args": {
"key": "MZCLD-3838"
},
"result": {
"key": "MZCLD-3838",
"summary": "Add READMEs documenting the argo/ folder structure in global-platform-admin",
"status": "Backlog",
"description_text": "Problem Someone opening argo/ in global-platform-admin gets no orientation. There are five READMEs and they are all narrow bootstrap notes, not explanations of what lives where. Current state: path state argo/README.md missing, no index at all argo/k8s/argocd-bootstrap/README.md secret creation steps plus helm unittest usage argo/k8s/argocd-image-updater-bootstrap/README.md secret creation steps argo/k8s/argo-rollouts-bootstrap/README.md three lines, chart mirroring only argo/k8s/argocd-preview-environments-bootstrap/README.md empty file argo/k8s/argocd-ephemeral-access-bootstrap/ no README argo/k8s/argocd-metrics-bootstrap/ no README argo/k8s/argocd-repository-details-bootstrap/ no README argo/k8s/mozcloud-shared-gateway-bootstrap/ no README argo/tf/ no README argo/tf/modules/argocd/README.md terraform-docs autogenerated, inputs and outputs only Nothing explains that templates/platform/ renders the Applications that manage ArgoCD's own components, that templates/clusters/ deploys per-cluster platform charts, that templates/tenants/ is where tenant ApplicationSets come from, or that tenants is a symlink to the repo-root tenants/ directory. Proposed work Document the folder structure in the repo, where it sits next to the code and gets reviewed with it. argo/README.md : an index. What k8s/ versus tf/ are for, one line per chart directory, where to start reading, and what deploy.sh and ns.yaml do. Link out to the Confluence Admin Guide for the narrative rather than repeating it. argo/k8s/argocd-bootstrap/README.md : add a structure section covering the templates/ subdirectories ( platform/ , clusters/ , tenants/ ), the per-domain values files ( values.yaml plus sandbox , webservices , dataservices overlays), the tenants symlink, and the ci/ and tests/ directories. Keep the existing bootstrap and testing content. Fill the gaps : write the empty argocd-preview-environments-bootstrap README, expand the three-line argo-rollouts-bootstrap one, and add READMEs for argocd-ephemeral-access-bootstrap , argocd-metrics-bootstrap , argocd-repository-details-bootstrap , and mozcloud-shared-gateway-bootstrap . Each should say what the component is, why we run it, which values key toggles it (for example argo.metrics.enabled ), and anything manual it needs. argo/tf/README.md : what the root config provisions (static IP, DNS, IAP-fronted backend, Cloud Armor policies) and how it relates to the Kubernetes side. Leave the autogenerated module README as is. Notes Keep these focused on structure and mechanics, not narrative. Confluence links here for detail; these link back to Confluence for how the system works, so each fact has one home. MZCLD-1281 is looking at mirroring GitHub READMEs into Confluence, which would let the same content surface in both places later without hand-syncing.",
"comment_count": 0,
"comments": []
}
},
{
"capability": "jira.issue.read",
"args": {
"key": "MZCLD-1281"
},
"result": {
"error": "read blocked by policy: resource not in run subject",
"args": {
"key": "MZCLD-1281"
}
},
"blocked": true
}
]{
"model": "claude-sonnet-5",
"input_tokens": 7055,
"output_tokens": 1775,
"estimated_cost_usd": 0.04779
}[]