Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions knowledge_base/permissions_and_lifecycle/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.databricks/

57 changes: 57 additions & 0 deletions knowledge_base/permissions_and_lifecycle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# Permissions and lifecycle

This Declarative Automation Bundles example shows combined bundle and resource permissions, target overrides, lifecycle protection, and resource-key replacement. See the [permissions documentation](https://docs.databricks.com/aws/en/dev-tools/bundles/permissions).

## Prerequisites

* Databricks CLI v1.20.0 or above.
* Workspace administrator access.
* A workspace group for your team.
* Existing `<schema>_dev` and `<schema>_prod` Unity Catalog schemas for the pipelines.

## Usage

1. Create a workspace group for your team.

`databricks groups create --display-name data-engineering-team --profile dabs-examples`

2. Validate and deploy each target.

`databricks bundle validate -t dev --var "team_group=data-engineering-team,catalog_name=<catalog>,schema_name=<schema>" --profile dabs-examples`

`databricks bundle deploy -t dev --var "team_group=data-engineering-team,catalog_name=<catalog>,schema_name=<schema>" --profile dabs-examples`

Repeat both commands with `-t prod`.

| Target | `users` from bundle | Team group on job | Team group on pipeline |
| --- | --- | --- | --- |
| dev | `CAN_VIEW` | `CAN_MANAGE_RUN` | `CAN_RUN` |
| prod | `CAN_VIEW` | `CAN_MANAGE` | `CAN_MANAGE` |

3. Run the job and pipeline for each target.

`databricks bundle run permission_job -t dev --var "team_group=data-engineering-team,catalog_name=<catalog>,schema_name=<schema>" --profile dabs-examples`

`databricks bundle run permission_pipeline -t dev --var "team_group=data-engineering-team,catalog_name=<catalog>,schema_name=<schema>" --profile dabs-examples`

Repeat both commands with `-t prod`.

4. Get each job ID from `databricks bundle summary` and read its effective permissions.

`databricks permissions get jobs <id> --profile dabs-examples`

`databricks permissions get pipelines <id> --profile dabs-examples`

5. Rename `permission_job` in both YAML files and deploy again to replace the job.

Set `lifecycle.prevent_destroy` to `true` to block this replacement or cleanup.

6. Restore `lifecycle.prevent_destroy` to `false` and destroy both targets.

`databricks bundle destroy -t dev --auto-approve --var "team_group=data-engineering-team,catalog_name=<catalog>,schema_name=<schema>" --profile dabs-examples`

Repeat the command with `-t prod`.

7. Delete the example team group.

`databricks groups delete <group-id> --profile dabs-examples`
52 changes: 52 additions & 0 deletions knowledge_base/permissions_and_lifecycle/databricks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
bundle:
name: permissions_and_lifecycle

include:
- resources/*.yml

variables:
team_group:
description: Workspace group for your team
catalog_name:
description: Unity Catalog catalog containing the pipeline schema
schema_name:
description: Existing schema used by the pipeline

permissions:
- level: CAN_VIEW
group_name: users

targets:
dev:
default: true
mode: development
workspace:
root_path: /Workspace/bundle-examples/${bundle.name}/${bundle.target}/${workspace.current_user.short_name}
resources:
jobs:
permission_job:
permissions:
- level: CAN_MANAGE_RUN
group_name: ${var.team_group}
pipelines:
permission_pipeline:
permissions:
- level: CAN_RUN
group_name: ${var.team_group}

prod:
mode: production
workspace:
root_path: /Workspace/bundle-examples/${bundle.name}/${bundle.target}
resources:
jobs:
permission_job:
permissions:
- level: CAN_MANAGE
group_name: ${var.team_group}
pipelines:
permission_pipeline:
permissions:
- level: CAN_MANAGE
group_name: ${var.team_group}

34 changes: 34 additions & 0 deletions knowledge_base/permissions_and_lifecycle/resources/permissions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
resources:
jobs:
permission_job:
name: permissions lifecycle job
lifecycle:
prevent_destroy: false
permissions:
- level: CAN_MANAGE_RUN
group_name: ${var.team_group}
tasks:
- task_key: permission_check
spark_python_task:
python_file: ../src/main.py
environment_key: default
environments:
- environment_key: default
spec:
environment_version: "6"

pipelines:
permission_pipeline:
name: permissions lifecycle pipeline
lifecycle:
prevent_destroy: false
permissions:
- level: CAN_RUN
group_name: ${var.team_group}
serverless: true
catalog: ${var.catalog_name}
target: ${var.schema_name}_${bundle.target}
libraries:
- file:
path: ../src/pipeline.py

1 change: 1 addition & 0 deletions knowledge_base/permissions_and_lifecycle/src/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
print("Permissions and lifecycle example")
6 changes: 6 additions & 0 deletions knowledge_base/permissions_and_lifecycle/src/pipeline.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
from pyspark import pipelines as dp


@dp.materialized_view
def permission_example():
return spark.range(1)