Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 80f4d5be22 | |||
| ee224fba3d | |||
| 8f26dff2f6 | |||
| a2f45be7f1 | |||
| 3c4c3aa1ab | |||
| 34d12a696a | |||
| 52c0baedf5 | |||
| e0c70b861a | |||
| 10323a2874 | |||
| edcef75418 |
+10
-10
@@ -5,7 +5,7 @@ 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`
|
||||
- [x] Audit cluster: nodes, namespaces, ingress, Flux state → `docs/cluster-audit.md` (issue #36 — closed ✅)
|
||||
- [ ] 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
|
||||
@@ -16,31 +16,31 @@ 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)
|
||||
- [x] VIN Decoder metrics instrumentation + Grafana dashboard (issue #129 — closed ✅)
|
||||
- [x] VIN Decoder Gatus health check (issue #134 — closed ✅)
|
||||
|
||||
## Phase 5 — Documentation site
|
||||
- [ ] `docs-site/` Astro + Redoc skeleton
|
||||
- [ ] Gitea Actions pipeline that copies per-API `openapi.yaml` files at build time
|
||||
- [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
|
||||
- [ ] One SEO blog post per API minimum (see master prompt §Phase 5)
|
||||
- [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`
|
||||
- [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.`
|
||||
- [x] VIN Decoder DNS `vin.leeworks.dev` (issue #130 — closed ✅)
|
||||
- [x] VIN Decoder RapidAPI listing (issue #131 — closed ✅ as tracker; operator action required)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Company Status
|
||||
|
||||
_Last updated: 2026-05-31 (sprint planning cycle)_
|
||||
_Last updated: 2026-06-02 (triage cycle — #168 STATUS.md cleanup)_
|
||||
|
||||
## APIs
|
||||
| API | Spec | Code | Deployed | Listed on RapidAPI | Paying Users | MRR |
|
||||
@@ -8,7 +8,7 @@ _Last updated: 2026-05-31 (sprint planning cycle)_
|
||||
| ZIP Enrichment | [~] | [~] | [ ] | [ ] | 0 | $0 |
|
||||
| Holidays | [~] | [~] | [ ] | [ ] | 0 | $0 |
|
||||
| Air Quality | [ ] | [ ] | [ ] | [ ] | 0 | $0 |
|
||||
| VIN Decoder | [x] | [ ] | [ ] | [ ] | 0 | $0 |
|
||||
| VIN Decoder | [x] | [x] | [ ] | [ ] | 0 | $0 |
|
||||
|
||||
Legend: [x]=done, [~]=in-progress, [ ]=not started
|
||||
|
||||
@@ -23,7 +23,47 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
||||
- **Image automation:** `flux/image-automation/` — ImageRepository + ImagePolicy + ImageUpdateAutomation for all three APIs
|
||||
- **VIN Decoder manifests:** `flux/vin-decoder/` — Flux HelmRelease + Kustomization committed (issue #140)
|
||||
|
||||
## Completed This Cycle (2026-05-31 — Sprint Cycle)
|
||||
## Completed This 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-01)
|
||||
|
||||
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)
|
||||
|
||||
## 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 +71,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,6 +88,8 @@ 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/`
|
||||
3. **Create `gitea-leeworks-agents-token` secret** in `flux-system` (#76)
|
||||
@@ -56,16 +98,15 @@ Legend: [x]=done, [~]=in-progress, [ ]=not started
|
||||
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
|
||||
|
||||
+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
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user