-
Notifications
You must be signed in to change notification settings - Fork 379
Add docs on restricting public access to management operations. #5847
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds a new shared documentation page describing strategies to restrict public access to management operations and wires it into versioned docs (7.1.0, 7.2.0, next) with corresponding mkdocs navigation entries. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive documentation on restricting public access to management operations in WSO2 Identity Server. The guide introduces two security approaches for isolating administrative operations from runtime traffic: network-level separation (control plane vs. data plane) and proxy-level isolation using separate hostnames.
Changes:
- Added new deployment guide explaining control plane/data plane separation and proxy-level isolation strategies
- Included NGINX configuration samples and WSO2 Identity Server configuration instructions
- Updated navigation across three versions (7.1.0, 7.2.0, and next) to include the new guide
Reviewed changes
Copilot reviewed 7 out of 10 changed files in this pull request and generated 17 comments.
Show a summary per file
| File | Description |
|---|---|
| en/includes/deploy/configure-console-hostname.md | New comprehensive guide with two approaches for restricting public access to management operations, including diagrams, NGINX configurations, and Identity Server settings |
| en/identity-server/next/mkdocs.yml | Added navigation entry for the new guide in the deployment section |
| en/identity-server/next/docs/deploy/configure-console-hostname.md | Include file that references the shared documentation |
| en/identity-server/7.2.0/mkdocs.yml | Added navigation entry for the new guide in the deployment section |
| en/identity-server/7.2.0/docs/deploy/configure-console-hostname.md | Include file that references the shared documentation |
| en/identity-server/7.1.0/mkdocs.yml | Added navigation entry for the new guide in the deployment section |
| en/identity-server/7.1.0/docs/deploy/configure-console-hostname.md | Include file that references the shared documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@en/includes/deploy/configure-console-hostname.md`:
- Line 154: Replace the typo "dosen't" with the correct contraction "doesn't" in
the sentence mentioning load balancers and URL rewrite rules (the line
containing "Some load balancers dosen't support URL rewrite rules similar to
`sub_filter` on NGINX."). Ensure the corrected sentence reads "Some load
balancers doesn't support..."—actually use "Some load balancers don't support
URL rewrite rules similar to `sub_filter` on NGINX." to match plural subject
"load balancers."
🧹 Nitpick comments (1)
en/includes/deploy/configure-console-hostname.md (1)
16-16: Optional: Image filename contains typo.The image filename
data-plane-control-plane-seperation.pnghas "seperation" misspelled (should be "separation"). Consider renaming both the file and this reference for consistency.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@en/includes/deploy/configure-console-hostname.md`:
- Line 40: The word "seperation" in the sentence should be corrected to
"separation"; update the Markdown in the section containing the sentence that
currently reads "logical isolation by exposing the Console application on a
different hostname instead of a full network seperation" to use "separation" so
it reads "...instead of a full network separation," ensuring the spelling change
is applied to the content that mentions the Console and runtime domain examples
(`is.dev.wso2.com`, `carbon.dev.wso2.com`).
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This pull request adds documentation on how to restrict public access to management operations in WSO2 Identity Server across versions 7.1.0, 7.2.0, and next. It introduces a new guide that explains two main strategies—network-level and proxy-level isolation—and updates navigation to include this guide in the deployment section.
Documentation Additions:
configure-console-hostname.md, detailing two approaches to isolate management operations from public access: (1) network-level separation between control and data planes, and (2) proxy-level isolation using a separate hostname and NGINX configuration. The guide includes diagrams, configuration samples, and step-by-step instructions.Navigation Updates:
mkdocs.ymlfor versions 7.1.0, 7.2.0, and next to include the new "Restrict public access to management operations" guide under the deployment section.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.