Configuring an external Docker registry

Important:

Automation Suite can currently connect only with a Docker registry that is signed by a public certificate (for example, a public certificate provided by cloud providers such as ACR, ECR, etc.). We are still working on providing support for Docker registry signed by a private authority host.

You can opt for an external Docker registry only in new installations of Automation Suite. Migrating from the internal Docker registry to an external Docker registry is currently not supported.

Glossary

OCI compliant registry - A registry implementation that meets the Open Container Initiative specifications. Formerly known as “Docker registry.” There are some widely used implementations, such as Azure Container Registry from Azure and Elastic Container Registry from AWS. In addition, there are self-hosted options such as the former container registry, now found under the Distributions repository.

Artifact - Under the OCI definitions, any image manifest or helm chart manifest hosted in an OCI compliant registry.

Prerequisites for offline installations

• Docker and Helm
• as-images.txt
• as-helm-charts.txt
• mirror-registry.sh

Installing Docker and Helm

You must ensure that you have Docker and Helm installed on the machine from where you plan to upload the Automation Suite container images and Helm charts to your external Docker registry.

• To download the Docker binaries, see the official documentation.
• To download the Helm binaries, see the official documentation.
• To authenticate to the Docker registry, see the official documentation. Alternatively, you can use the following commands by replacing the sample credentials with your actual registry credentials:

  docker login my.registry.io:443 --username "admin" --password "secret"

Downloading as-images.txt

To download as-images.txt, see Downloading installation bundles.

Downloading as-helm-charts.txt

To download as-helm-charts.txt, see Downloading installation bundles.

Downloading mirror-registry.sh

To download the mirror-registry.sh script, see Downloading the installation packages.

Uploading the Automation Suite images to the Docker registry

The mirror-registry.sh script requires outbound connectivity to the source (default registry.uipath.com) and target registries.

Command line argument	Environment variable	Description
--images-manifest	IMAGES_MANIFEST	(Optional) Path to images manifest file.
--helm-charts-manifest	HELM_CHARTS_MANIFEST	(Optional) Path to charts manifest file.
--target-registry-url	TARGET_REGISTRY_URL	(Mandatory) Pass the URL for the target registry.
--source-registry-url	SOURCE_REGISTRY_URL	(Optional) pass the URL for the source registry; default to registry.uipath.com.

# command line flags style
./mirror-registry.sh --target-registry-url my.registry.io:443 --source-registry-url registry.uipath.com --images-manifest /home/myuser/as-images.txt --helm-charts-manifest /home/myuser/as-helm-charts.txt

Uploading the Computer Vision images to the external Docker registry

Note:

These steps are needed only if you use Computer Vision. You can perform these steps at any point in time before using the product.

To upload the optional Computer Vision images to your external Docker registry, take the following steps:

1. Pull the desired Computer Vision image from the UiPath registry hosted on registry.uipath.com:

   docker pull <uipath_registry_server>/<image_name>

   Example: The UiPath registry server is registry.uipath.com; if the image name for Computer Vision is aicenter/cv2304:23.4.5.6, run:

   docker pull registry.uipath.com/aicenter/cv2304:23.4.5.6

2. Rename the image host as per your Docker registry name.

   docker tag <uipath_registry_server>/<image_name> <your_registry_server>/<image_name>

   Example: If your registry name is registory.mycompany.com, run:

   docker tag registry.uipath.com/aicenter/cv2304:23.4.5.6 registory.mycompany.com/aicenter/cv2304:23.4.5.6

3. Push the image to your external Docker registry.

   docker push <your_registry_server>/<image_name>

   Example:

   docker push registory.mycompany.com/aicenter/cv2304:23.4.5.6

The following images are available for the Computer Vision Models:

• aicenter/python36cv:v21.10.0-2
• aicenter/python36cvv3:23.4.0-rc19
• aicenter/cv2304:23.4.5.6

Uploading the Document Understanding images to the external Docker Registry

Note:

These steps are needed only if you use Document Understanding. You can perform these steps at any point in time before using the product.

To upload the optional Document Understanding images to your external Docker registry, take the steps in the Document Understanding documentation.