/
Quick Start Guide

IBM DataPower Operations Dashboard v1.0.21.x

A newer version of this product documentation is available.

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

Quick Start Guide

Owned by Amit Munwes
Last updated: Aug 13, 2024
6 min read

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

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.

For more information about system requirements and detailed installation procedures, please consult the Admin Guide in the product documentation at https://ibm.biz/dpod-docs.

Step 1: Choose the 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/Rocky Linux/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:

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

    • VMWare ESXi v7.x-v8.x with Intel processors.

    • VMWare Workstation/Player v16.x-v17.x with Intel processors.

    • VMware Fusion v12.x-v13.x 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.x-v1.11.x.

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

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

    • Rocky Linux v8.3-v8.9 - x86-64 bit only on supported HW or Hypervisor as stated above.

    • CentOS v7.7-v7.9 - x86-64 bit only on supported HW or Hypervisor as stated above.

    • 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 and work with your Linux team to configure the OS properly.

    • Third-party software such as antivirus, cybersecurity, monitoring, APM, endpoint protection, backup, etc. might significantly decrease the performance of DPOD and impact its functionality. During the resolution of issues, DPOD support will ask the customer to disable any 3rd party software in order to isolate the issues and verify their source. Support cannot be provided if the 3rd party tools are not disabled.

  • 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:

      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:

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

    • Configure iptables:

      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

    • Run the container:

      docker run -d \ --security-opt seccomp:unconfined \ --cgroupns host \ --cap-add SYS_ADMIN \ --cap-add=SYS_PTRACE \ --cap-add SYS_RESOURCE \ --tmpfs /tmp:exec \ --tmpfs /run \ -v /sys/fs/cgroup:/sys/fs/cgroup:rw \ -v /etc/localtime:/etc/localtime:ro \ -v /etc/timezone:/etc/timezone:ro \ -p 9022:22 \ -p 443:443 \ -p 60000:60000 \ -p 60020:60020 \ --stop-timeout 10 \ --hostname dpod \ --name dpod \ icr.io/dpod/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"

  • 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>

  • Perform the post-installation tasks as described in the Admin Guide in the product documentation.

 

Related content

Copyright © 2015 MonTier Software (2015) Ltd.