Skip to content

fix(docs): align quickstart PQC keygen and config with nightly platform image#353

Merged
marythought merged 2 commits into
mainfrom
fix/quickstart-pqc-version-mismatch
Jun 26, 2026
Merged

fix(docs): align quickstart PQC keygen and config with nightly platform image#353
marythought merged 2 commits into
mainfrom
fix/quickstart-pqc-version-mismatch

Conversation

@marythought

@marythought marythought commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The quickstart docker-compose pinned keygen source and config download to service/v0.16.0 while using the nightly platform image
  • After feat(core)!: conform hybrid PQ/T key formats to IETF drafts platform#3563 changed the hybrid key PEM format, the nightly image can no longer load keys generated by the v0.16.0 keygen, causing a 502 on /healthz
  • Switch both refs to main so they stay in sync with the nightly image

Reported in opentdf/platform#3068 (comment)

Longer-term fix (adding keygen as a platform subcommand) tracked in opentdf/platform#3673.

Test plan

  • test-stack CI job passes (currently failing on main)
  • Platform healthz returns 200 with PQC keys generated from main

Closes #352

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the local setup configuration to pull the latest example platform settings from the main branch.
    • Changed the key-generation setup to use the latest main branch source, helping ensure newer setup instructions stay in sync.

…rm image

The quickstart docker-compose pinned the keygen source and config
download to service/v0.16.0 while using the nightly platform image.
After opentdf/platform#3563 changed the hybrid key PEM format, the
nightly image can no longer load keys generated by the v0.16.0 keygen,
causing a 502 on /healthz.

Switch both refs to main so they stay in sync with the nightly image.

Closes #352

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
@marythought marythought requested review from a team as code owners June 26, 2026 16:52
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The quickstart docker-compose setup now downloads opentdf-example.yaml from opentdf/platform/main and pulls PQC key generation sources from origin main.

Changes

Quickstart source updates

Layer / File(s) Summary
Updated source branches
docs/getting-started/docker-compose.yaml
The platform config download command and the PQC key generation container both switch their source branch from service/v0.16.0 to main.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

  • opentdf/docs issue 352 — Matches the same docker-compose.yaml branch updates for the config download and PQC key generation steps.

Possibly related PRs

  • opentdf/docs#337 — Also updates docs/getting-started/docker-compose.yaml to change which platform config the quickstart pulls.
  • opentdf/docs#338 — Also changes the quickstart config source branch and the PQC key generation branch reference in the same file.

Suggested reviewers

  • jrschumacher
  • pflynn-virtru

Poem

A rabbit hops through setup bright,
From service/v0.16.0 to main so light.
Two branches twirl, then settle in place,
For config and keys in the quickstart space.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: syncing quickstart PQC key generation and config with the nightly platform image.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/quickstart-pqc-version-mismatch

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the docs/getting-started/docker-compose.yaml file to fetch the example configuration and pull source code from the main branch instead of the service/v0.16.0 release branch. There are no review comments, and I have no 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.

@marythought

Copy link
Copy Markdown
Contributor Author

Confirmed that main fails on the script job, here: https://github.com/opentdf/docs/actions/runs/28251987695/job/83706206391

If it passes in the PR with this fix that is our validation that short term fix works.

@github-actions

Copy link
Copy Markdown
Contributor

📄 Preview deployed to https://opentdf-docs-pr-353.surge.sh

@marythought marythought merged commit 26127d4 into main Jun 26, 2026
12 checks passed
@marythought marythought deleted the fix/quickstart-pqc-version-mismatch branch June 26, 2026 17:22
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.

fix: quickstart docker-compose PQC key format mismatch with nightly platform image

2 participants