InterSystems IRIS Data Platform 2019.2  /  Running InterSystems Products in Containers  /  Creating and Running InterSystems IRIS Docker Containers

InterSystems: The power behind what matters   

Using InterSystems IRIS Docker Images
InterSystems IRIS images provided by InterSystems are available worldwide from repositories, and can be downloaded using the docker pull command. (Pulling an image from a repository can also be done within a Dockerfile.)
The following sections cover several important issues concerning the use of InterSystems IRIS images provided by InterSystems, including:
Docker Platforms and Versions Supported by InterSystems
InterSystems supports use of the InterSystems IRIS Docker images it provides on Linux platforms, and the instructions and procedures in this document are intended to be used on Linux. Rather than executing containers as native processes, as on Linux platforms, Docker for Windows creates a Linux VM running under Hyper-V, the Windows virtualizer, to host containers. These additional layers add complexity that prevents InterSystems from supporting Docker for Windows at this time.
We understand, however, that for testing and other specific purposes, you may want to run InterSystems IRIS-based containers from InterSystems under Docker for Windows. For information about the differences between Docker for Windows and Docker for Linux that InterSystems is aware of as they apply to working with InterSystems-provided container images, see Using InterSystems IRIS Containers with Docker for Windows on InterSystems Developer Community; for general information about using Docker for Windows, see Getting started with Docker for Windows in the Docker documentation.
Docker images from InterSystems comply with the OCI support specification, and are supported on Docker Enterprise Edition and Community Edition, version 18.03 and later. Docker EE only is supported for production environments.
Not all combinations of platform and Docker version are supported by Docker; for detailed information from Docker on compatibility, see the Compatibility Matrix and About Docker CE.
Downloading the InterSystems IRIS Docker Image
To make the InterSystems IRIS Docker image from InterSystems available for use, you can:
For simplicity, these instructions assume you are working with the image acme/iris:stable
License Keys for InterSystems IRIS Containers
Like any InterSystems IRIS instance, an instance running in a container requires a license key (typically called iris.key). For general information about InterSystems IRIS license keys, see the “Managing InterSystems IRIS Licensing” chapter of the System Administration Guide.
The InterSystems IRIS Community Edition image available from the Docker Store (as described in the previous section) comes with a special free temporary license. Generally, however, license keys are not, and cannot be, included in an InterSystems IRIS container image. Instead, you must stage a license key in a storage location accessible to the container, typically a mounted volume, and provide some mechanism for copying it into the container, where it can be activated for the InterSystems IRIS instance running there.
The iris-main program, which runs as the blocking entrypoint application of an InterSystems IRIS container, provides two options for handling the license key that can be used in a docker start or docker run command starting an InterSystems IRIS container, as follows:
See The iris-main Program for a list of iris-main options, and Running InterSystems IRIS Containers for examples of using the --key and --license-config options.
Changing the Default InterSystems IRIS Password
InterSystems IRIS is installed with several predefined user accounts, including the _SYSTEM account (see Predefined Users Accounts in the “Users” chapter of the Security Administration Guide), The default password for the predefined accounts is SYS. You can use _SYSTEM/SYS as credentials for the first login to an InterSystems IRIS instance deployed in a container, but for security reasons you are immediately prompted to change the password. This is true whether you log in using the iris terminal command or the management portal.
The iris-main --password-file option can be used to change the default password in scripts and other automation; for more information, see The iris-main Program.
Discovering Defaults in InterSystems Containers
Default values in InterSystems containers are exposed through the standard label mechanism so that needed information can be discovered, as shown in the following example. Users familiar with InterSystems technology will recognize the typical default ports and other useful information.
$ docker inspect -f {{.Config.Labels}} intersystems/iris:2019.1.0S.111.0

  "Labels": {
      "com.intersystems.adhoc-info": "",
      "com.intersystems.platform-version": "2019.1.0S.111.0",
      "com.intersystems.ports.default.arbiter": "2188",
      "com.intersystems.ports.default.license-server": "4002",
      "com.intersystems.ports.default.superserver": "51773",
      "com.intersystems.ports.default.webserver": "52773",
      "com.intersystems.ports.default.xdbc": "53773",
      "com.intersystems.product-name": "IRIS",
      "com.intersystems.product-platform": "dockerubuntux64",
      "com.intersystems.product-timestamp": "Wed Jan 16 2019 00:37:59 EST",
      "com.intersystems.product-timestamp.iso8601": "2019-01-16T05:37:59Z",
      "maintainer": "InterSystems Worldwide Response Center <>",
      "org.opencontainers.image.created": "2019-01-16T07:57:10Z",
      "org.opencontainers.image.documentation": "",
      "org.opencontainers.image.title": "intersystems/iris",
      "org.opencontainers.image.vendor": "InterSystems",
      "org.opencontainers.image.version": "2019.1.0S.111.0-0"

Send us comments on this page
View this article as PDF   |  Download all PDFs
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA
Content Date/Time: 2019-09-19 06:44:28