Skip to content

SCRIPTS.md

Latest commit

 

History

History
137 lines (107 loc) · 10.2 KB

SCRIPTS.md

File metadata and controls

137 lines (107 loc) · 10.2 KB
Raw

Shell scripts index (scripts/)

Authoritative map of bash entrypoints in the repo root scripts/ directory.
Shared helpers live in scripts/common.sh (sourced by many scripts).

Obsolete scripts are not deleted outright: when retired, they are moved under scripts/archive/ with an entry in that folder’s README (same hygiene as docs/archive/).

Regression and testing (start here)

Script Purpose
run-regression.sh Main regression driver — pytest, vitest, isolation-eval protocol, Java/PHP/operator unit tests, Playwright, cluster/Newman, optional DAG verify & Results DB. See REGRESSION.md.
run-lang-unit-tests.sh Maven (both baggage modules), PHPUnit, operator go test ./internal/... ./api/....
run-baggage-conformance.sh Shared override-header contract: doctor, emit, Python/Node vector tests.
emit-baggage-env.sh Emit BAGGAGE_* / Vite / Spring / k8s env from a stack app.
validate-propagation-response.sh Fail-closed hop-to-hop check against a hop-report body.
run-local-hop-chain.sh Local Flask originator→forwarder→terminal; fails if pr-42 is rewritten.
baggage-doctor.sh Validate stack propagation roles and print per-app header config.
run-isolation-eval.sh Clone-vs-intercept harness: --offline plan CSV; --cluster Kind measurements.
run-cluster-ci.sh Kind cluster CI: isolation-eval --cluster, stack-dag-verify, Newman. Used by cluster-regression.yml (nightly / tags / Helm-or-cluster-script PRs; not every PR).
run-regression-agent.sh Streamed output for agents (Cursor); wraps tiers for iterative fix loops. AGENT-REGRESSION.md
run-regression-agent-full.sh Full agent-oriented run (heavier than default agent script).
run-regression-stream.sh Regression with streaming log-friendly behavior.
bootstrap-regression-venv.sh Create/refresh Python venv for orchestrator/shared-package tests.
run-orchestrator-tests.sh Pytest for orchestrator (+ optional integration / PipelineRun checks).
run-full-test-and-verify-results.sh Longer path including Results verification (used by regression flags).
verify-results-in-db.sh Assert Tekton Results / DB expectations after runs.
verify-dag-phase1.sh Local DAG structure checks (Phase 1).
verify-dag-phase2.sh Cluster: stack-dag-verify PipelineRun + CLI match (Phase 2).
verify-m4-stacks-and-labels.sh M4-era stack/label checks (still useful for multi-namespace stacks).
run-stack-tests-runners.sh Fixtures for Newman / Playwright / Artillery branches of run-stack-tests.

Kind cluster, Tekton, data plane

Script Purpose
kind-with-registry.sh Create Kind cluster with local registry (quick start). Nested VMs: kind.x-k8s.io + kube-proxy nftables.
cloud-agent-install.sh Cloud Agent install: refresh regression venv + Newman.
cloud-agent-start-docker.sh Cloud Agent start: dockerd with fuse-overlayfs; does not create Kind.
install-kind-default-storage.sh Default StorageClass for Kind.
install-tekton.sh Install Tekton Pipelines (and related baseline).
install-operator-kind.sh Kind: CRDs + tekton-dag-operator image/Deployment. Required for generate-run.sh --apply.
install-operator-webhook-kind.sh Kind: TLS certs + Stack ValidatingWebhookConfiguration (failurePolicy: Fail).
apply-stack-crs.sh Apply Stack (and Team) CRs from Git YAML into the cluster.
check-helm-chart.sh helm template / package sanity for helm/tekton-dag.
check-markdown-links.py Relative Markdown link checker (run from run-regression.sh).
check-ci-policy.py Dependabot ignores + operator Go pin (run from run-regression.sh).
install-tekton-dashboard.sh Install Tekton Dashboard.
uninstall-tekton-dashboard.sh Remove Tekton Dashboard.
port-forward-tekton-dashboard.sh kubectl port-forward to dashboard.
install-tekton-results.sh Tekton Results components.
install-postgres-kind.sh Postgres in Kind (Results / app DB).
install-neo4j-kind.sh Neo4j in Kind for graph features.
bootstrap-namespace.sh Bootstrap namespace resources with least-privilege pipeline RBAC. --cluster-admin is an explicit disposable-cluster escape hatch.

Images, pipelines, sample data

Script Purpose
publish-build-images.sh Build/push compile images (polyglot builders).
publish-orchestrator-image.sh Build/push orchestrator image.
publish-operator-image.sh Build/push operator image.
publish-management-gui-image.sh Build/push management GUI image.
generate-run.sh Emit/apply a StackRun (operator). --pipeline-run was removed in M16.
promote-pipelines.sh Promote pipeline definitions across environments/namespaces.
create-and-push-sample-repos.sh Sample app repos for demos/regression.
ensure-git-ssh-secret.sh Git SSH secret for cluster git operations.

PR flow, webhooks, E2E

Script Purpose
run-valid-pr-flow.sh Scripted valid PR path against cluster.
create-test-pr.sh Create a test PR (automation helper).
merge-pr.sh Merge helper for test PRs.
rerun-pr-from.sh Create a StackRun with spec.continueFrom to re-run stack-pr-continue from a failed PR.
configure-github-webhooks.sh Wire GitHub webhooks to EventListener.
run-e2e-with-intercepts.sh Local Kind helper: bootstrap (optional) + PR pipeline with telepresence or mirrord.
run-product-intercept-e2e.sh Authenticated trigger → StackRun → operator → PR PipelineRun → intercept traffic. Used by intercept-e2e.yml.
run-all-setup-and-test.sh Broad setup + test orchestration (legacy-style “do a lot”).

Intercept tooling (Telepresence, mirrord)

Script Purpose
install-telepresence-traffic-manager.sh Install Telepresence traffic manager in cluster.
install-mirrord.sh Install mirrord CLI / related setup.
run-mirrord-poc.sh Early mirrord PoC scenarios.
run-mirrord-m6-scenarios.sh M6 mirrord test scenario driver.

Dashboards, tunnels, utilities

Script Purpose
cloudflare-add-tunnel-cname.sh Cloudflare DNS for tunnel (EventListener exposure). See CLOUDFLARE-TUNNEL-EVENTLISTENER.md.
stack-graph.sh Stack / graph helper (CLI glue for Neo4j or exports).
install-php-local.sh Local PHP toolchain helper for sample apps.

One-off / migration

Script Purpose
extract-standalone-repo.sh Historical: copy milestone into a standalone repo layout (see README-FULL.md). Rarely needed now that tekton-dag is the main repo.

Demo toolchain (not under scripts/)

Location Purpose
docs/demos/generate-all.sh Thin wrapper: docgen generate-all (canonical: demos/README.md).
docs/demos/compose.sh Thin wrapper: docgen compose.

See milestones/milestone-8.md and milestones/milestone-12.2.md.

Related documentation