Skip to content

Commit

Permalink
Add section with installing UCX using PYPI hosted mirror
Browse files Browse the repository at this point in the history
  • Loading branch information
JCZuurmond committed Sep 19, 2024
1 parent 262b51a commit d77d9d1
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
* [Install UCX](#install-ucx)
* [[ADVANCED] Force install over existing UCX](#advanced-force-install-over-existing-ucx)
* [[ADVANCED] Installing UCX on all workspaces within a Databricks account](#advanced-installing-ucx-on-all-workspaces-within-a-databricks-account)
* [[ADVANCED] Installing UCX with company hosted PYPI mirror](#advanced-installing-ucx-with-company-hosted-pypi-mirror)
* [Upgrading UCX for newer versions](#upgrading-ucx-for-newer-versions)
* [Uninstall UCX](#uninstall-ucx)
* [Migration process](#migration-process)
Expand Down Expand Up @@ -252,6 +253,21 @@ This installation mode will automatically select the following options:

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

## [ADVANCED] Installing UCX with company hosted PYPI mirror

Some enterprise block the public PYPI index and host a company controlled PYPI mirror. To install UCX while using a
company hosted PYPI mirror for finding its dependencies, add all UCX dependencies to the company hosted PYPI mirror (see
"dependencies" in [`pyproject.toml`](./pyproject.toml)) and set the environment variable `PIP_INDEX_URL` to the company
hosted PYPI mirror URL while installing UCX:

```commandline
PIP_INDEX_URL="https://url-to-company-hosted-pypi.internal" databricks labs install ucx.
```

During installation reply *yes* to the question "Does the given workspace block internet access"?

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

## Upgrading UCX for newer versions

Verify that UCX is installed
Expand Down

0 comments on commit d77d9d1

Please sign in to comment.