kyuubi/docs
liangbowen 6b34898510
[KYUUBI #3217] [DOCS] Doc for using Marcos in row-level filter in Authz
### _Why are the changes needed?_

Support macros in Row-filter condition expression, introduced in Ranger 2.3 ([release notes](https://cwiki.apache.org/confluence/display/RANGER/Apache+Ranger+2.3.0+-+Release+Notes)), is an major feature to significantly simplify the row-filter condition expression in practice by replacing explicit condition query by using user/group's attributes.

- [RANGER-3605](https://issues.apache.org/jira/browse/RANGER-3605) : Support macros in row-filter/condition expressions
- [RANGER-3550](https://issues.apache.org/jira/browse/RANGER-3550) : support for using user/tag attributes in row-filter expressions and conditions
Consider user liangtiancheng with attribute born_city = guangzhou, we can define the row filter condition with city='${{USER.born_city}}' with the macro feature.

However, This feature implicit relies on an config named `ranger.plugin.spark.enable.implicit.userstore.enricher` and the default value false will prevent RangerUserStoreEnricher fetching user/group and their attributes. Macros in row-filter condition will fallback to null value (as lack of user attributes value in UserStore of auth context) in script transformation unexpectedly and imperceptibly.

Improving doc of ranger-spark-security.xml to aware of this feature and related config.

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

- [ ] Add screenshots for manual tests if appropriate

- [x] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #3267 from bowenliang123/doc-ranger-macros.

Closes #3217

aee4b201 [liangbowen] plain text
a7ec3bc9 [liangbowen] update docs and clearify difference between ranger.plugin.hive.policy.cache.dir and ranger.plugin.spark.policy.cache.dir configs
4887bd1f [liangbowen] simplify with "row filter expressions"
fa62402f [liangbowen] skip list items
9dd1cd4c [liangbowen] h5. Using Marcos in Row Level Filters
849bed5b [liangbowen] add docs for Additional configs for using Marcos in row-level filter

Authored-by: liangbowen <liangbowen@gf.com.cn>
Signed-off-by: Kent Yao <yao@apache.org>
2022-08-19 09:55:56 +08:00
..
_static/css [KYUUBI #2764] [DOCS] Fix tables in docs being coverd by right toc sidebar 2022-05-27 17:21:42 +08:00
appendix [KYUUBI #2751] [DOC] Replace sphinx_rtd_theme with sphinx_book_theme 2022-05-27 02:22:36 +08:00
changelog [KYUUBI #2846] Add v1.5.2-incubating changelog 2022-06-10 10:53:52 +08:00
client [KYUUBI #3101] [Subtask][#3100] Build the content for extension points documentation 2022-07-21 15:37:19 +08:00
community [KYUUBI #3268] Update release docs for status file news 2022-08-18 17:55:13 +08:00
connector [KYUUBI #3252] Fix the problem that |release| in the document was not replaced correctly 2022-08-17 13:44:40 +08:00
deployment [KYUUBI #3020] kyuubi ldap add new config property kyuubi.authentication.ldap.bindpw and kyuubi.authentication.ldap.attrs 2022-08-18 20:29:12 +08:00
develop_tools [KYUUBI #3241][DOCS] Update Develop Tools / Building a Runnable Distribution 2022-08-18 15:38:09 +08:00
extensions [KYUUBI #3210] [DOCS] Mention Kyuubi Spark SQL extension supports Spark 3.3 2022-08-10 10:16:32 +08:00
imgs [KYUUBI #3060] [Subtask][#3059] Build content of the connector document section 2022-07-14 14:19:13 +08:00
monitor [KYUUBI #3157][DOC] Modify logging doc due to using log4j2 instead of log4j 2022-08-15 21:15:56 +08:00
overview [KYUUBI #2751] [DOC] Replace sphinx_rtd_theme with sphinx_book_theme 2022-05-27 02:22:36 +08:00
quick_start [KYUUBI #3206] Change Flink default version to 1.15 2022-08-11 15:31:59 +08:00
security [KYUUBI #3217] [DOCS] Doc for using Marcos in row-level filter in Authz 2022-08-19 09:55:56 +08:00
tools [KYUUBI #3045][FOLLOWUP] Correct the common options and add docs for kyuubi-admin command 2022-07-15 10:47:49 +08:00
conf.py [KYUUBI #2764] [DOCS] Fix tables in docs being coverd by right toc sidebar 2022-05-27 17:21:42 +08:00
index.rst [KYUUBI #3101] [Subtask][#3100] Build the content for extension points documentation 2022-07-21 15:37:19 +08:00
make.bat [KYUUBI #874] [ASF] ASF Publish 2021-08-16 11:48:21 +08:00
Makefile
requirements.txt [KYUUBI #3126] Using markdown 3.3.7 for kyuubi document build 2022-07-25 14:46:20 +08:00