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

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 and detailed installation procedureprocedures, please consult the administration guideAdmin Guide in the product documentation at https://ibm.biz/dpod-docs.

Step 1:

...

Choose the

...

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:

...

type of installation

• DPOD supports the following installation scenarios. Choose an installation scenario. For production, this would be either All-in-One or the Cell environment:

  • All-in-One: The most simple installation for production environments, installed on a single virtual or physical server.

  • Cell Environment (Federated Deployment): Contains multiple virtual or physical servers, designed for very high throughput, does not replicate data between the members.

  • Developer Edition: Free, under a restricted license, and may be used for development and evaluation only, installed on a small virtual machine.

  • Docker Container for Developer Edition: Free, under a restricted license, and may be used for development and evaluation only, runs as a Docker container.

  • Simulator: Free, under a restricted license, and may be used for demonstrations and POCs, includes containers (Docker) that run DPOD along with gateways, MQ and additional components to simulate a complete and rich environment with real data constantly flowing into DPOD.

• DPOD supports the following server installation modes. Choose a server installation mode:

  • Non-Appliance Mode: The non-appliance mode may be installed on a virtual or a physical server with a pre-installed operating system (RHEL/CentOS only). The application is installed on the provided operating system.

  • Appliance Mode: The appliance mode may be installed on a virtual or a physical server using an ISO file. It includes both the operating system (CentOS) and the application.

Step 2: Review the hardware and software requirements

• The following DataPower gateways can be monitored and managed by DPOD:

  • DataPower Gateway firmware v10.5.x, v10.0.x and v2018.4.x.

  • DataPower Gateway operator v1.8.0+ (when the DPOD Cloud Agent component is used with containerized DataPower gateways in Kubernetes).

  • API Connect v10.0.x, v2018.4.x and v5.0.8.x.

  • DPOD only supports gateways with supported firmware levels that meet the minimum system requirements for DataPower Gateway.

  • The DataPower Gateway language must be set to English.

• DPOD can be installed on a virtual infrastructure (hypervisor). The following hypervisors are supported for running a DPOD production installation:

  • VMWare ESXi v6.0, v6.5, v6.7, v7.0 with Intel processors

  • VMWare Workstation/Player - v14, v15, v16 with Intel processors

  • 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 Mac with Intel processors

  • AWS EC2 Instance (Virtual Machine) with Intel processors (using Non-Appliance installation only)

  • Microsoft Azure Virtual Machine with Intel processors (using Non-Appliance installation only)

• DPOD can be installed on physical servers with Intel processors, especially when the load is high and the performance requires so. Physical hardware should be purchased according to specifications provided by the DPOD support team in a short sizing process.

• The DPOD Cloud Agent component (which is optional) requires:

  • Kubernetes 1.25,1.27 / OpenShift Container Platform (OCP) 4.12, 4.14

  • Operator Lifecycle Manager (OLM) installed

  • IBM DataPower Gateway operator v1.8.0+

• Operating system requirements (only applicable to Non-Appliance mode):

  • RHEL v7.7-v7.9, v8.3-v8.8 - x86-64 bit only on supported HW or Hypervisor as stated above.RHEL 7

  • CentOS v7.7-7v7.9 , 8.3 - 8.5 - x86-64 bit only 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):

  Code Block

  • .

  • The OS installation must be fresh, without any other installed products.

  • root access is required for the installation and for maintenance via the shell (e.g.: executing app-util.sh and various scripts). It is impossible to run the scripts using sudo instead.

  • Review the Operating System Requirements for Non-Appliance Mode page in the Admin Guide in the product documentation.

• The required resources depend on the type of installation, the expected TPS and the duration of the retention period.

  • If there are more than 120 TPS (transactions per second), or you plan to use the Cell environment, it is required to complete a sizing process by opening a support ticket with IBM Support.

  • The minimum required resources for All-in-One are 4 virtual CPU cores, 18 GB RAM, 200 GB disk.

  • The minimum required resources for the Developer Edition are 2 virtual CPU cores, 4 GB RAM, 30 GB disk.

  • The minimum required resources for the Docker Container for Developer Edition are 2 virtual CPU cores, 4 GB RAM, 6 GB disk.

  • The minimum required resources for the Simulator are 8 virtual CPU cores, 12 GB RAM, 25 GB disk.

• DPOD is I/O intensive, as it needs to persist all logs and information at very high rates. Therefore, for most of the installations, it needs to be configured with very fast disks, and with at least 3 separate disks (OS, app/logs, data).

• DPOD has the following network requirements:

  • At least one network interface for accessing DPOD's User Interface and communications with Gateway's Management Interface.

  • Some configurations, such as the Cell environment, require two network interfaces.

  • Firewall requirements are detailed in the Admin Guide in the product documentation.

Step 3: Obtain the software

• For the All-in-One or a Cell environment installations:

  • Non-Appliance Mode: Download the CEF file from IBM® Passport Advantage® (file name is DPOD_NonAppliance_<VERSION>.cef).

  • Appliance Mode: Download the ISO file from IBM® Passport Advantage® (file name is DPOD_Appliance_<VERSION>.iso).

  • Download the activation key file from IBM® Passport Advantage® (file name is DPOD-full-version-activation-key-<KEY-VERSION>.zip or DPOD-api-calls-activation-key-<KEY-VERSION>.zip).

• For the Developer Edition, download the ISO file from IBM® Fix Central (file name is DPOD_Developer_Edition_Appliance_<VERSION>.iso).

• The Docker Container for Developer Edition is hosted in IBM Container Registry (icr.io), so there’s no need to download anything.

• For the Simulator, follow the instructions at https://ibm.biz/dpod-simulator.

• For the DPOD Cloud Agent, download the Docker images from IBM® Passport Advantage® (.tgz files).

Step 4: Installation

• ISO installation:

  • Set the DPOD ISO file on your virtual/physical server's DVD and make sure it is configured in the server’s boot order.

  • Power on the virtual/physical server.

  • Start the installation and follow the instructions.

  • Provide the network configuration and set passwords.

  • After the server Os is installed and the server reboots, login as root.

  • Execute the command installApp.

  • Configure time zone, NTP, and environment name.

  • Read the End User License Agreement (EULA) and choose whether to accept it or not.

  • Choose the deployment profile that fits your requirements.

  • Wait for the installation to complete.

• CEF installation:

  • Copy the CEF file to /tmp.

  • Execute the following commands:

    Code Block
    cd <CEF_DIRECTORY> chmod 755 <CEF_FILE> ./<CEF_FILE>

  • Configure time zone, NTP, and environment name.

  • Read the End User License Agreement (EULA) and choose whether to accept it or not.

  • Choose the deployment profile that fits your requirements.

  • Wait for the installation to complete.

• Cell Environment:

  • Install the Cell Manager as All-in-One.

  • Install the Cell Member(s) as All-in-One.

  • Federate each Cell Member to the Cell Manager.

• Docker Container for Developer Edition:

  • Pull the image from IBM Container Registry:

    Code Block
    docker pull icr.io/dpod/dpod-developer-edition:latest

  • Configure iptables:

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

  Use the following command to create a DPOD Docker

  • Run the container:

    Code Block
    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

  • dpod-developer-edition: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

• Simulator: Follow the instructions at https://ibm.biz/dpod-simulator.

• DPOD Cloud Agent:

  • Load the Docker images to your container registry.

  • Configure mirroring so the k8s cluster will pull the images from your container registry.

  • Install the Cloud Agent CatalogSource.

  • Install the Cloud Agent operator.

  • Deploy the DPOD Cloud Agent instance.

  • Connect the Cloud Agent instance to the DPOD instance.

Step 5: Get started

• Log in to the Web Console (default username: admin, default password: adminuser) 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  address>

• Perform the post-installation stepstasks as described in the administrative guideAdmin Guide in the product documentation.