Skip to main content

Using the InterSystems Container Registry

Many InterSystems products, including InterSystems IRIS®, can be deployed in containers. This document describes the container images provided by InterSystems, and explains how to obtain them from the InterSystems Container Registry (ICR).

Container Images Available from InterSystems

The following sections list the public and limited access images available from the ICR, which is located at https://containers.intersystems.com/. The full identifier, including registry, repository, name, and tag is provided for each image so you can copy it and paste it into your command or file.

Public Images

The following ICR images can be pulled without authentication.

InterSystems IRIS Community Edition

2020.3 containers.intersystems.com/intersystems/iris-community:2020.3.0.221.0
2020.3, ARM64
containers.intersystems.com/intersystems/iris-community-arm64:2020.3.0.221.0
2020.3, IntegratedML containers.intersystems.com/intersystems/iris-ml-community:2020.3.0.302.0
2020.4 (preview) containers.intersystems.com/intersystems/iris-community:2020.4.0.521.0
2020.4, ARM64 (preview) containers.intersystems.com/intersystems/iris-community-arm64:2020.4.0.521.0

Documentation: Deploy InterSystems IRIS Community Edition on Your Own System in Deploy and Explore InterSystems IRIS

InterSystems IRIS for Health Community Edition

2020.3 containers.intersystems.com/intersystems/irishealth-community:2020.3.0.221.0
2020.3, ARM64
containers.intersystems.com/intersystems/irishealth-community-arm64:2020.3.0.221.0
2020.3, IntegratedML containers.intersystems.com/intersystems/irishealth-ml-community:2020.3.0.302.0
2020.4 (preview) containers.intersystems.com/intersystems/irishealth-community:2020.4.0.521.0
2020.4, ARM64 (preview) containers.intersystems.com/intersystems/irishealth-community-arm64:2020.4.0.521.0

Documentation: Deploy InterSystems IRIS Community Edition on Your Own System in Deploy and Explore InterSystems IRIS

System Alerting and Monitoring

1.0 containers.intersystems.com/intersystems/sam:1.0.0.115

Documentation: System Alerting and Monitoring Guide

Limited Access Images

Access to the following ICR images requires authentication:

InterSystems IRIS

2019.1 containers.intersystems.com/intersystems/iris:2019.1.1.615.1
2020.1 containers.intersystems.com/intersystems/iris:2020.1.0.215.0
2020.1, ARM64 containers.intersystems.com/intersystems/iris-arm64:2020.1.0.215.0
2020.2 containers.intersystems.com/intersystems/iris:2020.2.0.211.0
2020.2, ARM64 containers.intersystems.com/intersystems/iris-arm64:2020.2.0.211.0
2020.3 containers.intersystems.com/intersystems/iris:2020.3.0.221.0
2020.3, ARM64 containers.intersystems.com/intersystems/iris-arm64:2020.3.0.221.0
2020.3, IntegratedML containers.intersystems.com/intersystems/iris-ml:2020.3.0.302.0
2020.4 (preview) containers.intersystems.com/intersystems/iris:2020.4.0.521.0
2020.4, ARM64 (preview) containers.intersystems.com/intersystems/iris-arm64:2020.4.0.521.0

Documentation: Running InterSystems IRIS Containers in Running InterSystems Products in Containers

InterSystems IRIS for Health

2019.1 containers.intersystems.com/intersystems/irishealth:2019.1.1.615.1
2020.1 containers.intersystems.com/intersystems/irishealth:2020.1.0.217.0
2020.1, ARM64 containers.intersystems.com/intersystems/irishealth-arm64:2020.1.0.217.0
2020.2 containers.intersystems.com/intersystems/irishealth:2020.2.0.211.0
2020.2, ARM64 containers.intersystems.com/intersystems/irishealth-arm64:2020.2.0.211.0
2020.3 containers.intersystems.com/intersystems/irishealth:2020.3.0.221.0
2020.3, ARM64 containers.intersystems.com/intersystems/irishealth-arm64:2020.3.0.221.0
2020.3, IntegratedML containers.intersystems.com/intersystems/irishealth-ml:2020.3.0.302.0
2020.4 (preview) containers.intersystems.com/intersystems/irishealth:2020.4.0.521.0
2020.4, ARM64 (preview) containers.intersystems.com/intersystems/irishealth-arm64:2020.4.0.521.0

Documentation: Running InterSystems IRIS Containers in Running InterSystems Products in Containers

Health Connect

2020.1 containers.intersystems.com/intersystems/healthconnect:2020.1.0.217.1

Documentation: Running InterSystems IRIS Containers in Running InterSystems Products in Containers

InterSystems Cloud Manager (ICM)

2019.1 containers.intersystems.com/intersystems/icm:2019.1.1.615.1
2020.1 containers.intersystems.com/intersystems/icm:2020.1.0.215.0
2020.2 containers.intersystems.com/intersystems/icm:2020.2.0.211.0
2020.2, ARM64
containers.intersystems.com/intersystems/icm-arm64:2020.2.0.211.0
2020.3 containers.intersystems.com/intersystems/icm:2020.3.0.221.0
2020.4 (preview) containers.intersystems.com/intersystems/icm:2020.4.0.521.0
2020.4, ARM64 (preview) containers.intersystems.com/intersystems/icm-arm64:2020.4.0.521.0

Documentation: Launch ICM in the InterSystems Cloud Manager Guide

InterSystems Kubernetes Operator (IKO)

2.0 containers.intersystems.com/intersystems/iris-operator:2.0.0.223.0

Documentation: Using the InterSystems Kubernetes Operator

Arbiter

2019.1 containers.intersystems.com/intersystems/arbiter:2019.1.1.615.1
2020.1 containers.intersystems.com/intersystems/arbiter:2020.1.0.215.0
2020.2 containers.intersystems.com/intersystems/arbiter:2020.2.0.211.0
2020.3 containers.intersystems.com/intersystems/arbiter:2020.3.0.221.0
2020.4 (preview) containers.intersystems.com/intersystems/arbiter:2020.4.0.521.0
2020.4, ARM64 (preview) containers.intersystems.com/intersystems/arbiter-arm64:2020.4.0.521.0

Documentation: Mirroring with InterSystems IRIS Containers in Running InterSystems Products in Containers.

Web Gateway

2019.1 containers.intersystems.com/intersystems/webgateway:2019.1.1.615.1
2020.1 containers.intersystems.com/intersystems/webgateway:2020.1.0.215.0
2020.2 containers.intersystems.com/intersystems/webgateway:2020.2.0.211.0
2020.3 containers.intersystems.com/intersystems/webgateway:2020.3.0.221.0
2020.4 (preview) containers.intersystems.com/intersystems/webgateway:2020.4.0.521.0
2020.4, ARM64 (preview) containers.intersystems.com/intersystems/webgateway-arm64:2020.4.0.521.0

Documentation: Using the InterSystems Web Gateway Container in Running InterSystems Products in Containers

PasswordHash

1.0 containers.intersystems.com/intersystems/passwordhash:1.0

Documentation: Authentication and Passwords in Running InterSystems Products in Containers

Authenticating to the ICR

To log into the ICR, take the following steps:

  1. Load https://containers.intersystems.com/ in your browser and log in with your InterSystems/WRC credentials. The Credentials for [User] page displays with your Docker login credentials for the ICR.

  2. In your Docker interface (for example, your PowerShell window or Linux command line), authenticate to the ICR using the provided credentials. You can do this by copying and pasting the full docker login command displayed on the Credentials page, for example:

    docker login -u="<username>" -p="<provided-password>" containers.intersystems.com
    Copy code to clipboard

    To avoid exposing your password on the command line, however, you may want to instead enter the command docker login containers.intersystems.com, then enter your username at the Username prompt and paste your password into the Password: prompt.

    Note:

    If you are logged into another Docker registry, the docker login command may result in an error; log out of the other registry before logging into containers.intersystems.com.

  3. You can now pull images from the ICR, for example:

    docker pull containers.intersystems.com/intersystems/iris:2020.3.0.221.0
    Copy code to clipboard

Listing the ICR Inventory

Various APIs are available to list images and tags in a Docker registry. An example of an open source third-party utility that can be used to list a registry’s inventory is docker-ls, available at https://github.com/mayflower/docker-ls.

There are several ways to obtain this utility. You can:

  • Download precompiled docker-ls binaries for a variety of platforms.

  • Install the utility directly on some platforms, for example on Linux systems with the command

    sudo snap install docker-ls
    Copy code to clipboard
  • Pull and run the image carinadigital/docker-ls:latest on Linux platforms to install the utility, for example:

    docker run --rm carinadigital/docker-ls:latest
    Copy code to clipboard

Once docker-ls is installed, you can use the following command to list the repositories in the ICR:

docker-ls repositories --registry https://containers.intersystems.com 
  --user <username> --password <password>
Copy code to clipboard
Note:

To avoid exposing your password on the command line, you can use the --interactive-password option to be prompted for it instead.

If you want to list limited access images, you must include your credentials in the docker-ls repositories command regardless of whether you are logged into containers.intersystems.com, for example

$ docker-ls repositories --registry https://containers.intersystems.com 
    -u "<username>" --interactive-password
Password:
requesting list . done
repositories:
- intersystems/arbiter
- intersystems/arbiter-arm64
- intersystems/healthconnect
- intersystems/healthconnect-arm64
- intersystems/icm
- intersystems/icm-arm64
- intersystems/iris
- intersystems/iris-aa-community
- intersystems/iris-arm64
- intersystems/iris-community
- intersystems/iris-community-arm64
- intersystems/irishealth
- intersystems/irishealth-aa-community
- intersystems/irishealth-arm64
- intersystems/irishealth-community
- intersystems/irishealth-community-arm64
- intersystems/passwordhash
- intersystems/sam
- intersystems/webgateway
- intersystems/webgateway-arm64
Copy code to clipboard

To list the tags of all the images in a specific repository within the registry, you can use the docker-ls tags command. For example, to list the publicly available InterSystems IRIS for Health images without logging into the registry, use the following command:

$ docker-ls tags --registry https://containers.intersystems.com
    intersystems/irishealth-community
requesting list . done
repository: intersystems/irishealth-community
tags:
- 2020.1.0.217.1
- 2020.2.0.211.0
- 2020.3.0.200.0
Copy code to clipboard

Further examples are available at https://github.com/mayflower/docker-ls.