IBM DataPower Operations Dashboard v1.0.10.0

A newer version of this product documentation is available.

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

External Self Service Console

An DPOD External Self-service Console (“DPOD External Self-Service”) is an instance of DPOD All-In-One appliance that is deployed externally to a network, provides users with a Console UI only, and does not store any data of its own. In lieu of storing data, this instance communicates with an internal DPOD Console (“DPOD Internal Console”).

A typical use for an DPOD External Self-Service is to proxy the DPOD Console UI to a less secured network (e.g. a DMZ) without placing DPOD's internal Data Base in that area.

Security note: In the current version of DPOD External Self-Service, the connection to the internal data base is not protected using authentication mechanism. Consider this when planning your deployment and use additional security measures to protect network access to the internal data base.

Installation Preparation

Gather & Prepare Network

  1. Ensure you have an IP for the DPOD external Self-service console (including DNS, Default GW, subnet mask and other network configuration).
  2. Ensure you have an NTP server available and obtain the NTP server IP address.
  3. Ensure the ports detailed below are opened during or after install

From

To

Ports (Defaults)

Protocol

Usage

FROM DPOD External Self-Service  

NTP Server

123

NTP

Sync time between DPOD instances

FROM DPOD External Self-Service  

Organizational mail server

25

SMTP

Send reports by email

NTP Server

DPOD External Self-Service  

123

NTP

Sync time

FROM Users IPs         

DPOD External Self-Service  

80 ,443

HTTP/s

Work with DPOD Service Center Console

FROM Admins IPs         

DPOD External Self-Service  

22

TCP

SSH

FROM DPOD External Self-Service  

DPOD Internal Console  

9302

TCP

Connection to elastic Search Node

Hardware Requirements

ResourceRequirements
Storage
  • Disk 1 (for OS): 40GB
  • Disk 2 (for product installation): 40GB
  • Disk 3 (Date): minimum 5GB
MemoryMinimum of 32GB reserved
CPUMinimum 4 cores (2 virtual sockets, with 2 virtual cores each, reserved)
Network
  • 1 network interface for the UI
  • (Optional) - a second network interface to separate DPOD's External Self Service access
    to the internal database from the UI interface. 
HypervisorVMWare ESX 5.x

DPOD External Self-Service Post Installation Tasks

  1. Stop DPOD components 

  2. Ensure all components are down

  3. Disable all DPOD services except Derby, UI and Reports
    1. Edit (with vi) /etc/sysconfig/MonTier and find the line starting with

      SERVICES_FIRST_GROUP="MonTier-Derby MonTier-es-raw-trans-Node-1"

      and remove all components except for MonTier-Derby:

      SERVICES_FIRST_GROUP="MonTier-Derby"
    2. Comment out the following lines:

      SERVICES_SECOND_GROUP="MonTier-es-raw-trans-Node ..."
      SERVICES_THIRD_GROUP="MonTier-HK-ESRetention" ...
      SERVICES_FORTH_GROUP="MonTier-AggAgent- ..."
      SERVICES_FIFTH_GROUP="MonTier-BalancerAgent ..."
      SERVICES_SIXTH_GROUP="MonTier-WsmAgent-1 ..."
    3. Change 

      SERVICES_SEVENTH_GROUP="MonTier-UI MonTier-Reports MonTier-HK-WsmKeepalive MonTier-HK-SyslogKeepalive"

      to remove all components except MonTier-UI and MonTier-Reports

      SERVICES_SEVENTH_GROUP="MonTier-UI MonTier-Reports"
  4. Change DPOD's Elastic Search alias entry in /etc/hosts to direct to the internal console:

    vi /etc/hosts

    Change the line that directs montier-es to point to the internal Console IP Address (1.1.1.1 in the example below)

    1.1.1.1     montier-es
  5. Edit DPOD UI configuration file:

    vi /app/ui/MonTier-UI/conf/MonTierUI.conf

    and change the port on the following line

    elasticsearch.discovery.zen.ping.unicast.hosts=montier-es[9300]

    to the new port

    elasticsearch.discovery.zen.ping.unicast.hosts=montier-es[9302]
  6. Comment out the following lines:

    elasticsearch.node.name=MonTier-UI
    elasticsearch.network.host=montier-es-http
    elasticsearch.transport.tcp.port=9320
    elasticsearch.http_node.host=montier-es-http
    elasticsearch.http_node.port=9200
  7. Update the SystemParameter SQL table:

    UPDATE SystemParameter
    SET value='false'
    WHERE name='agents.management.enabled'; 
  8. Update the SystemParameter SQL table:

    UPDATE SystemParameter
    SET value='false'
    WHERE name = 'system.internal_self_service.is_internal';
  9. If you wish to let the external self service users access the DevOps Services Portal, change the following system parameters in the external self service console:
    a. Internal Self Service Address - enter the address of the internal self service portal
    b. Internal Self Service User Name - the DPOD user name that will be used to access the internal portal - it is recommended to create a new user for this purpose
    c. Internal Self Service Password - the password for the user that will be used to access the internal portal
    d. Internal Self Service Webserver Port - (defaults to 443) the webserver port for the internal self service portal - change this value only if advised.

DPOD Internal Console Post Installation Tasks

Connect to the DPOD Internal Console server and alter the configuration to let it accept communication from the DPODExternal Self-Service console.

  1. Stop DPOD components

  2. Ensure all components are down :

  3. Change DPOD ElasticSearch alias entry in /etc/hosts to bind to external IP address

    vi /etc/hosts

    and change the line 

    127.0.0.1   montier-es

    to DPOD's internal console IP address (e.g. 1.1.1.1)

    1.1.1.1     montier-es
  4. Start DPOD components

  5. Ensure all required components are up (all but "MonTier-AggAgent-1-xxx”  and “MonTier-BalancerAgent-1-xxx”)

    check_status.sh -a

DPOD External Self-Service post installation checks

To verify the DPOD External Self-Service installation, start the External console and ensure all is working as expected.

  1. Start DPOD components

  2. Ensure all required components are up:

    The following components must be running:

    1. MonTier-Derby
    2. MonTier-UI
    3. MonTier-Reports

  3. Enure the UI components is up using ElasticSearch Client mode connection.
    Inside the UI log file at /logs/ui/ MonTier-UI.log  locate the following line:

    04/04/2016 06:55:53,941- DEBUG o.m.c.u.e.ElasticSearchClient [montier-ui-server-startStop-1] Connecting to ElasticSearch as transport client
  4. Basic Installation Verification
    1. Start DPOD's console and sign in: http://<DPOD Server>/
    2. Ensure the System Overview dashboard contains data
    3. Ensure the Investigate screen contains data.

IBM DataPower Operations Dashboard (DPOD) v1.0.10.0