49 lines
2.0 KiB
Markdown
49 lines
2.0 KiB
Markdown
# PulseCast infra/QA
|
|
|
|
Namespace-only Kubernetes manifests, smoke tests, and the k6 SSE load test for
|
|
PulseCast. This repo never applies cluster changes by itself: the human runs the
|
|
commands in `docs/deploy.md`.
|
|
|
|
## Layout
|
|
|
|
```text
|
|
deploy/k8s/ web, api, ml + cloudflared Deployments and Services, ConfigMaps
|
|
deploy/examples/ example Secret shapes (placeholders only, never applied)
|
|
scripts/smoke.sh public + in-cluster smoke checks
|
|
k6/sse.js 120 concurrent SSE clients for 5 minutes
|
|
docs/deploy.md Gate 1 runbook and exact human checklist
|
|
docs/load-test.md load-test procedure and how to record results
|
|
docs/failure-drills.md FastAPI-down, tunnel-down, pod-restart drills
|
|
Makefile validate, build, push, deploy, smoke, load helpers
|
|
```
|
|
|
|
## Quick start
|
|
|
|
```bash
|
|
export KUBECONFIG=/path/to/fch26-onemanarmy-sa-kubeconfig.yaml # chmod 600
|
|
make validate # client-side dry run only, never applies
|
|
make deploy CONFIRM=yes # human only; requires the three Secrets first
|
|
make smoke # public HTTPS + API + ML health checks
|
|
make load # k6 SSE load test (needs the k6 SSE extension)
|
|
```
|
|
|
|
Read `docs/deploy.md` before the first deploy. It contains the Gitea token,
|
|
`docker login`, hello-world push, `gitea-regcred`, Cloudflare Tunnel, public
|
|
hostname, and verification steps.
|
|
|
|
## Git workflow
|
|
|
|
`main` is integration. New work happens on a `feat/<topic>` branch in its own
|
|
worktree. Before every push: `git fetch origin && git merge origin/main`.
|
|
Never force-push `main`. The initial scaffold is the one bootstrap exception
|
|
committed directly to `main`.
|
|
|
|
## Safety rules
|
|
|
|
- No Ingress, cert-manager, external-dns, Jobs, CronJobs, CRDs, Roles,
|
|
RoleBindings, NetworkPolicies, or any cluster-scoped resource.
|
|
- Exposure only through the `cloudflared` Deployment.
|
|
- No secrets, tokens, kubeconfig, or raw CSV in git.
|
|
- The human applies cluster mutations. `make deploy` refuses to run without
|
|
`CONFIRM=yes`.
|