Skip to content

Commit 838fe0d

Browse files
authored
Remove upstream/consumer repo references (#489)
- Simplify clusters config to single clusters.yaml source of truth - Remove consumer override/fallback logic from logging pipeline docs - Drop "upstream/" path prefixes in loki, mimir, and observability docs - Consolidate B200 runner note without upstream/consumer distinction The docs previously described a two-repo model (upstream vs consumer) with override semantics. This cleanup aligns documentation with the current single-repo structure. Signed-off-by: Jean Schmidt <contato@jschmidt.me>
1 parent 2210dd9 commit 838fe0d

5 files changed

Lines changed: 10 additions & 20 deletions

File tree

osdc/CLAUDE.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,9 @@ Modular Kubernetes infrastructure platform on AWS EKS. A shared `base/` provides
88

99
Working directory: `osdc/`. Run all commands from here.
1010

11-
## Clusters Configuration (IMPORTANT)
11+
## Clusters Configuration
1212

13-
**All paths below are relative to this CLAUDE.md file.**
14-
15-
Two `clusters.yaml` files exist — always check both when investigating module deployment:
16-
17-
- **`./clusters.yaml`** — upstream cluster definitions (the platform's own clusters)
18-
- **`../../clusters.yaml`** — consumer repo cluster definitions (consumer-specific clusters)
19-
20-
Modules may be deployed in upstream clusters but not consumer clusters, or vice versa. Never conclude a module is "not deployed" without checking both files.
13+
All clusters are defined in `./clusters.yaml`. This is the single source of truth for cluster definitions, module deployment, and per-cluster configuration.
2114

2215
## NEVER USE TERRAFORM — USE TOFU ONLY
2316

osdc/docs/loki_query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,4 +177,4 @@ To include timestamps:
177177

178178
## Source
179179

180-
Upstream reference: `upstream/osdc/CLAUDE.md`, section "Querying Logs in Grafana Cloud Loki". Verified via live queries against `pytorch-arc-cbr-production` on 2026-03-20.
180+
Reference: `CLAUDE.md`, section "Querying Logs in Grafana Cloud Loki". Verified via live queries against `pytorch-arc-cbr-production` on 2026-03-20.

osdc/docs/mimir_query.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,9 @@ curl -s -u "$MIMIR_USER:$MIMIR_PASS" \
252252

253253
## Source
254254

255-
Upstream references:
256-
- `upstream/osdc/CLAUDE.md` — general architecture
257-
- `upstream/osdc/modules/monitoring/CLAUDE.md` — monitoring module docs, credential setup
255+
References:
256+
- `CLAUDE.md` — general architecture
257+
- `modules/monitoring/CLAUDE.md` — monitoring module docs, credential setup
258258
- `clusters.yaml` — Mimir read/write URLs
259259
- `upstream/osdc/modules/monitoring/helm/alloy-values.yaml` — Alloy remote_write config
260260

osdc/docs/node-utilization-optimization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ OSDC uses Kubernetes Guaranteed QoS pods (requests == limits) for all runner wor
88

99
**Original state** (before Phase 2): 36 of 39 runner types had homogeneous utilization below 90%. Several had worst-case utilization under 20%. After Phase 2 (ratio-matched nodepools), x86 CPU worst-case improved from 12.6% to ~74% and ARM64 from 37.9% to 75.3%.
1010

11-
> **Note**: This analysis covers both upstream runners (35 in `modules/arc-runners/defs/`) and consumer B200 runners (4 in the consumer repo's `modules/arc-runners-b200/defs/`). B200 nodepool and runner defs are not in the upstream repo.
11+
> **Note**: This analysis covers all runners including B200 runners in `modules/arc-runners-b200/defs/`.
1212
1313
## How Packing Works
1414

osdc/docs/observability.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -195,12 +195,9 @@ Each module can contribute log parsing rules by placing a `logging/pipeline.allo
195195
During deploy, `assemble_config.py`:
196196

197197
1. Reads `clusters.yaml` to get the cluster's enabled modules
198-
2. For each module, checks `$OSDC_ROOT/modules/<name>/logging/pipeline.alloy` (consumer override first)
199-
3. Falls back to `$OSDC_UPSTREAM/modules/<name>/logging/pipeline.alloy`
200-
4. Inserts all discovered blocks at the `// MODULE_PIPELINES` marker in `base.alloy`
201-
5. Outputs the assembled config as a ConfigMap YAML (`alloy-logging-config`)
202-
203-
**Consumer opt-out**: an empty (whitespace-only) `pipeline.alloy` in the consumer's modules directory suppresses the upstream pipeline for that module entirely. The upstream file is NOT checked as fallback. This lets consumers disable a module's log parsing without deleting the upstream file.
198+
2. For each module, checks `modules/<name>/logging/pipeline.alloy`
199+
3. Inserts all discovered blocks at the `// MODULE_PIPELINES` marker in `base.alloy`
200+
4. Outputs the assembled config as a ConfigMap YAML (`alloy-logging-config`)
204201

205202
**Example module pipeline** (`modules/karpenter/logging/pipeline.alloy`):
206203

0 commit comments

Comments
 (0)