Skip to content

docs: refresh quick start and reconcile wiki with current dataplane - #143

Merged
lucarlig merged 2 commits into
mainfrom
user/luca/wiki-local-jwks-startup
Sep 9, 2026
Merged

docs: refresh quick start and reconcile wiki with current dataplane#143
lucarlig merged 2 commits into
mainfrom
user/luca/wiki-local-jwks-startup

Conversation

@lucarlig

@lucarlig lucarlig commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

The wiki mixed the former token verification and session/prefix routing model with the current JWKS and request-scoped implementation. This made local startup fail and left conflicting deployment and protocol guidance.

  • Provide a complete local quick start with Redis, a counter fixture, JWKS token minting, explicit user routes, modern MCP requests, and secrets-detection plugins enabled. Fix the counter fixture's Docker build package selection.
  • Audit all 13 wiki pages and the table of contents against the source. Correct architecture, claims and authorization limits, configuration schemas, header/plugin ordering, failure modes, replica behavior, and production image limitations. Separate the modern MCP contract from legacy migration code and future roadmap work.
  • Replace removed load-test commands, align verification commands with CI, correct telemetry enablement and metric names, repair links, and make text flows readable in mdBook.

Validation:

  • Live Redis/counter/dataplane checks: health, JWKS, token minting, route publication, server/discover, tools/call, and secrets-detection denial passed.
  • Live collector/Prometheus checks: HTTP traces export at RUST_TRACE_LOG=info; every documented metric and PromQL query returns data.
  • All-features workspace tests: 247 passed, 13 intentionally skipped. Formatting, Clippy, dependency checks, workspace build, benchmark compilation, and cargo-shear passed. Cargo-deny retains an existing yanked-dependency warning.
  • mdBook build/test and rendered-page inspection passed; 427 local links/anchors, 26 Bash blocks, and 36 documented CLI flags checked. Load recipes checked against the released cf-integration 0.3.1 CLI and source.

The full repository Compose topology still needs JWKS/signing and publisher configuration updates; the wiki now identifies those prerequisites rather than presenting it as ready to run. Full-stack conformance and throughput benchmarks were not run for this documentation change.

Signed-off-by: lucarlig <luca.carlig@ibm.com>
Signed-off-by: lucarlig <luca.carlig@ibm.com>
@lucarlig lucarlig changed the title docs: refresh local quick start with JWKS and plugins docs: refresh quick start and reconcile wiki with current dataplane Sep 9, 2026
@lucarlig
lucarlig marked this pull request as ready for review September 9, 2026 12:23
@lucarlig
lucarlig merged commit 32b052c into main Sep 9, 2026
11 checks passed
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