IBM Integration Bus Express Edition

Amazon EC2 Installation Guide

This guide will provide step by step instructions how to startusing the installed products on your AWS EC2 instance

1. Overview

This AMI contains a ready-to-run IBM Integration Bus image at the selected version. In order to use this image, you need to launch it with your selected type, and log in via SSH to create and configure required Integration Nodes, Message Flows and Listeners etc. 

2. Launching an instance

2.1 From the AWS Marketplace

  1. Select the IBM WebSphere Product based on your requirements in the AWS Marketplace;
  2. Click on the link to go to that versions page in AWS Marketplace;
  3. Check the 'Other Versions' link to see other versions available (you can select the actual version later).
  4. Under 'Pricing Details' panel select your Region and either Hourly or Yearly fees.
  5. Click on the 'Continue', button to go to the '1-Click Launch' tab on the configuration page;
  6. On the 'Software Pricing' panel choose your instance type and pricing type;
  7. On the 'Version' panel, select the fix pack version you require;
  8. On the 'Region' panel, select the Region you require;
  9. On the 'EC2 Instance Type' panel, choose the instance type. The m3.medium type or larger is recommended when running IBM Integration Bus. Larger instances may be required based on the number of IBM Integration Nodes etc required and the expected resource use of each;
  10. On the 'VPC Settings' panel Configure the VPC settings to your requirements or leave the defaults;
  11. On the 'Security Group' panel, specify the security group. The security group needs to permit to following ports [note that the internal firewall will be configured later to permit only ports used by IIB and RD]:

    1. Port 22 to connect via SSH (enabled by default),
    2. Port 9090 to reach RapidDeploy web console,
    3. Port 4445 to reach the IIB WebUI,
    4. Port 5951 if using the remote toolkit,
    5. Port 20000 and 20100 to open for RapidDeploy Remote Agent (optional)
    1. If you don't already have a security group as above, go to your EC2 Control Panel and select 'Security Groups' under 'Network & Security'
    2. Click 'Create Security Group' button
    3. To open all ports, Click 'Add Rule'. 
    4. In the 'Type' dropdown, Specify 'All TCP' or your preferred configuration.
    5. In the 'Source' dropdown, Specify 'Anywhere' or your preferred configuration.
  12. On the 'Key Pair' panel, select a key pair to use. You will need this key later to connect to the instance.
  13. Scroll back to the top of the page and click 'Accept Software Terms and Launch with 1-Click'.
  14. The Instance will be Launched.
  15. We strongly recommend that once launched, you assign an elastic IP address to the running instance before logging in for the first time to set up the profile(s).

2.2 From the AWS EC2 Control Panel

  1. Select the IBM WAS AMI based on your requirements;
  2. Right click on the AMI, or from the drop down menu, choose the ‘Launch’ option;
  3. On the 'Choose Instance Type' tab, choose the instance type. The m3.medium type or larger is recommended when running IBM Integration Bus. Larger instances may be required based on the number of IBM Integration Nodes etc required and the expected resource use of each;
  4.  Click 'Next: Configure Instance Details'.
  5. On the 'Configure Instance' tab, configure the instance to your requirements or leave the defaults. Click 'Next: Add Storage'.
  6. On the 'Add Storage' tab, add additional storage as required or leave as default. Click 'Next: Tag Instance'.

  7. On the 'Tag Instance' tab, Tag your instance with a suitable name. Click 'Next: Configure Security Group'.

  8. On the 'Configure Security Group' tab, specify the security group. The security group needs to permit to following ports:

    1. Port 22 to connect via SSH (enabled by default),
    2. Port 9090 to reach RapidDeploy web console,
    3. Port 4445 to reach the IIB WebUI,
    4. Port 5951 if using the remote toolkit,
    5. Port 20000 and 20100 to open for RapidDeploy Remote Agent (optional)
    1. To open all ports, Click 'Add Rule'. 
    2. In the 'Type' dropdown, Specify 'All TCP' or your preferred configuration.
    3. In the 'Source' dropdown, Specify 'Anywhere' or your preferred configuration.
  9. Click 'Review and Launch'.
  10. Review settings, then click 'Launch'.
  11. Add your key pair, Check the 'Acknowledge key file access' checkbox and click 'Launch Instance'.
  12. We strongly recommend that once launched, you assign an elastic IP address to the running instance before logging in for the first time to set up the Node(s).

3. Initial login

The IBM Integration Bus products are shipped with a base binary installation but without the necessary Integration Nodes created. On the first login to the instance, you will be placed into a console wizard, which will guide you through the process of creating and starting IBM Integration Nodes and other configuration steps. The following is an overview of the steps you will be guided through to get started with the installed products on the instance.

Once the instance has started up (you can see it by having "2/2 checks passed " in EC2 console).

  1. Log onto the instance from the EC2 console or via SSH as the ‘midvision’ user, using the key you selected above.  For example:

    • From the EC2 console by clicking the "Connect to your instance" button with username "midvision", using the previously (instance launch-time) selected .pem keyfile.

    • Via SSH from your desktop, for example

      ssh -i ./MidVisionUSMC.pem midvision@ec2-52-87-198-23.compute-1.amazonaws.com
  2. You should see the MidVision banner and then you are placed in a setup wizard.

    Welcome to                                                                                                                                             
    
     __  __ _     ___     ___     _                    ____ _                 _
    |  \/  (_) __| \ \   / (_)___(_) ___  _ __        / ___| | ___  _   _  __| |
    | |\/| | |/ _` |\ \ / /| / __| |/ _ \| '_ \ _____| |   | |/ _ \| | | |/ _` |
    | |  | | | (_| | \ V / | \__ \ | (_) | | | |_____| |___| | (_) | |_| | (_| |
    |_|  |_|_|\__,_|  \_/  |_|___/_|\___/|_| |_|      \____|_|\___/ \__,_|\__,_|
    
                                                           A MidVision Service
    
            * WebSite: http://portal.midvision.com/page/cloud-applications
            * Support: http://support.midvision.com/redmine/projects/devtestcloud
            * Wiki:    http://support.midvision.com/redmine/projects/devtestcloud/wiki      
    
    
    Welcome, this is DevTestCloud Websphere MQ image first run configuration
    
    Note that you can rerun this configuration wizard again by executing /home/midvision/firstrunsetup.sh script
    
    Configuration steps
    1. Create and start an IBM Integration Bus server
    2. Set RapidDeploy framework initial password
    3. Open ports on RHEL firewall
    

On the first login to the instance, you will be placed into a console wizard, which will guide you through the process of creating and configuring IBM Integration Bus. After logging onto the instance via SSH as the ‘midvision’ user you will be placed in a setup wizard. The following is an overview of the steps you will be guided through to create the required profiles on the instance:

  1. Create and start an IBM Integration Bus server.
  2. Set initial password for RapidDeploy user "mvadmin".
  3. Choose which ports to open on Red Hat Linux firewall. You should open port 9090 for the RapidDeploy web console if required.

Please refer to IBM documentation for IBM Integration Bus configuration.

4. Accessing the installation

4.1 Accessing RapidDeploy User Interface 

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 Security group 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 list.

[midvision@ ] systemctl disable rapiddeploy.service

4.2 Accessing the IIB Interface

After the initial node creation upon first login, the user interface can be accessed via

http://[publicip]:4445
The user will be "midvision" and the initial password will be your instance ID of the VM. Please refer to the IIB documentation for further usage information.

4.2.1 IIB Licensing

The IIB node created as a part of the first login process will be created at your purchased licensing level. Each additional node MUST be created at your entitled level to comply with licensing restrictions (IE if one purchased “express”, then there is only one node allowed per VM etc). One can check their current license level per node from the command line. Where “integration_nodeName” is the name of the integration node to be queried. Please refer to the IBM IIB documentation for more specifics. IIB10 Licensing  IIB9 Licensing.  

[midvision@ ] mqsimode --o

5. Maintaining the installation

5.1 Changing  the RapidDeploy initial password

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 instance. Be careful because if you choose default option the password will be changed into 'instance-id'

5.2 Users

  • 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 ec2-user", "su midvision"
  • ec2-user:  This user does not have SUDO rights. If you want to switch back to root user, type "exit", this will take you back to the previous user session.

5.3 Opening Red Hat Entreprise Linux firewall with the openfirewall.sh script

RHEL 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/mqm), 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 9090

Open firewall port 9090 iptables: Saving firewall rules to /etc/sysconfig/iptables:[ OK ]

5.4 Starting and stopping RapidDeploy manually

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

[midvision@ ] sudo service rapiddeploy start

[midvision@ ] sudo service rapiddeploy 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.

5.5 Starting and stopping IIB nodes manually

To restart an IIB node from the command line, use the mqsi commands on the midvision users $PATH.
Example usage:

[midvision@ ] mqsistart

[midvision@ ] mqsistop

5.6 Files used for DevTestCloud services

There are a few scripts and other files in mqm 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 mqm 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 run once.

6.0 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 Contacting MidVision support

Please visit our  support website.