Add STARTS_WITH policy condition to allow for URN-wildcard-based policies

[githendrik]

In our company we run a distributed setup for ingestions. Every source system run the ingestion on their infra and pushes metadata into our datahub instance. With the policies that are currently available, we are facing the issue that we have to give pretty broad permissions to the different ingestion users.

To improve this, we propose the change in this PR.

Applying these changes would introduce a new policy condition called STARTS_WITH that can be used for metadata-based policies.

GraphQL payload example:

{
  "operationName": "createPolicy",
  "variables": {
    "input": {
      "type": "METADATA",
      "name": "urn-prefix-policy",
      "state": "ACTIVE",
      "description": "",
      "privileges": [
        "EDIT_ENTITY"
      ],
      "actors": {
        "users": [YOUR-USERS-HERE],
        "groups": [],
        "allUsers": false,
        "allGroups": false,
        "resourceOwners": false
      },
      "resources": {
        "filter": {
          "criteria": [
            {
              "field": "URN",
              "values": [
                "urn:li:dataset:(urn:li:dataPlatform:kafka,sbd.",
                "urn:li:dataset:(urn:li:dataPlatform:s3,sbd."
              ],
              "condition": "STARTS_WITH"
            }
          ]
        }
      }
    }
  },
  "query": "mutation createPolicy($input: PolicyUpdateInput!) { createPolicy(input: $input) }"
}

This would grant all required permissions to the ingestion user for their respective platforms/instances purely based on URN-prefixes.

We would also propose to adapt the PolicyDetailsModal to indicate such a STARTS_WITH condition using an asterisk *:

Due to the technical nature of these policies that require manual typing of urn-strings, we don't think it makes sense to also add support for them in the policy dialog UI. But if you think this should be added, we'd gladly do that.

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[david-leifker]

@hrichert - Please run ./gradlew spotlessApply --rerun-tasks to make sure all the linting is applied. Thank you!

[david-leifker]

lgtm! thanks!