Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 5.32 KB

File metadata and controls

73 lines (57 loc) · 5.32 KB

Documentation index

This folder contains design, operations, and verification docs for the tekton-dag project. The main README describes layout, milestones, quick start, and demo videos on GitHub Pages.

Documentation map

Area Where
Milestones (current) ../milestones/ — M4 through M12, M12.2, M8 (partial demos)
Milestones (historical) ../milestones/completed/ — M2, M3
Archive (not maintained) archive/ — obsolete session plans and similar
Customization & ops CUSTOMIZATION.md, MAINTENANCE.md
Teams: stacks + baggage libs TEAM-ONBOARDING-STACKS-AND-BAGGAGE.md — header libraries per runtime, new stack checklist
Demo toolchain (M8) demos/demos/README.md, generate-all.sh; milestones/milestone-8.md
GitHub Pages GITHUB-PAGES.md — how the demo site is deployed; fix 404
Illustrations & logo assets/README.md — composite PNGs + split panels in assets/panels/ for READMEs and demos
Agents / regression loop AGENT-REGRESSION.md — iterate until full regression green; ../AGENTS.md
Testing story (M12.2 B) TESTING-AND-REGRESSION-OVERVIEW.md — layers, demo narration; REGRESSION.md — commands
Shell scripts index SCRIPTS.md — every scripts/*.sh entrypoint; ../scripts/README.md — quick links
Management GUI extension MANAGEMENT-GUI-EXTENSION.md — Vue/Flask/Tekton pattern; demos/segments-m12-2-regression-gui.md — video shot list
Clusters vs production ENVIRONMENTS-AND-CLUSTERS.md — validation / baseline vs production cluster wording

Active documents

Core architecture and flows

Document Description
DAG-AND-PROPAGATION.md Stack DAG model, propagation roles (originator, forwarder, terminal), intercept behavior
TEAM-ONBOARDING-STACKS-AND-BAGGAGE.md Baggage libraries (libs/*) by framework; checklist for new stacks and team wiring
c4-diagrams.md C4 context/container diagrams: PR/merge flow, intercept scenarios, version lifecycle
PR-TEST-FLOW.md Valid PR test flow: create PR, run pipeline, merge
PR-WEBHOOK-TEST-FLOW.md Webhook-driven PR and merge trigger flow
m10-multi-team-architecture.md Multi-team Helm, orchestrator, namespaces

Platform integration

Document Description
CLOUDFLARE-TUNNEL-EVENTLISTENER.md Exposing the EventListener via Cloudflare Tunnel
argocd-architecture-guide.md tekton-dag + ArgoCD + Tekton responsibilities and GitOps layout

Verification and intercept deep-dives

Document Description
REGRESSION.md Run full regression before updating testing/demo docsscripts/run-regression.sh and phases (pytest, Playwright, Newman, Kind)
local-dag-verification-plan.md Plan and scripts for verifying DAG structure locally (Phase 1/2)
mirrord-poc-results.md Milestone 5: MetalBear mirrord PoC — install, header filter, security/mitigations, recommendation
mirrord-m6-test-scenarios.md Milestone 6: Full mirrord test scenarios, procedures and pass criteria
m7-mirrord-intercept-task.md intercept-backend param, mirrord task, “run either” design (see milestone-7.md)
bootstrap-pipeline-speed-analysis.md Bootstrap pipeline performance notes (M7.1)

Milestone 4 supplements

Document Description
m4-multi-namespace.md Multi-namespace pipeline scaling
m4-eventlistener-per-namespace.md EventListener per namespace
m4-test-stacks-and-integration.md Test stacks and integration
m4-baggage-libraries-overview.md Baggage libraries overview
m41-publishing-strategy.md M4.1 library publishing and consumption

Demos and extended design

Document Description
demo-playbook.md What to record and how to demo (complements M8)
README-FULL.md Long-form design: Tekton job standardization, stack model, intercepts, versioning (historical depth)

Archive

See archive/README.md for historical documents that are no longer maintained.