Skip to content

Commit 3694524

Browse files
authored
docs: add migration v5 periodic materialization notes (#170)
1 parent c0501f1 commit 3694524

3 files changed

Lines changed: 14 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Added
11+
12+
- **Migration v5 periodic materialization playbook** in
13+
[`examples/migration_v5/periodic_materialization/README.md`](examples/migration_v5/periodic_materialization/README.md)
14+
(PR [#168](https://github.com/GoogleCloudPlatform/BigQuery-Agent-Analytics-SDK/pull/168)).
15+
Documents the customer path for keeping the MAKO graph fresh on
16+
a schedule: local dry-run via `run_job.py`, Cloud Run Job +
17+
Cloud Scheduler deployment with `--smoke`, required APIs and
18+
IAM, recommended schedules, Cloud Logging JSON report shape,
19+
Cloud Monitoring alerts, state-table inspection, teardown, and
20+
troubleshooting. Complements the migration v5 four-guarantee
21+
notebook by covering the production cron path.
22+
1023
## [0.3.0] - 2026-05-15
1124

1225
### Release highlights

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ architecture, rationale, and implementation plans behind key SDK features.
6161

6262
| Document | Description |
6363
|----------|-------------|
64+
| [Migration v5 periodic materialization playbook](../examples/migration_v5/periodic_materialization/README.md) | Customer deployment path for keeping the MAKO migration v5 graph fresh on a schedule: local dry-run, Cloud Run Job + Cloud Scheduler deploy with `--smoke`, IAM matrix, schedule guidance, JSON log shape, Cloud Monitoring alert filters, state-table inspection, cleanup, and troubleshooting. |
6465
| [proposal_bigquery_agent_cli.md](proposal_bigquery_agent_cli.md) | CLI proposal and command design |
6566
| [python_udf_support_design.md](python_udf_support_design.md) | BigQuery Python UDF architecture |
6667
| [remote_function_rationale.md](remote_function_rationale.md) | Cloud Run remote function rationale |

examples/migration_v5/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,10 +195,6 @@ The flow customers actually follow:
195195

196196
See **[`periodic_materialization/README.md`](./periodic_materialization/README.md)** for the full customer playbook: required APIs, IAM matrix, recommended schedules per latency target, Cloud Monitoring alert queries, state-table SQL, troubleshooting, and live-deployment evidence captured against the canonical test project.
197197

198-
## What's NOT in this commit
199-
200-
- `docs/README.md` / `CHANGELOG.md` entries — staged for a follow-up PR alongside the user-facing release notes.
201-
202198
## Related
203199

204200
- [#107 storyboard](https://github.com/GoogleCloudPlatform/BigQuery-Agent-Analytics-SDK/issues/107) — per-cell plan the notebook implements.

0 commit comments

Comments
 (0)