Docker Container for Light Developer Edition

The Docker Container for Light Developer Edition is a lightweight Developer Edition (previously known as Light Edition) designated mainly for developers.
It is geared towards the DataPower developer that wants to run DPOD on their development workstation, in the context of limited functionality.
The Docker Container for Light Developer Edition does not support upgrades and not entitled to IBM support. Each new version requires deployment of new container.

Limitations

Docker installations are limited to 3 monitored devices.
Docker installations are limited to 7 days. After 7 days, you will be redirected to a license page where a license request key can be generated.
Send the license request key to an IBM representative to get your license (the representative's email address will appear on screen).

Software and Hardware Prerequisites

Software

The Docker Container for Light Developer Edition has been tested only on:

CentOS 7.4 (kernel 3.10) with Docker CE (Community Edition) version 17.09.1
Ubuntu 16.04.3 LTS (Xential) with Docker CE version 17.09.1
Apple MacOS 10.13.4 with Docker CE version 18.03.1
Docker on Windows is not supported

Make sure to configure your Docker installation as recommended in Docker Compatibility Matrix, especially make sure to use the recommended storage driver.

Hardware

At least 2GB of disk space that can grow up to 4GB.
At least 3GB of free memory.
At least 4 Cores of Intel based CPUs.

Installation

Image Download and Installation

Download the desired DPOD Docker image from IBM Docker Hub or from IBM's Fix Central

Specific version: datapower-operations-dashboard:<version number>. For example: datapower-operations-dashboard:1.0.8.0
Latest version: datapower-operations-dashboard:latest

Image Installation

There are two options for installing DPOD Docker image on you local image repository:

Use the Docker pull command:

docker pull ibmcom/datapower-operations-dashboard:latest

Manual load: after downloading the desired images to your Docker host use the load command:
```
docker load < /tmp/DPOD-Developer-Docker-1.0.8.tgz
```

Use the following command to display your local image repository:

docker images

This is how the result should look like:

Enable Firewall Rules

If needed enable firewall rules for allowing DataPower access to DPOD Docker container agents (syslog on port 60000 and wsm on port 60020 ) :

iptables -I INPUT 1 -p tcp -m tcp -s 0.0.0.0/0 -d 0.0.0.0/0 --dport 60000 -j ACCEPT
iptables -I INPUT 1 -p tcp -m tcp -s 0.0.0.0/0 -d 0.0.0.0/0 --dport 60020 -j ACCEPT

save the configuration :

iptables-save

Create a new Docker container

Use the following command to create a DPOD Docker container:

Make sure to replace DPOD_EXT_HOST_IP parameter value (currently provided as "<Host IP Address>") in the command below with the IP Address of the host machine that runs the Docker containers.

docker run -d \
   --security-opt seccomp:unconfined \
   --cap-add SYS_ADMIN \
   --tmpfs /tmp \
   --tmpfs /run \
   --tmpfs /run/lock \
   -v /sys/fs/cgroup:/sys/fs/cgroup:ro \
   -v /etc/localtime:/etc/localtime:ro \
   -p 9022:22 \
   -p 443:443 \
   -p 60000:60000 \
   -p 60020:60020 \
   --stop-timeout 10 \
   --hostname dpod \
   --name dpod \
   datapower-operations-dashboard:latest && docker exec -d -u root dpod /bin/su - -c "export ACCEPT_LICENSE=true; export TIME_ZONE=America/New_York; export DPOD_EXT_HOST_IP=<Host IP Address>; /app/scripts/app-init.sh"

Notes:

Ports: the container should expose the following ports:

22 – SSH access to the container
443 – Web Console access
60000 – Syslog agent. It is important that you map this port as it is exposed (60000)
60020 – WS-M agent. It is important that you map this port as it is exposed (60200)

Special Considerations for Apple MacOS

Add the --privileged option to the Docker run command.
The file /etc/localtime should be shared with the container: copy the file located on /etc/localtime to the user directory usually located at /Users/<user name>.
If you choose to copy the file to another directory make sure to add it to the Docker File Sharing (Docker preferences -> Preferences -> File sharing).
Remove the cgroup volume from Docker run command.

Example of Docker run command for MacOS:

docker run -d \
   --security-opt seccomp:unconfined \
   --cap-add SYS_ADMIN \
   --privileged \
   --tmpfs /tmp \
   --tmpfs /run \
   --tmpfs /run/lock \
   -v /Users/User1/localtime:/etc/localtime:ro \
   -p 9022:22 \
   -p 443:443 \
   -p 60000:60000 \
   -p 60020:60020 \
   --stop-timeout 10 \
   --hostname dpod \
   --name dpod \
   datapower-operations-dashboard:latest && docker exec -d -u root dpod /bin/su - -c "export ACCEPT_LICENSE=true; export TIME_ZONE=America/New_York; export DPOD_EXT_HOST_IP=192.168.65.110; /app/scripts/app-init.sh"

Important:

Run the Docker exec command in order to apply your specific Docker environment. The command could be run in any point of time after creating and running the Docker container.

It may take up to 10 minutes for the application to start.

The following environment variables can be used when invoking the command:

ACCEPT_LICENSE: (mandatory) Indication that the user has accepted the EULA (End User License Agreement). The value for accepting is the number 1. (For reviewing the license agreement see "reviewing license agreement ")
TIME_ZONE: (optional) use the time zone configured to your monitored device. The time zone should be compatible with the “tz database time zone”. The default time zone is “America/New_York”.
DPOD_EXT_HOST_IP: (optional) Use this variable if your monitored device does not have direct access to your DPOD container (for example, if you are using physical or virtual IDG appliance).
The value should be the Docker host IP address.
DPOD_NTP_1: (optional) use this value to configure your primary NTP server IP address inside the DPOD container.
DPOD_NTP_2, DPOD_NTP_3, DPOD_NTP_4: (optional) use this value to configure your secondary NTP servers IP address inside the DPOD container.

Use the following command to display running docker containers:

docker ps

Access the DPOD container

Web Console - From your web browser use the container IP address, or more likely your Docker host IP address mapped to the Web Console port (443 in the example) : https://<IP address>.
user : admin and default password : adminuser
SSH - Use the container IP address, or more likely your Docker host IP address mapped to the ssh port (9022 in the example) .
user : root and default password : dpod

Re-run Previously Created DPOD Docker Container

docker start dpod  && docker exec -d -u root dpod /bin/su - -c "export ACCEPT_LICENSE=true; export TIME_ZONE=America/New_York; export DPOD_EXT_HOST_IP=192.168.65.110; /app/scripts/app-init.sh"

Note : Run the Docker exec command in order to apply your specific Docker environment. The command could be run in any point of time after creating and running the Docker container.