Deploying via Docker

This section describes how to deploy the OpenIAM platform in a Docker Swarm environment; Kubernetes is supported only in the Enterprise version. The procedures described in this section must be performed in the order that they are presented. Some steps in this installation require root level privileges to the system where OpenIAM will be deployed.

What is Docker?

Docker is a tool for creating, deploying, and running applications using containers. Docker Compose is a tool for defining and running multi-container Docker applications. Docker provides a standardized, lightweight, execution environment that maintains all dependencies within it. It can be run on either physical or virtualized environments which are on-premise or in the cloud. For more information about docker, please see see the Docker website and Docker Documentation.

OpenIAM on Docker

The OpenIAM Docker deployment method enables you to deploy on OpenIAM using a series of pre-configured containers in a short amount of time without the complexity of deploying a series of dependencies. The simplified deployment method requires:

  • Installing the Docker software
  • Configuring environment variables
  • Running scripts for setting up and starting up the OpenIAM instance. Running the deployment scripts automatically takes care of all component dependencies and release updates.

OpenIAM docker containers are maintained on Docker hub. Once these containers have been pulled into your environment using the details below, you will also need:

  • Docker client - Docker Community Edition (CE) versions 19.03.12 or higher
  • Docker compose - Defines and enables the operation of a multi-container Docker application. OpenIAM uses docker-compose file format 3.2

OpenIAM Solution Stacks

The OpenIAM solution consists of several stacks that are deployable the Docker Swarm. Docker swarm is a container orchestration tool, meaning that it allows for the manage multiple containers deployed across multiple host machines. The content of each stack is described below

Critical Infrastructure stacks

The infrastructure stacks are used across the OpenIAM solution regardless of the functionality that you are enabling. These components must be operational for the OpenIAM solution to function correctly.

Stack NameDescription
ElasticsearchRuns Elasticsearch. Elasticsearch is an enterprise-level search engine. Elasticsearch uses an index-based search approach, which allows for fast searching. The architecture allows for scalability, flexibility, and multi-tenancy support
RedisRuns Redis. Redis is an in-memory data structure store used as a database, cache, and message broker by OpenIAM
MariaDB / PostgresSQLRuns either MariaDB or PostgreSQL as the product repository. MariaDB is configured as the default repository. Aside from these two databases, you can also use a remote database
RabbitMQRuns RabbitMQ. RabbitMQ is the message brokering software service for sending and receiving messages between systems
VaultRuns Hashicorp's Vault. Vault secures, stores, and tightly controls access to tokens, passwords, certificates, API keys, and other secrets
EtcdRuns Etcd, which is used to store Vault data. Etcd is a distributed key-value store.

MariaDB is the default Database. You can change this to PostgreSQL if you prefer. You will not enable both database

Service stacks

Stack NameDescription
OpenIAM core servicesRuns services shared across the product.
Identity managerRuns the identity manager application. Identity manager automates the task of managing identities across various devices and applications used by the enterprise.
WorkflowRuns the workflow application. A workflow is a repeatable process during which documents, information, or requests are passed from one participant to another for action, according to a set of procedural rules. A participant can be a person, machine, or both.
Groovy managerRuns Groovy Manager, an application for managing Groovy scripts in OpenIAM. Apache Groovy is a dynamic programming language for the Java platform. allows you to add, update, edit, and modify Groovy scripts to extend the identity governance and web access management functionality to meet specific, complex requirements.
SynchronizationRuns the synchronization application. Synchronization allows you to synchronize data from one or more authoritative sources to a set of managed systems. Synchronization configuration enables monitoring a source system for changes and then updating target systems at scheduled periodic intervals.
ReconciliationRuns the reconciliation application. This is two side synchronization between OpenIAM and the target system
Authorization managerRuns the authorization manager. This module handles RBAC authorization via relationships between Users, Organizations, Roles, Groups, and Resources.
E-mail ManagerRuns the email manager. Handles sending and receiving email.

UI Stack

Stack NameDescription
Tomcat with three applicationsThree web applications which are described below
  • IdP - The OpenIAm web application which provides centralized authentication and self-service password reset functionality. This application also allows OpenIAM to be configured as both an Identity Provider and a Service Provider
  • Webconsole - The OpenIAM web application for administrators for managing identities across various devices and applications used by an enterprise, and for controlling access to these devices and applications.
  • Self-service - The OpenIAM end-user web application that allows users to create new requests, reset and change passwords, manage their profiles, manage access requests, manage challenge response security questions, look up corporate users through a directory search, and reset their accounts if they are locked out. Authorized users can also use the request approval functionality.

Reverse Proxy Stack

Stack NameDescription
Apache Webserver with rProxyGateway between clients and a server for managing inbound traffic to a server.

System requirements

The table below specifies the minimum system requirements for deploying a non-production OpenIAM v4.2.x instance using Docker.

MINIMUM Hardware requirements

ConfigurationNon-ProductionProduction (may increase based on sizing)
Memory24 GB32 GB
CPU6 CPUs8 CPUs
Disk80 GB100 GB

Please ensure that you are environment is aligned with the minimum system requirements described above. These parameters are not optional. OpenIAM will not start if system resources are below the minimum levels.

For production use: Customers with active subscriptions and partners, should contact OpenIAM Support (techsupport@openiam.com) for assistance with sizing requirements.

Software requirements

SpecificationRequirement
OSUbuntu (18.04 LTS, 20.04 LTS) or CentOS/RHEL (7.x, 8.x)
Docker client19.03.12 or higher
Docker compose1.28.2 or higher
Supported BrowsersGoogle Chrome (v89.0.4389.114 and later), Microsoft Edge, Mozilla Firefox (v87 and later)

Preparing your system

The OpenIAM application requires a few configurations to be performed prior to installing the application. These steps are described below.

Install required packages

Prior to installing the OpenIAM, please execute the commands below to install the required packages. If you have already logged in as “root”, you do not need to prefix them with “sudo”. If you have used another account, then you need to use “sudo”

DescriptionCommand on CentOS 8+Command on CentOS 7+Command on Ubuntu
Update the OSdnf updateyum updateapt-get update
Install Nanodnf install nanoyum install nanoapt-get install nano
Install wgetdnf install wgetyum install wgetapt-get install wget
Install gitdnf install gityum install gitapt-get install git

Example for CentOS 8.x

dnf update
dnf install nano wget git

Example for Ubuntu 20.04

apt-get update
apt-get upgrade
apt-get install nano wget git

Update the hosts file

Make sure that your /etc/hosts file contains a value for the hostname that you defined earlier. To edit the hosts file, use an editor like Nano.

127.0.0.1 iam-nonprod

Settings for Elasticsearch and Docker

Elasticsearch

OpenIAM uses Elasticsearch as a search engine. To enable fast access, Elasticsearch maps portions of an index into its memory address space. This is done through nmap, a Unix system call that maps files or devices into memory. To use mmap effectively, Elasticsearch requires sufficient mmap counts. The default operating system limits on mmap counts are inadequate for the required performance and this may result in out of memory exceptions. The required mmap value can be configured by setting the vm.max_map_count value in /etc/sysctl.conf to be at least 262144. To ensure that the vm.max_map_count persists across restarts, set this value in the /etc/sysctl.conf file

Disabling IPv6 on Docker Host

By default, IPv6 is disabled in Docker. Disabling IPv6 on Docker host(s) prevents any potential network issues. To disable IPv6 on host(s) where Docker is running, ensure that the Docker host(s) have the following value set in /etc/sysctl.conf: net.ipv6.conf.all.disable_ipv6=1 and net.ipv6.conf.default.disable_ipv6 = 1

To summarize, the /etc/sysctl.conf file must have the following changes:

vm.max_map_count=262144
net.ipv6.conf.all.disable_ipv6=1
net.ipv6.conf.default.disable_ipv6=1

Save the above changes and then run sudo sysctl -p to apply these settings without restarting the system.

Install the Docker engine

Docker Engine is a containerization technology for building and containerizing applications. Docker Engine acts as a client-server application with:

  • A server with a long-running daemon process dockerd.
  • APIs which specify interfaces that programs can use to talk to and instruct the Docker daemon.
  • A command line interface (CLI) client docker

To install the docker engine, follow the OS specific steps below. For, additional information related to the installation of the docker engine can be found at:

Ubuntu

Setup the repository

Update the apt package index and install packages to allow apt to use a repository over HTTPS

apt-get install \
apt-transport-https \
ca-certificates \
curl \
gnupg-agent \
software-properties-common

Use the following command to set up the stable repository.

add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"

Note: if you see the following error while running this operation on Ubuntu 20.04LTS, follow the additional steps describe below before installing the docker engine.

Err:5 https://download.docker.com/linux/ubuntu focal InRelease
The following signatures couldn't be verified because the public key is not available: NO_PUBKEY 7EA0A9C3F273FCD8
Reading package lists... Done
W: GPG error: https://download.docker.com/linux/ubuntu focal InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY 7EA0A9C3F273FCD8
E: The repository 'https://download.docker.com/linux/ubuntu focal InRelease' is not signed.

Open apt sources list in a text editor, like nano:

nano /etc/apt/sources.list

Scroll to the bottom and find the following lines:

deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable
# deb-src [arch=amd64] https://download.docker.com/linux/ubuntu focal stable

Comment out that first line with a # at the beginning. Next, copy the same line right below it, except switching out the ubuntu codename focal for eoan. After the changes, it should look like the example below:

# deb [arch=amd64] https://download.docker.com/linux/ubuntu focal stable
deb [arch=amd64] https://download.docker.com/linux/ubuntu eoan stable
# deb-src [arch=amd64] https://download.docker.com/linux/ubuntu focal stable

Save this file and run the following two commands to install the docker engine.

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

Install the docker engine

sudo apt-get update && sudo apt install docker-ce docker-ce-cli containerd.io
sudo systemctl enable docker.service
sudo systemctl enable containerd.service

Verify that Docker Engine is installed correctly by running the hello-world image.

docker run hello-world

CentOS / RHEL

Setup the repository

Install the yum-utils package (which provides the yum-config-manager utility) and set up the stable repository

yum install -y yum-utils
yum-config-manager \
--add-repo \
https://download.docker.com/linux/centos/docker-ce.repo

Install the Docker engine

Install the latest version of Docker Engine and containerd. The next step is to start the engine.

yum install docker-ce docker-ce-cli containerd.io
systemctl start docker
systemctl enable docker.service
systemctl enable containerd.service

Install Docker compose

Compose is a tool for defining and running multi-container Docker applications such as OpenIAM. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration. The procedure described below installs version 1.28.2 of Docker Compose on your system

  • Run the command below to download the current stable release of Docker Compose
curl -L "https://github.com/docker/compose/releases/download/1.28.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
  • Apply executable permissions to the binary
chmod +x /usr/local/bin/docker-compose
  • To check the version of docker compose, run the command below
docker-compose --version

Installing the OpenIAM Application

The installation process allows for a significant amount of flexibility. The steps below describes the minimum number of parameters which need to be configured to install on a single VM. Additional details in the sections referenced by the table below. If you are new to OpenIAM, we recommend starting with the simpler path with a more limited set of options.

Clone the OpenIAM Docker repository

Next we need to clone the OpenIAM Docker Git Repository which contains import scripts which set environment variables, start and stop the container services. To clone the repository follow the steps below. They should be performed in a Linux terminal window.

mkdir -p /usr/local/openiam
cd /usr/local/openiam
git clone https://bitbucket.org/openiam/openiam-docker-compose.git
cd openiam-docker-compose/
git checkout RELEASE-4.2.0.8

The cloned repository will contain the following scripts.

ScriptDescription
env.shFile containing environment variables. The required environment variables can be updated and added in this file. The env.sh file is sourced during the installation process and the export statements in this file are executed.
setup.shScript for setting up and updating the OpenIAM configuration. During the initial OpenIAM deployment, this script initializes the network and pulls the latest images from the OpenIAM repository (openiamdocker) on Docker Hub. When updating the OpenIAM deployment, running this script pulls newer images from the OpenIAM repository on Docker Hub
startup.shScript for starting up the OpenIAM instance.When updating the OpenIAM deployment, running this script updates the configuration on your system with the latest release updates.
Warning: Please do not modify this script in any way.
shutdown.shScript for shutting down all OpenIAM stacks, except volumes.
teardown.shScript for tearing down all OpenIAM stacks, volumes, and networks.
genrate.cert.shScript to generate certificates or Vault authentication.

Additional configuration options

SectionDescription
Yaml FilesYAML configuration files are provided for the services and infrastructure components used within OpenIAM. These files provide configuration information for the containers.
Configuration optionsConfiguration options which will be used during installation.

Initialize Vault

OpenIAM uses Vault in order to store secrets, such as database passwords, redis passwords, etc. Communication with Vault occurs via a certificate.

  • Edit the /usr/local/openiam/openiam-docker-compose/env.sh file which was downloaded from the openiam-docker-compose project above.
  • Set the VAULT_JKS_PASSWORD in the env.sh file. This password can be anything that you want.
  • Run the command, shown below, to generate a CA Certificate.
    • In the Enterprise version, you have the option to use an existing CA Certificate from a trusted CA.
cd /usr/local/openiam/openiam-docker-compose
sudo ./generate.cert.sh

You should see output similar to the example shown below:

SQL Files exist
This script will generate a key-pair that vault will use. Make sure to first set VAULT_JKS_PASSWORD in env.sh
Press enter to continue
Generating RSA private key, 2048 bit long modulus (2 primes)
.......+++++
.....................................+++++
e is 65537 (0x010001)
Generating RSA private key, 2048 bit long modulus (2 primes)
...+++++
.........+++++
e is 65537 (0x010001)
Signature ok
subject=C = CZ, ST = Test, L = Test, O = Test, OU = Test, CN = vault
Getting CA Private Key
writing RSA key

Upon successful completion of the above operation, you should also see several certificates related files as shown in the image below.

Certificates generated

Define database ports

Starting with V4.2.0, OpenIAM uses Flyway to manage database schema generation and migrations from one version to the next. This ensures that your database is properly versioned and up-to-date. OpenIAM supports Flyway versioning for MariaDB, PostgreSQL, and MSSQL, and Oracle 12.2+

The env.sh file defines properties which will be used by Flyway.

At a minimum, you will need to define to set the following parameters: To enable Flyway, set the following properties in env.sh

  • DB_TYPE - This parameter define the type of database that you will be using as the OpenIAM product repository. My default this value is set to "MariaDB" which is installed by default .
  • FLYWAY_OPENIAM_HOST - Host where the OpenIAM database will be residing. This is the primary product schema. If you are using MariaDB or PostgreSQL in a docker container, set it to database
  • FLYWAY_OPENIAM_PORT - Port where the OpenIAM database will be running. Default ports for the supported databases include:
    • MariaDB=3306
    • Postgres=5432
    • Oracle=1521
    • Microsoft SQL Server=1433
  • FLYWAY_ACTIVITI_HOST - Host where the Activti database will be residing. Activiti, is the database used by the workflow engine. If you are using MariaDB or PostgreSQL in a docker container, set it to database
  • FLYWAY_ACTIVITI_PORT - Port where Activiti database, which is used by the workflow engine, will be running.

Initialize Docker Swarm

Docker uses swarms for cluster management and orchestration features of Docker Engine, the technology for containerizing applications. Docker engines participating in a cluster run in the swarm mode. The swarm mode is enabled by either initializing a swarm, as in the command above, or by joining an existing swarm. For more information, see docker swarm and Swarm mode key concepts documentation.

Make sure that you initialize the Docker swarm. Log into Docker and initialize the swarm by entering the following command in a terminal:

sudo docker swarm init

You will see output similar to this:

Swarm initialized: current node (7risfc2161nwzir4a65po3lro) is now a manager.
To add a worker to this swarm, run the following command:
docker swarm join --token SWMTKN-1-15mdug8xi71uap0dgaayqi2ohhl8qxaaeg7m8k6q015yiuqt0j-6ip90bh1rm2td8y9baoya4qlx 173.231.56.82:2377
To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions.

Open ports for Docker Swarm

By default, the shell scripts provided by OpenIAM deploy to the docker swarm. You must ensure that the necessary ports are opened otherwise the manager and worker node(s) will not be able to communicate with each other.

Important: Please see this information about ports above 30000 used by the swarm from the load balancing section of Docker documentation: The swarm manager uses ingress load balancing to expose the services you want to make available externally to the swarm. The swarm manager can automatically assign the service a PublishedPort or you can configure a PublishedPort for the service. You can specify any unused port. If you do not specify a port, the swarm manager assigns the service a port in the 30000-32767 range.

Pull the docker images

To setup (and/or update) your configuration, you can run the setup.sh script. This will initialize the network, and pull the latest images from dockerhub.

For users, familiar with OpenIAM, you can modify the script as required by your internal needs.

  • Run the setup.sh script as shown below to pull the docker images form Docker Hub.
sudo ./setup.sh

This process will take several minutes. Upon successful completion, you will see the following lines at the end.

6b5a3f1b27b2: Pull complete
Digest: sha256:c6203c5d0aff447e22b45a47d89520d911fd66f1dea46fbb09686630143f6dad
Status: Downloaded newer image for openiamdocker/vault-ce:alpine-4.2.0.8-prod
docker.io/openiamdocker/vault-ce:alpine-4.2.0.8-prod
+ docker pull openiamdocker/vault-bootstrap-ce:alpine-4.2.0.8-prod
alpine-4.2.0.8-prod: Pulling from openiamdocker/vault-bootstrap-ce
e7c96db7181b: Pull complete
223f524ede65: Pull complete
8a9b395ef2a1: Pull complete
548fb5617b91: Pull complete
8481eb09db37: Pull complete
5d5a8a804852: Pull complete
0a7be734b4c8: Pull complete
dfe91b384f33: Pull complete
d62695d9e373: Pull complete
dd03756330a9: Pull complete
0b987ede0960: Pull complete
Digest: sha256:7a70df865c7d7fccdba17e8be372e34677b719cf23b730b14ecf9469022e6fe2
Status: Downloaded newer image for openiamdocker/vault-bootstrap-ce:alpine-4.2.0.8-prod
docker.io/openiamdocker/vault-bootstrap-ce:alpine-4.2.0.8-prod
...

Start the OpenIAM Application

Now you are ready to start the OpenIAM containers. Run the startup.sh script to initiate the startup process

sudo ./startup.sh

You should see output similar to the example below

SQL Files exist
Using MariaDB as the database type...
Nothing found in stack: flyway
etcd_storage
vault_server_storage
vault_client_storage
connector_data_storage
filebeat-storage
upload_storage
Unable to find image 'busybox:latest' locally
latest: Pulling from library/busybox
aa2a8d90b84c: Pull complete
Digest: sha256:be4684e4004560b2cd1f12148b7120b0ea69c385bcc9b12a637537a2c60f97fb
Status: Downloaded newer image for busybox:latest
Creating service etcd_etcd
Creating service vault_vault
Creating service vault-bootstrap_vault_bootstrap
Creating service openiam-elasticsearch-storage_service
Creating service openiam-jks-storage_service
Creating service openiam-activiti-storage_service
Creating service openiam-rabbitmq-storage_service
Creating service openiam-iamscripts-storage_service
connector_data_storage
Creating service redis_service
Creating service elasticsearch_service
Creating service rabbitmq_service
openiam-mysql-storage_storage
Creating service database_database
Creating service flyway_flyway
Creating service openiam_synchronization
Creating service openiam_groovy_manager
Creating service openiam_reconciliation
Creating service openiam_device-manager
Creating service openiam_auth-manager
Creating service openiam_workflow
Creating service openiam_email-manager
Creating service openiam_esb
Creating service openiam_idm
Creating service ui_ui
Creating service ldap-connector_service
Creating service rproxy_rproxy

Watch the container startup process

The containers may take 8 to 15 minutes (depending your environment) to startup completely. You can watch the start up process using the command below. Note, that the UI container will take sometime and be among the last to start up as it has dependencies on other components being up first.

watch -n 5 'docker ps'

You should see output similar to the example below when all containers have started successfully

Every 5.0s: docker ps localhost: Sat May 15 16:56:39 2021
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
5c098a123c84 openiamdocker/ui-ce:debian-4.2.0.8-prod "docker-entrypoint.s…" 6 minutes ago Up 6 minutes (healthy) 8080/tcp ui_ui.yjyaxoepjp4qpxxaclcr1e4hj.1jtwi5sbamhs6ldvunrxuuyyj
5c724d05c06f openiamdocker/email-manager-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 14 minutes ago Up 14 minutes (healthy) openiam_email-manager.yjyaxoepjp4qpxxaclcr1e4hj.tdpgtu9jby9vqnl2nva35938z
9ae62d7f6814 openiamdocker/device-manager-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 14 minutes ago Up 14 minutes (healthy) openiam_device-manager.yjyaxoepjp4qpxxaclcr1e4hj.u2xrgtca08dqdwm2eaz8qcape
4b937980ac60 openiamdocker/esb-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 14 minutes ago Up 14 minutes (healthy) 9080/tcp openiam_esb.yjyaxoepjp4qpxxaclcr1e4hj.n3uwoyndx733n01vcbw8ne7qz
1849e75a0c04 openiamdocker/workflow-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 14 minutes ago Up 14 minutes (healthy) openiam_workflow.yjyaxoepjp4qpxxaclcr1e4hj.lorx3lm0cj6n5dgclrjnvqo9p
3ebba79a550a openiamdocker/groovy-manager-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 15 minutes ago Up 14 minutes (healthy) openiam_groovy_manager.yjyaxoepjp4qpxxaclcr1e4hj.tjmrtwlfs4e58uqlh9fdqfutf
51ef30e22ec4 openiamdocker/rproxy-ce:debian-4.2.0.8-prod "httpd-foreground" 21 minutes ago Up 21 minutes (healthy) 0.0.0.0:80->80/tcp, 443/tcp rproxy_rproxy.yjyaxoepjp4qpxxaclcr1e4hj.5asjr7ov89y230q07nfdtdcso
e453003ae06e openiamdocker/ldap-connector-rabbitmq-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 21 minutes ago Up 21 minutes (healthy) ldap-connector_service.yjyaxoepjp4qpxxaclcr1e4hj.ls6wlm5rkvmq5h2b45twitixu
0a271e763d68 openiamdocker/idm-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 21 minutes ago Up 21 minutes (healthy) openiam_idm.yjyaxoepjp4qpxxaclcr1e4hj.on5fgrf1i9a7azjwb6xzmjr6s
aa9b173e7b90 openiamdocker/auth-manager-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 21 minutes ago Up 21 minutes (healthy) openiam_auth-manager.yjyaxoepjp4qpxxaclcr1e4hj.vkfm6qel3d6gqo4jtjfndjpuh
d997e6a4ad87 openiamdocker/reconciliation-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 21 minutes ago Up 21 minutes (healthy) openiam_reconciliation.yjyaxoepjp4qpxxaclcr1e4hj.o36h8nnskc74jstgg4fizwtp0
19649556b81b openiamdocker/synchronization-ce:debian-4.2.0.8-prod "docker-entrypoint.sh" 21 minutes ago Up 21 minutes (healthy) openiam_synchronization.yjyaxoepjp4qpxxaclcr1e4hj.hb5fyaui8rk9sa9s9134f5v4o
8cb1c48685db openiamdocker/mariadb-ce:debian-4.2.0.8-prod "init.sh /run.sh" 22 minutes ago Up 22 minutes (healthy) 3306/tcp database_database.1.s1xa5f7i7fxh3jf3mjn70mqkc
2c4512376aea openiamdocker/rabbitmq-ce:alpine-4.2.0.8-prod "docker-entrypoint.s…" 23 minutes ago Up 22 minutes (healthy) 4369/tcp, 5671-5672/tcp, 15691-15692/tcp, 25672/tcp rabbitmq_service.1.pwyyligv23znvwxuxahatu7xc
19276fcf0b6a openiamdocker/elasticsearch-ce:debian-4.2.0.8-prod "init.sh" 23 minutes ago Up 22 minutes (healthy) 9200/tcp, 9300/tcp elasticsearch_service.yjyaxoepjp4qpxxaclcr1e4hj.3x1l1qn7hu9surqpab7d41ajs
73257460b5df openiamdocker/redis-ce:debian-4.2.0.8-prod "redis.sh /run.sh" 23 minutes ago Up 22 minutes (healthy) 6379/tcp redis_service.1.lw4vnvbavbtncqppu7qjz7y8v
7e90b90240b3 openiamdocker/vault-ce:alpine-4.2.0.8-prod "docker-entrypoint.s…" 23 minutes ago Up 23 minutes (healthy) 8200/tcp vault_vault.1.9i1u6mygrlazjajimm4ytm9dx
f26e95760cd6 bitnami/etcd:3.3.13 "/entrypoint.sh etcd" 23 minutes ago Up 23 minutes 2379-2380/tcp etcd_etcd.1.y3b8bub61beji7pw8jxn6o412

Validate the startup

curl -k -I -L http://127.0.0.1/idp/login

You should see output similar to the example below

HTTP/1.1 200
Date: Sat, 15 May 2021 16:57:47 GMT
Server: Apache
Content-Security-Policy: default-src 'self' 'unsafe-inline' 'unsafe-eval'; script-src 'self' 'unsafe-inline' 'unsafe-eval' apis.google.com; style-src 'self' 'unsafe-inline' 'unsafe-eval' *; form-action 'self' 'unsafe-inline' 'unsafe-eval' *; img-src 'self' *; font-src 'self' *;
Access-Control-Allow-Origin: *
X-Frame-Options: sameorigin
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache
Pragma: no-cache
Expires: Wed, 31 Dec 1969 23:59:59 GMT
X-UA-Compatible: IE=EmulateIE10
x-openiam-force-auth: false
x-openiam-login-uri: /idp/login
Content-Type: text/html;charset=utf-8
Content-Language: en
Set-Cookie: SESSION=NzQ2MTQ5Y2EtNDgwMS00OTFjLWIwODktMjYzYzJhNWI4MzNm; Path=/idp/; HttpOnly; SameSite=Lax
Vary: Accept-Encoding
Transfer-Encoding: chunked

The application is now operational and you can login.

First time login

The final validation of our deployment is to be able to login to the OpenIAM web applications. To do this, must first find the IP address of our VM.

Next open your browser (preferably Chrome or Firefox), and hit:

http://[ip address of your installation ]/webconsole

Use the following credentials for the first-time login:

Username: sysadmin
Password: passwd00

OpenIAM Login page

The next screen will ask you to change the default password. On the side is the password policy. Please enter a new password which complies with this policy. You will be able to change both the password and the policy later

Change password

The following screen will ask for answers to a set of challenge questions. The answers to these questions can be used as part of the forgot password functionality. This to can be changed later as you start to configure the solution for your needs.

Challenge questions

The last step in the startup process is to define a "Content Provider". A content provider is an important concept in OpenIAM and is explained in more detail in the administration guide. For this initial setp, we only need to provide the following information to define the default content provider.

NameDescription
Content Provider NameYou can think of a content provider an “alias” which represents a domain. This is described in more detail in the OpenIAM documentation. For this setup, please enter a value such as : Default CP
Domain PatternThis value is defaulted in. It should be the IP address or host DNS name of the instance where OpenIAM has been installed
Is SSL?Flag which indicates if communication will be over SSL. For this step, select No. The steps to enable SSL are defined separately

Define initial content provider

After setting the content provider, you will be taken to the landing page of the admin interface in OpenIAM called the Webconsole. You will see the search screen below.

After the content provider is setup, OpenIAM will need a few minutes for the system cache to refresh. During this time, you may see some screens which are blank. Allow for the refresh to complete.

After this time, you instance is ready for additional configuration.

Webconsole landing page

Frequently used commands with Docker

The following commands are frequently used with Docker.

CommandDescription
./startup.shStarts the OpenIAM Docker containers
./shutdown.shStops the OpenIAM Docker containers
Ensure that all containers have stopped before restarting. You can validate that the containers have stopped using the docker ps command
docker psShows all the containers which are running
watch -n 5 'docker ps'Allows you to observe the docker containers. The view is refreshed every -n seconds.
docker logs [container id]Shows the logs related to the Container ID. You can get the Container ID from the docker ps command.
docker exec -it [container id] bashAllows you to connect to the container
docker restart -t [time][container id]Allows you to restart a container. Time is the number seconds to wait after stopping a container, but its started again.