Introduction

Here we describe Docker image for midPoint that is to be used within the TIER IdM environment.

The image can be found in the TIER/midPoint_container GitHub project.

Besides the image itself, the project contains a couple of demonstrations of its usage:

...

Introduction

This page shows how to get started with a Docker image for the midPoint component of the InCommon Trusted Access Platform.

Anchor
prerequisites prerequisites

Prerequisites

In order to set up and run this container and associated demonstrations, you need a Linux machine with a reasonably recent Docker and docker-compose installation. The most advanced demo/grouper optionally uses an LDAP browser, e.g. Apache Directory Studio that itself requires Java.

...

Also, make sure appropriate ports are available on the host machine. They are listed in the documentation to individual demonstrations; usually they are 8443 and 3306, sometimes 389, 443, or 5432. The demo/grouper needs even more free ports, please see the description.

Getting started (simple demo)

The image cannot be "run" by itself as it requires a midPoint repository - i.e. an SQL database - to execute. So the easiest way how to start dockerized midPoint is to use one of the provided demonstrations. The most logical choice for the first run just getting started with midPoint is demo/simple.

$ git clone --branch v1.2 https://github.internet2.edu/TIERDocker/midPoint_container.git
$ cd midPoint_container/demo/simple
$ docker-compose up

Building own images

The above commands download tier/TAP midpoint image from the Docker hubInternet2's enterprise github. Alternatively, you can build this image yourself. Here is how:

$ git clone --branch v1.2 https://github.internet2.edu/TIERDocker/midPoint_container.git
$ cd midPoint_container
$ ./build.sh
$ cd demo/simple
$ docker-compose up

(Note the build.sh has a -n switch that skips downloading the midPoint distribution archive, saving some time during repeated builds.)

After starting

After docker-compose up command successfully finishes you should see something like this on the console:

...

Now you can log into midPoint using https://localhost:8443/midpoint URL, with an user of administrator and a password of 5ecr3t. If you are using midPoint 4.8.1 or greater please check the documentation on how to set an initial password. 

Beyond the simple demo

Besides the midPoint image itself, and the simple demo discussed above, the project contains demonstrations that integrate midPoint with selected other components

Configuring the container (general information)

The lowest level of configuration of the midPoint container is during its inclusion into a Docker composition. There is the full set of environment properties and other configurable items (e.g. Docker secrets and configs) available.

During the composition some of the environment properties can be made accessible from the outside. This depends strictly on the compositor. The demonstrations here show some of the options.

How to set environment variables after composition is done

After the composition is done, you can set the environment variables like this:

...

$ env ENV="test" USERTOKEN="4.0.1" MP_MEM="4096m" docker-compose up

How to set Docker secrets and configs

The way of accessing secrets and configs is specific to the composition. In our demonstrations these are stored in the configs-and-secrets directory. They are provided to midPoint containers in appropriate ways. (Currently, secrets are passed as Docker secrets, configs are mounted as volumes. This might be changed in the future.) For detailed information on individual items please see the following sections.

Configuring specific container features

In this section we describe how to configure and use specific features of this midPoint dockerization.

Repository

Repository configuration is done via the following environment variables.

...

Of course, you can provide the password file in any other way, assuming you correctly set REPO_PASSWORD_FILE environment variable.

Logging

Logging is configured by setting the following environment variables:

...

According to the specification, semicolons and spaces in these fields are eliminated. We decided to replace them by underscores.

Authentication

This midPoint dockerization supports two authentication mechanisms.

...

Other

Other aspects can be configured using the following variables and Docker secrets or configs.

...

Guiding requirements for this project: TIER Docker Container Specification