IBM DataPower Operations Dashboard v1.0.20.x

A newer version of this product documentation is available.

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

Post Installation Tasks

Verifying the Installation

  1. Verify that there are no errors in the installation logs.

  2. Verify all services are running using Command Line Interface (CLI) (option 3 - Check Status).

Activating the Product

Please perform the following tasks to activate the product:

  1. Log in to the Web Console (default username: admin, default password: adminuser).

  2. In the Welcome modal:

    1. Define the main type of monitored transactions and preferred theme (this will determine the default type and theme for all users):

      1. Choose DataPower Gateway services if the main type of monitored transactions is traditional DataPower services (e.g.: WSP, MPGW).

      2. Choose API Connect APIs if the main type of monitored transactions are API-Connect APIs.

    2. Change the default password for username admin (required after the first login).

    3. If required, upload an activation key:

      1. The activation key is included in the download assembly for the program you purchased. In Passport Advantage, make sure to select version “1.0.x” (and not the specific DPOD version).
        For the full version, please apply the activation key found in eAssembly "IBM DataPower Operations Dashboard V1.0.x Full Version Activation eAssembly" (G071VEN/M088JEN).
        For the API calls version, please apply the activation key found in eAssembly "IBM DataPower Operations Dashboard V1.0.x API Calls Version Activation eAssembly" (G071TEN/M088HEN).

      2. The activation key file is a password-protected zip file. Do not try to unzip the activation key zip file, just upload it as is to DPOD.

      3. An activation key is not required for the free Developer Edition and the Docker Container for Developer Edition, which include a trial period.

    4. Make sure the URL of the Web Console is valid.

  3. Read the End User License Agreement, and if acceptable, accept it.

  4. Once logged in, check the system status.

Adding and Configuring Monitored Gateways

  1. Make sure to meet the Monitored Gateways Requirements.

  2. Follow Adding Monitored Gateways.

  3. Configure the monitored gateways to send data to DPOD by following Configuring Monitored Gateways.

  4. If you are using DPOD to monitor API-Connect APIs, and the API-Connect Analytics subsystem is installed, you may configure it to offload data to DPOD to see payload and headers, and to enjoy Expert Mode dashboards.

Security and Roles

  1. Log in to the Admin Console (default username: admin, default password: adminuser) and change the default password.

  2. Complete the LDAP configuration steps.
    The built-in local repository of users, groups and roles is only for POCs and demo usage. To better comply with more strict security requirements it is advised to leave the Local User Registry Management disabled in System Parameters (it is disabled by default). When disabled, DPOD will not allow to add or edit any users, roles or groups, and will display a relevant error message.

  3. Create Custom Roles for users or groups to restrict the permissions each user has in the system.
    For example, allow the development team of a certain group of APIs to see transactions of their own APIs, while preventing access to other teams' APIs.

  4. Secure the installation by replacing self signed certificate of the web console and limiting admin dashboard to specific IP addresses.

Notifications

  1. In order to send reports, alerts, internal alerts or maintenance events via Email, setup the SMTP host, password, port and user name in the system parameters page.

  2. In order to configure notifications, follow Configuring Notifications by Email/WS/Syslog/Local File.

  3. In order to publish alerts via Syslog, configure the alerts syslog server hostname and port in the system parameters page.

  4. In order to receive internal DPOD health checks alerts via Syslog or Email, enter the Email recipients and change the value for "Internal Alerts - Send Email on Alert" , "Internal Alerts - Email Destination Address for Alerts" and "Internal Alerts - Send Syslog on Alert" in the system parameters pageRestart the keepalive service via app-util.sh after changing these parameters.

  5. In order to publish DPOD maintenance events (backup, sync, firmware upgrade) via Syslog, configure the maintenance syslog server hostname and port in the system parameters page.

  6. In order to receive Syslog notification for the backup, sync or firmware upgrade features, change "Maintenance Syslog Notifications Destination Hostname"  in the system parameters page.

Maintenance Plans and DevOps Portal

  1. In order to use the backup appliance feature, change the "Backups -  Destination Path" in the system parameters page to a new dedicated mount point.

  2. In order to use the appliance firmware upgrade feature, follow Configuration for Appliance Firmware Upgrade.

  3. Setup DevOps portal if you want to use DevOps features such as Remote or Local WSDL validation and promotion.

Backup

Schedule a periodic backup of the DPOD server(s) using the Backup Utility.



Copyright © 2015 MonTier Software (2015) Ltd.