Skip to content

Installing Volt MX Foundry on a Standalone Mode in Bundled JBoss

Note:  If a user installs Volt MX Foundry Console on a partition different from the user's home directory, the user must have read/write execute permissions.

This section of the document provides you with the instructions for installing and configuring Volt MX Foundry Console.

Important:  Ensure that you have the required hardware and access to the supporting software as mentioned in the Prerequisites section and performed the steps as mentioned in the Pre-installation Tasks section.

Make sure you have proper administrative rights to install Volt MX Foundry on your computer.

You also need a user where Volt MX Foundry will be installed.

The \<Install Location> directory contains the log files logging each invocation of the installer. To make problem identification easier, provide these log files to Volt MX when reporting an issue.

Accessing the live installation logs while the installation is running

  • Note: "tmp" directory is available inside JBoss_Home location.
  • During the installation, all the live logs will be created in the "tmp" directory, with the file name prefixed as "lax-" followed by timestamp. These are the two installation log files:
    • lax-12347050814474460129-out.tmp
    • lax-24487050814400678962-err.tmp
    installation_log_files_1
  • Note: These two files are important if there is any interruption to the installation, and due to which these files will not be merged into a single log file.
  • Tailing live log files during installation:

    To tail the live log files during installation, run the following command:


    tail -f lax-12347050814474460129-out.tmp tail_log_files_1 tail_log_files_2 tail_log_files_3
  • Once installation is done, these two log files will be merged and stored in the installation directory, with the file name prefixed as "Volt_MX_Foundry_Install_" followed by timestamp. merged_log_files_1
  • Reading log files once installation is completed:

    To read the log files once installation is completed, run the following command:


    vi Volt_MX_Foundry_Install_09_28_2021_23_02_07.log reading_log_files_1 reading_log_files_2 reading_log_files_3 reading_log_files_4 reading_log_files_5


To install Volt MX Foundry Console on bundled JBoss using the installer, follow these steps:

  1. Execute the following command to switch to the user that you created.

    # su - username

  2. Press Enter. The system prompt you to enter the password.

  3. Enter the password, and press Enter.
  4. Unzip the VoltMXFoundrySetup.tar.gz file, and navigate to the folder VoltMXFoundry_Installer_Linux.
  5. Start the ./VoltMXFoundryInstaller-x.x.x.x_GA.bin file by executing the following command:

Preparing to install...
Extracting the JRE from the installer archive...
Unpacking the JRE...
Extracting the installation resources from the installer archive...
Configuring the installer for this system's environment...

Launching installer...

\===============================================================================
Volt MX Foundry (created with InstallAnywhere)
-------------------------------------------------------------------------------
Preparing CONSOLE Mode Installation...
\===============================================================================
Introduction
------------
This installer will install a new or upgrade an existing instance of Volt MX Foundry.

Volt MX Foundry is a set of enterprise-grade mobile infrastructure services that makes it easy to build amazing apps that integrate and support all of your backend systems. With open, standards-based development, scalable and secure services, and exceptional agility, enterprises can dramatically reduce the cost and complexity of enterprise mobility projects.

To proceed with installation, please confirm that the following prerequisites have been met -

1. Database server for installation. MySQL, MariaDB, Oracle, and MS SQL Server are the supported databases. MariaDB is supported for Tomcat/JBoss only.
 2. Corresponding database user should exist and that user should have all required     
    privileges as per the documentation.
 3. If you want to use your existing SSL certificate then please have the SSL certificate
    mapped to the domain name you want to use.
4. If you want to install with JBoss as an option for application  server, then have the application server preconfigured. Please note that single node JBoss is also bundled as part of the installer, in case you want to install afresh.

To change input, type 'back' to go back to the previous step.
To cancel the installation, type 'quit' at any time.

For getting started on Volt MX Foundry, refer http://community.hclvoltmx.com/documentation

For upgrading Volt MX Foundry, refer online documentation.

If you have more questions or feedback, you can join our http://community.hclvoltmx.com/ or, raise a http://support.voltmx.com/.

->1- Continue with Installation.
   2- Abort Installation.

ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS TO ACCEPT THE DEFAULT:

  1. Press Enter. The Software License Agreement  details appear.

    \========================================================================
    License Agreement
    -----------------
    Installation and Use of Volt MX Foundry Console Requires Acceptance of the Following License Agreement:

    VOLTMX, INC.
    SOFTWARE LICENSE AGREEMENT

    THE TERMS AND CONDITIONS CONTAINED HEREIN CONSTITUTE A LEGAL AGREEMENT.

    THIS AGREEMENT ("AGREEMENT") CONTAINS THE ENTIRE AGREEMENT BETWEEN YOU ("LICENSEE") AND VOLTMX, INC. ("VOLTMX") WITH RESPECT TO THE TERMS AND CONDITIONS DESCRIBED HEREIN. READ THIS AGREEMENT CAREFULLY BEFORE YOU CLICK THE "I ACCEPT" BUTTON BELOW. BY CLICKING ON THE "I ACCEPT" BUTTON, YOU ACKNOWLEDGE THAT (1) YOU ARE AUTHORIZED TO ENTER THIS AGREEMENT FOR AND ON BEHALF OF YOUR COMPANY, AND ARE DOING SO, AND (2) YOU HAVE READ AND UNDERSTAND AND AGREE THAT YOU AND THE COMPANY SHALL BE BOUND BY THESE TERMS AND CONDITIONS AND ALL MODIFICATIONS AND ADDITIONS PROVIDED FOR. IF YOU DO NOT AGREE WITH THESE TERMS AND CONDITIONS, CLICK ON THE "I DO NOT ACCEPT" BUTTON BELOW AND INSTALLATION WILL TERMINATE.

    DO YOU ACCEPT THE TERMS OF THIS LICENSE AGREEMENT? (Y/N): Y

  2. Press Enter to continue with new installation.

    The following installation types are supported for new installation:

    • Development for single machine instance.
    • Non-Production for larger environments like QA or UAT.
    • Production for the production instance.

    \===============================================================================
    Licensing Type
    --------------

    Please select the type of environment you want to install. Development – Single server instance typically used for development Non-Production – A multi-server environment for testing or staging environments Production – A full production-grade environment

    1- Development
         2- Non-Production
       ->3- Production

    ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

  3. Enter your choice and press Enter. The Send Usage Data Anonymously details appear. Allows HCL to collect product usage information to make your Volt MX Foundry experience better. HCL does not save any of your private or application data.

    \=============================================================================== Send Usage Data Anonymously -------------- ------------

    Help us make your Volt MX Foundry experience better by allowing us to collect product usage information. We will not save any of your private or application data.

    Send usage data anonymously.

    ->1- Yes      2- No

    ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

  4. Enter your choice and press Enter. The Install Components details appear.

    \======================================================================= Install Components ------------------ Please select Volt MX Foundry components to install. The Console is the administrative interface to manage your apps, environments and users. The Identity Services helps you to use a single gateway for all your authentication and authorization requests. The Integration Services helps you connect with any enterprise or third-party system to expose, transform and orchestrate your data as APIs. The API Developer Portal is a console that enables partner teams to discover, test and consume APIs. Engage your app users over sms, email and push using segmentation, location, campaigns and event driven messaging. A specialized component used to manage offline data synchronization between the backend system of record and the front-end app. Console, Identity and Integration Services are mandatory components of Volt MX Foundry. In a development scenario, all components can be installed on the same server. However, it is recommended to install these components on separate servers for a production environment.

    ->1- Console   ->2- Identity Services   ->3- Integration Services   ->4- API Development Portal   ->5- Engagement Services

    ENTER A COMMA-SEPARATED LIST OF NUMBERS REPRESENTING THE DESIRED CHOICES, OR PRESS TO ACCEPT THE DEFAULT::

    • Console - To install Volt MX Foundry Console, type 1 and press Enter. The system creates the following databases: <prefix>mfconsoledb<suffix>, <prefix>mfaccountsdb<suffix>, and  <prefix>mfreportsdb<suffix>.
    • Identity Services - To install Volt MX Identity Services, type 2 and press Enter. The system creates the following database: <prefix>idconfigdb<suffix>.
    • Integration Services - To install Volt MX Foundry Integration, type 3 and press Enter. The system creates the following databases: voltmxadmindb  and  mfreportsdb.
    • API Developer Portal - To install developer portal, type 4 and press Enter.

    Note: During installation if you have selected API Developer Portal, the API Developer Portal is created. You can directly access your VoltMX Developer Portal in Volt MX Foundry Console.

    • Engagement Services - To install Volt MX Foundry Engagement Services, type 5 and press Enter. The system creates the following database: <prefix>vpnsdb<suffix>.

    Reports Database

    The reports database is used for configuring reports.

    The Installer creates the mfreportsdb if you choose either Console or Integration Services:

    • Console without Integration Services (with or without Engagement Services)
    • Console and Integration Services (with or without Engagement Services)
    • Integration Services without Console (with or without Engagement Services)

    Reports Database for Integration on a Separate Node:

    While installing console and integration on separate nodes, the installer prompts you to point the reports database during the integration installation.

    For example:

    You have installed only Console on one node. The installer creates these three databases such as <>mfreportsdb<> along with the <>mfconsoledb<> and <>mfaccountsdb<>. For example, your report database name is voltmxmfreportsdb1

    When you install the integration with or without one or more components (identity, or Engagement Services) on a separate node, the installer displays the Reports Database Name field in the Database Details window. If the installer prompts you to enter the existing reports db, enter the reports database name (for example, voltmxmfreportsdb1) in the Database Details window > Reports Database Name field.

    Refer to creating a reports database, for example, mfreports.

  5. Press Enter to continue the installation. The Install Folder details appear.

    \======================================================================= Install Folder ---------------------

    Please choose a destination folder for this installation.

    NOTE: The installation path should not contain any special characters.

    Default Install Folder: /home/user1/VoltMXFoundry

    ENTER AN ABSOLUTE PATH, OR PRESS TO ACCEPT THE DEFAULT :

    Note:  By default, Volt MX Foundry is installed at the home directory of the user.

  6. Press Enter to continue the installation. The installer prompts for the Application Server details as follows:

    \=============================================================================== Application Server ------------------

    Enter requested information ->1- Tomcat    2- JBoss

    ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

  7. In the Application Server, type 2.

    Note: By default Tomcat manager password in used by Volt MX Foundry for Web Application publish. To change the default Tomcat manager password, the new password needs to be replaced in the password value for user manager in <tomcat-users> tag in tomcat-users.xml.

    Now to replace the value in database, the password value should be encrypted. To encrypt the database password, follow these steps mentioned in the Encrypt_Passwords section.

    Once the password is encrypted, replace the encrypted value in the prop_value column in the row where prop_value is management_server_password of <DatabasePrefix>admindb<DatabaseSuffix> database in the server_configuration table.

  8. Press Enter to continue the installation. The Installation Mode details appear.

    \=============================================================================== Installation Mode ----------------- Please select your required installation mode. Standalone mode is for single node deployment whereas domain mode is for multi node deployment in JBoss cluster. Please note that if you want to install in domain mode then JBoss cluster should be preconfigured.

    Note: If you are running JBoss in Domain node for a production setup, please procure appropriate licenses from Red Hat, Inc.

    ->1- Standalone Mode (Single Node)    2- Standalone Mode (Existing)    3- Domain Mode (Multi Node)

    ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

    • Standalone Mode (Single Node): To install Volt MX Foundry on single node on JBoss that is bundled with the Volt MX Foundry installer, chooseStandalone Mode (Single Node).
    • Standalone Mode (Existing): To install Volt MX Foundry on single node on JBoss that is installed on your machine, choose Standalone Mode (Existing). For more details on how to install Volt MX Foundry on the existing JBoss, refer to Installing Volt MX Foundry on a pre-configured standalone JBoss - (Single Node).
    • Domain Mode (Multinode): To install Volt MX Foundry on JBoss multinode, choose Domain Mode. Before installing domain mode, ensure that the JBoss cluster is configured on your install system. For more details on how to install Volt MX Foundry on Domain mode, refer to JBoss Multinode Installation Procedure.

    Important: Before installing Volt MX Foundry on domain mode, ensure that the JBoss cluster is configured on your install system.

  9. In the Installation Mode if you type 1 and press Enter, the HTTP or HTTPS details appear.

    \======================================================================== HTTP or HTTPS ------------- Please select the communication protocol you want to use. We recommend that you use HTTPS in production environment. ->1- HTTP    2- HTTPS

    ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

  10. In HTTP or HTTPS  if you select 1 and press Enter, the following details in the Details for Application Server details appear.

    \===============================================================================
    Details for Application Server
    ------------------------------
    \=============================================================================== Please enter the Hostname/IP Address and port you want to use. The default value is the IP Address of this machine.

    Hostname/IP Address (Default: ):

    HTTP Port (Default: 8080): 8181

  11. In the HTTP or HTTPS, if you type 2 and press Enter, the following details in the Details for Application Server details appear.

    \===============================================================================
    Details for Application Server
    ------------------------------

    Please enter the Hostname/IP Address and port you want to use. The default value is the IP Address of this machine.

    NOTE: If you want to use your existing SSL certificate then please have the SSL certificate mapped to the domain name you want to use.

    Hostname/IP Address (Default: ):

    HTTP Port (Default: 8080):

    HTTPS Port (Default: 8443):

    Important: After installing Volt MX Foundry, import your SSL certificate (for example, domain.subdomain.crt) into your Volt MX Foundry installer's JRE trusted certificate authority (CA) certificates file - for example, <INSTALL_DIR>/jre/lib/security/cacerts

    If your SSL certificate is not configured, the system displays an error - for example, "peer not authenticated".

    For details, refer to Troubleshoot with SSL Certificate Issues.

    Note:  Based on the inputs provided in the previous  HTTP or HTTPS  >  a  or  HTTP or HTTPS  >  b, one of the following error messages appears:

    • If a port is already in use, the installer displays the following error message:

    \===============================================================================
    Validation of Host Detail
    -------------------------
    Port 22 is already in use.

    Please provide a different port.

    ->1- Go back to give valid input.
       2- Abort Installation.

    ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS TO ACCEPT THE DEFAULT:

    • If you provide an invalid port, the installer displays the following error message:

    \===============================================================================
    Port Validation
    ---------------
    Please enter a valid port. Port should be in between 1-65535.
    ->1- Go back to give valid port.
       2- Abort Installation.

    ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

    • If you provide an invalid Hostname/IP address, the installer displays the following error message:

    \===============================================================================
    Invalid Hostname/IP Address
    ---------------------------

    Please enter a valid hostname/IP address.

    ->1- Go back to give valid details.
       2- Abort Installation.

    ENTER THE NUMBER OF THE DESIRED CHOICE, OR PRESS TO ACCEPT THE DEFAULT:

  12. Provide the Hostname/IP Address, HTTP Port, and HTTPS Port, and press Enter. The SSL Configuration for HTTPS Communication details appear only if you select HTTPS. Choose one of the following two options:

    \======================================================================== SSL Configuration for HTTPS Communication -----------------------------------------

    Please select the appropriate option to proceed.

    ->1- Create self-signed certificate    2- Provide SSL certificate

    ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

    1. In the SSL Configuration for HTTPS Communication, if you select 1, the Details for self-signed SSL Certificate details appear.

      Important: To add an existing SSL certificate to cacerts file, refer to How to Add Your Existing SSL Certificate.

      \======================================================================== Details for self-signed SSL Certificate -----------------------------------------

      Please provide the following details to create self-signed certificate. All the fields are mandatory.

      Please note that the path of self-signed certificate will be  /root/VoltMXFoundry/keystore.jks.

      Organizational Unit (DEFAULT: ): platform

      Host Name (DEFAULT: ): hcl.com

      Company (DEFAULT: ): Volt MX

      City (DEFAULT: ): HYD

      State (DEFAULT: ): AP

      Country (DEFAULT: ): IND

      Note: The path for a self-signed certificate will be in this location: <install folder>\keystore.jks

    2. In the SSL Configuration for HTTPS Communication, if you select 2, the SSL Certificate Details details appear.

      Note: Provide path for .jks file as input.

      \======================================================================== SSL Certificate Details ----------------------- Please provide the following details

      Absolute Path to Keystore File (Default: ): /downloads/_.hcl.net.2016.jks

    3. Type the details. The installer prompts for Password for keystore file details as follows:

      \======================================================================== Password for keystore file -----------------------------------------

      Password should contain minimum six characters and should not contain space.

      Please enter the password:

      • If you enter an incorrect password -- for example, one that is fewer than six characters, contains a space, or is empty -- the following error message for an invalid keystore password is displayed.

      \======================================================================== Password for keystore file -----------------------------------------

      \======================================================================== Invalid Keystore Password ------------------------- Keystore password must be at least six characters and should not contain space.

      PRESS TO ACCEPT THE FOLLOWING (OK):

  13. Type the password.

  14. Press Enter. The Database Choice details appear:

    \======================================================================== Database Choice ----------------------------------------- Please select the database provider of your choice.

    ->1- MySQL 5.7

    2- MySQL 5.7 Cluster - Group Replication

    3- Oracle 19c (19.3.0)

    4- SQL Server 2017

    5- MariaDB 10.3. 13

    ENTER THE NUMBER FOR YOUR CHOICE, OR PRESS TO ACCEPT THE DEFAULT::

  15. In the Database Choice, choose the DB:

    • In the Database Choice if you select 1, the MySQL Database Details appear.

    \======================================================================== MySQL Database Details -----------------------------------------

    Please enter MySQL database server details

    Database Server IP (DEFAULT: localhost):

    Port (DEFAULT: 3306):

    Username (DEFAULT: ): root

    1. Enter the following details:
      • Database Server IP: Enter the server Hostname/IP to be used to create a database of selected components of Volt MX Foundry. By default, the server Hostname/IP is set as localhost.
      • Port: Enter the database port of the MySQL Server. By default, this field is set to 3306 for MySQL.
      • Username: Enter the user name used while creating the database user - for example, dbclient.
    2. Provide a password and press Enter.

      • If the database connection fails, the following error message displays.

        \=============================================================================== Database Connection Failed -------------------------- Database connection failed.

        For the following reasons: Communications link failure

        The last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.

        PRESS TO ACCEPT THE FOLLOWING (OK):

      • If the database server not compatible, the following error message displays:

        \=============================================================================== Incompatible Database Server Version ------------------------------------ Minimum requirement for MySQL database server is 5.7.

        PRESS TO ACCEPT THE FOLLOWING (OK):

    3. In the Database Choice if you select 2, the Oracle Database Details appear.

    \======================================================================== Oracle Database Details -----------------------------------------

    Please enter Oracle database server details.

    Database Server Hostname/IP (Default: 10.10.24.51):

    Port (Default: 1521):

    Service ID / Service Name(Default: ):

    System Username (Default: ):

    1. Enter the following details:

      • Database Server IP: Enter the server Hostname/IP to be used to create a database of selected components of Volt MX Foundry. By default, the server Hostname/IP is set as localhost.
      • Port: Enter the database port of the Oracle Server. By default, this field is set to 1521 for oracle.
      • Service ID / Service Name: Enter Oracle service ID or service name. Service ID is unique alias given to an instance name of Oracle DB.

      • System Username: Enter the user name used while creating the database user.

    2. Press Enter. The installer prompts for Enter Password for Database User details as follows:

      \======================================================================== Enter Password for Database User ----------------------------------------- Please enter the password:

    3. Provide a password and press Enter.

      • If the database connection fails, the following error message displays.

        \=============================================================================== Database Connec