fix(docs): pin quickstart to pre-PQC platform image and config#337
Conversation
|
Need the big picture first? Review this PR in Change Stack to see what changed before going file by file. 📝 WalkthroughWalkthroughThe docker-compose quickstart downloads a platform configuration file via ChangesQuickstart Config Alignment
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request updates the docker-compose.yaml file in the getting-started documentation to download the opentdf-dev.yaml configuration file instead of opentdf-example.yaml. There are no review comments, and I have no additional feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/getting-started/docker-compose.yaml (1)
332-340: ⚖️ Poor tradeoffConsider pinning downloads to stable release tags for long-term stability.
All external file downloads currently reference the
mainbranch (lines 339, 371, 415, 430), which makes the quickstart vulnerable to future breaking changes upstream. While the current change correctly fixes the immediate PQC key mismatch, a future enhancement could pin these downloads to stable release tags instead.This would provide:
- Predictable, tested configurations
- Protection against breaking changes on main
- Easier rollback if issues arise
However, this is a broader architectural decision beyond the scope of fixing the current PQC key issue, and the current approach is consistent across all downloads.
Also applies to: 360-405, 408-416, 419-464
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/getting-started/docker-compose.yaml` around lines 332 - 340, Replace direct downloads that reference the repository "main" branch with URLs pinned to a stable release tag: update the command in the download-platform-config service (command that fetches https://raw.githubusercontent.com/opentdf/platform/main/opentdf-dev.yaml) to use a specific release tag (e.g., .../opentdf/<RELEASE_TAG>/opentdf-dev.yaml) and make the same change for the other download commands referenced in the file (the other wget/curl commands that currently point to .../main/...). Ensure each URL uses the identical chosen release tag so all fetched configs are deterministic and documented.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/getting-started/docker-compose.yaml`:
- Around line 332-340: Replace direct downloads that reference the repository
"main" branch with URLs pinned to a stable release tag: update the command in
the download-platform-config service (command that fetches
https://raw.githubusercontent.com/opentdf/platform/main/opentdf-dev.yaml) to use
a specific release tag (e.g., .../opentdf/<RELEASE_TAG>/opentdf-dev.yaml) and
make the same change for the other download commands referenced in the file (the
other wget/curl commands that currently point to .../main/...). Ensure each URL
uses the identical chosen release tag so all fetched configs are deterministic
and documented.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: df22149a-6bcb-46ea-b63b-0313eec85923
📒 Files selected for processing (1)
docs/getting-started/docker-compose.yaml
|
📄 Preview deployed to https://opentdf-docs-pr-337.surge.sh |
|
Confirmed The same test passes here, which indicates that the quickstart guide should work when this is merged. |
The quickstart docker-compose downloads opentdf-example.yaml from platform/main, which now includes hybrid PQC keyring entries (xwing, ML-KEM) that require key files the quickstart doesn't generate. Switch to opentdf-dev.yaml which only requires RSA and EC keys that the existing generate-keys service creates. Fixes #336 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The previous commit incorrectly switched to opentdf-dev.yaml, which uses localhost hostnames instead of Docker service names and would break the containerized quickstart. Pin to opentdf-example.yaml at the service/v0.15.0 tag instead — this has the correct Docker hostnames and no PQC keyring entries that the quickstart's key generation can't satisfy. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Pin both the platform container image (nightly-a29f108) and the config download (opentdf-example.yaml at the same commit) to the last main commit before hybrid PQC key support was added. The previous attempt to use opentdf-dev.yaml would have broken because it uses localhost hostnames instead of Docker service names. The image and config must stay in sync — a nightly image built from main expects the config shape from the same commit. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
18c6915 to
e3f1ea7
Compare
Add a generate-pqc-keys service that builds the platform's keygen utility via sparse checkout and generates the hybrid post-quantum key files (X-Wing, P256+ML-KEM-768, P384+ML-KEM-1024) that opentdf-example.yaml now requires. Unpins the platform image and config download back to nightly/main so the quickstart tracks the latest platform automatically. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This reverts commit 39569c3.
Add a generate-pqc-keys service that sparse-checkouts the platform's keygen utility and generates hybrid post-quantum key files (X-Wing, P256+ML-KEM-768, P384+ML-KEM-1024) that opentdf-example.yaml requires since opentdf/platform#3276. Supersedes the stopgap pin in #337 — quickstart tracks nightly/main again. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add a generate-pqc-keys service that sparse-checkouts the platform's keygen utility and generates hybrid post-quantum key files (X-Wing, P256+ML-KEM-768, P384+ML-KEM-1024) that opentdf-example.yaml requires since opentdf/platform#3276. Supersedes the stopgap pin in #337 — quickstart tracks nightly/main again. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add a generate-pqc-keys service that sparse-checkouts the platform's keygen utility and generates hybrid post-quantum key files (X-Wing, P256+ML-KEM-768, P384+ML-KEM-1024) that opentdf-example.yaml requires since opentdf/platform#3276. Supersedes the stopgap pin in #337 — quickstart tracks nightly/main again. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add a generate-pqc-keys service that sparse-checkouts the platform's keygen utility and generates hybrid post-quantum key files (X-Wing, P256+ML-KEM-768, P384+ML-KEM-1024) that opentdf-example.yaml requires since opentdf/platform#3276. Supersedes the stopgap pin in #337 — quickstart tracks nightly/main again. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Problem
The quickstart docker-compose downloads
opentdf-example.yamlfromplatform/main, which now includes hybrid PQC keyring entries (hpqt:xwing,hpqt:secp256r1-mlkem768,hpqt:secp384r1-mlkem1024) added in opentdf/platform#3276. The quickstart'sgenerate-keysservice only creates RSA and EC keys via openssl — no PQC key files are generated. The platform crashes at startup:Confirmed
mainis broken: https://github.com/opentdf/docs/actions/runs/27036624683Stopgap fix
Pin the platform image (
nightly-a29f108) and config download to the lastmaincommit before PQC landed. Image and config stay in sync, no PQC keys needed.Long-term fix (add PQC key generation to the quickstart) will follow in a separate PR.
Fixes #336
Test plan
main(run)🤖 Generated with Claude Code