docs: add self-signed certificate guide for OIDC providers#391
docs: add self-signed certificate guide for OIDC providers#391markphelps wants to merge 5 commits intomainfrom
Conversation
Add documentation for trusting self-signed/internal CA certificates when using OIDC with self-hosted identity providers (Keycloak, Dex, etc). Includes: - Dockerfile example with update-ca-certificates - Kubernetes deployment example (init container + shared volume) - Verification command Closes flipt-io/flipt#5296
PR ReviewThis is a useful addition that addresses a real pain point for users with self-hosted OIDC providers. The overall structure is clear and the context is well-explained. A few issues worth addressing before merging: Must Fix1. Missing language tag on error code block CLAUDE.md requires language tags on all code blocks. The error message block at the top of the section has no language tag: ``` Should be at minimum ```text``` or ``````` with a 2. Kubernetes init container may not have The init container uses Consider either:
3. Kubernetes Deployment YAML is missing required fields The example is missing spec:
replicas: 1
selector:
matchLabels:
app: flipt
template:
metadata:
labels:
app: flipt
spec:
...Should Fix4. Use proper subheadings instead of bold text for examples
5. Error message prefix may vary The documented error: The prefix Nice to Have6. Cross-reference to Lines 588–590 in the same file document a Overall this is good documentation that fills a real gap. The Kubernetes YAML completeness issue is the most important to fix before this goes out — incomplete examples can frustrate users more than no example at all. |
PR ReviewGood addition to the docs — this fills a real gap for users with self-hosted OIDC providers. The content is clear and the use cases are well-chosen. A few issues to address before merging: Blocking: Malformed code block inside the
|
- Add language tag to error code block - Use alpine image for init container (has apk available) - Add apk install step in init container - Add required K8s Deployment fields (replicas, selector, labels) - Use proper subheadings instead of bold text - Note both error message variants for searchability - Fix malformed code block inside Tip component - Remove -brief flag from openssl command for portability - Add kubectl create secret snippet - Add Note about OIDC lacking ca_path (cross-ref to K8s auth) Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
|
Addressed all review feedback:
|
PR ReviewAll feedback from the previous review rounds has been addressed — great work. The documentation is now well-structured, accurate, and follows the conventions in CLAUDE.md. A few notes below: Blocking: CI lint check is failingThe You can reproduce it locally with: cd docs && npm run lintAnd for Vale prose linting: cd docs && vale v2/configuration/authentication.mdxWhat looks good
Once the lint failure is resolved, this looks ready to merge. |
Signed-off-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
PR ReviewAll feedback from previous review rounds has been addressed. The content is well-structured and follows the conventions in CLAUDE.md. A few minor observations below: CI checks are still runningThe cd docs && npm run lint
cd docs && vale v2/configuration/authentication.mdxMinor:
|
Adds documentation for trusting self-signed/internal CA certificates when using OIDC with self-hosted identity providers (Keycloak, Dex, etc).
Context: flipt-io/flipt#5296 — Users with self-hosted OIDC providers using internal CAs get
x509: certificate signed by unknown authorityerrors. A community member (kristofersokk) shared the workaround; this PR documents it properly.Includes:
update-ca-certificatesopenssl s_clientCloses flipt-io/flipt#5296