IBM DataPower Virtual Edition on Azure

Microsoft Azure Installation guide

1. Overview

This guide will provide step by step instructions how to start using the installed products on your Microsoft Azure instance.

This Azure Virtual Machine contains a ready-to-run IBM DataPower Virtual Edition image at the selected version. In order to use this image, you need to launch it with your selected type. Once launched, the DataPower console will then be ready to access.

Visit the IBM DataPower Virtual Edition page on the Azure Marketplace

2. Launching an instance

In order to launch IBM Datapower Virtual Edition (referred to as DataPower), a few settings need to be configured on the Azure console as follows:

  1. Open new Azure Virtual Machine wizard;
  2. Select the IBM DataPower Virtual Edition image based on your requirements from gallery;
  3. Choose VM name, size, Authentication user and credentials. The Standard DS2V2/General Purpose type or larger is recommended when running IBM DataPower Virtual Edition. Larger instances may be required based on the throughput and number of Domains etc required and the expected resource use of each;
  4. Define cloud service DNS name, Regions and open endpoint ports.
Port 22 to connect via SSH (enabled by default) to the instance hosting the DataPower Virtual Edition, 

Port 9990 to reach the IBM Datapower Virtual Edition Gateway Console, 
Port 9090 to reach RapidDeploy web console, 
Port 20000 and 20100 to open for RapidDeploy Remote Agent (optional)

 3. Initial login and setup

On Launching the instance, the IBM DataPower Virtual Edition application is also started automatically. You can log in to the IBM DataPower Gateway console without any further configuration.

If you don’t want to perform any bespoke configuration, skip this section and move on to section 4, “Accessing the Web Consoles”.

Note: If you log in straight after the instance is launched DataPower may not have finished starting up so you need to wait at least 5 minutes and then use credentials from section 4 to log in.

Once the instance has started up.

  1. Log onto the instance via SSH with your Azure user and credentials.
  2. You should see the MidVision banner and then you are placed in a setup wizard.
    Welcome to                                                                                                                                             
    
     __  __ _     ___     ___     _                    ____ _                 _ 
    |  \/  (_) __| \ \   / (_)___(_) ___  _ __        / ___| | ___  _   _  __| |
    | |\/| | |/ _` |\ \ / /| / __| |/ _ \| '_ \ _____| |   | |/ _ \| | | |/ _` |
    | |  | | | (_| | \ V / | \__ \ | (_) | | | |_____| |___| | (_) | |_| | (_| |
    |_|  |_|_|\__,_|  \_/  |_|___/_|\___/|_| |_|      \____|_|\___/ \__,_|\__,_|
    
                                                                                
                                                           A MidVision Service
    
            * WebSite: https://www.midvisioncloud.com/product-category/microsoft-azure-marketplace
            * Support: http://support.midvision.com/redmine/projects/devtestcloud
            * Forum:    https://www.midvisioncloud.com/community
    
    Please run 'sudo su - midvision' to start using provided services. 
    
    Welcome, this is MidVisionCloud DataPower Virtual Edition image first run configuration
    Note that you can rerun this configuration wizard again by executing /home/midvision/firstrunsetup.sh script
    Configuration steps
    1. Set DataPower Virtual Edition password
    2. Set RapidDeploy framework initial password
    3. Open ports on RHEL firewall
    Your default DataPower web console password for 'admin' user is set to mvadmin
    Would you like to change it now [yes/no] ?
    yes
    Configuring password for DataPower 'admin' user
    Set password for DataPower user 'admin'. Submit blank for default value of the instance id: mvadmin
    Make sure your password is at least 6 characters long
  3. Type a password or leave blank for the default instance-id and hit [return]. Confirm the password. You should see the following output.
    Setting DataPower password for user admin...
    spawn telnet 0 2200
    Trying 0.0.0.0...
    Connected to 0.
    Escape character is '^]'.
    [hostname]
    Unauthorized access prohibited.
    login: admin
    Password: **********
    
    Welcome to IBM DataPower Gateway console configuration. 
    Copyright IBM Corporation 1999-2016 
    
    Version: IDG.7.5.0.0 build 274960 on Mar 11, 2016 3:09:45 PM
    Serial number: 0000001
    idg# configure terminal
    Global configuration mode
    idg(config)# user-password
    Enter old password: **********
    Enter new password: ******
    Re-enter new password: ******
    Password for user 'admin' changed
    Cleared RBM cache
    idg(config)# exit
    idg# eConnection closed by foreign host.
    DataPower password successfully set
  4. Set initial password for RapidDeploy user “mvadmin“. Hit [return] to accept the default of the instance id.
    Configuring password for RapidDeploy default user 'mvadmin'
    Set password for user 'mvadmin'. Submit blank for default value of the instance id: mvadmin
  5. Open required firewall ports on Red Hat Linux firewall. Select ‘y’ and hit [return].
    Open firewall ports for RapidDeploy (port 9090) and DataPower (port 9990) [y/n]?
  6. The wizard finishes with the following output:
    Configuration finished, you may now start using DataPower (port 9990) and RapidDeploy (9090) service.
    DataPower: https://[publicip]:9990
    RapidDeploy: [publicip]:9090/MidVision

4. Accessing the web consoles

4.1 Access the IBM DataPower Gateway Console

To confirm installation, access the DataPower Gateway Console at:
https://[publicip]:9990/
You can log in to the console as “admin” using your ‘mvadmin‘ as password. This is the default password unless you changed it as part of section 3 above.

4.2 Access the RapidDeploy web console

RapidDeploy server and agent will start up automatically when you start your instance. You can access the web console on:

http://[publicip]:9090/MidVision

Note: make sure you have port 9090 open in your VM ports when trying to access RapidDeploy web console. For the first time, you can set the password for the default username ” mvadmin “.

You can prevent auto starting RapidDeploy on instance startup by removing it from the system chkconfig list.

[midvision@ ] systemctl disable rapiddeploystart.service
 

5. Maintaining the installation

The following sections cover some of the activities you might want to perform after the instance has been started.
  • azureuser: This is the provisioned Azure user. The username can vary due to can be customised. It is permitted to use all SUDO rights. To switch to the midvision user, type “sudo su - midvision“.
  • midvision:  This is the default user, which you can log in as. It is permitted to use all SUDO rights. To switch to the root user, type “sudo su“.
  • root:              This is the superuser in linux systems. You can log in as any other user without using passwords. E.g: “su azureuser“, “su midvision

CentOS instances are shipped with a firewall by default to protect your machine. For security reasons, the instance is only accessible via SSH (port 22) at first, so further ports can be opened on the firewall as needed. You will need to open all the ports in this internal firewall, which you have open in your Security group. There is a script placed in the user home of midvision (/home/midvision), which is also the starting location when logged in. You will need to be the root user to run this script. Example usage:

[midvision@ ] sudo ./open-firewall.sh 9990
Open firewall port 9990 iptables: Saving firewall rules to /etc/sysconfig/iptables:[ OK ]
 

There are a few scripts and other files in midvision and root users home directory, which will need to remain unchanged in order to keep the provided scripts working. There are a set of scripts in midvision home directory. Those scripts are executed when logging into the instance controlled by  .bash_profile , but you can also execute them manually whenever they are needed. There are some hidden files used as well,  .firstrun  indicates that the setup wizard has already ran once,  .dontask  indicates that the user will not be prompted again for running the setuphost script (if chosen not to ask again), .host file is needed to determine the previously bound hostname to WebSphere service.

To restart RapidDeploy manually from the filesystem, use the rapiddeploy linux service. The RapidDeploy version is 5.0.3. RapidDeploy home is located at /var/rd/midvision Example usage:

[midvision@ ] sudo service rapiddeploystart start 
[midvision@ ] sudo service rapiddeploystart stop

The RapidDeploy server uses an in-memory database, so your RapidDeploy framework needs to be shut down properly to save your work. This happens when the instance is stopping or when calling the stop service manually from the command line. Note that on instance restart, unsaved data will be lost.

For security reasons, you will need to change the default password (default value is ‘mvadmin‘) for user mvadmin. This will be requested the first time only when you log in to the RapidDeploy server.

6. Troubleshooting

6.1 Session loss during setup

If you lose your SSH connection to the target instance during the first run setup script execution (e.g. as a result of a network problem), we advise you to delete and recreate the EC2 instance and run the script again.

6.2 Cannot access the IBM DataPower Virtual Edition Gateway Console

Check that the default server is running, and you have correctly opened all the required ports on the firewall, especially 9990, and that your instance was created using a security group definition that allows TCP access to the instance on the required ports.

6.3 Contacting MidVision support

Please visit our support website.