Skip to content

Commit

Permalink
minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
renardeinside committed Jan 13, 2025
1 parent 69fd794 commit 5e91fda
Show file tree
Hide file tree
Showing 7 changed files with 71 additions and 71 deletions.
16 changes: 8 additions & 8 deletions docs/ucx/docs/installation/cross_workspace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Ask your Databricks Account admin to run the [`sync-workspace-info` command](#sy
workspace information with the UCX installations. Once the workspace information is synced, you can run the
[`create-table-mapping` command](#create-table-mapping-command) to align your tables with the Unity Catalog.

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


## `sync-workspace-info` command

Expand All @@ -37,7 +37,7 @@ If you cannot get account administrator privileges in reasonable time, you can t
run [`manual-workspace-info` command](#manual-workspace-info-command) to enter Databricks Workspace IDs and Databricks
Workspace names.

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


## `manual-workspace-info` command

Expand All @@ -61,7 +61,7 @@ run. It prompts the user to enter the required information manually and creates
useful for workspace administrators who are unable to use the `sync-workspace-info` command, because they are not
Databricks Account Administrators. It can also be used to manually create the workspace info in a new workspace.

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


## `create-account-groups` command

Expand All @@ -83,7 +83,7 @@ This command is useful for the setups, that don't have SCIM provisioning in plac

Once you're done with this command, proceed to the [group migration workflow](#group-migration-workflow).

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


## `validate-groups-membership` command

Expand All @@ -103,7 +103,7 @@ used to debug issues related to group membership. See [group migration](docs/loc

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

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


## `validate-table-locations` command

Expand Down Expand Up @@ -134,7 +134,7 @@ Considerations when resolving tables with overlapping locations are:
- Tags
- ACLs

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


## `cluster-remap` command

Expand All @@ -159,7 +159,7 @@ to revert the cluster remapping.

You can revert the cluster remapping using the [`revert-cluster-remap` command](#revert-cluster-remap-command).

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


## `revert-cluster-remap` command

Expand All @@ -176,7 +176,7 @@ its configuration from UC to original one.It will iterate through the list of cl
cluster configurations to original one.This will also ask the user to provide the list of clusters that has to be reverted as a prompt.
By default, it will revert all the clusters present in the backup folder

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


## `upload` command

Expand Down
10 changes: 5 additions & 5 deletions docs/ucx/docs/reference/commands/code_migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ After you're done with the [table migration](#Table-Migration), you can proceed
Once you're done with the code migration, you can run the [`cluster-remap` command](#cluster-remap-command) to remap the
clusters to be UC compatible.

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


## `lint-local-code` command

Expand All @@ -26,7 +26,7 @@ When run from an IDE terminal, this command generates output as follows:
![img.png](/img/lint-local-code-output.png)
With modern IDEs, clicking on the file link opens the file at the problematic line

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


## `migrate-local-code` command

Expand All @@ -39,7 +39,7 @@ migrate all python and SQL files in the current working directory. This command
at the moment only supports Python and SQL files and discards code comments and formatting during
the automated transformation process.

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


## `migrate-dbsql-dashboards` command

Expand All @@ -58,7 +58,7 @@ This command can be run with `--dashboard-id` flag to migrate a specific dashboa

This command is incremental and can be run multiple times to migrate new dashboards.

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


## `revert-dbsql-dashboards` command

Expand All @@ -71,4 +71,4 @@ databricks labs ucx revert-dbsql-dashboards [--dashboard-id <dashboard-id>]

This command can be run with `--dashboard-id` flag to migrate a specific dashboard.

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

6 changes: 3 additions & 3 deletions docs/ucx/docs/reference/commands/metastore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
These commands are used to assign a Unity Catalog metastore to a workspace. The metastore assignment is a pre-requisite
for any further migration steps.

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


## `show-all-metastores` command

Expand All @@ -15,7 +15,7 @@ This command lists all the metastores available to be assigned to a workspace. I
all the metastores available in the account. This command is useful when there are multiple metastores available within
a region, and you want to see which ones are available for assignment.

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


## `assign-metastore` command

Expand All @@ -27,7 +27,7 @@ This command assigns a metastore to a workspace with `--workspace-id`. If there
workspace region, the command automatically assigns that metastore to the workspace. If there are multiple metastores
available, the command prompts for specification of the metastore (id) you want to assign to the workspace.

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


## `create-ucx-catalog` command

Expand Down
38 changes: 19 additions & 19 deletions docs/ucx/docs/reference/commands/table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ using the [`skip` command](#skip-command).

Once you're done with the table migration, proceed to the [code migration](#code-migration-commands).

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


## `principal-prefix-access` command

Expand All @@ -42,7 +42,7 @@ Once you're done running this command, proceed to the [`migrate-credentials` com

The "prefix" refers to the start - i.e. prefix - of table locations that point to the cloud storage location.

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


### Access for AWS S3 Buckets

Expand All @@ -64,7 +64,7 @@ It has the following format:

Once done, proceed to the [`migrate-credentials` command](#migrate-credentials-command).

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


### Access for Azure Storage Accounts

Expand All @@ -82,7 +82,7 @@ will be skipped.

Once done, proceed to the [`migrate-credentials` command](#migrate-credentials-command).

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


## `create-missing-principals` command (AWS Only)
```bash
Expand All @@ -97,7 +97,7 @@ Two optional parameter are available for this command:
`--role-name` - This parameter is used to set the prefix for the role name. The default value is `UCX-ROLE`.
`--role-policy` - This parameter is used to set the prefix for the role policy name. The default value is `UCX-POLICY`.

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


## `delete-missing-principals` command (AWS Only)
```bash
Expand All @@ -107,7 +107,7 @@ This command helps to delete the IAM role created by UCX. It lists all the IAM R
command and allows user to select multiple roles to delete. It also checks if selected roles are mapped to any storage credentials
and asks for confirmation from user. Once confirmed, it deletes the role and its associated inline policy.

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


## `create-uber-principal` command

Expand All @@ -127,7 +127,7 @@ Azure Resource Manager APIs.

This command is one of prerequisites for the [table migration process](#table-migration).

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


## `migrate-credentials` command

Expand Down Expand Up @@ -157,7 +157,7 @@ Please review the file and delete the Instance Profiles you do not want to be mi

Once you're done with this command, run [`validate-external-locations` command](#validate-external-locations-command) after this one.

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


## `validate-external-locations` command

Expand All @@ -172,7 +172,7 @@ This command validates and provides mapping to external tables to external locat

Once you're done with this command, proceed to the [`migrate-locations` command](#migrate-locations-command).

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


## `migrate-locations` command

Expand All @@ -195,7 +195,7 @@ or SQL warehouse

Once you're done with this command, proceed to the [`create-table-mapping` command](#create-table-mapping-command).

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


## `create-table-mapping` command

Expand Down Expand Up @@ -230,7 +230,7 @@ This command is one of prerequisites for the [table migration process](#Table-Mi

Once you're done with table migration, proceed to the [code migration](#code-migration-commands).

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


## `skip` command

Expand All @@ -247,7 +247,7 @@ only be used exclusively. This command is useful to temporarily disable migratio

Once you're done with table migration, proceed to the [code migration](#code-migration-commands).

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


## `unskip` command

Expand All @@ -257,7 +257,7 @@ databricks labs ucx unskip --schema X [--table Y] [--view Z]

This command removes the mark set by the [`skip` command](#skip-command) on the given schema, table or view.

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


## `create-catalogs-schemas` command

Expand All @@ -274,7 +274,7 @@ the schema and catalog if at least one such table is migrated to it.
For AWS, it checks any instance profiles mapped to the interactive cluster or sql warehouse. It checks the mapping of instance profiles
to the bucket. It then maps the bucket to the tables which has external location on those bucket created and grants `USAGE` access to
the schema and catalog if at least one such table is migrated to it.
[[back to top](#databricks-labs-ucx)]


## `assign-owner-group` command

Expand All @@ -288,7 +288,7 @@ The principal running the command and later, the migration workflows, is require
The command will list all the groups the principal is a member of and allow the selection of the owner group.
It sets the default_owner_group property in the config.yml file.

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


## `migrate-tables` command

Expand All @@ -310,7 +310,7 @@ For AWS, it checks any instance profiles mapped to the interactive cluster or sq
to the bucket. It then maps the bucket to the tables which has external location on those bucket created and grants either `SELECT` permission if
the instance profile only has read access on the bucket and `ALL_PRIVILEGES` if the instance profile has write access on the bucket.

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


## `revert-migrated-tables` command

Expand All @@ -326,7 +326,7 @@ to debug issues related to table migration.

Go back to the [`create-table-mapping` command](#create-table-mapping-command) after you're done with this command.

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


## `move` command

Expand All @@ -348,7 +348,7 @@ This is due to Unity Catalog not supporting multiple tables with overlapping pat

This command supports moving multiple tables at once, by specifying `*` as the table name.

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


## `alias` command

Expand All @@ -361,4 +361,4 @@ It takes a `WorkspaceClient` object and `from` and `to` parameters as parameters
the `TableMove` class. This command is useful for developers and administrators who want to create an alias for a table.
It can also be used to debug issues related to table aliasing.

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

16 changes: 8 additions & 8 deletions docs/ucx/docs/reference/common_challenges.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Common Challenges and the Solutions
Users might encounter some challenges while installing and executing UCX. Please find the listing of some common challenges and the solutions below.

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


### Network Connectivity Issues

Expand Down Expand Up @@ -69,7 +69,7 @@ ssl.SSLCertVerificationError: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verif
[to force requests library to set verify=False](https://github.com/psf/requests/blob/8c211a96cdbe9fe320d63d9e1ae15c5c07e179f8/requests/sessions.py#L718)
as well as set `SSL_CERT_DIR` env var pointing to the proxy CA cert for the urllib3 library.

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


### Insufficient Privileges

Expand Down Expand Up @@ -111,7 +111,7 @@ Admin privileges required for commands:
| [<u>sync-workspace-info</u>](#sync-workspace-info-command) | Account Admin |
| [<u>manual-workspace-info</u>](#manual-workspace-info-command) | Workspace Admin |

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


### Version Issues

Expand Down Expand Up @@ -140,7 +140,7 @@ specific version of UCX, you can do it using the command
`databricks labs install ucx@\<version\>`, for example,
`databricks labs install [email protected]`.

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


### Authentication Issues

Expand All @@ -165,7 +165,7 @@ authentication</u>](https://docs.databricks.com/en/dev-tools/cli/authentication.
[<u>Basic authentication
(legacy)</u>](https://docs.databricks.com/en/dev-tools/cli/authentication.html#basic-auth).

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


### Multiple Profiles in Databricks CLI

Expand All @@ -189,7 +189,7 @@ profile: `databricks labs install ucx -p prod`.
**Solution:** The installation command `databricks labs install ucx`
will provide an option to select one account profile.

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


### Workspace has an external Hive Metastore (HMS)

Expand Down Expand Up @@ -219,7 +219,7 @@ admin settings do not have the configurations already set. For example,
add *spark.hadoop.javax.jdo.option.ConnectionURL \<connectionstring\>*
under Data Access Configuration of SQL Warehouse Admin Settings.

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


### Verify the Installation

Expand All @@ -236,4 +236,4 @@ successfully, the installation can be verified with the following steps:
external HMS, verify from the results that the assessment has
analyzed the external HMS tables.

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

Loading

0 comments on commit 5e91fda

Please sign in to comment.