lekdan commited on
Commit
c59b1ff
·
verified ·
1 Parent(s): be6cbb5

Document bash invocation for workflow scripts

Browse files
Files changed (1) hide show
  1. docs/PIPELINE_RUNBOOK.md +7 -7
docs/PIPELINE_RUNBOOK.md CHANGED
@@ -38,7 +38,7 @@ cargo build --release -p osu_indexer -p osu_fetcher
38
  cp osu_fetcher.toml.example osu_fetcher.toml
39
  # fill osu! API credentials; keep this file local only
40
 
41
- UPLOAD=1 scripts/update_maps_v1.sh
42
  ```
43
 
44
  `scripts/update_maps_v1.sh` performs the full update:
@@ -110,7 +110,7 @@ fewer `compact-*.parquet` files, then regenerates `latest_revisions` and
110
  Run compaction manually after older runs or when no new maps are being ingested:
111
 
112
  ```bash
113
- UPLOAD=1 scripts/compact_metadata_v1.sh
114
  ```
115
 
116
  Useful knobs:
@@ -120,7 +120,7 @@ COMPACT=0 # skip compaction for one update run
120
  COMPACT_TARGET_ROWS=1000000 # target rows per compacted all_revisions file
121
  COMPACT_MIN_FILES=2 # compact table dirs with at least this many files
122
  COMPACT_WORKERS=4 # parallel table compaction workers
123
- UPLOAD=0 scripts/compact_metadata_v1.sh # local-only compaction pass
124
  ```
125
 
126
  Compaction never touches `archives/`, `state/fetcher/`, `blobs/`, or
@@ -140,7 +140,7 @@ cd ~/osu_model
140
 
141
  UPLOAD=1 \
142
  BATCH_ID=compact-v1-$(date -u +%Y%m%dT%H%M%SZ) \
143
- scripts/rebuild_compact_v1.sh
144
  ```
145
 
146
  The rebuild script deletes local `data/`, stale local `blobs/`, and stale local
@@ -152,13 +152,13 @@ slow legacy-prefix deletion. If old `blobs/` or `manifests/` prefixes reappear
152
  and you intentionally want to remove them during the rebuild:
153
 
154
  ```bash
155
- CLEAN_LEGACY_PREFIXES=1 UPLOAD=1 scripts/rebuild_compact_v1.sh
156
  ```
157
 
158
  Smoke test without upload:
159
 
160
  ```bash
161
- UPLOAD=0 LIMIT=5 scripts/rebuild_compact_v1.sh
162
  ```
163
 
164
  Do not use `LIMIT` for the real rebuild.
@@ -172,7 +172,7 @@ If you already have new `.osz` files from another source, put them under
172
  mkdir -p incoming_osz
173
  cp /path/to/new/*.osz incoming_osz/
174
 
175
- HYDRATE=1 FETCH=0 INPUT_DIR=incoming_osz UPLOAD=1 scripts/update_maps_v1.sh
176
  ```
177
 
178
  The ingest step hashes each archive and skips any SHA-256 already committed in
 
38
  cp osu_fetcher.toml.example osu_fetcher.toml
39
  # fill osu! API credentials; keep this file local only
40
 
41
+ UPLOAD=1 bash scripts/update_maps_v1.sh
42
  ```
43
 
44
  `scripts/update_maps_v1.sh` performs the full update:
 
110
  Run compaction manually after older runs or when no new maps are being ingested:
111
 
112
  ```bash
113
+ UPLOAD=1 bash scripts/compact_metadata_v1.sh
114
  ```
115
 
116
  Useful knobs:
 
120
  COMPACT_TARGET_ROWS=1000000 # target rows per compacted all_revisions file
121
  COMPACT_MIN_FILES=2 # compact table dirs with at least this many files
122
  COMPACT_WORKERS=4 # parallel table compaction workers
123
+ UPLOAD=0 bash scripts/compact_metadata_v1.sh # local-only compaction pass
124
  ```
125
 
126
  Compaction never touches `archives/`, `state/fetcher/`, `blobs/`, or
 
140
 
141
  UPLOAD=1 \
142
  BATCH_ID=compact-v1-$(date -u +%Y%m%dT%H%M%SZ) \
143
+ bash scripts/rebuild_compact_v1.sh
144
  ```
145
 
146
  The rebuild script deletes local `data/`, stale local `blobs/`, and stale local
 
152
  and you intentionally want to remove them during the rebuild:
153
 
154
  ```bash
155
+ CLEAN_LEGACY_PREFIXES=1 UPLOAD=1 bash scripts/rebuild_compact_v1.sh
156
  ```
157
 
158
  Smoke test without upload:
159
 
160
  ```bash
161
+ UPLOAD=0 LIMIT=5 bash scripts/rebuild_compact_v1.sh
162
  ```
163
 
164
  Do not use `LIMIT` for the real rebuild.
 
172
  mkdir -p incoming_osz
173
  cp /path/to/new/*.osz incoming_osz/
174
 
175
+ HYDRATE=1 FETCH=0 INPUT_DIR=incoming_osz UPLOAD=1 bash scripts/update_maps_v1.sh
176
  ```
177
 
178
  The ingest step hashes each archive and skips any SHA-256 already committed in