apache/kyuubi
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

[KYUUBI #1399] [DOCS] Add doc for engine share level

Browse Source 
<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->

doc improvement

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [x] Add screenshots for manual tests if appropriate

![image](https://user-images.githubusercontent.com/8326978/141964500-f0121a54-4ce9-4e9d-84a5-c4a4ab1f0ac9.png)

---

![image](https://user-images.githubusercontent.com/8326978/141965482-f367e486-c68b-44d8-85d9-9c7f0e7e63aa.png)
- [x] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #1399 from yaooqinn/sldoc.

Closes #1399

d8bcce8a [Kent Yao] [DOCS] Add doc for engine share level
21e2548f [Kent Yao] [DOCS] Add doc for engine share level
bba8dc9d [Kent Yao] [DOCS] Add doc for engine share level

Authored-by: Kent Yao <yao@apache.org>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
This commit is contained in:
Kent Yao 2021-11-16 19:58:25 +08:00 committed by ulysses-you
parent 178c39e221
commit bf9736e31b
No known key found for this signature in database
GPG Key ID: 4C500BC62D576766
7 changed files with 184 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
docs/deployment/engine_share_level.md Normal file
View File

File diff suppressed because one or more lines are too long

12
docs/deployment/index.rst
View File

@ -46,4 +46,14 @@ Configurations
:glob:
settings
spark/index
spark/index
Engines
-------
.. toctree::
:maxdepth: 2
:numbered: 3
:glob:
engine_share_level

1
docs/imgs/engine_share_level_connection.drawio Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/imgs/engine_share_level_group.drawio Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/imgs/engine_share_level_server.drawio Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/imgs/engine_share_level_user.drawio Normal file
View File

File diff suppressed because one or more lines are too long

2
docs/overview/kyuubi_vs_thriftserver.md
View File

@ -226,7 +226,7 @@ Inside an Engine, the Engine's user, a.k.a. `Spark User`, will also be the same.
When an Engine runs queries received from the JDBC connection, the Engine's user must also have rights to access the data.
Besides, if it needs access to metadata during this process, then we can also add a fine-grained SQL standard ACL management on the metadata layer now with [Submarine Spark Security Plugin](https://submarine.apache.org/docs/userDocs/submarine-security/spark-security/README).
The Engines have their lifecycle, which is related to the `kyuubi.session.engine.share.level` specified via client configurations.
The Engines have their lifecycle, which is related to the `kyuubi.engine.share.level` specified via client configurations.
For example, if set to `CONNECTION`, then the corresponding Engine will be created for each JDBC connection and terminates itself when we close the connection.
For another example, if set to `USER`, the corresponding Engine is cached and shared with all JDBC connections from the same user, even through different Kyuubi servers in HA mode.
The Engine will eventually timeout after all the sessions are closed.