Skip to content

Commit 3280e85

Browse files
committed
Explain workflow runs in the README
1 parent ec2aada commit 3280e85

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
8080
* [`table-migrated-to-uc`](#table-migrated-to-uc)
8181
* [`to-json-in-shared-clusters`](#to-json-in-shared-clusters)
8282
* [`unsupported-magic-line`](#unsupported-magic-line)
83+
* [(EXPERIMENTAL) Migration Progress Workflow](#experimental-migration-progress-workflow)
8384
* [Utility commands](#utility-commands)
8485
* [`logs` command](#logs-command)
8586
* [`ensure-assessment-run` command](#ensure-assessment-run-command)
@@ -126,7 +127,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
126127
* [`revert-cluster-remap` command](#revert-cluster-remap-command)
127128
* [`upload` command](#upload-command)
128129
* [`download` command](#download-command)
129-
* [`join-collection` command](#join-collection command)
130+
* [`join-collection` command](#join-collection-command)
130131
* [collection eligible command](#collection-eligible-command)
131132
* [Common Challenges and the Solutions](#common-challenges-and-the-solutions)
132133
* [Network Connectivity Issues](#network-connectivity-issues)
@@ -994,6 +995,19 @@ This message indicates the code that could not be analysed by UCX. User must che
994995

995996
[[back to top](#databricks-labs-ucx)]
996997

998+
## [EXPERIMENTAL] Migration Progress Workflow
999+
1000+
The `migration-process-experimental` workflow updates a subset of the inventory tables to track migration status of
1001+
workspace resources that need to be migrated. Besides updating the inventory tables, this workflow tracks the migration
1002+
progress by updating the following [UCX catalog](#create-ucx-catalog-command) tables:
1003+
1004+
- `workflow_runs`: Tracks the status of the workflow runs.
1005+
1006+
_Note: A subset of the inventory is updated, *not* the complete inventory that is initially gathered by
1007+
the [assessment workflow](#assessment-workflow)._
1008+
1009+
[[back to top](#databricks-labs-ucx)]
1010+
9971011
# Utility commands
9981012

9991013
## `logs` command
@@ -1029,13 +1043,10 @@ listed with the [`workflows` command](#workflows-command).
10291043
databricks labs ucx update-migration-progress
10301044
```
10311045

1032-
This command updates a subset of the inventory tables that are used to track workspace resources that need to be
1033-
migrated. It does this by triggering the `migration-process-experimental` workflow to run on a workspace and waiting for
1034-
it to complete. This can be used to ensure that dashboards and associated reporting are updated to reflect the current
1035-
state of the workspace.
1036-
1037-
_Note: Only a subset of the inventory is updated, *not* the complete inventory that is initially gathered by
1038-
the [assessment workflow](#assessment-workflow)._
1046+
This command runs the [(experimental) migration progress workflow](#experimental-migration-progress-workflow) to update
1047+
the migration status of worksapce resources that need to be migrated. It does this by triggering
1048+
the `migration-process-experimental` workflow to run on a workspace and waiting for
1049+
it to complete.
10391050

10401051
Workflows and their status can be listed with the [`workflows` command](#workflows-commandr), while failed workflows can
10411052
be fixed with the [`repair-run` command](#repair-run-command).

0 commit comments

Comments
 (0)