Installing initial Global Mailbox node on Sterling B2B Integrator

Install the initial Global Mailbox node on Sterling B2B Integrator to use Global Mailbox capabilities.

Before you begin

Complete the following tasks before you install the initial Global Mailbox node with the user interface:
  • Complete your topology and installation planning and keep it ready for reference. For more information on topology planning, see Planning the topology and Planning your installation.
  • Complete Phase 1 and phase 2 tasks specified in Global Mailbox installation sequence .
  • Download IBM® JDK from IBM Fix Central or IBM Passport Advantage and install.
  • Set the appropriate path for the JDK. For more information, see Setting Java variables on Linux, Setting Java variables on Windows, and Setting Java variables on AIX.
  • Download the Sterling B2B Integrator V6.0 or later package from IBM Fix Central or IBM Passport Advantage.
  • Extract the package to a folder, go to the media directory and locate the following files:
    • IM_<operating system>.zip in the InstallationManager folder
    • Common_Repo.zip
  • Extract the files to a common directory. After you extract the files, the directory must have the following subdirectories:
    • IM_<operating system>
    • b2birepo
    • gmrepo
  • For UNIX or Linux operating systems, set the ulimit and language as follows:
    • ulimit -n 4096
    • ulimit -u 16000
    • export LANG=en_US
  • Keep the host names or IP address and port numbers of the Cassandra, ZooKeeper, and WebSphere MQ nodes handy. You are prompted to enter this information as you proceed with the installation.
  • If you are using GPFS server as a shared storage in your setup, ensure that all instances of GPFS are up and running in the setup before installing.

About this task

Global Mailbox is supported on these platforms:
  • Windows
  • UNIX or Linux
  • AIX

The Global Mailbox instance that you install on an existing Sterling B2B Integrator V6.0 or later instance is registered with Sterling B2B Integrator, similar to the automatic registration when both are installed together. If the adapter containers are installed and configured on the existing Sterling B2B Integrator instance, they are used after installing Global Mailbox.

In Global Mailbox topology, the initial node is installed only one time. All subsequent installs are additional nodes. The subsequent installations can be second and subsequent nodes in the data center where you installed the initial node or first and subsequent nodes in other data centers. The initial node creates the database schema in Cassandra, which is allowed only one time across all nodes in all data centers.

To install the initial Global Mailbox node on an existing Sterling B2B Integrator V6.0 or later node with the user interface:

Procedure

  1. Open a command prompt and do one of the following tasks to start the Installation Manager:
    1. Go to the IM_<operating_system> directory and type ./userinst or userinst.exe (Windows) for the following scenarios:
      • If you do not have the Installation Manager installed and are using the Installation Manager agent provided with V6.0 or later.
      • If you have a 64-bit Installation Manager installed.
      • If you have the Installation Manager installed on a platform that has only one download available for Installation Manager. For example, AIX, HP, zLinux.
    2. Go to <installation directory>/Installation Manager/eclipse (for Windows system, replace / with \) and type ./IBMIM or IBMIM.exe (Windows), if you have 32-bit Installation Manager installed on a Linux or Windows system.
  2. On the Installation Manager home page, click Install.
    Important: If IM_<operating_system>, gmrepo, and b2birepo directories are not in the same directory or if you already have Installation Manager installed, then you get a message saying that there no packages to install or Installation Manager could not connect to the repositories. You must add the Global Mailbox and Sterling B2B Integrator repository files to the Installation Manager repository. For more information about adding repository files, see Repository preferences.
  3. On the Install Packages screen, select Global Mailbox. This action selects the versions also. Click Next.
    Important: Ignore the message that Global Mailbox package is already installed. That message is for Cassandra and ZooKeeper installation and not for the initial Global Mailbox node.
  4. From the list of installation directories, select the directory where Sterling B2B Integrator is installed and click Next.
    Restriction: The installation directory for the Global Mailbox node and Sterling B2B Integrator must be the same. You cannot proceed with the installation if you select another installation directory.
  5. Select Initial Global Mailbox Node and click Next.
  6. Enter the host name or IP address of the ZooKeeper nodes in all data centers and click Add. If the default client port number is not used when you installed the ZooKeeper nodes, change the port number.
    The Global Mailbox node that you are installing is a client. The client connects to the ZooKeeper nodes you define in this step. Zookeeper nodes are part of the Zookeeper ensemble that manages resource locks used by Global Mailbox.
    Important: When installing the initial Global Mailbox node, you must provide information about all the ZooKeeper, Cassandra, and WebSphere® MQ nodes in all the data centers. The ZooKeeper nodes that you are adding here must be started and running. ZooKeeper configuration information is stored in the global.properties file.

    If you do not want to connect to the ZooKeeper node or made a mistake when entering the node details, then you can choose to remove the node. To remove a node, select the node and click Remove. Removing the ZooKeeper node does not stop or uninstall the ZooKeeper node. If you remove a ZooKeeper node in this step, the Sterling B2B Integrator or Global Mailbox nodes do not connect to the node.

  7. Click Next.
  8. Complete the following steps to provide Cassandra, storage, replication, and WebSphere MQ topology configuration information. The Global Mailbox node that you are installing is a client, which connects to the nodes you define in this step.
    Important: When installing the initial Global Mailbox node, you must provide information about all the ZooKeeper, Cassandra, and WebSphere MQ nodes and storage configuration in all the data centers.
    1. Specify the host name or IP address of each Cassandra node and click Add.
      The Global Mailbox node that you are installing is a client. The client connects to the Cassandra nodes you define in this step. Cassandra nodes are part of the Cassandra cluster, which manages metadata replication in the Global Mailbox system.
      Important: The Cassandra nodes that you are adding here must be started and running. Cassandra configuration information is stored in the global.properties file.

      The Cassandra nodes that you specify in this step are initialized during the installation of the initial Global Mailbox node. Ensure that the Cassandra nodes are not preinitialized.

      If you specified a custom client port when installing Cassandra, specify the port number in this step. The client port is populated by default. Retain the default port number for all nodes. If you used a different port number when installing Cassandra, use that port number now.

      If you made a mistake when entering the host name or port or you do not want to connect to the node, then you can remove the Cassandra node. Removing the Cassandra node in this step does not stop or uninstall the node. To remove a node, select the node and click Remove. If you remove a Cassandra node here, the Sterling B2B Integrator or Global Mailbox nodes do not connect to that Cassandra node.

    2. Click Continue to Step 2.
    3. To define the shared storage location for each data center, select the data center, type the shared storage location for the data center, and click Add.
      Restriction: When installing Global Mailbox on a Windows server, you must specify the path to shared folder in the format <drive_name>:\<shared_foldername>. For example, C:\Storage or a mapped drive or Z:\Storage. A UNC path is not supported for Windows. When mounting mapped drives, you must follow the procedure specified in How to map network shares into drives to a Windows service permanently.

      When you install the initial Global Mailbox node, storage buckets (1st_provisioned and global_mbx) and the first variant (0) are created. By default, Global Mailbox uses the global_mbx bucket to store message payload. When installing the initial Global Mailbox node, you must specify the storage base path for all other data centers. After installing the initial Global Mailbox node, the storage buckets and the configuration information (global.properties and installinfo.properties files) are copied to the storage base path specified for other data centers.

    4. Type the Sterling B2B Integrator system passphrase that you specified when installing Sterling B2B Integrator. The passphrase is used to protect storage data.
    5. Confirm the passphrase.
    6. Type the Sterling B2B Integrator administrator account password and confirm the same.

      The Sterling B2B Integrator administrator account password is used by Global Mailbox to make REST calls for user lookup and event lookup REST services, which run on Sterling B2B Integrator. As Sterling B2B Integrator is already installed, you are prompted for the password here to register those lookup services for the Global Mailbox processes. When you are installing Sterling B2B Integrator and Global Mailbox together, you are not prompted for the administrator passphrase when providing details for Global Mailbox. The passphrase you provide when specifying details for Sterling B2B Integrator is used to register Global Mailbox processes.

    7. Click Continue to Step 3.
    8. Type the host name and port for the replication server:
      Local Host Name
      Default is the host name of the local machine.
      Secure Server Port
      Default is 33001.
    9. Click Continue to Step 4.
    10. Select the data center where you are installing the initial Global Mailbox node.
    11. Click Continue to Step 5.
    12. To define the WebSphere MQ topology for each data center, select the data center, type the host name or IP address, specify the port, and click Add.
      Important: You must provide the list of WebSphere MQ servers for each data center.

      The port is populated by default. If you had used a different port number when configuring the WebSphere MQ node, use that port number now. To remove the WebSphere MQ node, select the required node and click Remove.

    13. Click Continue to Step 7.
    14. To define the WebSphere MQ configuration, complete the following steps:
      Important: The queue name, channel name, user name, and password must be same across the WebSphere MQ cluster. The installer validates if it can establish connection with the queue that is specified here. At least one queue must be present and must be active per data center for the installation to proceed, else the installation fails. The WebSphere MQ configuration that is specified here is stored in the installinfo.properties file in the /config directory, along with the global.properties file.
      1. Select the data center name, type the queue manager name, and click Set.
      2. Type the queue name and channel name.
      3. Type the user name, who is authorized to use the queue.
      4. Type the password for the user name.
  9. Click Next.
  10. Click Install.
  11. Review the installation package summary information. Notice the installation progress in the Repository Information section.
  12. Click Finish.
    Important: The Cassandra schema is initialized by default during the installation of the initial Global Mailbox node.