Use your organization's container registry

When using your organization's container registry with ArcGIS Enterprise on Kubernetes, you must prepare it with the Esri container images prior to new deployments, updates, or upgrades. To do so, you must use offline tools that are included with the software to download Esri's docker hub images and upload them to your organization's container registry. Steps to use offline tools for new deployments, updates, and upgrades are provided.

Note:

If your organization requires you to use a separate client workstation to download Esri's docker hub images and manifest file and subsequently upload them to your organization's registry, you will need to repeat steps to download and extract the deployment scripts on each client workstation and copy the downloaded images and manifest from one machine to the other.

Prepare for a new deployment

If you are preparing to deploy ArcGIS Enterprise on Kubernetes in a new environment, complete the following steps:

1. From My Esri, obtain the software version of ArcGIS Enterprise on Kubernetes that you intend to deploy.
2. Download and extract the deployment scripts to your client machine.
3. Refer to the release notes to identify the corresponding version tag for the software release you intend to deploy.
4. Use the image-download.sh script to download the container images to your client machine.
5. Use the image-upload.sh script to upload container images into your organization's container registry.
6. Run the deployment script to deploy ArcGIS Enterprise on Kubernetes.

Prepare for an update

By default, when applying a software update in ArcGIS Enterprise on Kubernetes, the update will automatically apply all preceding updates to ensure all cumulative fixes are included. To apply an update using your organization's container registry, you must host all available container image tags for any previous updates in addition to the targeted update in your registry. To do so, complete the following steps:

1. From My Esri, obtain the deployment scripts for the same version of ArcGIS Enterprise on Kubernetes that your organization is currently using.
2. Refer to the release notes to identify the corresponding version tags for all available software updates for the version of the software your organization is currently using.
3. Use the image-download.sh script to download the container images to your client machine. You will need to run the script for each version tag and corresponding software update that is available.
4. Use the image-upload.sh script to upload all container images into your organization's container registry.
5. If your organization is in a disconnected environment or if you are managing updates with an imported manifest file, complete steps to download and import the offline manifest to your organization.
   1. Use the create-offline-manifest script to download the corresponding version manifest file into your organization.
   2. Use the create-offline-manifest script to import the corresponding version manifest file into your organization.
6. Follow steps to apply an update in your organization.

Prepare for an upgrade

In order to apply an upgrade using your organization's container registry, you must download and import images tagged for all updates at the current version of your organization. Subsequently, you must download and upload images tagged for the release upgrade and any available updates for the version you are upgrading to. To do so, complete the following steps:

Note:

As part of the upgrade process, if there is an update available for that software version, it will be applied to the upgraded organization. If those update images are not found in the organization's registry, the update will fail, but the organization will remain at the upgraded release.

1. Ensure your organization is up-to-date with all available updates for your current version before applying an upgrade. If your organization isn't up-to-date, follow steps to prepare for an update.
2. If your organization is in a disconnected environment or if you are managing updates with an imported manifest file, complete steps to download and import the offline manifest to your organization. When doing so, you must use deployment scripts for the same version of ArcGIS Enterprise on Kubernetes that your organization is currently using.
   1. Use the create-offline-manifest script to download the corresponding version manifest file into your organization.
   2. Use the create-offline-manifest script to import the corresponding version manifest file into your organization.
3. From My Esri, obtain the version of ArcGIS Enterprise on Kubernetes deployment scripts that you intend to upgrade to. You will use the offline tools in this software package to conduct upgrade steps.
4. Refer to the release notes to identify the corresponding version tags for all of the following:
   1. The software release that you intend to upgrade to
   2. All available updates for the software release that you intend to upgrade to
5. Use the image-download.sh script to download the container images to your client machine.
6. Use the image-upload.sh script to upload all container images into your organization's container registry.
7. Follow steps to apply an upgrade in your organization.