Skip to content

Commit e10db99

Browse files
authored
Document to run validate-groups-membership before groups migration, not after (#3631)
## Changes Document to run `validate-groups-membership` before groups migration, not after, as this is the correct order. ### Linked issues Resolves #3506
1 parent 8ce175f commit e10db99

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/ucx/docs/reference/commands/index.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,9 @@ Workspace Group Name Members Count Account Group Name Members Count Differen
159159

160160
This command validates the groups to see if the groups at the account level and workspace level have different membership.
161161
This command is useful for administrators who want to ensure that the groups have the correct membership. It can also be
162-
used to debug issues related to group membership. See [group migration](docs/reference/local-group-migration.md) and
163-
[group migration](/docs/reference/workflows#group-migration-workflow) for more details.
162+
used to debug issues related to group membership. See
163+
[group migration](/docs/reference/workflows#group-migration-workflow) and
164+
[group migration](docs/reference/local-group-migration.md) for more details.
164165

165166
Valid group membership is important to ensure users has correct access after legacy table ACL is migrated in [table migration process](/docs/process/#table-migration-process)
166167

@@ -282,7 +283,7 @@ are eligible to be run as a collection. User can run the below commands as colle
282283
- `migrate-tables`
283284
- `migrate-acls`
284285
- `migrate-dbsql-dashboards`
285-
- `validate-group-membership`
286+
- `validate-groups-membership`
286287
Ex: `databricks labs ucx ensure-assessment-run --run-as-collection=True`
287288

288289
## Metastore related commands

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,8 @@ A Databricks admin [assigns account groups to workspaces](https://docs.databrick
107107
using [identity federation](https://docs.databricks.com/en/admin/users-groups/index.html#enable-identity-federation)
108108
to manage groups from a single place: your Databricks account. We expect UCX users to create account groups
109109
centrally while most other Databricks resources that UCX touches are scoped to a single workspace.
110-
If you do not have account groups matching the workspace in which UCX is installed, please
110+
For extra confidence, run [`validate-groups-membership` command](#validate-groups-membership-command) before running the
111+
group migration. If you do not have account groups matching groups in the workspace in which UCX is installed, you can
111112
run [`create-account-groups` command](/docs/reference/commands#create-account-groups) before running the group migration workflow.
112113

113114
The group migration workflow is designed to migrate workspace-local groups to account-level groups. It verifies if
@@ -148,13 +149,11 @@ executed after a successful run of the assessment workflow. The group migration
148149
destination groups.
149150

150151
After successfully running the group migration workflow:
151-
1. Use [`validate-groups-membership` command](/docs/reference/commands#validate-groups-membership) for extra confidence the newly created
152-
account level groups are considered to be valid.
153-
2. Run the [`remove-workspace-local-backup-grups`](/docs/reference/commands#validate-groups-membership) to remove workspace-level backup
152+
1. Run the [`remove-workspace-local-backup-grups`](/docs/reference/commands#validate-groups-membership) to remove workspace-level backup
154153
groups, along with their permissions. This should only be executed after confirming that the workspace-local
155154
migration worked successfully for all the groups involved. This step is necessary to clean up the workspace and
156155
remove any unnecessary groups and permissions.
157-
3. Proceed to the [table migration process](/docs/process#table-migration-process).
156+
2. Proceed to the [table migration process](/docs/process#table-migration-process).
158157

159158
For additional information see:
160159
- The [detailed design](/docs/reference/local-group-migration) of thie group migration workflow.

src/databricks/labs/ucx/queries/assessment/estimates/01_0_group_migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Follow those steps in order to successfully migrate your groups to the account:
1212

1313
If you're not using an Identity Provider (Okta, Azure Entra etc...):
1414
1. Create the groups at the account level, consider using the [create-account-groups](https://github.com/databrickslabs/ucx/blob/main/README.md#create-account-groups-command) command.
15-
1. For extra safety, consider running [validate-group-membership](https://github.com/databrickslabs/ucx/blob/main/README.md#validate-groups-membership-command) command to validate that you have the same amount of groups/users in the workspace and the account
15+
1. For extra safety, consider running [validate-groups-membership](https://github.com/databrickslabs/ucx/blob/main/README.md#validate-groups-membership-command) command to validate that you have the same amount of groups/users in the workspace and the account
1616
2. Enable SCIM at the Account level.
1717

1818
If you're using an Identity Provider:
1919
1. Enable SCIM at the account level
2020
2. Disable SCIM at the workspace level if not done already.
2121
3. Trigger a sync from your IdP to the account
22-
1. To validate that all groups are properly setup for the group migration, run [validate-group-membership](https://github.com/databrickslabs/ucx/blob/main/README.md#validate-groups-membership-command)
22+
1. To validate that all groups are properly setup for the group migration, run [validate-groups-membership](https://github.com/databrickslabs/ucx/blob/main/README.md#validate-groups-membership-command)
2323

2424
Once the account groups are setup, perform the group migration by using the Group migration workflow, more information in the [docs](https://github.com/databrickslabs/ucx/blob/main/README.md#group-migration-workflow)

0 commit comments

Comments
 (0)