Skip to content

Fix outdated ingestion pipeline docs#903

Merged
akkomar merged 6 commits into
mainfrom
doc_updates
Jul 20, 2026
Merged

Fix outdated ingestion pipeline docs#903
akkomar merged 6 commits into
mainfrom
doc_updates

Conversation

@akkomar

@akkomar akkomar commented Jul 20, 2026

Copy link
Copy Markdown
Member

This corrects outdated statements in the ingestion pipeline docs, found by cross-checking each doc against the current implementation in https://github.com/mozilla/gcp-ingestion and IaC repos.

akkomar added 4 commits July 16, 2026 13:50
The Decoded topic is read by the Kubernetes Live Sink (part of the
ingestion-sink service on GKE), not a Dataflow job. Update the prose and
relabel the diagram node accordingly.

Also drop the inaccurate 'guaranteed to contain a few days of history'
caveat: live tables are for low-latency access to recent data, not a
supported analysis interface. Point readers to the stable tables instead.
The Raw topic is read by the Kubernetes Raw Sink (part of the ingestion-sink
service), not a Dataflow job, and writes to the payload_bytes_raw dataset. The
'Landfill' name is historical. Update the prose and relabel the diagram nodes;
keep a parenthetical for the old name. Match gcp-ingestion's own terminology
('Kubernetes Raw Sink job') rather than the stale 'custom Java application'
phrasing from a 2020 transition note.
Verified against gcp-ingestion ingestion-edge (create_app.py, publish.py,
util.py, dockerflow.py):

- GET /status does not exist. Health is served via Dockerflow endpoints
  (/__lbheartbeat__, /__heartbeat__, /__version__). Rewrite the GET request
  and response-code sections accordingly.
- The ?v=4 query parameter is not validated or rejected at the edge; the edge
  routes on path only and forwards the body opaquely. Describe the actual
  behavior.
- POST/PUT response codes: add 431 (attribute exceeds PubSub's 1024-byte
  limit) and 507 (local retry queue full), which the edge actually returns;
  drop 411 and 414, which are not enforced.
- Define the previously dangling [decoder] and [schemas repository]
  reference-style links.
Verified against gcp-ingestion: ingestion-beam's PubsubMessageToTableRow is
now a thin wrapper that adds Beam metrics and converts to a BigQuery TableRow;
the transformation logic (map types, nested arrays, tuples, coercion,
additional_properties) moved to ingestion-core's PubsubMessageToObjectNode.
Point the doc there and fix the 'Thee'/'telemtry' typos in the paragraph.
@akkomar akkomar changed the title Fix outdated ingestion pipeline docs (drift vs gcp-ingestion) Fix outdated ingestion pipeline docs Jul 20, 2026
@akkomar
akkomar enabled auto-merge (squash) July 20, 2026 14:00

@edugfilho edugfilho left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@akkomar
akkomar merged commit d170a61 into main Jul 20, 2026
9 checks passed
@akkomar
akkomar deleted the doc_updates branch July 20, 2026 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants