[KYUUBI #7676][DOCS] Recommend multi-tenant session config safeguards - #7677
[KYUUBI #7676][DOCS] Recommend multi-tenant session config safeguards#7677nightcityblade wants to merge 5 commits into
Conversation
…guards Signed-off-by: nightcityblade <jackchen@haloailabs.com>
|
Greeting is somehow broken. Sending a message by hand
|
|
@nightcityblade Thank you for the PR! |
|
Thanks — I added a concrete starting policy in 44994a2. It silently keeps server-defined driver/executor memory while explicitly rejecting client changes to The text also explains when to use the ignore versus restrict list, tells administrators to tailor the baseline, and clarifies that operation-level |
wForget
left a comment
There was a problem hiding this comment.
@nightcityblade Thanks for your contribution. However, the documentation you modified is for the Kyuubi AuthZ Plugin For Spark SQL, which is unrelated to the configuration mentioned in this PR.
|
Thanks for catching the scope mismatch. I moved the multi-tenant session-configuration guidance out of the Spark authorization plugin page and into the general Kyuubi security overview. The full Sphinx HTML build succeeds with the same six unrelated existing warnings, and |
|
Also, would you create a new doc under docs/security for this guidance? Adding to index.md is not a good idea. I would like to keep the index.md only for index |
|
Addressed the latest feedback in 95c480e:
Validation: the full Sphinx HTML build succeeds with the same six unrelated existing warnings, and |
|
Addressed: the guidance now lives in a dedicated docs/security/session_configuration.md page, includes the requested main-resource, engine-share-level, and deploy-mode safeguards, marks the list as non-comprehensive, and clarifies that only some settings remain mutable via SET. |
|
Fixed the Spotless Markdown failure in a861a77 by adding the required trailing blank line to docs/security/index.md. Local build/mvn spotless:check now passes across all 41 reactor modules. |
### Why are the changes needed? The session configuration ignore and restrict lists are empty by default. In a multi-tenant deployment, leaving both lists empty lets clients override sensitive session-level configuration during engine bootstrap and connection setup. This adds an explicit administrator recommendation to the existing security documentation. Closes #7676. ### How was this patch tested? - `env PATH=/usr/bin:/bin:/usr/sbin:/sbin dev/reformat` - `sphinx-build -W --keep-going -D suppress_warnings=myst.xref_missing,misc.highlighting_failure -b html docs /tmp/kyuubi-docs-build-7676-focused` - Confirmed the generated `security/authorization/spark/overview.html` contains the recommendation. The Sphinx suppression covers existing warnings in unrelated documentation; the changed page builds without warnings. ### Was this patch assisted by generative AI tooling? Assisted-by: OpenAI Codex:GPT-5 Closes #7677 from nightcityblade/kyuubi-7676-recommend-session-config. Closes #7676 a861a77 [nightcityblade] docs: fix security index formatting 95c480e [nightcityblade] docs: separate session configuration guidance 9bf6e91 [nightcityblade] docs: move session config guidance to security overview 44994a2 [nightcityblade] [KYUUBI #7676][DOCS] Add session config baseline efb6239 [nightcityblade] [KYUUBI #7676][DOCS] Recommend multi-tenant session config safeguards Lead-authored-by: nightcityblade <jackchen@haloailabs.com> Co-authored-by: nightcityblade <nightcityblade@gmail.com> Signed-off-by: Akira Ajisaka <aajisaka@apache.org> (cherry picked from commit 503aa4f) Signed-off-by: Akira Ajisaka <aajisaka@apache.org>
|
Merged to master and branch-1.12. Thank you @nightcityblade @wForget |
Why are the changes needed?
The session configuration ignore and restrict lists are empty by default. In a
multi-tenant deployment, leaving both lists empty lets clients override
sensitive session-level configuration during engine bootstrap and connection
setup. This adds an explicit administrator recommendation to the existing
security documentation.
Closes #7676.
How was this patch tested?
env PATH=/usr/bin:/bin:/usr/sbin:/sbin dev/reformatsphinx-build -W --keep-going -D suppress_warnings=myst.xref_missing,misc.highlighting_failure -b html docs /tmp/kyuubi-docs-build-7676-focusedsecurity/authorization/spark/overview.htmlcontainsthe recommendation.
The Sphinx suppression covers existing warnings in unrelated documentation;
the changed page builds without warnings.
Was this patch assisted by generative AI tooling?
Assisted-by: OpenAI Codex:GPT-5