[docs] Document keycloakInternalUrl platform value#452
Conversation
Add documentation for the new keycloakInternalUrl option that allows the dashboard's oauth2-proxy to route backend requests through the internal Keycloak service, bypassing external DNS and TLS. Assisted-By: Claude AI Signed-off-by: Kirill Ilin <stitch14@yandex.ru>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR adds documentation for a new OIDC Keycloak configuration field Changes
Poem
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 |
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation for OIDC configuration by introducing and explaining the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the new keycloakInternalUrl platform value. The changes are well-written and provide clear explanations across the platform package reference, a new section in the self-signed certificates guide, and an informational alert in the OIDC setup guide. I have one suggestion to improve navigation by adding a direct link to the new section.
| ``` | ||
|
|
||
| {{% alert color="info" %}} | ||
| **Optional**: If you want the dashboard to reach Keycloak via the internal cluster network instead of the external ingress, set `keycloakInternalUrl`. This is useful in environments with self-signed certificates or restricted external access. See [Self-Signed Certificates](../self-signed-certificates/) for details. |
There was a problem hiding this comment.
For a better user experience, it's good practice to link directly to the relevant section of a document. The current link takes the user to the top of the 'Self-Signed Certificates' page, but the relevant information is in a new section. Please add an anchor to the link to navigate the user directly to the 'Optional: Configure Internal Keycloak URL for Dashboard' section.
| **Optional**: If you want the dashboard to reach Keycloak via the internal cluster network instead of the external ingress, set `keycloakInternalUrl`. This is useful in environments with self-signed certificates or restricted external access. See [Self-Signed Certificates](../self-signed-certificates/) for details. | |
| **Optional**: If you want the dashboard to reach Keycloak via the internal cluster network instead of the external ingress, set `keycloakInternalUrl`. This is useful in environments with self-signed certificates or restricted external access. See [Self-Signed Certificates](../self-signed-certificates/#optional-configure-internal-keycloak-url-for-dashboard) for details. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
content/en/docs/v1/operations/oidc/enable_oidc.md (1)
85-85: Use the full config path for precision.At Line 85, consider using
authentication.oidc.keycloakInternalUrlinstead ofkeycloakInternalUrlto match the reference docs and reduce ambiguity.✏️ Suggested wording tweak
-**Optional**: If you want the dashboard to reach Keycloak via the internal cluster network instead of the external ingress, set `keycloakInternalUrl`. This is useful in environments with self-signed certificates or restricted external access. See [Self-Signed Certificates](../self-signed-certificates/) for details. +**Optional**: If you want the dashboard to reach Keycloak via the internal cluster network instead of the external ingress, set `authentication.oidc.keycloakInternalUrl`. This is useful in environments with self-signed certificates or restricted external access. See [Self-Signed Certificates](../self-signed-certificates/) for details.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/en/docs/v1/operations/oidc/enable_oidc.md` at line 85, Replace the ambiguous key name `keycloakInternalUrl` with the fully-qualified config path `authentication.oidc.keycloakInternalUrl` in the documentation text so it matches the reference docs and removes ambiguity when users set the value; locate the occurrence of `keycloakInternalUrl` in the enable_oidc.md content and update the phrasing to reference `authentication.oidc.keycloakInternalUrl` instead.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@content/en/docs/v1/operations/oidc/enable_oidc.md`:
- Line 85: Replace the ambiguous key name `keycloakInternalUrl` with the
fully-qualified config path `authentication.oidc.keycloakInternalUrl` in the
documentation text so it matches the reference docs and removes ambiguity when
users set the value; locate the occurrence of `keycloakInternalUrl` in the
enable_oidc.md content and update the phrasing to reference
`authentication.oidc.keycloakInternalUrl` instead.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5d644b85-057c-444d-9203-884fc9b64404
📒 Files selected for processing (3)
content/en/docs/v1/operations/configuration/platform-package.mdcontent/en/docs/v1/operations/oidc/enable_oidc.mdcontent/en/docs/v1/operations/oidc/self-signed-certificates.md
2 participants
What this PR does
Documents the new
authentication.oidc.keycloakInternalUrlplatform value across three pages:Related: cozystack/cozystack#2224
Release note
Summary by CodeRabbit