Skip to content
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

[#6110] doc(authz): Add document for chain authorization plugin #6115

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jerqi
Copy link
Contributor

@jerqi jerqi commented Jan 6, 2025

What changes were proposed in this pull request?

Add document for chain authorization plugin

Why are the changes needed?

Fix: #6110

Does this PR introduce any user-facing change?

Just document.

How was this patch tested?

No need.

|-----------------------------------------------------------|-------------------------------------------------------------------------------------------|---------------|-----------------------------|------------------|
| `authorization-provider` | Providers to use to implement authorization plugin such as `chain` | (none) | No | 0.8.0-incubating |
| `authorization.chain.plugins` | The comma-separated list of plugin names, just like `${plugin-name1},${plugin-name2},...` | (none) | Yes if you use chain plugin | 0.8.0-incubating |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `authorization.chain.plugins` | The comma-separated list of plugin names, just like `${plugin-name1},${plugin-name2},...` | (none) | Yes if you use chain plugin | 0.8.0-incubating |
| `authorization.chain.plugins` | The comma-separated list of plugin names, like `${plugin-name1},${plugin-name2},...` | (none) | Yes if you use chain plugin | 0.8.0-incubating |

:::caution
The Gravitino chain authorization plugin only supports the Apache Ranger HadoopSQL Plugin and Apache Ranger HDFS Plugin.
The properties of every chained plugin in the authorization should be configured with the `authorization.chain.${plugin-name}` as the prefix.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The properties of every chained plugin in the authorization should be configured with the `authorization.chain.${plugin-name}` as the prefix.
The properties of every chained authorization plugin should use `authorization.chain.${plugin-name}` as the prefix.


Suppose you have an Apache Hive service in your datacenter and have created a `hiveRepo` in Apache Ranger to manage its permissions.
The Apache Hive service will use HDFS to store its data. You have created a `hdfsRepo` in Apache Ranger to manage HDFS's permissions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "You have created" mean?
The four (sub-)sentences there are all assumptions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Improvement] Add the document for chained authorization plugin
3 participants