Skip to content

Commit 13be222

Browse files
authored
Added missing documentation for create-uber-principal command (#1015)
1 parent 98f9571 commit 13be222

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
2020
* [Install UCX](#install-ucx)
2121
* [Upgrading UCX for newer versions](#upgrading-ucx-for-newer-versions)
2222
* [Uninstall UCX](#uninstall-ucx)
23+
* [Migration process](#migration-process)
2324
* [Workflows](#workflows)
2425
* [Readme notebook](#readme-notebook)
2526
* [Assessment workflow](#assessment-workflow)
@@ -36,6 +37,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
3637
* [`principal-prefix-access` command](#principal-prefix-access-command)
3738
* [Access for AWS S3 Buckets](#access-for-aws-s3-buckets)
3839
* [Access for Azure Storage Accounts](#access-for-azure-storage-accounts)
40+
* [`create-uber-principal` command](#create-uber-principal-command)
3941
* [`migrate-credentials` command](#migrate-credentials-command)
4042
* [`validate-external-locations` command](#validate-external-locations-command)
4143
* [`create-table-mapping` command](#create-table-mapping-command)
@@ -160,6 +162,41 @@ Databricks CLI will confirm a few options:
160162

161163
[[back to top](#databricks-labs-ucx)]
162164

165+
# Migration process
166+
167+
On the high level, the steps in migration process can be described as:
168+
169+
```mermaid
170+
flowchart TD
171+
subgraph workspace-admin
172+
assessment --> group-migration
173+
group-migration --> table-migration
174+
table-migration --> code-migration
175+
assessment --> create-table-mapping
176+
create-table-mapping --> table-migration
177+
create-table-mapping --> code-migration
178+
validate-external-locations --> table-migration
179+
table-migration --> revert-migrated-tables
180+
revert-migrated-tables --> table-migration
181+
end
182+
subgraph account-admin
183+
create-account-groups --> group-migration
184+
sync-workspace-info --> create-table-mapping
185+
group-migration --> validate-groups-membership
186+
end
187+
subgraph iam-admin
188+
setup-account-scim --> create-account-groups
189+
assessment --> create-uber-principal
190+
create-uber-principal --> table-migration
191+
assessment --> principal-prefix-access
192+
principal-prefix-access --> migrate-credentials
193+
migrate-credentials --> validate-external-locations
194+
setup-account-scim
195+
end
196+
```
197+
198+
[[back to top](#databricks-labs-ucx)]
199+
163200
# Workflows
164201

165202
Part of this application is deployed as [Databricks Workflows](https://docs.databricks.com/en/workflows/index.html).
@@ -402,6 +439,18 @@ on each storage account. This requires Azure CLI to be installed and configured
402439

403440
[[back to top](#databricks-labs-ucx)]
404441

442+
## `create-uber-principal` command
443+
444+
```text
445+
databricks labs ucx create-uber-principal [--subscription-id X]
446+
```
447+
448+
**Requires Cloud IAM admin privileges.** Once the [`assessment` workflow](#assessment-workflow) complete, you should run
449+
this command to creates a service principal with the _**read-only access to all storage**_ used by tables in this
450+
workspace and configure the [UCX Cluster Policy](#installation) with the details of it. Once migration is complete, this
451+
service principal should be unprovisioned. On Azure, it creates a principal with `Storage Blob Data Reader` role
452+
assignment on every storage account using Azure Resource Manager APIs.
453+
405454
## `migrate-credentials` command
406455

407456
```commandline

labs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ commands:
122122
{{range .}}{{.wf_group_name}}\t{{.wf_group_members_count}}\t{{.acc_group_name}}\t{{.acc_group_members_count}}\t{{.group_members_difference}}
123123
{{end}}
124124
125-
- name: migrate_credentials
125+
- name: migrate-credentials
126126
description: Migrate credentials for storage access to UC storage credential
127127

128128
- name: create-account-groups

0 commit comments

Comments
 (0)