Skip to content

Commit bb0c232

Browse files
authored
[DOCS] Explain when to run remove-workspace-local-backup-groups workflow (#3707)
## Changes Explain when to run `remove-workspace-local-backup-groups` workflow as the documentation was not clear about this. ### Functionality - [x] added relevant user documentation
1 parent c9da729 commit bb0c232

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

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

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Workflows
22

3-
Part of this application is deployed as [Databricks Workflows](https://docs.databricks.com/en/workflows/index.html).
4-
You can view the status of deployed workflows via the [`workflows` command](/docs/reference/commands#workflows).
5-
Failed workflows can be fixed with the [`repair-run` command](/docs/reference/commands#repair-run).
6-
7-
3+
Part of UCX is deployed as [Databricks workflows](https://docs.databricks.com/en/workflows/index.html) to orchestrate
4+
steps of the [migration process](/docs/reference/process). You can view the status of deployed workflows through the
5+
[`workflows` command](/docs/reference/commands#workflows) and rerun failed workflows with the
6+
[`repair-run` command](/docs/reference/commands#repair-run).
87

98
## Assessment workflow
109

@@ -94,8 +93,6 @@ The UCX assessment workflow is designed to only run once, re-running will **not*
9493
inventory and findings for a workspace need to be updated then first reinstall UCX by [uninstalling](/docs/installation#uninstall-ucx)
9594
and [installing](/docs/installation) it again.
9695

97-
98-
9996
## Group migration workflow
10097

10198
> You are required to complete the [assessment workflow](/docs/reference/workflows#assessment-workflow) before starting the group migration workflow.
@@ -149,18 +146,22 @@ executed after a successful run of the assessment workflow. The group migration
149146
destination groups.
150147

151148
After successfully running the group migration workflow:
152-
1. Run the [`remove-workspace-local-backup-grups`](/docs/reference/commands#validate-groups-membership) to remove workspace-level backup
153-
groups, along with their permissions. This should only be executed after confirming that the workspace-local
154-
migration worked successfully for all the groups involved. This step is necessary to clean up the workspace and
155-
remove any unnecessary groups and permissions.
149+
1. [Remove workspace-level backup groups](#remove-workspace-local-backup-groups) along with their
150+
permissions.
156151
2. Proceed to the [table migration process](/docs/process#table-migration-process).
157152

158153
For additional information see:
159154
- The [detailed design](/docs/reference/local-group-migration) of thie group migration workflow.
160155
- The [migration process diagram](/docs/process) showing the group migration workflow in context of the whole
161156
migration process.
162157

158+
### Remove workspace local backup groups
163159

160+
> Run this workflow only **after** the [group migration workflow](#group-migration-workflow)
161+
162+
The `remove-workspace-local-backup-groups` removes the now renamed and redundant workspace-local groups along with their
163+
permissions. Run this workflow after confirming that the group migration is successful for all the groups involved.
164+
Running this workflow is optional but recommended to keep the workspace clean.
164165

165166
## Table migration workflows
166167

@@ -239,9 +240,6 @@ The output is processed and displayed in the migration dashboard using the in `r
239240
- run the [`create-table-mapping` command](/docs/reference/commands#create-table-mapping)
240241
- or manually create a `mapping.csv` file in Workspace -> Applications -> ucx
241242

242-
243-
244-
245243
## [EXPERIMENTAL] Migration Progress Workflow
246244

247245
The `migration-progress-experimental` workflow populates the tables visualized in the

0 commit comments

Comments
 (0)