IBM DataPower Operations Dashboard v1.0.17.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Quick Start Guide

This guide will help you get started with IBM® DataPower® Operations Dashboard v1.0.17.0.

Product Overview

IBM® DataPower® Operations Dashboard delivers advanced operations for real-time visibility of transactions and centralized operations to enable quicker problem resolution and operational resiliency. The product installation media is provided as a bootable ISO file, that can be deployed on a virtual machine as well as physical hardware. For more information about system requirements or a detailed installation procedure, please consult the administration guide.

Step 1: Obtain the software

Download the package from IBM® Passport Advantage®. The package includes the following components:

  • The image to deploy:

    • An ISO file for Appliance package (Std or Developer Edition).

    • A CEF file (Compressed Executable File) for Non-Appliance package.

    • A tar.gz Docker image file (lightweight "Developer edition") - Available on IBM® Fix Central.

  • This document.

Step 2: Review hardware and system configuration

  • The Product supports installation on either physical hardware or hypervisors which both requires:

    • Support of 64 bit architecture

    • Must be Intel® CPU's with hyper threading

  • The product supports the following hypervisors:

    • VMWare ESX - v6.0, v6.5, v6.7, v7.0

    • VMWare Workstation/Player - v14, v15, v16

    • VMware Fusion - v11.0, v11.5, v12.x

    • PureApp (only on Intel Processors) - no pattern yet available, can be provided only as an imported OVA.

    • For Hyper V support - contact your IBM sales representatives.

  • Non Appliance installations will require a user pre installed operating system:

    • CentOS 7.7-7.9 - x86-64 bit only on supported HW or Hypervisor as stated above

    • RHEL 7.7-7.9, 8.3-8.5 - x86-64 bit only on supported HW or Hypervisor as stated above

  • Installation for Docker Container with Light Developer Edition has been tested only on CentOS 7.8 with Docker CE version 18.09.2 and Ubuntu Desktop 18.04.3 LTS with Docker CE version 18.09.2.

  • Docker hosted on Windows is not supported.

  • The minimum resource allocation for the Developer Edition installation is as follows:

    • 2 virtual processors (vCPU)

    • Minimum of 3 GB RAM (4 GB recommended)

    • Disk space of 25GB, with only 1 disk

  • The minimum resource allocation for the Docker Container for Light Developer Edition installation is as follows:

    • At least 2GB of disk space that can grow up to 4GB.

    • At least 3GB of free memory (RAM).

  • The minimum resource allocation for Standard Edition:

    • 4 virtual processors (vCPU)

    • 18 GB RAM 

    • Disk space of 180 GB (thick provisioned) configured as follows:

      • Appliance package - Storage space must be divide divided to 3 disks:

        • Operating System - 40GB

        • Install - 40GB

        • Data - 100GB 

      • Non Appliance package - follow the Appliance configuration for performance.

        • The installation process will not verify the usage of 3 Disks but performance issues can not be addressed if this configuration is not applied.

Step 3: Installation

Option A: Appliance and software installation

Install the ISO file

Use the appropriate ISO file to install DPOD:

  • Standard Edition (Production and Non-Production Environment)

    • Appliance Package - DPOD_CentOS_v.v.v.iso  (can be download from PPA)

    • Non Appliance Package - DPOD_RedHat__v.v.v.cef (can be download from PPA)

  • Developer Edition: DPOD_Developer_CentOS_v.v.v.iso  

When installing on a physical hardware:

  • The ISO file should be burned to a bootable DVD or copied to a bootable USB drive.

  • Make sure to enable the bootable DVD or USB drive in the machine's BIOS boot order list.

When installing on a virtual environment:

  • Create a new virtual machine based on the system requirements above.

  • Make sure to define a DVD/CD in the virtual machine configuration.

  • Link the DVD/CD defined before to the ISO file.

Start the machine and follow the steps below:

  • Accept license agreement.

  • Follow the on screen instructions and provide the installation script with general OS parameters such as time, time zone, NTP, Network and more.

  • Choose your environment name

  • Choose the correct deployment profile based on the aggregated TPS on all your monitored devices.

  • Set passwords for the application user and root user.

  • Wait for system to reboot.

Deploy Software

  • Login as root with the password you set in a previous step.

  • Execute the following command:

    • installApp

  • Follow the instructions on screen until the installation finishes successfully.

Option B: Software Installation on a pre-prepared Appliance

Install the CEF file

You can install DPOD on an fresh, dedicated pre installed CentOS/RHEL 7.7-7.8 by following the steps below:

  • Prepare your appliance.

  • Download the CEF package and move it to the /tmp folder of your server.

  • Run the CEF package and follow the on-screen instructions.

  • Verify your installation.

Option C: Docker Container Deployment

  • Import the Docker image to your local Docker repository.

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

  • After downloading the desired images to your Docker host use the load command: docker load < /tmp/dpod-latest.tar.gz

  • Use the following command to display your local image repository: docker images

  • 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 iptables-save
  • Use the following command to create a DPOD Docker container:

    docker run -d \ --security-opt seccomp:unconfined \ --cap-add SYS_ADMIN \ --cap-add SYS_RESOURCE \ --cap-add SYS_TIME \ --tmpfs /tmp:exec \ --tmpfs /run \ --tmpfs /run/lock \ -v /sys/fs/cgroup:/sys/fs/cgroup:ro \ -v /etc/localtime:/etc/localtime:ro \ --device /dev/rtc \ -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"
  • For further details regarding  the docker run command please see product documentation.

Step 4: Get started

  • Access the Web console via the URL: https://<DPOD ip address>

  • Sign in using the default credentials (case sensitive):

    • Username: admin

    • Password: adminuser

  • Perform the verification steps as described in the administrative guide.

  • Perform the  post-installation steps as described in the administrative guide.



IBM DataPower Operations Dashboard (DPOD) v1.0.17.0