[ZEPPELIN-6489] Fix stale Shiro authentication documentation links - #5361
[ZEPPELIN-6489] Fix stale Shiro authentication documentation links#5361xhaktm00 wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates stale Apache Zeppelin Shiro authentication documentation links referenced in a config template and in Kerberos/Knox authentication filter log messages, aligning them with the current published docs path under docs/latest/setup/security/.
Changes:
- Update
conf/shiro.ini.templatecomment to use the correcthttps://URL and updated docs path/filename. - Update Kerberos filter error message link to the current Shiro authentication docs URL and preserve the
#kerberos-authanchor. - Re-wrap the Knox filter error message URL across lines to keep within checkstyle line-length constraints while updating the link target.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| conf/shiro.ini.template | Fixes the Shiro auth documentation link in the Active Directory realm configuration comment. |
| zeppelin-server/src/main/java/org/apache/zeppelin/realm/kerberos/KerberosAuthenticationFilter.java | Updates the KerberosRealm misconfiguration error message to point to the correct Shiro auth docs URL. |
| zeppelin-server/src/main/java/org/apache/zeppelin/realm/jwt/KnoxAuthenticationFilter.java | Updates the KnoxJwtRealm misconfiguration error message URL and re-wraps it to satisfy line-length rules. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jongyoul
left a comment
There was a problem hiding this comment.
The Kerberos link still uses #kerberos-auth, but the published page has the heading HTTP SPNEGO Authentication. The site runs AnchorJS over that heading, producing #http-spnego-authentication, so the current fragment does not navigate to the Kerberos section. Please update the fragment to #http-spnego-authentication and re-check the complete URL.
|
@jongyoul Thank you for pointing this out. The page generates heading ids at runtime via AnchorJS, which I missed when checking the static HTML. I updated the Kerberos fragment to |
What is this PR for?
The Shiro authentication docs URL referenced in
conf/shiro.ini.templateand in the Kerberos/Knox authentication filter error messages no longer resolves. The stale link has three defects: it useshttp://instead ofhttps://(template only), the path is missing thesetup/segment, and the file name is missing an underscore (shiroauthentication.html→shiro_authentication.html).This PR updates all three pointers to the current docs address, which is published from
docs/setup/security/shiro_authentication.md:https://zeppelin.apache.org/docs/latest/setup/security/shiro_authentication.html
The surrounding comment/message text is unchanged. One line in
KnoxAuthenticationFilteris re-wrapped to keep the longer URL within the 100-character checkstyle limit.What type of PR is it?
Documentation
Todos
conf/shiro.ini.template,KerberosAuthenticationFilterandKnoxAuthenticationFilterWhat is the Jira issue?
How should this be tested?
No code behavior changes — the URLs appear only in a config template comment and log messages, so no unit tests are added.
docs/setup/security/shiro_authentication.mdScreenshots (if appropriate)
N/A
Questions: