yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-11-10 00:11:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): policies footnotes out of order (#13691)

Browse Source
This commit is contained in:
Kevin Karch 2025-06-06 13:42:07 -04:00 committed by GitHub
parent 11cd28ebc8
commit bf57943f3d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 43 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
docs/authorization/policies.md
View File

@ -171,17 +171,11 @@ These privileges are for DataHub operators to access & manage the administrative
| Create Business Attribute | Allow actor to create new Business Attribute. | | Create Business Attribute | Allow actor to create new Business Attribute. |
| Manage Structured Properties | Manage structured properties in your instance. | | Manage Structured Properties | Manage structured properties in your instance. |
| View Tests | View Asset Tests. | | View Tests | View Asset Tests. |
| Manage Tests[^2] | Allow actor to create and remove Asset Tests. | | Manage Tests[^1] | Allow actor to create and remove Asset Tests. |
| View Metadata Proposals[^2] | Allow actor to view the requests tab for viewing metadata proposals. | | View Metadata Proposals[^1] | Allow actor to view the requests tab for viewing metadata proposals. |
| Create metadata constraints[^3] | Allow actor to create metadata constraints. | | Create metadata constraints[^2] | Allow actor to create metadata constraints. |
| Manage Platform Settings[^2] | Allow actor to view and change platform-level settings, like integrations & notifications. | | Manage Platform Settings[^1] | Allow actor to view and change platform-level settings, like integrations & notifications. |
| Manage Monitors[^2] | Allow actor to create, update, and delete any data asset monitors, including Custom SQL monitors. Grant with care. | | Manage Monitors[^1] | Allow actor to create, update, and delete any data asset monitors, including Custom SQL monitors. Grant with care. |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
[^3]: Deprecated feature
#### Entity Management #### Entity Management
@ -195,21 +189,17 @@ These privileges are for DataHub operators to access & manage the administrative
| Platform Privileges | Description | | Platform Privileges | Description |
| --------------------------------------------- | -------------------------------------------------------------------------------------------------------- | --- | | --------------------------------------------- | -------------------------------------------------------------------------------------------------------- | --- |
| Restore Indices API[^1] | Allow actor to use the Restore Indices API. | | | Restore Indices API[^3] | Allow actor to use the Restore Indices API. | |
| Get Timeseries index sizes API[^1] | Allow actor to use the get Timeseries indices size API. | | Get Timeseries index sizes API[^3] | Allow actor to use the get Timeseries indices size API. |
| Truncate timeseries aspect index size API[^1] | Allow actor to use the API to truncate a timeseries index. | | Truncate timeseries aspect index size API[^3] | Allow actor to use the API to truncate a timeseries index. |
| Get ES task status API[^1] | Allow actor to use the get task status API for an ElasticSearch task. | | Get ES task status API[^3] | Allow actor to use the get task status API for an ElasticSearch task. |
| Enable/Disable Writeability API[^1] | Allow actor to enable or disable GMS writeability for data migrations. | | Enable/Disable Writeability API[^3] | Allow actor to enable or disable GMS writeability for data migrations. |
| Apply Retention API[^1] | Allow actor to apply retention using the API. | | Apply Retention API[^3] | Allow actor to apply retention using the API. |
| Analytics API access[^1] | Allow actor to use API read access to raw analytics data. | | Analytics API access[^3] | Allow actor to use API read access to raw analytics data. |
| Explain ElasticSearch Query API[^1] | Allow actor to use the Operations API explain endpoint. | | Explain ElasticSearch Query API[^3] | Allow actor to use the Operations API explain endpoint. |
| Produce Platform Event API[^1] | Allow actor to produce Platform Events using the API. | | Produce Platform Event API[^3] | Allow actor to produce Platform Events using the API. |
| Manage System Operations | Allow actor to manage system operation controls. This setting includes all System Management privileges. | | Manage System Operations | Allow actor to manage system operation controls. This setting includes all System Management privileges. |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
### Common Metadata Privileges ### Common Metadata Privileges
These privileges are to view & modify any entity within DataHub. These privileges are to view & modify any entity within DataHub.
@ -223,15 +213,11 @@ These privileges are to view & modify any entity within DataHub.
| Delete | Allow actor to delete this entity. | | Delete | Allow actor to delete this entity. |
| Create Entity | Allow actor to create an entity if it doesn't exist. | | Create Entity | Allow actor to create an entity if it doesn't exist. |
| Entity Exists | Allow actor to determine whether the entity exists. | | Entity Exists | Allow actor to determine whether the entity exists. |
| Get Timeline API[^1] | Allow actor to use the GET Timeline API. | | Get Timeline API[^3] | Allow actor to use the GET Timeline API. |
| Get Entity + Relationships API[^1] | Allow actor to use the GET Entity and Relationships API. | | Get Entity + Relationships API[^3] | Allow actor to use the GET Entity and Relationships API. |
| Get Aspect/Entity Count APIs[^1] | Allow actor to use the GET Aspect/Entity Count APIs. | | Get Aspect/Entity Count APIs[^3] | Allow actor to use the GET Aspect/Entity Count APIs. |
| View Entity[^2] | Allow actor to view the entity in search results. | | View Entity[^1] | Allow actor to view the entity in search results. |
| Share Entity[^2] | Allow actor to share an entity with another DataHub Cloud instance. | | Share Entity[^1] | Allow actor to share an entity with another DataHub Cloud instance. |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
#### Aspect Privileges #### Aspect Privileges
@ -249,26 +235,18 @@ These privileges are to view & modify any entity within DataHub.
| Edit Lineage | Allow actor to add and remove lineage edges for this entity. | | Edit Lineage | Allow actor to add and remove lineage edges for this entity. |
| Edit Properties | Allow actor to edit the properties for an entity. | | Edit Properties | Allow actor to edit the properties for an entity. |
| Edit Owners | Allow actor to add and remove owners of an entity. | | Edit Owners | Allow actor to add and remove owners of an entity. |
| Get Timeseries Aspect API[^1] | Allow actor to use the GET Timeseries Aspect API. | | Get Timeseries Aspect API[^3] | Allow actor to use the GET Timeseries Aspect API. |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
#### Proposals #### Proposals
| Proposals Privileges | Description | | Proposals Privileges | Description |
| ---------------------------------- | -------------------------------------------------------------------- | | ---------------------------------- | -------------------------------------------------------------------- |
| Propose Tags[^2] | Allow actor to propose adding a tag to an asset. | | Propose Tags[^1] | Allow actor to propose adding a tag to an asset. |
| Propose Glossary Terms[^2] | Allow actor to propose adding a glossary term to an asset. | | Propose Glossary Terms[^1] | Allow actor to propose adding a glossary term to an asset. |
| Propose Documentation[^2] | Allow actor to propose updates to an asset's documentation. | | Propose Documentation[^1] | Allow actor to propose updates to an asset's documentation. |
| Manage Tag Proposals[^2] | Allow actor to manage a proposal to add a tag to an asset. | | Manage Tag Proposals[^1] | Allow actor to manage a proposal to add a tag to an asset. |
| Manage Glossary Term Proposals[^2] | Allow actor to manage a proposal to add a glossary term to an asset. | | Manage Glossary Term Proposals[^1] | Allow actor to manage a proposal to add a glossary term to an asset. |
| Manage Documentation Proposals[^2] | Allow actor to manage a proposal update an asset's documentation | | Manage Documentation Proposals[^1] | Allow actor to manage a proposal update an asset's documentation |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
### Specific Entity-level Privileges ### Specific Entity-level Privileges
@ -279,16 +257,12 @@ These privileges are not generalizable.
| Entity | Privilege | Description | | Entity | Privilege | Description |
| ------ | -------------------------------------- | ------------------------------------------------------------------------------------------------ | | ------ | -------------------------------------- | ------------------------------------------------------------------------------------------------ |
| Group | Edit Group Members | Allow actor to add and remove members to a group. | | Group | Edit Group Members | Allow actor to add and remove members to a group. |
| Group | Manage Group Notification Settings[^2] | Allow actor to manage notification settings for a group. | | Group | Manage Group Notification Settings[^1] | Allow actor to manage notification settings for a group. |
| Group | Manage Group Subscriptions[^2] | Allow actor to manage subscriptions for a group. | | Group | Manage Group Subscriptions[^1] | Allow actor to manage subscriptions for a group. |
| Group | Edit Contact Information | Allow actor to change the contact information such as email & chat handles. | | Group | Edit Contact Information | Allow actor to change the contact information such as email & chat handles. |
| User | Edit Contact Information | Allow actor to change the contact information such as email & chat handles. | | User | Edit Contact Information | Allow actor to change the contact information such as email & chat handles. |
| User | Edit User Profile | Allow actor to change the user's profile including display name, bio, title, profile image, etc. | | User | Edit User Profile | Allow actor to change the user's profile including display name, bio, title, profile image, etc. |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
#### Dataset #### Dataset
| Entity | Privilege | Description | | Entity | Privilege | Description |
@ -298,27 +272,23 @@ These privileges are not generalizable.
| Dataset | Edit Dataset Column Descriptions | Allow actor to edit the column (field) descriptions associated with a dataset schema. | | Dataset | Edit Dataset Column Descriptions | Allow actor to edit the column (field) descriptions associated with a dataset schema. |
| Dataset | Edit Dataset Column Tags | Allow actor to edit the column (field) tags associated with a dataset schema. | | Dataset | Edit Dataset Column Tags | Allow actor to edit the column (field) tags associated with a dataset schema. |
| Dataset | Edit Dataset Column Glossary Terms | Allow actor to edit the column (field) glossary terms associated with a dataset schema. | | Dataset | Edit Dataset Column Glossary Terms | Allow actor to edit the column (field) glossary terms associated with a dataset schema. |
| Dataset | Propose Dataset Column Glossary Terms[^2] | Allow actor to propose column (field) glossary terms associated with a dataset schema. | | Dataset | Propose Dataset Column Glossary Terms[^1] | Allow actor to propose column (field) glossary terms associated with a dataset schema. |
| Dataset | Propose Dataset Column Tags[^2] | Allow actor to propose new column (field) tags associated with a dataset schema. | | Dataset | Propose Dataset Column Tags[^1] | Allow actor to propose new column (field) tags associated with a dataset schema. |
| Dataset | Manage Dataset Column Glossary Terms[^2] | Allow actor to manage column (field) glossary term proposals associated with a dataset schema. | | Dataset | Manage Dataset Column Glossary Terms[^1] | Allow actor to manage column (field) glossary term proposals associated with a dataset schema. |
| Dataset | Propose Dataset Column Descriptions[^2] | Allow actor to propose new descriptions associated with a dataset schema. | | Dataset | Propose Dataset Column Descriptions[^1] | Allow actor to propose new descriptions associated with a dataset schema. |
| Dataset | Manage Dataset Column Tag Proposals[^2] | Allow actor to manage column (field) tag proposals associated with a dataset schema. | | Dataset | Manage Dataset Column Tag Proposals[^1] | Allow actor to manage column (field) tag proposals associated with a dataset schema. |
| Dataset | Edit Assertions | Allow actor to add and remove assertions from an entity. | | Dataset | Edit Assertions | Allow actor to add and remove assertions from an entity. |
| Dataset | Edit Dataset Queries | Allow actor to edit the Queries for a Dataset. | | Dataset | Edit Dataset Queries | Allow actor to edit the Queries for a Dataset. |
| Dataset | Create erModelRelationship | Allow actor to add erModelRelationship on a dataset. | | Dataset | Create erModelRelationship | Allow actor to add erModelRelationship on a dataset. |
| Dataset | Edit Monitors[^2] | Allow actor to edit monitors for the entity. | | Dataset | Edit Monitors[^1] | Allow actor to edit monitors for the entity. |
| Dataset | Edit SQL Assertion Monitors[^2] | Allow actor to edit custom SQL assertion monitors for the entity. Note that this gives read query access to users with through the Custom SQL assertion builder. Grant with care. | | Dataset | Edit SQL Assertion Monitors[^1] | Allow actor to edit custom SQL assertion monitors for the entity. Note that this gives read query access to users with through the Custom SQL assertion builder. Grant with care. |
| Dataset | Edit Data Contract[^2] | Allow actor to edit the Data Contract for an entity. | | Dataset | Edit Data Contract[^1] | Allow actor to edit the Data Contract for an entity. |
| Dataset | Manage Data Contract Proposals[^2] | Allow actor to manage a proposal for a Data Contract | | Dataset | Manage Data Contract Proposals[^1] | Allow actor to manage a proposal for a Data Contract |
| Tag | Edit Tag Color | Allow actor to change the color of a Tag. | | Tag | Edit Tag Color | Allow actor to change the color of a Tag. |
| Domain | Manage Data Products | Allow actor to create, edit, and delete Data Products within a Domain | | Domain | Manage Data Products | Allow actor to create, edit, and delete Data Products within a Domain |
| GlossaryNode | Manage Direct Glossary Children | Allow actor to create and delete the direct children of this entity. | | GlossaryNode | Manage Direct Glossary Children | Allow actor to create and delete the direct children of this entity. |
| GlossaryNode | Manage All Glossary Children | Allow actor to create and delete everything underneath this entity. | | GlossaryNode | Manage All Glossary Children | Allow actor to create and delete everything underneath this entity. |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
#### Misc #### Misc
| Entity | Privilege | Description | | Entity | Privilege | Description |
@ -328,10 +298,6 @@ These privileges are not generalizable.
| GlossaryNode | Manage Direct Glossary Children | Allow actor to create and delete the direct children of this entity. | | GlossaryNode | Manage Direct Glossary Children | Allow actor to create and delete the direct children of this entity. |
| GlossaryNode | Manage All Glossary Children | Allow actor to create and delete everything underneath this entity. | | GlossaryNode | Manage All Glossary Children | Allow actor to create and delete everything underneath this entity. |
[^1]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^2]: DataHub Cloud only
## Coming Soon ## Coming Soon
The DataHub team is hard at work trying to improve the Policies feature. We are planning on building out the following: The DataHub team is hard at work trying to improve the Policies feature. We are planning on building out the following:
@ -345,3 +311,9 @@ Under consideration
## Feedback / Questions / Concerns ## Feedback / Questions / Concerns
We want to hear from you! For any inquiries, including Feedback, Questions, or Concerns, reach out on Slack! We want to hear from you! For any inquiries, including Feedback, Questions, or Concerns, reach out on Slack!
[^3]: Only active if REST_API_AUTHORIZATION_ENABLED is true
[^1]: DataHub Cloud only
[^2]: Deprecated feature