Compare commits
71 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 113f09a867 | |||
| 86d45ab9a6 | |||
| 2c4fc14278 | |||
| c6165c1e08 | |||
| b88ac14e58 | |||
| 8fdd2a1edf | |||
| c8271db1ec | |||
| 7adcc9a524 | |||
| 25045d4ff1 | |||
| 7a45bfc369 | |||
| 273a41e1fe | |||
| 23dfec20a1 | |||
| cc7172d563 | |||
| 695dac91c4 | |||
| b2d33a56c4 | |||
| 8c2cce576e | |||
| 9c2f228f0c | |||
| 1f8014113f | |||
| 9470207b07 | |||
| 04a6185824 | |||
| cde5122702 | |||
| c7b44b9da6 | |||
| 691fe45c13 | |||
| 14433e7741 | |||
| a5aeaf64df | |||
| 58c6e28ea5 | |||
| 321d3e6bf4 | |||
| 14c051fe8f | |||
| 7cb427f4ea | |||
| c3ee09b52c | |||
| e3aa6b5fa1 | |||
| 9bc28c2b46 | |||
| a52bea2552 | |||
| e3247de665 | |||
| 8981122af8 | |||
| be423719e1 | |||
| 1c04b047e8 | |||
| 57a1f67802 | |||
| e4bf3ee12b | |||
| fb68a12b86 | |||
| 5dd9f4dbc6 | |||
| 01ec869a35 | |||
| cfb8acea58 | |||
| 3a56a9f4f3 | |||
| cf33100c4b | |||
| ca91ebeae9 | |||
| 8ffcdf53db | |||
| dac39c8fa7 | |||
| 5fccccb0ed | |||
| d8cc0402a3 | |||
| 1982e74aaf | |||
| 64f1d1bd12 | |||
| daa3866926 | |||
| 2208c61ff1 | |||
| 99ffdf48c4 | |||
| 2eadeeb4ee | |||
| a30834db51 | |||
| b4460ad818 | |||
| e228f61c21 | |||
| 80f4d5be22 | |||
| ee224fba3d | |||
| 8f26dff2f6 | |||
| a2f45be7f1 | |||
| 3c4c3aa1ab | |||
| 34d12a696a | |||
| 52c0baedf5 | |||
| e0c70b861a | |||
| 10323a2874 | |||
| edcef75418 | |||
| 1bbcb8e28a | |||
| cd41724f39 |
+28
-20
@@ -5,10 +5,12 @@ Cross-repo milestones. Per-API phases live in each API repo's ROADMAP.md.
|
||||
> **As of 2026-05-30, a 4th API (VIN Decoder) has been added. Per-API phases also live in `leeworks-agents/vin-decoder`.**
|
||||
|
||||
## Phase 0 — Orientation (one-time)
|
||||
- [ ] Audit cluster: nodes, namespaces, ingress, Flux state → `docs/cluster-audit.md`
|
||||
- [ ] Add Flux GitRepository + Kustomization watching `leeworks-agents/api-company`
|
||||
- [ ] Deploy `gitea-act-runner` in cluster via Flux HelmRelease (`flux/gitea-runner/`)
|
||||
- [ ] Stand up `registry.leeworks.dev` (container registry) — required before any API CI works
|
||||
- [x] Audit cluster: nodes, namespaces, ingress, Flux state → `docs/cluster-audit.md` (issue #36 — closed ✅)
|
||||
- [ ] Add Flux GitRepository + Kustomization watching `leeworks-agents/api-company` — issue #218 (fork PR #399 merged to leeworks-agents/Talos; awaiting operator merge of 0xWheatyz/Talos PR #14)
|
||||
- [ ] Deploy `gitea-act-runner` in cluster via Flux HelmRelease (`flux/gitea-runner/`) — issue #3
|
||||
- [ ] Stand up `registry.leeworks.dev` (container registry) — required before any API CI works — issue #4
|
||||
- [ ] Validate ESO HelmRelease deployment and ExternalSecret sync for all 4 API namespaces — issue #178
|
||||
- [ ] Extend full-stack Flux validation checklist to cover VIN Decoder — issue #179 (extends #66)
|
||||
|
||||
## Phase 1 — API Contracts
|
||||
Each API repo writes its `openapi.yaml` first and lints it. Spec is the source of truth.
|
||||
@@ -16,36 +18,42 @@ Each API repo writes its `openapi.yaml` first and lints it. Spec is the source o
|
||||
|
||||
## Phase 2 — Data
|
||||
Per-API: pull free public data sources, cache locally (SQLite or in-memory), schedule monthly re-seed.
|
||||
- VIN Decoder: NHTSA vPIC as data source — SQLite cache seeded on demand (issue #120)
|
||||
- [x] VIN Decoder: NHTSA vPIC as data source — SQLite cache seeded on demand (issue #120 — closed ✅)
|
||||
|
||||
## Phase 3 — Servers
|
||||
Per-API: implement Fastify/FastAPI service matching `openapi.yaml` exactly. RapidAPI proxy-secret middleware on every route.
|
||||
- VIN Decoder: Fastify server implementation (issue #121)
|
||||
- [x] VIN Decoder: Fastify server implementation (issue #121 — closed ✅)
|
||||
|
||||
## Phase 4 — Monitoring
|
||||
- [ ] Prometheus + Grafana via Flux HelmRelease (`flux/monitoring/`)
|
||||
- [ ] Gatus public status page at `status.leeworks.dev`
|
||||
- [ ] Instrument every API with `api_requests_total`, `api_response_duration_seconds`, `api_data_freshness_seconds`
|
||||
- [ ] VIN Decoder metrics instrumentation + Grafana dashboard (issue #129)
|
||||
- [ ] Prometheus + Grafana via Flux HelmRelease (`flux/monitoring/`) — issue #7
|
||||
- [ ] Gatus public status page at `status.leeworks.dev` — issue #8
|
||||
- [x] Instrument every API with `api_requests_total`, `api_response_duration_seconds`, `api_data_freshness_seconds` (issue #27 — closed ✅)
|
||||
- [x] Add Prometheus metrics endpoint to holidays service (issue #180 — closed ✅)
|
||||
- [ ] Verify VIN Decoder metrics endpoint and ServiceMonitor scrape config — issue #231
|
||||
- [x] VIN Decoder metrics instrumentation + Grafana dashboard (issue #129 — closed ✅)
|
||||
- [x] VIN Decoder Gatus health check (issue #134 — closed ✅)
|
||||
- [x] Enable Alertmanager in kube-prometheus-stack + configure Slack receiver for SLO alerts (issue #210 — closed ✅)
|
||||
|
||||
## Phase 5 — Documentation site
|
||||
- [ ] `docs-site/` Astro + Redoc skeleton
|
||||
- [ ] Gitea Actions pipeline that copies per-API `openapi.yaml` files at build time
|
||||
- [ ] Deploy to `docs.leeworks.dev` via Flux
|
||||
- [ ] One SEO blog post per API minimum (see master prompt §Phase 5)
|
||||
- [x] `docs-site/` Astro + Redoc skeleton (issue #28 — closed ✅)
|
||||
- [x] Gitea Actions pipeline that copies per-API `openapi.yaml` files at build time (issues #29 ✅, #38 ✅, #85 ✅)
|
||||
- [ ] Deploy to `docs.leeworks.dev` via Flux — issue #30
|
||||
- [x] One SEO blog post per API minimum (issues #39 ✅ — ZIP/Holidays/AirQuality, #124 ✅ — VIN Decoder)
|
||||
- [x] VIN Decoder docs page (issue #123 — closed ✅)
|
||||
- [x] VIN Decoder SEO blog post (issue #124 — closed ✅)
|
||||
|
||||
## Phase 6 — Pre-launch
|
||||
- [ ] `docs/legal/terms-of-service.md`
|
||||
- [ ] `docs/legal/privacy-policy.md`
|
||||
- [ ] `docs/legal/acceptable-use-policy.md`
|
||||
- [ ] DNS: `zip.leeworks.dev`, `holidays.leeworks.dev`, `aqi.leeworks.dev`, `docs.`, `status.`, `registry.`
|
||||
- [x] `docs/legal/terms-of-service.md` (issue #40 — closed ✅)
|
||||
- [x] `docs/legal/privacy-policy.md` (issue #40 — closed ✅)
|
||||
- [x] `docs/legal/acceptable-use-policy.md` (issues #40 ✅, #89 ✅)
|
||||
- [ ] DNS: `zip.leeworks.dev`, `holidays.leeworks.dev`, `aqi.leeworks.dev`, `docs.`, `status.`, `registry.` — issues #33, #106, #150
|
||||
- [x] VIN Decoder DNS `vin.leeworks.dev` (issue #130 — closed ✅)
|
||||
- [x] VIN Decoder RapidAPI listing (issue #131 — closed ✅ as tracker; operator action required)
|
||||
- [ ] PayPal linked to RapidAPI (manual, on 18th birthday)
|
||||
- [ ] Paid tiers enabled on RapidAPI listings (manual)
|
||||
- [ ] PayPal linked to RapidAPI (manual, on 18th birthday) — issue #19
|
||||
- [ ] Paid tiers enabled on RapidAPI listings (manual) — issues #44 (original 3), #151 (VIN Decoder)
|
||||
|
||||
- [ ] Execute pre-launch checklist before go-live — issue #166
|
||||
- [ ] Publish launch announcement (HN, Reddit, Twitter, Dev.to) — issue #167
|
||||
|
||||
## Revenue target
|
||||
|
||||
|
||||
@@ -1,20 +1,20 @@
|
||||
# Company Status
|
||||
|
||||
_Last updated: 2026-05-31 (sprint planning cycle)_
|
||||
_Last updated: 2026-06-08 (cycle #240)_
|
||||
|
||||
## APIs
|
||||
| API | Spec | Code | Deployed | Listed on RapidAPI | Paying Users | MRR |
|
||||
|----------------|------|------|----------|--------------------|--------------|-----|
|
||||
| ZIP Enrichment | [~] | [~] | [ ] | [ ] | 0 | $0 |
|
||||
| Holidays | [~] | [~] | [ ] | [ ] | 0 | $0 |
|
||||
| Air Quality | [ ] | [ ] | [ ] | [ ] | 0 | $0 |
|
||||
| VIN Decoder | [x] | [ ] | [ ] | [ ] | 0 | $0 |
|
||||
| ZIP Enrichment | [x] | [x] | [ ] | [ ] | 0 | $0 |
|
||||
| Holidays | [x] | [x] | [ ] | [ ] | 0 | $0 |
|
||||
| Air Quality | [x] | [x] | [ ] | [ ] | 0 | $0 |
|
||||
| VIN Decoder | [x] | [x] | [ ] | [ ] | 0 | $0 |
|
||||
|
||||
Legend: [x]=done, [~]=in-progress, [ ]=not started
|
||||
|
||||
## Infrastructure
|
||||
- Cluster nodes: 3 control plane (10.0.1.3, .4, .5) + workers (testing1)
|
||||
- **Flux wiring (api-company):** Manifests staged at `flux/api-company-source/` — PENDING Talos merge (issue #2)
|
||||
- **Flux wiring (api-company):** `flux/api-company-source/` — Fork PR #399 **MERGED** to leeworks-agents/Talos; upstream PR #14 open on 0xWheatyz/Talos — awaiting operator merge to activate Flux (issue #2)
|
||||
- **Gitea Actions runner:** Flux manifest committed at `flux/gitea-runner/` — PENDING runner token secret + Talos wiring (issue #3)
|
||||
- **Container registry:** Gitea built-in registry selected; docs/registry.md committed — PENDING Gitea packages enabled (issue #4)
|
||||
- **Prometheus + Grafana:** Flux HelmRelease at `flux/monitoring/` — PENDING Flux wiring + Grafana secret (issue #7)
|
||||
@@ -22,8 +22,231 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
||||
- **API service manifests:** `flux/zip-enrichment/`, `flux/holidays/`, `flux/air-quality/` scaffolded (PR #48, closes #46)
|
||||
- **Image automation:** `flux/image-automation/` — ImageRepository + ImagePolicy + ImageUpdateAutomation for all three APIs
|
||||
- **VIN Decoder manifests:** `flux/vin-decoder/` — Flux HelmRelease + Kustomization committed (issue #140)
|
||||
- **Alertmanager:** `flux/monitoring/helmrelease.yaml` — enabled with Slack receiver config (`gatus-slack-webhook` secret); PR #212 open (issue #210)
|
||||
|
||||
## Completed This Cycle (2026-05-31 — Sprint Cycle)
|
||||
## Completed This Cycle (2026-06-08 — Triage Cycle #240)
|
||||
|
||||
- **Triage** — All 28 open `agent-ready` issues reviewed and commented with current status (2026-06-08).
|
||||
- **All issues confirmed blocked** on the same critical-path operator tasks: #47 (create `0xWheatyz/api-company`), #218 (merge Talos PR #14), #33/#106/#150 (DNS).
|
||||
- **No agent-implementable work found** — all open issues are either manual operator tasks or gated on Flux/cluster activation; kubectl unreachable from agent environment.
|
||||
- **28 issues triaged** — status comments posted on all open `agent-ready` issues.
|
||||
- **0 new issues created** — no gaps found; all ROADMAP items remain grounded in open issues.
|
||||
- **0 issues closed** — no stale issues; oldest open issue is #3 from 2026-05-18 (21 days < 30-day threshold).
|
||||
- **0 label changes** — all existing labels correct.
|
||||
- **0 open PRs** — nothing to review or merge.
|
||||
- **`kustomize build flux/` = PASS** — no manifest regressions.
|
||||
- **Critical path unchanged:** (1) Operator creates `0xWheatyz/api-company` (#47), (2) Operator merges `0xWheatyz/Talos` PR #14 (#218), (3) Operator configures DNS for all 8 subdomains (#33, #106, #150).
|
||||
|
||||
## Completed Previous Cycle (2026-06-07 — Triage Cycle #232)
|
||||
|
||||
- **Triage** — All 28 open `agent-ready` issues reviewed and commented with current status (2026-06-07).
|
||||
- **All issues confirmed blocked** on the same critical-path operator tasks: #47 (create `0xWheatyz/api-company`), #218 (merge Talos PR #14), #33/#106/#150 (DNS).
|
||||
- **No agent-implementable work found** — all open issues are either manual operator tasks or gated on Flux/cluster activation; kubectl unreachable from agent environment.
|
||||
- **1 new issue triaged** — #231 commented with @qa-engineer assessment; BLOCKED on #218.
|
||||
- **0 new issues created** — no gaps found; all ROADMAP items remain grounded in open issues.
|
||||
- **0 issues closed** — no stale issues.
|
||||
- **0 label changes** — all existing labels correct.
|
||||
- **0 open PRs** — nothing to review or merge.
|
||||
- **`kustomize build flux/` = PASS** — no manifest regressions.
|
||||
- **Critical path unchanged:** (1) Operator creates `0xWheatyz/api-company` (#47), (2) Operator merges `0xWheatyz/Talos` PR #14 (#218), (3) Operator configures DNS for all 8 subdomains (#33, #106, #150).
|
||||
|
||||
## Completed Previous Cycle (2026-06-06 — Sprint Planning Cycle #227)
|
||||
|
||||
|
||||
|
||||
- **Sprint Planning** — Full ROADMAP cross-reference + backlog triage completed (2026-06-06).
|
||||
- **ROADMAP cross-reference:** All 18 unchecked items confirmed grounded in open issues — **zero gaps**.
|
||||
- Phase 0: #3, #4, #66, #76–#83, #126–#128, #173, #178, #179, #203, #218 — all tracked.
|
||||
- Phase 4: #7, #8, #174 — all tracked.
|
||||
- Phase 5: #30 — tracked.
|
||||
- Phase 6: #19, #33, #44, #106, #116, #139, #150, #151, #161, #166, #167 — all tracked.
|
||||
- **Staleness check:** Oldest open issue is #3 / #4 from 2026-05-18 (19 days) — **below 30-day threshold; zero closures**.
|
||||
- **Label audit:** All priority/complexity labels confirmed correct from cycle #221 audit — **zero changes**.
|
||||
- **0 new issues created** — no roadmap gaps found.
|
||||
- **0 issues closed** — no stale issues.
|
||||
- **0 label changes** — all existing labels correct.
|
||||
- **`kustomize build flux/` = PASS** — no manifest regressions.
|
||||
- **Critical path unchanged:** (1) Operator creates `0xWheatyz/api-company` (#47), (2) Operator merges `0xWheatyz/Talos` PR #14 (#218), (3) Operator configures DNS for all 8 subdomains (#33, #106, #150).
|
||||
|
||||
## Completed Previous Cycle (2026-06-06 — Triage Cycle #226)
|
||||
|
||||
- **Triage** — All 28 open `agent-ready` issues reviewed and commented with current status (2026-06-06).
|
||||
- **All issues confirmed blocked** on the same critical-path operator tasks: #47 (create `0xWheatyz/api-company`), #218 (merge Talos PR #14), #33/#106/#150 (DNS).
|
||||
- **No agent-implementable work found** — all open issues are either manual operator tasks or gated on Flux/cluster activation.
|
||||
- **0 new issues created** — no gaps found; all ROADMAP items are grounded in open issues.
|
||||
- **0 issues closed** — no issues are stale or resolvable by agent action.
|
||||
- **0 PRs open** — nothing to review or merge.
|
||||
- **`kustomize build flux/` = PASS** — no manifest regressions.
|
||||
- **Current critical path unchanged:** (1) Operator creates `0xWheatyz/api-company` (#47), (2) Operator merges `0xWheatyz/Talos` PR #14 (#218), (3) Operator configures DNS for all 8 subdomains (#33, #106, #150).
|
||||
|
||||
## Completed Previous Cycle (2026-06-06 — Sprint Planning Cycle #221)
|
||||
|
||||
- **#221** — STATUS.md updated for 2026-06-06 sprint planning cycle (this entry). Last-updated date confirmed 2026-06-06.
|
||||
- **0 new issues created** — all ROADMAP unchecked items confirmed grounded in open issues (35 open issues, zero gaps).
|
||||
- **0 issues closed** — oldest open issue is #3 from 2026-05-18 (19 days < 30-day stale threshold).
|
||||
- **3 label changes:**
|
||||
- #106 (grafana.leeworks.dev DNS): added `blocked` label (missing despite dependency on #47)
|
||||
- #150 (vin.leeworks.dev DNS): added `blocked` label (missing despite dependency on #47)
|
||||
- #203 (ClusterIssuer verification): downgraded P1 → P2 (gated on DNS #33, not a first-order blocker)
|
||||
- **Critical path unchanged:** Operator must (1) create `0xWheatyz/api-company` (#47), (2) merge upstream Talos PR #14 (#218) to activate Flux, (3) configure DNS (#33, #106, #150).
|
||||
- **`kustomize build flux/` = PASS** — no manifest regressions.
|
||||
|
||||
## Completed Previous Cycle (2026-06-06 — Docs Cycle #219)
|
||||
|
||||
- **#219** — STATUS.md Current Blockers updated: removed closed issues #187 and #90; replaced with open issue #218 (Operator: merge 0xWheatyz/Talos upstream PR #14 to activate Flux GitOps for api-company). Critical Path item 2 updated to reference #218. `kustomize build flux/` = PASS.
|
||||
|
||||
## Completed Previous Cycle (2026-06-05 — Sprint Planning Cycle #215)
|
||||
|
||||
- **#215** — STATUS.md updated for 2026-06-05 sprint planning cycle (this entry). Last-updated date confirmed 2026-06-05.
|
||||
- **1 new issue created:** #214 (ROADMAP.md Phase 4 Alertmanager annotation — documentation gap filed).
|
||||
- **0 issues closed** — no stale issues; oldest open issue is #2 from 2026-05-18 (18 days < 30-day threshold).
|
||||
- **0 label/priority changes** — all existing labels confirmed correct.
|
||||
- **ROADMAP cross-reference:** all unchecked items confirmed grounded in open issues; 1 new documentation gap found and filed (#214 — Alertmanager / Slack receiver missing from ROADMAP.md Phase 4).
|
||||
- **Critical path unchanged:** Operator must (1) create `0xWheatyz/api-company` (#47), (2) merge upstream Talos PR #14 (#187) to activate Flux, (3) configure DNS (#33, #106, #150).
|
||||
- **`kustomize build flux/` = PASS** — no regressions.
|
||||
- **0 open PRs** — nothing to review or merge.
|
||||
|
||||
## Completed Previous Cycle (2026-06-05 — Sprint Planning Cycle #211)
|
||||
|
||||
- **#211** — STATUS.md updated for 2026-06-05 sprint planning cycle (this entry). Last-updated date confirmed 2026-06-05.
|
||||
- **1 new issue implemented:** #210 (Enable Alertmanager + Slack receiver — gap identified by roadmap cross-reference); PR #212 opened to `leeworks-agents/api-company` with `kustomize build flux/` = PASS.
|
||||
- **0 issues closed** — oldest open issue is #2 from 2026-05-18 (18 days old — under 30-day stale threshold).
|
||||
- **0 label changes** — all priority/complexity labels confirmed correct.
|
||||
- **ROADMAP cross-reference:** 18 unchecked items confirmed grounded in open issues; 1 new gap found and filed (#210 — Alertmanager was missing from roadmap coverage).
|
||||
- **Current Blockers unchanged:** Operator must (1) create `0xWheatyz/api-company` (#47), (2) merge upstream Talos PR #14 (#187) to activate Flux, (3) configure DNS (#33, #106, #150).
|
||||
- **`kustomize build flux/` = PASS** — no regressions.
|
||||
- **1 open PR** — PR #212 (Alertmanager enable + Slack receiver): `kustomize build flux/` PASS; pending merge.
|
||||
|
||||
## Completed Previous Cycle (2026-06-05 — Sprint Planning Cycle #206)
|
||||
|
||||
- **#206** — STATUS.md updated for 2026-06-05 sprint planning cycle (this entry). Last-updated date set to 2026-06-05.
|
||||
- **Completed outcomes from 2026-06-04 sprint planning cycle recorded:**
|
||||
- Issue #204 (smoke-tests): reopened and relabeled `blocked` — was prematurely closed while prerequisites (DNS #33/#150, Flux #2/#187) are still open.
|
||||
- ROADMAP cross-reference: all 18 unchecked items confirmed grounded in open issues (zero gaps).
|
||||
- Staleness check: oldest open issue is #2 from 2026-05-18 (18 days, under 30-day threshold — no closures).
|
||||
- Label audit: no label changes required — all existing priority/complexity labels are correct.
|
||||
- **Critical path confirmed:** Operator must (1) create `0xWheatyz/api-company` (#47), (2) merge upstream Talos PR #14 (#187) to activate Flux, (3) configure DNS (#33, #106, #150).
|
||||
- **`kustomize build flux/` = PASS** — no regressions.
|
||||
- **0 open PRs** — nothing to review or merge.
|
||||
|
||||
## Completed Previous Cycle (2026-06-04 — Triage Cycle #204)
|
||||
|
||||
- **Triage** — All 29 open `agent-ready` issues reviewed and commented with current status (2026-06-04).
|
||||
- **#204** (smoke tests): ❌ BLOCKED — all HTTP endpoints timeout; DNS not configured; kubectl unreachable.
|
||||
- **#203** (ClusterIssuer): ❌ BLOCKED — kubectl not accessible from agent environment.
|
||||
- **#187, #90, #2** (Flux wiring): Waiting on operator to merge upstream Talos PR #14.
|
||||
- **#179, #178, #66** (validation checklists): Blocked on Flux active + cluster access.
|
||||
- **#174** (VIN metrics): `kustomize build flux/` PASS; blocked on cluster deploy.
|
||||
- **#173, #81, #128, #126, #127, #83, #80, #79, #77, #76, #74, #73, #70** (secrets): Manual operator tasks, all documented.
|
||||
- **#167, #166** (launch/pre-launch): Blocked on DNS + Flux + RapidAPI + PayPal.
|
||||
- **#161, #151, #150, #139, #116, #106, #47, #44, #33, #30, #19, #8, #7, #4, #3**: Manual operator tasks or blocked on operator actions.
|
||||
- **`kustomize build flux/` = PASS** — no regressions.
|
||||
- **0 PRs open** — nothing to review or merge.
|
||||
- **Critical path unchanged:** Operator must (1) create `0xWheatyz/api-company` (#47), (2) merge upstream Talos PR #14 (#187) to activate Flux.
|
||||
|
||||
## Completed Previous Cycle (2026-06-04 — Sprint Planning Cycle #200/#201)
|
||||
|
||||
- **#200** — STATUS.md Infrastructure section updated: Flux wiring row for `flux/api-company-source/` updated to reflect Fork PR #399 **MERGED** to leeworks-agents/Talos; upstream PR #14 open on 0xWheatyz/Talos awaiting operator merge. Current Blockers updated to note upstream PR #14 as critical gate.
|
||||
- **#201** — Sprint planning STATUS.md update for 2026-06-04 cycle. Issues #200 and #201 created this cycle. ROADMAP cross-reference: all 18 unchecked items confirmed grounded in open issues (no gaps). Staleness check: oldest open issue is #2 from 2026-05-18 (17 days, not stale — threshold 30 days). Priority review: all labels confirmed appropriate. Critical path: operator-gated on 0xWheatyz/Talos PR #14 merge.
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-04 — Sprint Planning Cycle #198)
|
||||
|
||||
- **#198** — STATUS.md updated for 2026-06-04 sprint planning cycle. Last updated date set to 2026-06-04.
|
||||
- **Sprint Summary:** 0 new code issues created (all ROADMAP items grounded — all 18 unchecked items have corresponding open issues). 0 issues closed (no stale; oldest is #2 at 17 days). 0 label changes. Critical path is entirely operator-gated: Talos merge of #187 unblocks the #2/#3/#4 chain.
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-04 — Sprint Planning Cycle #196)
|
||||
|
||||
- **#196** — STATUS.md updated for 2026-06-04 sprint planning cycle. Last updated date set to 2026-06-04.
|
||||
- **Sprint Summary:** ROADMAP cross-reference complete — all 18 unchecked items have corresponding open issues (no gaps). 1 new issue created: #196 (this STATUS.md update). 0 issues closed (no stale issues; oldest open issue is #2 from 2026-05-18, only 17 days old). 0 label changes (all priority/complexity labels correct). Critical path remains entirely operator-gated.
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-03 — Sprint Planning Cycle #193/#194)
|
||||
|
||||
- **#194** — ROADMAP.md annotated with missing issue cross-references: Phase 0 issue #2 entry updated to reference implementation issue #187; Phase 6 entries added for issue #166 (pre-launch checklist) and #167 (launch announcement). Closes leeworks-agents/api-company#194.
|
||||
- **#193** — STATUS.md updated for 2026-06-03 sprint planning cycle. Current Blockers confirmed accurate; #80 (gitea-image-automation-token) listed. Closes leeworks-agents/api-company#193.
|
||||
- **Sprint Summary:** 2 new documentation issues created (#193 STATUS.md update, #194 ROADMAP annotation). 0 issues closed. 0 stale. Critical path entirely operator-gated.
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-03 — Audit Cycle #190/#191)
|
||||
|
||||
- **#190** — ZIP Enrichment API audit complete: `openapi.yaml` present at repo root (57 KB, OpenAPI 3.0.3); server entry point `src/server.js`; all routes confirmed implemented; `X-RapidAPI-Proxy-Secret` preHandler middleware on all routes except `/health`; `/metrics` Prometheus endpoint present; STATUS.md ZIP Enrichment Spec and Code rows updated to `[x]`. Closes leeworks-agents/api-company#190.
|
||||
- **#191** — Holidays API audit complete: `openapi.yaml` present at repo root (13 KB, OpenAPI 3.0.3); server entry point `src/server.js`; all routes confirmed implemented; `X-RapidAPI-Proxy-Secret` preHandler middleware on all routes except `/health` and `/metrics`; `/metrics` Prometheus endpoint present (issue #180 confirmed done); STATUS.md Holidays Spec and Code rows updated to `[x]`. Closes leeworks-agents/api-company#191.
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-03 — Sprint Planning Cycle)
|
||||
|
||||
- **#188** — STATUS.md updated for 2026-06-03 sprint planning cycle (this entry). Last updated date set to 2026-06-03.
|
||||
- **#187** — Talos PR for api-company Flux source manifests: PR #399 on `leeworks-agents/Talos` confirmed valid; upstream deploy PR created targeting `0xWheatyz/Talos`.
|
||||
- **#186** — Air Quality API audit complete: `openapi.yaml` ✅ exists at repo root in `leeworks-agents/air-quality`; server implementation ✅ present (`src/server.ts`, `src/app.ts`, `src/routes/`); STATUS.md Air Quality row updated to `[x]/[x]`.
|
||||
- **#178** relabeled — added `blocked` label (depends on #173 + Flux active).
|
||||
- **#174** relabeled — added `blocked` label (depends on #18 deploy + #7 monitoring).
|
||||
- **Current Blockers updated:** #187 added before #90 (same unblock target, more actionable).
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-02 — Sprint Planning Cycle #175/#176)
|
||||
|
||||
- **#176** — ROADMAP.md Phase 6 unchecked items annotated with issue cross-references: DNS — issues #33, #106, #150; PayPal — issue #19; Paid tiers — issues #44 (original 3), #151 (VIN Decoder). No checked items changed.
|
||||
- **#175** — STATUS.md updated with 2026-06-02 sprint planning cycle results (this entry). Last updated date set to 2026-06-02.
|
||||
- **Sprint Summary:** 2 new documentation issues created (#175 STATUS.md update, #176 ROADMAP Phase 5/6 annotation). 0 code issues created (all ROADMAP items already covered by existing issues). 0 issues closed (none stale). 0 reprioritizations.
|
||||
- **Current Blockers updated:** #173 (ESO source secrets in `external-secrets` ns) and #174 (VIN Decoder metrics instrumentation) added.
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-02 — Sprint Planning Cycle)
|
||||
|
||||
- **#171** — ROADMAP.md Phase 0 unchecked items annotated with issue #2, #3, #4; Phase 4 unchecked items annotated with issue #7, #8, #27; Phase 5 unchecked item annotated with issue #30. No checked-off items changed.
|
||||
- **#170** — STATUS.md updated with 2026-06-02 sprint planning cycle results (this entry). Last updated date set to 2026-06-02.
|
||||
- **Sprint Summary:** 2 new issues created (#171, #170), 0 issues closed this cycle, 0 stale found.
|
||||
- **`kustomize build flux/` = PASS** — no regressions confirmed.
|
||||
|
||||
## Completed Previous Cycle (2026-06-02 — Triage Cycle #168)
|
||||
- **#168** — STATUS.md cleanup: removed all stale “open, in progress” references to #120 and #121 (both confirmed closed ✅ in leeworks-agents/vin-decoder). Historical sections corrected. VIN Decoder Code column confirmed `[x]`.
|
||||
- **`kustomize build flux/` = PASS** — no regressions.
|
||||
|
||||
## Completed Previous Cycle (2026-06-01 — Sprint Planning Cycle)
|
||||
- **#163** — ROADMAP.md Phase 2 and Phase 3 VIN Decoder bullets marked `[x]` with closed ✅ references for issues #120 and #121.
|
||||
- **#164** — STATUS.md Current Blockers updated: removed #120 and #121 (both confirmed closed ✅). Top actionable agent task updated to #163.
|
||||
- **`kustomize build flux/` = PASS** — no regressions.
|
||||
|
||||
## Completed Previous Cycle (2026-06-01 — Triage Cycle)
|
||||
- **#158** — STATUS.md updated with 2026-06-01 current blockers and sprint summary.
|
||||
- **#156** — ROADMAP.md checkboxes updated: Phase 4 VIN Decoder metrics, Phase 5 docs-site/pipeline/blog, Phase 6 legal docs all checked off.
|
||||
- **VIN Decoder Code `[x]`** — leeworks-agents/vin-decoder data layer (#120) and Fastify server (#121) confirmed merged; STATUS.md Code column updated.
|
||||
- **PR #160 closed** — had merge conflicts and ROADMAP.md regressions (unchecked completed items). Clean fix applied here.
|
||||
- **`kustomize build flux/` = PASS** — no regressions.
|
||||
|
||||
## Current Blockers (as of 2026-06-07)
|
||||
|
||||
In dependency order — operator tasks unless noted:
|
||||
|
||||
1. **P1 #47** — Create `0xWheatyz/api-company` upstream repo (operator) — **highest priority, unblocks everything**
|
||||
2. **P1 #76** — Create `gitea-leeworks-agents-token` secret in `flux-system` (operator)
|
||||
3. **P1 #77** — Create `gitea-runner-token` secret in `gitea-runner` namespace (operator)
|
||||
4. **P1 #79** — Create `gitea-registry` imagePullSecrets in all API namespaces (operator)
|
||||
5. **P1 #83** — Configure `GITEA_TOKEN` Actions secret in zip-enrichment, holidays, air-quality repos (operator)
|
||||
6. **P1 #126** — Configure `GITEA_TOKEN` Actions secret in vin-decoder repo (operator — depends on #122 ✅)
|
||||
7. **P1 #127** — Create `gitea-registry` imagePullSecret in `vin-decoder` namespace (operator)
|
||||
8. **P1 #218** — Operator: merge 0xWheatyz/Talos upstream PR #14 to activate Flux GitOps for api-company — Fork PR #399 already MERGED to leeworks-agents/Talos; upstream PR #14 is the critical gate; unblocks #2, #3, #4, #66 chain (replaces closed #187 and #90)
|
||||
10. **P2 #80** — Create `gitea-image-automation-token` secret in `flux-system` namespace (operator) — enables Flux image automation
|
||||
11. **P2 #173** — Create ESO source secrets in `external-secrets` namespace for RapidAPI proxy-secret syncing (operator) — blocks ESO sync
|
||||
12. **P2 #231** — Verify VIN Decoder metrics endpoint and ServiceMonitor scrape config in live cluster (depends on #218 — Flux must be active first)
|
||||
13. **P2 #178** — Validate ESO HelmRelease deployment and ExternalSecret sync for all 4 API namespaces (depends on #173 + Flux active)
|
||||
14. **P2 #179** — Execute extended full-stack Flux validation checklist including VIN Decoder (depends on #126, #127, #128)
|
||||
|
||||
## Sprint Summary (2026-06-01 — Sprint Planning Cycle)
|
||||
- **Issues closed this cycle:** 0
|
||||
- **New issues created this cycle:** 1 (#163 — ROADMAP/STATUS cleanup after #120/#121)
|
||||
- **Stale issues found:** 0
|
||||
- **Top actionable agent task:** #163 (pure doc update, immediately actionable)
|
||||
- **Critical path:** Entirely operator-gated after #163 is merged (see Current Blockers)
|
||||
|
||||
## Sprint Summary (2026-06-01)
|
||||
- **Issues closed since last STATUS update (#146):** #145–#154 — VIN Decoder sprint docs + infra (✅ all closed)
|
||||
- **Issues opened this sprint:** #150 (vin DNS reminder), #151 (VIN Decoder RapidAPI tiers), #155 (if applicable), #156 (ROADMAP.md update), #157 (full-stack validation), #158 (STATUS.md update), #163 (ROADMAP/STATUS cleanup post-#120/#121), #164 (STATUS.md sprint planning update)
|
||||
- **Top actionable agent task:** #163 (ROADMAP/STATUS doc cleanup for #120/#121 — pure doc update, immediately actionable)
|
||||
|
||||
## Completed Previous Cycle (2026-05-31 — Sprint Cycle)
|
||||
- **#146** — STATUS.md updated to reflect VIN Decoder sprint wave (#117–#141): APIs table row added, completed wave documented, blockers updated.
|
||||
- **#145** — ROADMAP.md updated to reference VIN Decoder as 4th API across all phases (Phase 1–6). `kustomize build flux/` = PASS.
|
||||
- **PR #147 opened** — docs: update ROADMAP.md and STATUS.md for VIN Decoder sprint wave (closes #145, #146).
|
||||
@@ -31,8 +254,8 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
||||
## Completed Previous Cycle (2026-05-30 — VIN Decoder Sprint Wave)
|
||||
### VIN Decoder issues #117–#141 — status as of 2026-05-31:
|
||||
- **#117** — VIN Decoder spec + feasibility — **closed ✅** (`apis/vin-decoder/openapi.yaml` merged)
|
||||
- **#120** — VIN Decoder data layer (SQLite/NHTSA vPIC) — **open, in progress** (P1 blocker)
|
||||
- **#121** — VIN Decoder Fastify server — **open, in progress** (P1 blocker, depends on #120)
|
||||
- **#120** — VIN Decoder data layer (SQLite/NHTSA vPIC) — **closed ✅** (leeworks-agents/vin-decoder)
|
||||
- **#121** — VIN Decoder Fastify server — **closed ✅** (leeworks-agents/vin-decoder)
|
||||
- **#122** — Create `leeworks-agents/vin-decoder` repo — **closed ✅**
|
||||
- **#123** — VIN Decoder docs page — **closed ✅**
|
||||
- **#124** — VIN Decoder SEO blog post — **closed ✅**
|
||||
@@ -48,24 +271,25 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
||||
- **#141** — Pricing page updated for VIN Decoder — **closed ✅** (PR #144 merged)
|
||||
|
||||
## Critical Path (operator must complete in order)
|
||||
See **Current Blockers** section above for the full ordered list as of 2026-06-01.
|
||||
|
||||
1. **Create `0xWheatyz/api-company` repo** (#47) — **highest priority, unblocks everything**
|
||||
2. **Add api-company Flux source to Talos** (#90) — needs Talos PR, reference manifests at `flux/api-company-source/`
|
||||
2. **Merge upstream Talos PR #14 to activate Flux for api-company** (#218) — manifests already committed; operator must merge 0xWheatyz/Talos PR #14
|
||||
3. **Create `gitea-leeworks-agents-token` secret** in `flux-system` (#76)
|
||||
4. **Create `gitea-runner-token` secret** in `gitea-runner` (#77)
|
||||
5. **Enable Gitea packages + DNS for `registry.leeworks.dev`** (#4)
|
||||
6. **All other secrets** (#70, #73, #74, #79, #80, #81, #83) follow in order
|
||||
|
||||
## Blockers — VIN Decoder critical path
|
||||
- **P1: #120** — VIN Decoder data layer (NHTSA vPIC SQLite cache) — agent work pending
|
||||
- **P1: #121** — VIN Decoder Fastify server — agent work pending, depends on #120
|
||||
- **P1: #127** — Create `gitea-registry` imagePullSecret in `vin-decoder` namespace — operator manual task
|
||||
- **P2: #126** — Configure `GITEA_TOKEN` secret in `vin-decoder` repo — operator manual task
|
||||
- **P2: #128** — Create `rapidapi-proxy-secret` in `vin-decoder` namespace — operator manual task
|
||||
- **P2: #129** — VIN Decoder Prometheus metrics instrumentation — agent work pending, depends on #121
|
||||
- ~~**P2: #129** — VIN Decoder Prometheus metrics instrumentation~~ — **closed ✅** (PR merged)
|
||||
- **P3: #139** — Add RAPIDAPI_VIN_* Actions secrets — operator task, depends on RapidAPI listing (#131)
|
||||
|
||||
## New Issues This Sprint (2026-05-30, #120–#146)
|
||||
- **#120** — VIN Decoder data layer — **open, P1**
|
||||
- **#121** — VIN Decoder Fastify server — **open, P1**
|
||||
- **#120** — VIN Decoder data layer — **closed ✅** (leeworks-agents/vin-decoder)
|
||||
- **#121** — VIN Decoder Fastify server — **closed ✅** (leeworks-agents/vin-decoder)
|
||||
- **#126** — Operator: GITEA_TOKEN secret in vin-decoder repo — manual operator task
|
||||
- **#127** — Operator: gitea-registry imagePullSecret in vin-decoder namespace — manual operator task, P1 blocker
|
||||
- **#128** — Operator: rapidapi-proxy-secret in vin-decoder namespace — manual operator task
|
||||
|
||||
@@ -286,7 +286,11 @@ annotations:
|
||||
|
||||
## Grafana Dashboard
|
||||
|
||||
A reference dashboard JSON is available at `docs/grafana-api-dashboard.json` (TBD — will be committed once Grafana is deployed per issue #7).
|
||||
Grafana dashboards are committed as Flux ConfigMaps and are auto-loaded by Grafana via the `grafana_dashboard: "1"` label:
|
||||
- `flux/monitoring/grafana-dashboard-apis.yaml` — consolidated 4-API dashboard (all APIs)
|
||||
- `flux/monitoring/vin-decoder-dashboard.yaml` — VIN Decoder-specific dashboard
|
||||
|
||||
Dashboards will load automatically once Grafana is deployed (issue #7) and Flux is active (issue #218).
|
||||
|
||||
Key panels to include:
|
||||
1. Request rate by API and status (`rate(api_requests_total[5m])`)
|
||||
|
||||
+106
-7
@@ -2,7 +2,7 @@
|
||||
|
||||
**Audience:** Human operator (0xWheatyz)
|
||||
**Purpose:** Ordered, copy-paste-ready guide to bring the full `api-company` stack live.
|
||||
**Last updated:** 2026-05-26
|
||||
**Last updated:** 2026-06-01
|
||||
**Closes:** leeworks-agents/api-company#50
|
||||
|
||||
---
|
||||
@@ -165,6 +165,7 @@ Repos to configure:
|
||||
- `leeworks-agents/zip-enrichment`
|
||||
- `leeworks-agents/holidays`
|
||||
- `leeworks-agents/air-quality`
|
||||
- `leeworks-agents/vin-decoder` (see also Phase 4-A Step 4)
|
||||
|
||||
**For each repo:** Repo → Settings → Actions → Secrets → Add Secret
|
||||
- **Name:** `GITEA_TOKEN`
|
||||
@@ -186,9 +187,9 @@ kubectl create secret generic gitea-image-automation-token \
|
||||
|
||||
---
|
||||
|
||||
## Phase 4 — DNS for API services (issue #33)
|
||||
## Phase 4 — DNS for API services (issues #33, #106, #150)
|
||||
|
||||
Add DNS A records for all seven leeworks.dev subdomains (all point to the same
|
||||
Add DNS A records for **all eight** leeworks.dev subdomains (all point to the same
|
||||
cluster ingress IP):
|
||||
|
||||
| Hostname | Target |
|
||||
@@ -196,6 +197,7 @@ cluster ingress IP):
|
||||
| `zip.leeworks.dev` | `<cluster ingress IP>` |
|
||||
| `holidays.leeworks.dev` | `<cluster ingress IP>` |
|
||||
| `aqi.leeworks.dev` | `<cluster ingress IP>` |
|
||||
| `vin.leeworks.dev` | `<cluster ingress IP>` |
|
||||
| `docs.leeworks.dev` | `<cluster ingress IP>` |
|
||||
| `grafana.leeworks.dev` | `<cluster ingress IP>` |
|
||||
| `status.leeworks.dev` | `<cluster ingress IP>` |
|
||||
@@ -204,7 +206,7 @@ cluster ingress IP):
|
||||
Verify DNS propagation:
|
||||
|
||||
```bash
|
||||
for host in zip holidays aqi docs grafana status registry; do
|
||||
for host in zip holidays aqi vin docs grafana status registry; do
|
||||
echo -n "${host}.leeworks.dev: "
|
||||
dig ${host}.leeworks.dev +short
|
||||
done
|
||||
@@ -215,6 +217,76 @@ propagates (typically minutes, up to 48 h).
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Phase 4-A — VIN Decoder namespace setup (issues #126, #127, #128, #139)
|
||||
|
||||
Before VIN Decoder pods can start, the following manual steps are required.
|
||||
Do these alongside Phase 3 (they are independent of the DNS batch):
|
||||
|
||||
### Step 4A-1 — Create `vin-decoder` namespace
|
||||
|
||||
```bash
|
||||
kubectl create namespace vin-decoder --dry-run=client -o yaml | kubectl apply -f -
|
||||
```
|
||||
|
||||
### Step 4A-2 — Create `gitea-registry` imagePullSecret in `vin-decoder` namespace (issue #127)
|
||||
|
||||
Reuse the same Gitea token with `read:packages` scope from secrets checklist item #8.
|
||||
|
||||
```bash
|
||||
kubectl create secret docker-registry gitea-registry \
|
||||
--namespace=vin-decoder \
|
||||
--docker-server=registry.leeworks.dev \
|
||||
--docker-username=leeworks-agents \
|
||||
--docker-password=<GITEA_TOKEN_WITH_READ_PACKAGES> \
|
||||
--docker-email=agent@leeworks.dev
|
||||
```
|
||||
|
||||
Verify:
|
||||
```bash
|
||||
kubectl get secret gitea-registry -n vin-decoder -o jsonpath='{.type}'
|
||||
# Expected: kubernetes.io/dockerconfigjson
|
||||
```
|
||||
|
||||
### Step 4A-3 — Create `rapidapi-proxy-secret` in `vin-decoder` namespace (issue #128)
|
||||
|
||||
**Now (placeholder — unblocks deploy testing):**
|
||||
```bash
|
||||
kubectl create secret generic rapidapi-proxy-secret \
|
||||
--namespace=vin-decoder \
|
||||
--from-literal=X-RapidAPI-Proxy-Secret=PLACEHOLDER_REPLACE_AFTER_RAPIDAPI_LISTING
|
||||
```
|
||||
|
||||
**After VIN Decoder is listed on RapidAPI (Phase 5), update with real secret:**
|
||||
```bash
|
||||
kubectl create secret generic rapidapi-proxy-secret \
|
||||
-n vin-decoder \
|
||||
--from-literal=X-RapidAPI-Proxy-Secret=<VIN_RAPIDAPI_PROXY_SECRET> \
|
||||
--save-config --dry-run=client -o yaml | kubectl apply -f -
|
||||
```
|
||||
|
||||
### Step 4A-4 — Add `GITEA_TOKEN` Actions secret to `leeworks-agents/vin-decoder` repo (issue #126)
|
||||
|
||||
Gitea → `leeworks-agents/vin-decoder` → Settings → Secrets and Variables → Actions
|
||||
- **Name:** `GITEA_TOKEN`
|
||||
- **Value:** Gitea personal access token with `write:packages` scope
|
||||
|
||||
Verify it appears in the repo's Actions Secrets list before the next push to `main`.
|
||||
|
||||
### Step 4A-5 — Add RapidAPI VIN secrets to `leeworks-agents/api-company` Actions (issue #139)
|
||||
|
||||
> **Blocked** — requires VIN Decoder to be listed on RapidAPI first (issue #131 tracker; operator action required).
|
||||
|
||||
Once the VIN Decoder listing is live:
|
||||
|
||||
Gitea → `leeworks-agents/api-company` → Settings → Secrets and Variables → Actions
|
||||
|
||||
| Secret name | Where to find it |
|
||||
|---------------------------|------------------|
|
||||
| `RAPIDAPI_VIN_API_ID` | RapidAPI dashboard → VIN Decoder listing → Overview |
|
||||
| `RAPIDAPI_VIN_VERSION_ID` | RapidAPI dashboard → VIN Decoder listing → Versions tab |
|
||||
|
||||
## Phase 5 — RapidAPI + PayPal (issue #44, #19)
|
||||
|
||||
> **Blocked on operator being 18+ for PayPal.** Complete when eligible.
|
||||
@@ -241,8 +313,25 @@ kubectl create secret generic rapidapi-proxy-secret \
|
||||
kubectl create secret generic rapidapi-proxy-secret \
|
||||
-n air-quality \
|
||||
--from-literal=X-RapidAPI-Proxy-Secret=<VALUE>
|
||||
|
||||
# vin-decoder (updates the placeholder secret from Phase 4-A Step 3)
|
||||
kubectl create secret generic rapidapi-proxy-secret \
|
||||
-n vin-decoder \
|
||||
--from-literal=X-RapidAPI-Proxy-Secret=<VIN_VALUE> \
|
||||
--save-config --dry-run=client -o yaml | kubectl apply -f -
|
||||
```
|
||||
|
||||
Also configure VIN Decoder pricing tiers on RapidAPI (issue #151):
|
||||
|
||||
| Tier | Monthly Price | Request Limit | Rate Limit |
|
||||
|-------|---------------|----------------|-------------|
|
||||
| Free | $0 | 100 req/mo | 5 req/min |
|
||||
| Basic | $9 | 5,000 req/mo | 60 req/min |
|
||||
| Pro | $19 | 20,000 req/mo | 200 req/min |
|
||||
| Ultra | $49 | 100,000 req/mo | 500 req/min |
|
||||
|
||||
Confirm VIN Decoder revenue flows through the same PayPal account as the other 3 APIs.
|
||||
|
||||
---
|
||||
|
||||
## Quick Verification Checklist
|
||||
@@ -287,12 +376,22 @@ Phase 2: Service secrets (runner-token, grafana-admin, gatus-webhook, registry)
|
||||
|
||||
Phase 3: CI secrets + image-automation token
|
||||
└─► images build, push, and auto-update → API services deploy
|
||||
(includes leeworks-agents/vin-decoder GITEA_TOKEN — Step 3-A)
|
||||
|
||||
Phase 4: DNS records
|
||||
Phase 4: DNS records (8 subdomains including vin.leeworks.dev)
|
||||
└─► HTTPS certs issued → public URLs go live
|
||||
|
||||
Phase 5: RapidAPI + PayPal
|
||||
└─► revenue enabled
|
||||
Phase 4-A: VIN Decoder namespace setup (#126, #127, #128)
|
||||
4A-1: vin-decoder namespace created
|
||||
4A-2: gitea-registry imagePullSecret in vin-decoder (#127)
|
||||
4A-3: rapidapi-proxy-secret placeholder in vin-decoder (#128)
|
||||
4A-4: GITEA_TOKEN Actions secret in vin-decoder repo (#126)
|
||||
4A-5: RAPIDAPI_VIN_API_ID + RAPIDAPI_VIN_VERSION_ID Actions secrets (#139)
|
||||
[blocked on VIN Decoder RapidAPI listing]
|
||||
└─► VIN Decoder pods start; CI can push images
|
||||
|
||||
Phase 5: RapidAPI + PayPal (all 4 APIs including VIN Decoder; issue #151)
|
||||
└─► revenue enabled for all 4 APIs
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@@ -77,7 +77,7 @@ Use this checklist as the final go-live gate — run through every item the day
|
||||
flux get all
|
||||
|
||||
# Check API pod health
|
||||
for ns in zip-enrichment holidays air-quality docs-site; do
|
||||
for ns in zip-enrichment holidays air-quality vin-decoder docs-site; do
|
||||
echo "=== $ns ==="
|
||||
kubectl get pods -n $ns
|
||||
done
|
||||
@@ -85,13 +85,13 @@ done
|
||||
# Verify TLS certs
|
||||
kubectl get certificates -A
|
||||
|
||||
# Check all 7 DNS subdomains
|
||||
for sub in zip holidays aqi docs status registry grafana; do
|
||||
# Check all 8 DNS subdomains
|
||||
for sub in zip holidays aqi vin docs status registry grafana; do
|
||||
echo "$sub.leeworks.dev -> $(dig $sub.leeworks.dev +short)"
|
||||
done
|
||||
|
||||
# Smoke test health endpoints
|
||||
for svc in "zip.leeworks.dev/health" "holidays.leeworks.dev/health" "aqi.leeworks.dev/health"; do
|
||||
for svc in "zip.leeworks.dev/health" "holidays.leeworks.dev/health" "aqi.leeworks.dev/health" "vin.leeworks.dev/v1/health"; do
|
||||
echo "$svc: $(curl -s -o /dev/null -w '%{http_code}' https://$svc)"
|
||||
done
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ Follow this list top-to-bottom; each step unblocks the next.
|
||||
- [ ] 1. `gitea-leeworks-agents-token` (flux-system) — unblocks Flux GitRepository auth
|
||||
- [ ] 2. `gitea-runner-token` (gitea-runner) — unblocks Gitea Actions runner registration
|
||||
- [ ] 3. `grafana-admin` (monitoring) — unblocks Grafana login
|
||||
- [ ] 4. `gatus-slack-webhook` (monitoring) — unblocks Gatus alert notifications
|
||||
- [ ] 4. `gatus-slack-webhook` (monitoring) — unblocks Gatus alert notifications AND Alertmanager Slack SLO alerts
|
||||
- [ ] 5. `GITEA_TOKEN` in each API repo's Actions Secrets — unblocks CI image push
|
||||
- [ ] 6. Gitea packages enabled + DNS record for `registry.leeworks.dev` — unblocks image push to registry
|
||||
- [ ] 7. Add api-company Flux source + kustomization to 0xWheatyz/Talos — unblocks all GitOps reconciliation
|
||||
@@ -92,9 +92,12 @@ Grafana will be accessible at `https://grafana.leeworks.dev` (login: `admin` / `
|
||||
|-----------|-------|
|
||||
| Name | `gatus-slack-webhook` |
|
||||
| Namespace | `monitoring` |
|
||||
| Purpose | Gatus posts downtime alerts to a Slack channel via incoming webhook |
|
||||
| Purpose | Gatus posts downtime alerts to a Slack channel via incoming webhook. Also mounted by Alertmanager (`alertmanagerSpec.secrets`) to send SLO / firing-alert Slack notifications. |
|
||||
| Source | Slack → Your workspace → Apps → Incoming Webhooks → Add to Slack → copy webhook URL |
|
||||
| Unblocks | Issue #8 (Gatus status page at `status.leeworks.dev`) |
|
||||
| Unblocks | Issue #8 (Gatus status page at `status.leeworks.dev`); Alertmanager Slack receiver (issue #210) |
|
||||
| Consumers | **Two components** share this secret: (1) **Gatus** (`flux/monitoring/gatus-helmrelease.yaml`) — public status-page alerts; (2) **Alertmanager** (`flux/monitoring/helmrelease.yaml` via `alertmanagerSpec.secrets`) — SLO / firing-alert Slack notifications |
|
||||
|
||||
> **Note (dual consumer):** Creating this one secret (`gatus-slack-webhook` in the `monitoring` namespace) unblocks **both** Gatus alert delivery AND Alertmanager's Slack receiver. The Alertmanager configuration references this secret at `global.slack_api_url_file: /etc/alertmanager/secrets/gatus-slack-webhook/url` (enabled in PR #212 / issue #210).
|
||||
|
||||
```bash
|
||||
kubectl create secret generic gatus-slack-webhook \
|
||||
@@ -266,7 +269,7 @@ kubectl create secret generic rapidapi-proxy-secret \
|
||||
1 (gitea-leeworks-token) → Flux can pull this repo over HTTPS
|
||||
2 (gitea-runner-token) → runner online → CI runs
|
||||
3 (grafana-admin) → Grafana login works
|
||||
4 (gatus-slack-webhook) → Gatus alerting works
|
||||
4 (gatus-slack-webhook) → Gatus alerting works + Alertmanager Slack SLO alerts
|
||||
5 + 6 (GITEA_TOKEN + registry packages) → CI pushes images → API services deploy
|
||||
8 (gitea-registry) → pods can pull images from registry.leeworks.dev → services start
|
||||
9 (gitea-image-automation-token) → Flux ImageUpdateAutomation pushes tag-update commits
|
||||
|
||||
@@ -9,7 +9,7 @@ data:
|
||||
api-dashboard.json: |
|
||||
{
|
||||
"annotations": { "list": [] },
|
||||
"description": "Request rate, latency, error rate, and data freshness for zip-enrichment, holidays, and air-quality APIs",
|
||||
"description": "Request rate, latency, error rate, and data freshness for zip-enrichment, holidays, air-quality, and vin-decoder APIs",
|
||||
"editable": true,
|
||||
"graphTooltip": 1,
|
||||
"panels": [
|
||||
|
||||
@@ -85,7 +85,25 @@ spec:
|
||||
action: replace
|
||||
target_label: kubernetes_pod_name
|
||||
alertmanager:
|
||||
enabled: false # Enable when alert routing is configured
|
||||
enabled: true
|
||||
config:
|
||||
global:
|
||||
slack_api_url_file: /etc/alertmanager/secrets/gatus-slack-webhook/url
|
||||
route:
|
||||
receiver: slack-api-alerts
|
||||
group_by: [alertname, namespace]
|
||||
group_wait: 30s
|
||||
group_interval: 5m
|
||||
repeat_interval: 4h
|
||||
receivers:
|
||||
- name: slack-api-alerts
|
||||
slack_configs:
|
||||
- channel: '#api-alerts'
|
||||
title: '{{ .CommonAnnotations.summary }}'
|
||||
text: '{{ range .Alerts }}{{ .Annotations.description }}{{ end }}'
|
||||
alertmanagerSpec:
|
||||
secrets:
|
||||
- gatus-slack-webhook
|
||||
kubeStateMetrics:
|
||||
enabled: true
|
||||
nodeExporter:
|
||||
|
||||
@@ -8,3 +8,4 @@ resources:
|
||||
- gatus-helmrelease.yaml
|
||||
- grafana-dashboard-apis.yaml
|
||||
- prometheusrule-apis.yaml
|
||||
- vin-decoder-dashboard.yaml
|
||||
|
||||
@@ -18,9 +18,9 @@ spec:
|
||||
- alert: APIHighErrorRate
|
||||
expr: |
|
||||
(
|
||||
sum by (job) (rate(api_requests_total{status=~"5..", job=~"zip|holidays|air-quality"}[5m]))
|
||||
sum by (job) (rate(api_requests_total{status=~"5..", job=~"zip|holidays|air-quality|vin-decoder"}[5m]))
|
||||
/
|
||||
sum by (job) (rate(api_requests_total{job=~"zip|holidays|air-quality"}[5m]))
|
||||
sum by (job) (rate(api_requests_total{job=~"zip|holidays|air-quality|vin-decoder"}[5m]))
|
||||
) > 0.05
|
||||
for: 5m
|
||||
labels:
|
||||
@@ -36,9 +36,9 @@ spec:
|
||||
- alert: APIHighErrorRate
|
||||
expr: |
|
||||
(
|
||||
sum by (job) (rate(api_requests_total{status=~"5..", job=~"zip|holidays|air-quality"}[5m]))
|
||||
sum by (job) (rate(api_requests_total{status=~"5..", job=~"zip|holidays|air-quality|vin-decoder"}[5m]))
|
||||
/
|
||||
sum by (job) (rate(api_requests_total{job=~"zip|holidays|air-quality"}[5m]))
|
||||
sum by (job) (rate(api_requests_total{job=~"zip|holidays|air-quality|vin-decoder"}[5m]))
|
||||
) > 0.20
|
||||
for: 5m
|
||||
labels:
|
||||
@@ -55,7 +55,7 @@ spec:
|
||||
expr: |
|
||||
histogram_quantile(
|
||||
0.95,
|
||||
sum by (job, le) (rate(api_response_duration_seconds_bucket{job=~"zip|holidays|air-quality"}[5m]))
|
||||
sum by (job, le) (rate(api_response_duration_seconds_bucket{job=~"zip|holidays|air-quality|vin-decoder"}[5m]))
|
||||
) > 2
|
||||
for: 5m
|
||||
labels:
|
||||
@@ -70,7 +70,7 @@ spec:
|
||||
# -------------------------------------------------------------------
|
||||
- alert: APIDataStale
|
||||
expr: |
|
||||
api_data_freshness_seconds{job=~"zip|holidays|air-quality"} > 2592000
|
||||
api_data_freshness_seconds{job=~"zip|holidays|air-quality|vin-decoder"} > 2592000
|
||||
for: 30m
|
||||
labels:
|
||||
severity: warning
|
||||
@@ -84,7 +84,7 @@ spec:
|
||||
# -------------------------------------------------------------------
|
||||
- alert: APIDataCriticallyStale
|
||||
expr: |
|
||||
api_data_freshness_seconds{job=~"zip|holidays|air-quality"} > 5184000
|
||||
api_data_freshness_seconds{job=~"zip|holidays|air-quality|vin-decoder"} > 5184000
|
||||
for: 1h
|
||||
labels:
|
||||
severity: critical
|
||||
@@ -98,9 +98,9 @@ spec:
|
||||
# -------------------------------------------------------------------
|
||||
- alert: APIDown
|
||||
expr: |
|
||||
absent(up{job=~"zip|holidays|air-quality"} == 1)
|
||||
absent(up{job=~"zip|holidays|air-quality|vin-decoder"} == 1)
|
||||
or
|
||||
up{job=~"zip|holidays|air-quality"} == 0
|
||||
up{job=~"zip|holidays|air-quality|vin-decoder"} == 0
|
||||
for: 2m
|
||||
labels:
|
||||
severity: critical
|
||||
|
||||
@@ -0,0 +1,161 @@
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: grafana-dashboard-vin-decoder
|
||||
namespace: monitoring
|
||||
labels:
|
||||
grafana_dashboard: "1"
|
||||
data:
|
||||
vin-decoder-dashboard.json: |
|
||||
{
|
||||
"annotations": { "list": [] },
|
||||
"description": "Request rate, latency, error rate, and cache hit ratio for the VIN Decoder API",
|
||||
"editable": true,
|
||||
"graphTooltip": 1,
|
||||
"panels": [
|
||||
{
|
||||
"collapsed": false,
|
||||
"gridPos": { "h": 1, "w": 24, "x": 0, "y": 0 },
|
||||
"id": 1,
|
||||
"title": "VIN Decoder — Request Rate",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "prometheus" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": { "axisLabel": "requests/sec", "drawStyle": "line", "fillOpacity": 10, "lineWidth": 1, "showPoints": "never" },
|
||||
"unit": "reqps"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 0, "y": 1 },
|
||||
"id": 2,
|
||||
"options": {
|
||||
"legend": { "calcs": ["mean", "max"], "displayMode": "table", "placement": "bottom" },
|
||||
"tooltip": { "mode": "multi" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"expr": "sum by (route) (rate(api_requests_total{api=\"vin-decoder\"}[5m]))",
|
||||
"legendFormat": "{{route}}",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Request Rate by Route",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "prometheus" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": { "axisLabel": "", "drawStyle": "line", "fillOpacity": 10, "lineWidth": 1, "showPoints": "never" },
|
||||
"unit": "percentunit"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 12, "y": 1 },
|
||||
"id": 3,
|
||||
"options": {
|
||||
"legend": { "calcs": ["mean", "last"], "displayMode": "table", "placement": "bottom" },
|
||||
"tooltip": { "mode": "multi" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"expr": "sum(rate(api_requests_total{api=\"vin-decoder\",status_code=~\"5..\"}[5m])) / sum(rate(api_requests_total{api=\"vin-decoder\"}[5m]))",
|
||||
"legendFormat": "5xx error rate",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "5xx Error Rate",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"gridPos": { "h": 1, "w": 24, "x": 0, "y": 9 },
|
||||
"id": 10,
|
||||
"title": "VIN Decoder — Latency",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "prometheus" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "palette-classic" },
|
||||
"custom": { "axisLabel": "seconds", "drawStyle": "line", "fillOpacity": 5, "lineWidth": 1, "showPoints": "never" },
|
||||
"unit": "s"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 24, "x": 0, "y": 10 },
|
||||
"id": 4,
|
||||
"options": {
|
||||
"legend": { "calcs": ["mean", "max"], "displayMode": "table", "placement": "bottom" },
|
||||
"tooltip": { "mode": "multi" }
|
||||
},
|
||||
"targets": [
|
||||
{
|
||||
"expr": "histogram_quantile(0.50, sum by (route, le) (rate(api_response_duration_seconds_bucket{api=\"vin-decoder\"}[5m])))",
|
||||
"legendFormat": "P50 {{route}}",
|
||||
"refId": "A"
|
||||
},
|
||||
{
|
||||
"expr": "histogram_quantile(0.95, sum by (route, le) (rate(api_response_duration_seconds_bucket{api=\"vin-decoder\"}[5m])))",
|
||||
"legendFormat": "P95 {{route}}",
|
||||
"refId": "B"
|
||||
},
|
||||
{
|
||||
"expr": "histogram_quantile(0.99, sum by (route, le) (rate(api_response_duration_seconds_bucket{api=\"vin-decoder\"}[5m])))",
|
||||
"legendFormat": "P99 {{route}}",
|
||||
"refId": "C"
|
||||
}
|
||||
],
|
||||
"title": "Response Latency P50 / P95 / P99 by Route",
|
||||
"type": "timeseries"
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"gridPos": { "h": 1, "w": 24, "x": 0, "y": 18 },
|
||||
"id": 20,
|
||||
"title": "VIN Decoder — Cache & Data Freshness",
|
||||
"type": "row"
|
||||
},
|
||||
{
|
||||
"datasource": { "type": "prometheus", "uid": "prometheus" },
|
||||
"fieldConfig": {
|
||||
"defaults": {
|
||||
"color": { "mode": "thresholds" },
|
||||
"thresholds": {
|
||||
"steps": [
|
||||
{ "color": "green", "value": null },
|
||||
{ "color": "yellow", "value": 2592000 },
|
||||
{ "color": "red", "value": 5184000 }
|
||||
]
|
||||
},
|
||||
"unit": "s"
|
||||
},
|
||||
"overrides": []
|
||||
},
|
||||
"gridPos": { "h": 8, "w": 12, "x": 0, "y": 19 },
|
||||
"id": 5,
|
||||
"options": { "reduceOptions": { "calcs": ["lastNotNull"] }, "orientation": "auto", "textMode": "auto", "colorMode": "background" },
|
||||
"targets": [
|
||||
{
|
||||
"expr": "api_data_freshness_seconds{api=\"vin-decoder\"}",
|
||||
"legendFormat": "data freshness",
|
||||
"refId": "A"
|
||||
}
|
||||
],
|
||||
"title": "Data Freshness (seconds since last NHTSA fetch)",
|
||||
"type": "stat"
|
||||
}
|
||||
],
|
||||
"refresh": "1m",
|
||||
"schemaVersion": 38,
|
||||
"tags": ["vin-decoder", "api-company"],
|
||||
"title": "VIN Decoder API",
|
||||
"uid": "vin-decoder-api",
|
||||
"version": 1
|
||||
}
|
||||
@@ -37,7 +37,8 @@ spec:
|
||||
- name: vin-decoder
|
||||
image: registry.leeworks.dev/vin-decoder/api:latest # {"$imagepolicy": "flux-system:vin-decoder"}
|
||||
ports:
|
||||
- containerPort: 3000
|
||||
- name: http
|
||||
containerPort: 3000
|
||||
env:
|
||||
- name: RAPIDAPI_PROXY_SECRET
|
||||
valueFrom:
|
||||
@@ -72,7 +73,8 @@ spec:
|
||||
selector:
|
||||
app: vin-decoder
|
||||
ports:
|
||||
- port: 80
|
||||
- name: http
|
||||
port: 80
|
||||
targetPort: 3000
|
||||
- apiVersion: networking.k8s.io/v1
|
||||
kind: Ingress
|
||||
|
||||
@@ -4,3 +4,4 @@ resources:
|
||||
- namespace.yaml
|
||||
- externalsecret.yaml
|
||||
- helmrelease.yaml
|
||||
- servicemonitor.yaml
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
apiVersion: monitoring.coreos.com/v1
|
||||
kind: ServiceMonitor
|
||||
metadata:
|
||||
name: vin-decoder
|
||||
namespace: vin-decoder
|
||||
labels:
|
||||
release: kube-prometheus-stack
|
||||
spec:
|
||||
selector:
|
||||
matchLabels:
|
||||
app: vin-decoder
|
||||
endpoints:
|
||||
- port: http
|
||||
path: /metrics
|
||||
interval: 30s
|
||||
Reference in New Issue
Block a user