Skip to content

Commit b19c33a

Browse files
authored
Extend code migration progress documentation (#3588)
<!-- REMOVE IRRELEVANT COMMENTS BEFORE CREATING A PULL REQUEST --> ## Changes Extend code migration progress documentation by detailing: - Start with linting then do the migration - Use dashboards - Use local commands - Reference default catalog resource - Add section for finalising the migration ### Linked issues Resolves #2231 ### Functionality - [ ] added relevant user documentation
1 parent 37e300b commit b19c33a

File tree

2 files changed

+25
-93
lines changed

2 files changed

+25
-93
lines changed

docs/ucx/docs/process/index.mdx

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ On a high level, the steps in migration process are:
99
2. [group migration](/docs/reference/workflows#group-migration-workflow)
1010
3. [table migration](/docs/process/#table-migration-process)
1111
4. [data reconciliation](/docs/reference/workflows#post-migration-data-reconciliation-workflow)
12-
5. [code migration](/docs/reference/commands#code-migration-commands)
12+
5. [code migration](#code-migration)
13+
6. [final details](#final-details)
1314

1415
The migration process can be schematic visualized as:
1516

@@ -287,4 +288,26 @@ databricks labs ucx revert-migrated-tables --schema X --table Y [--delete-manage
287288
The [`revert-migrated-tables` command](/docs/reference/commands#revert-migrated-tables) drops the Unity Catalog table or view and reset
288289
the `upgraded_to` property on the source object. Use this command to allow for migrating a table or view again.
289290

291+
## Code Migration
290292

293+
After you're done with the [table migration](#table-migration-process) and
294+
[data reconciliation](/docs/reference/workflows#post-migration-data-reconciliation-workflow), you can proceed with code
295+
migration.
296+
297+
Before migrating code, use the linter to investigate what should be changed to become Unity Catalog compatible:
298+
- The `assessment` and `migration-progress` [dashboards](/docs/reference/dashboards) show details on
299+
linted workspace resources.
300+
- [`lint-local-code` command](/docs/reference/commands#lint-local-code) lints code on your local file system.
301+
302+
The [linter advices show codes and messages](/docs/reference/linter_codes) on the detected compatability issues and how
303+
to resolve them.
304+
305+
After investigating the code linter advices, code can be migrated. We recommend to:
306+
- Use the [`migration-progress` dashboard](/docs/reference/dashboards) to prioritize and track resource migration.
307+
- Use the [`migrate-` commands`](/docs/reference/commands#code-migration-commands) to migrate resources.
308+
- Set the [default catalog](https://docs.databricks.com/en/catalogs/default.html) to Unity Catalog.
309+
310+
## Final details
311+
312+
Once you're done with the [code migration](#code-migration), you can run the:
313+
- [`cluster-remap` command](/docs/reference/commands#cluster-remap) to remap the clusters to be UC compatible.

0 commit comments

Comments
 (0)