IBM App Connect Enterprise on AWS

Amazon EC2 Installation guide

1. Overview

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

This AMI contains a ready-to-run IBM App Connect 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, Integration Servers, Message Flows, Listeners, etc.

Visit the IBM App Connect Enterprise page on the AWS Marketplace

2. Launching an instance

In order to launch IBM App Connect Enterprise (referred as ACE), a few settings need to be configured on the AWS console as follows. The instructions for launching an instance differ depending on where you launch it from. Initially you will launch the instance from the AWS Marketplace.

 

  • Select the IBM WebSphere Product based on your requirements in the AWS Marketplace;
  • Click on the link to go to the versions page in the AWS Marketplace;
  • Check the ‘Other Versions ‘ link to see other versions available (you can select the actual version later);
  • Under ‘Pricing Details‘ panel select your Region and either Hourly or Yearly fees;
  • Click on the ‘Continue‘ button to go to the ‘1-Click Launch‘ tab on the configuration page;
  • On the ‘Software Pricing‘ panel choose your instance type and pricing type;
  • On the ‘Version‘ panel, select the fix pack version you require;
  • On the ‘Region‘ panel, select the Region you require;
  • On the ‘EC2 Instance Type‘ panel, choose the instance type. The m3.medium type or larger is recommended when running IBM App Connect. Larger instances may be required based on the number of Integration Nodes, etc, required and the expected resource use of each;
  • On the ‘VPC Settings‘ panel configure the VPC settings to your requirements or leave the defaults;
  • 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 WebSphere]:
    Port 22 to connect via SSH (enabled by default), 
    Port 9090 to reach RapidDeploy web console, 
    Port 4445 to reach the ACE web UI,
    Port 5951 if using the remote toolkit, Port 20000 and 20100 to open for RapidDeploy Remote Agent (optional)
     
    • If you don’t already have a security group as above, go to your EC2 Control Panel and select ‘Security Groups‘ under ‘Network & Security‘.
    • Click ‘Create Security Group‘ button.
    • To open all ports, Click ‘Add Rule‘.
    • In the ‘Type‘ dropdown, Specify ‘All TCP‘ or your preferred configuration.
    • In the ‘Source‘ dropdown, Specify ‘Anywhere‘ or your preferred configuration.
  • On the ‘Key Pair‘ panel, select a key pair to use. You will need this key later to connect to the instance;
  • Scroll back to the top of the page and click ‘Accept Software Terms and Launch with 1-Click‘;
  • The Instance will be launched;
  • 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);
  1. Select the IBM App Connect 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 App Connect. Larger instances may be required based on the number of Integration Nodes, etc, required and the expected resource use of each; Click ‘Next: Configure Instance Details‘;
  4. On the ‘Configure Instance‘ tab configure the instance to your requirements or leave the defaults. Click ‘Next: Add Storage‘;
  5. On the ‘Add Storage‘ tab, add additional storage as required or leave as default. Click ‘Next: Tag Instance‘;
  6. On the ‘Tag Instance‘ tab, tag your instance with a suitable name. Click ‘Next: Configure Security Group';
  7. On the ‘Configure Security Group‘ tab, specify the security group. The security group needs to permit to following ports:
    Port 22 to connect via SSH (enabled by default), 
    Port 9090 to reach RapidDeploy web console, 
    Port 4445 to reach the ACE web UI,
    Port 5951 if using the remote toolkit, Port 20000 and 20100 to open for RapidDeploy Remote Agent (optional)
     
    • To open all ports, click ‘Add Rule‘.
    • In the ‘Type‘ dropdown, specify ‘All TCP‘ or your preferred configuration.
    • In the ‘Source‘ dropdown, specify ‘Anywhere‘ or your preferred configuration.
  8. Click ‘Review and Launch‘;
  9. Review settings, then click ‘Launch‘;
  10. Add your key pair, check the ‘Acknowledge key file access’ checkbox and click ‘Launch Instance‘;
  11. 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 and setup

The IBM App Connect 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 a sample integration node and integration server, 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 the 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” (if your ACE instance contains an IBM MQ installation use “mqm” as username), using the previously (instance launch-time) selected .pem keyfile.
    • Via SSH from your terminal, 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 into 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


    MQSI 11.0.0.1
    /opt/IBM/ace-11.0.0.1/server

    Welcome, this is the MidVisionCloud IBM App Connect AMI first run configuration.

    Configuration steps:

    1. Create and start an IBM App Connect sample server.
    2. Set RapidDeploy framework initial password.
    3. Open ports on RHEL firewall.

    Create and start an IBM App Connect sample server? [y/n]
  3. 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 App Connect. After logging onto the instance via SSH as the ‘midvision’ (or ‘mqm’) 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 App Connect sample server.
    2. Set the initial password for the 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 and 4445 for the sample integration node web user interface.

    Please refer to IBM documentation for IBM App Connect Enterprise configuration.

4. Accessing the web consoles

4.1 Accessing the ACE interface

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

http://[publicip]:4445

You can log in to ACE console as “midvision”  (or “mqm” if you choose an ACE with MQ product) using your ‘[instance-id]‘ as the password.

Please refer to the ACE documentation for further usage information (https://www.ibm.com/support/knowledgecenter/SSTTDS_11.0.0/com.ibm.ace.home.doc/help_home.htm).

4.2 ACE Licensing

The ACE 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. 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 ACE documentation for more specifics. 

[midvision@ ] mqsimode –o

4.3 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 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 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.
  • 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“.
  • [mqm]: This is the default user for AMIs where both ACE and MQ are installed, 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.

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

[midvision@ ] mqsistart
[midvision@ ] mqsistop

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/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 9090
Open firewall port 9090 iptables: Saving firewall rules to /etc/sysconfig/iptables:[ OK ]
 

There are a few scripts and other files in midvision (or 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 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.9. 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 ‘[instance-id]‘) 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 ACE admin console

Check that the default server is running, and you have correctly opened all the required ports on the firewall, 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.