Skip to content

Commit ce539ab

Browse files
committed
Update cli and docs
1 parent 027e55e commit ce539ab

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -731,13 +731,14 @@ are displayed. To display `DEBUG` logs, use the `--debug` flag.
731731
### `ensure-assessment-run`
732732

733733
```commandline
734-
databricks labs ucx ensure-assessment-run
734+
databricks labs ucx ensure-assessment-run [--force-refresh true/false]
735735
```
736736

737737
This command ensures that the [assessment workflow](/docs/reference/workflows#assessment-workflow) was run on a workspace.
738738
This command will block until job finishes.
739739
Failed workflows can be fixed with the [`repair-run` command](/docs/reference/commands#repair-run). Workflows and their status can be
740740
listed with the [`workflows` command](/docs/reference/commands#workflows).
741+
The `--force-refresh` flag can be used to force the assessment workflow to run again overwriting the previous assessment results, even if it was already run before.
741742

742743
### `update-migration-progress`
743744

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ Proceed to the [group migration workflow](/docs/reference/workflows#group-migrat
100100

101101
> ⚠️ Caution: To fully refresh the UCX assessment workflow and overwrite existing results, set the force_refresh parameter to true (or True).
102102
For large workspaces, this process can be time-consuming and resource-intensive. Only use this option if a complete reassessment is absolutely necessary.
103+
Alternatively, you can re run assessment using the [command](/docs/reference/commands#ensure-assessment-run) with the `force-refresh` parameter set to `true` to overwrite existing results.
103104

104105
## Group migration workflow
105106

labs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ commands:
8787
- name: run-as-collection
8888
description: (Optional) Whether to check (and run if necessary) the assessment for the collection of workspaces
8989
with ucx installed. Default is false.
90-
- name: force_refresh
90+
- name: force-refresh
9191
description: (Optional) Force a full refresh of the assessment job, even if it was run recently.
9292
Default is false.
9393

0 commit comments

Comments
 (0)