Skip to content

Commit 81bfc62

Browse files
authored
Adds requirement for matching account groups to be created before assessment to the docs (#4017)
## Changes Account groups need to exist before assessment so that the crawl_groups in the assessment finds and matches them to populate the groups table. ### Linked issues Resolves #3451 ### Functionality - [x] added relevant user documentation
1 parent e60ba30 commit 81bfc62

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

docs/ucx/docs/reference/workflows/index.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,21 @@ steps of the [migration process](/docs/process). You can view the status of depl
1212
The assessment workflow can be triggered using the Databricks UI or via the
1313
[`ensure-assessment-run` command](/docs/reference/commands#ensure-assessment-run).
1414

15+
> Account groups matching workspace local groups in which UCX is installed need to exist before running assessment.
16+
17+
The account groups can be created in one of three ways:
18+
1. Manually created using the "Account Console".
19+
2. Using SCIM or other service utilizing the Account API.
20+
3. Using the [`create-account-groups` command](/docs/reference/commands#create-account-groups) command.
21+
1522
The assessment workflow retrieves - or *crawls* - details of [workspace assets](https://docs.databricks.com/en/workspace/workspace-assets.html)
1623
and [securable objects in the Hive metastore](https://docs.databricks.com/en/data-governance/table-acls/object-privileges.html#securable-objects-in-the-hive-metastore)
1724
relevant for upgrading to UC to assess the compatibility with UC. The `crawl_` tasks retrieve assess and objects. The
1825
`assess_` tasks assess the compatibility with UC. The output of each task is stored in the
1926
[inventory database](/docs/installation#installation-resources) so that it can be used for further analysis and decision-making through
2027
the [assessment report](/docs/reference/assessment).
2128

29+
2230
1. `crawl_tables`: This task retrieves table definitions from the Hive metastore and persists the definitions in
2331
the `tables` table. The definitions include information such as:
2432
- Database/schema name
@@ -106,7 +114,7 @@ to manage groups from a single place: your Databricks account. We expect UCX use
106114
centrally while most other Databricks resources that UCX touches are scoped to a single workspace.
107115
For extra confidence, run [`validate-groups-membership` command](/docs/reference/commands#validate-groups-membership) before running the
108116
group migration. If you do not have account groups matching groups in the workspace in which UCX is installed, you can
109-
run [`create-account-groups` command](/docs/reference/commands#create-account-groups) before running the group migration workflow.
117+
run [`create-account-groups` command](/docs/reference/commands#create-account-groups) before running the assessment and group migration workflow.
110118

111119
The group migration workflow is designed to migrate workspace-local groups to account-level groups. It verifies if
112120
the necessary groups are available to the workspace with the correct permissions, and removes unnecessary groups and

0 commit comments

Comments
 (0)