Skip to content

Commit d4c067e

Browse files
Docs: Ranger Tags Implementation Changes (#135)
* docs: ranger tags implementation changes * fix: removed hybrid runner part
1 parent 1ec3597 commit d4c067e

File tree

2 files changed

+56
-0
lines changed

2 files changed

+56
-0
lines changed

connectors/security/ranger/index.mdx

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ The user connecting to Apache Ranger should have the following permissions:
3535
# - Read access to service definitions
3636
```
3737
### Connection Details
38+
3839
We support Apache Ranger with Basic Authentication using username and password.
3940
## Reverse Metadata Ingestion
4041
The Apache Ranger connector is designed specifically for **reverse metadata ingestion**. This means that OpenMetadata will sync metadata information (primarily tags) from your data sources back to Apache Ranger.
@@ -48,6 +49,61 @@ The Apache Ranger connector is designed specifically for **reverse metadata inge
4849
- **Tag Synchronization**: Currently, we only sync tag information to Ranger.
4950
- **Source-Ranger Communication**: You are responsible for configuring the communication between Apache Ranger and your actual data sources. OpenMetadata only handles the metadata synchronization to Ranger
5051
- **Bidirectional Sync**: This is currently a one-way sync from OpenMetadata to Ranger
52+
53+
### Tag Synchronization Details
54+
55+
Understanding how tag synchronization works between OpenMetadata and Apache Ranger is crucial for proper implementation.
56+
57+
#### What Gets Created During Reverse Metadata Ingestion
58+
59+
During reverse metadata ingestion, OpenMetadata creates **only the mapping** between:
60+
- **Ranger Resources**: The specific entity (database, schema, table, or column)
61+
- **Tags**: The tag name and tag value
62+
63+
**Important:** We do **not** create or depend on tag policies during the reverse metadata workflow. The policy creation is **not mandatory** for the workflow to function. Policies can be created in Ranger after the reverse metadata workflow completes.
64+
65+
#### Policy Management
66+
67+
The actual application of tag-based policies—such as access control, data masking, or row-level filtering—is handled **entirely by Apache Ranger**. OpenMetadata's role is limited to:
68+
1. Syncing tag metadata from OpenMetadata to actual data sources
69+
2. Creating tag-to-resource mappings in Ranger
70+
3. Keeping these mappings synchronized as tags change in OpenMetadata
71+
72+
#### Supported Tag Levels
73+
74+
We provide comprehensive tag support at multiple levels:
75+
- **Database level**: Tags applied to entire databases
76+
- **Schema level**: Tags applied to schemas
77+
- **Table level**: Tags applied to tables
78+
- **Column level**: Tags applied to individual columns
79+
80+
This multi-level support allows you to implement fine-grained governance policies based on your organization's requirements.
81+
82+
#### Tag Naming Convention
83+
84+
OpenMetadata uses a clear and consistent tag naming convention when syncing to Ranger. Tags are formatted as:
85+
86+
```
87+
classification.tag
88+
```
89+
90+
**Example:**
91+
- A tag named `Sensitive` under the `PII` classification in OpenMetadata
92+
- Will be synced to Ranger as: `PII.Sensitive`
93+
94+
This naming convention ensures clarity and prevents naming conflicts in Ranger.
95+
96+
<Frame caption="Example showing PII.Sensitive tag in OpenMetadata and Ranger">
97+
<img src="/public/images/connectors/ranger/tag-naming-example.png" alt="Tag Naming Convention Example" />
98+
</Frame>
99+
100+
#### Complete Workflow Example
101+
102+
1. **In OpenMetadata**: You apply the tag `PII.Sensitive` to a column `customer_email` in table `users`
103+
2. **Reverse Metadata Sync**: OpenMetadata creates a mapping in Ranger linking the resource `database.schema.users.customer_email` to tag `PII.Sensitive`
104+
3. **In Apache Ranger**: You create a policy that applies masking to all resources tagged with `PII.Sensitive`
105+
4. **Result**: The policy automatically applies to `customer_email` and any other resources tagged as `PII.Sensitive`
106+
51107
## Metadata Ingestion
52108
<MetadataIngestionUi connector={"Ranger"} selectServicePath={"/public/images/connectors/ranger/select-service.png"} addNewServicePath={"/public/images/connectors/ranger/add-new-service.png"} serviceConnectionPath={"/public/images/connectors/ranger/service-connection.png"} />
53109
## Troubleshooting
176 KB
Loading

0 commit comments

Comments
 (0)