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.

External Self Service Console


This feature is deprecated and you should avoid using it.


A DPOD External Self-Service Console is an instance of DPOD All-In-One installation that is deployed externally to a network, provides users with a Console UI only, and does not store any transactional data of its own. In lieu of storing data, this instance communicates with a DPOD Internal Console.

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

Installation Preparation

Network Requirements

  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

DPOD External Self-Service Console 

NTP Server

123

NTP

Sync time between DPOD instances

DPOD External Self-Service Console

Organizational mail server

25

SMTP

Send reports by email

NTP Server

DPOD External Self-Service Console  

123

NTP

Sync time

Users IPs         

DPOD External Self-Service Console  

80, 443

HTTP/s

Work with DPOD Service Center Console

Admins IPs         

DPOD External Self-Service Console  

22

TCP

SSH

DPOD External Self-Service Console  

DPOD Internal Console  

9200, 9302

TCP

Connection to DPOD Internal Console Store

Hardware Requirements

DPOD External Self-Service Console should have a Low deployment profile as detailed in Hardware and Software Requirements with the following exceptions:

  1. The Data disk can be as small as 5 GB (instead of 100 GB)
  2. (Optional) You may add a second network interface to separate DPOD's External Self Service Console access to the DPOD Internal Console from the UI interface.

DPOD External Self-Service Console Post Installation Tasks

After installing DPOD on the External Self-Service Console machine, follow the steps below:

  1. Stop DPOD components

  2. Ensure all components are down

  3. Disable some DPOD services:
    1. Edit (using vi) the file /etc/sysconfig/MonTier ,change the following line:

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

      and remove all components except for MonTier-Derby:

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

      SERVICES_SECOND_GROUP="MonTier-es-raw-trans-Node ..."
      SERVICES_FORTH_GROUP="MonTier-AggAgent- ..."
      SERVICES_FIFTH_GROUP="MonTier-BalancerAgent ..."
      SERVICES_SIXTH_GROUP="MonTier-WsmAgent-1 ..."
  4. Change DPOD's Store entries in /etc/hosts to direct to DPOD Internal Console IP address (1.1.1.1 in the example below):

    1.1.1.1     montier-es
    1.1.1.1     montier-es-http
  5. Start configuration database service

    start_services.sh -o derby
    ij
  6. Update the SystemParameter SQL table:

    UPDATE SystemParameter
    SET value='false'
    WHERE name='agents.management.enabled';
    
    UPDATE SystemParameter
    SET value='false'
    WHERE name = 'system.internal_self_service.is_internal';
    
    UPDATE SystemParameter
    SET value='false'
    WHERE name = 'system.should_run_retention_on_startup';
    
    update HATSRECURRINGTASK set isEnabled='false' where taskType not in ('DATABASE_CLEANUP', 'FILE_CLEANUP', 'INTERNAL_ALERTS_CHECK_DERBY', 'INTERNAL_ALERTS_CHECK_FS_FREESPACE');
  7. 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
    (you can do that from Manage → Customize → System Parameters after the web console starts):
    1. Internal Self Service Address: Enter the address of the internal self service portal.
    2. Internal Self Service Webserver Port: (defaults to 443) The webserver port for the internal self service portal - change this value only if advised.
  8. Update external server's encryption key:
    1. Copy the encryption key from internal server to the external server's temp folder - do not override servers encryption file:

      scp root@<internal server ip>:/app/keys/encryption.key /tmp/encryption.key
    2. Deploy the key using utility:

      /app/scripts/replace_encryption_key.sh --deploy /tmp/encryption.key

DPOD Internal Console Post Installation Tasks

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

  1. Stop DPOD components

  2. Ensure all components are down :

  3. Change DPOD Store entries in /etc/hosts to bind to DPOD Internal Console IP address instead of 127.0.0.1 (1.1.1.1 in the example below):

    1.1.1.1     montier-es
    1.1.1.1     montier-es-http
  4. Start DPOD components

  5. Ensure all components are up and running

    app_status.sh
    
    #Output Example:
    MonTier-AppAdmin (pid 17836) is running...
    MonTier-Derby (pid 17940) is running...
    MonTier-es-raw-trans-Node-1 (pid 18125) is running...
    MonTier-es-raw-trans-Node-2 (pid 21122) is running...
    MonTier-es-raw-trans-Node-3 (pid 21103) is running...
    MonTier-es-raw-trans-Node-4 (pid 21120) is running...
    MonTier-SyslogAgent-1 (pid 27350) is running...
    MonTier-SyslogAgent-2 (pid 27286) is running...
    MonTier-SyslogAgent-3 (pid 27177) is running...
    MonTier-SyslogAgent-4 (pid 27075) is running...
    MonTier-WsmAgent-1 (pid 27002) is running...
    MonTier-WsmAgent-2 (pid 26921) is running...
    MonTier-WsmAgent-3 (pid 26881) is running...
    MonTier-WsmAgent-4 (pid 26773) is running...
    MonTier-HK-ESRetention (pid 24012) is running...
    MonTier-HK-WdpDeviceResources (pid 27590) is running...
    MonTier-HK-WdpServiceResources (pid 27447) is running...
    MonTier-HK-SyslogKeepalive (pid 1976) is running...
    MonTier-HK-WsmKeepalive (pid 1932) is running...
    MonTier-UI (pid 1635) is running...
    MonTier-Reports (pid 1830) is running...
    MonTier-AgentNode (pid 1736) is running...

IBM DataPower Operations Dashboard (DPOD) v1.0.17.0