meshIQ Platform DSX deployment pack – meshIQ

Follow the steps below to get started with meshIQ Platform DSX setup.

Before running this procedure, please verify the prerequisites below.

Prerequisites

Linux System

Operating System: Linux 64 bit OS, Ubuntu, RedHat (or equivalent, e.g. Fedora, CentOS, Rocky Linux, etc).
CPU: Minimum 4 virtual CPUs
Memory: Minimum 16 GB RAM
File System: Minimum 100 GB free space, SSD preferred
Recommended installation directory: /opt/meshiq

Some steps below require root access.

1. USERID:

Create the Linux user ID (UID) and group that will be used to start all meshIQ services.

The default user and group are meshiq:meshiq. This can be changed to any product owner user account.

The UID and group must own all files and directories under the installation directory, $APIN_HOME

2. SWAP:

We highly recommended that you turn off Swap within the operating system on all virtual machine servers running meshIQ.

To disable swap, perform the following:

a) Identify configured swap devices and files with the following command:

            cat /proc/swaps

b) Turn off all swap devices and files with the following command:

            /swapoff -a

c) Comment out any swap matching references found in /etc/fstab.

3. LIMITS:

Modify /etc/security/limits.conf and add the lines below for your user.

Replace meshiq with the user that will start meshIQ processes.

          meshiq           soft    nofile  65536
          meshiq           hard    nofile  65536

          meshiq           soft    nproc   65536
          meshiq           hard    nproc   65536

4. NETWORK PORTS:

The following list contains all processes network ports that are involved in meshIQ DSX deployment.

        DOMAIN SERVER (ATPNAMES): ............. 2323, 3000 (TCP)
           CEP SERVER (ATPNODE): .............. 3007 (TCP)
        ZOOKEEPER: ............................ 9983 (TCP)
        SOLR: ................................. 8983 (TCP)
        DSX Service URL:....................... 8580 (TCP)
        DSX Autocomplete service URL:.......... 7580 (TCP)

The machine on which the install will be done must meet all prerequisites for installation described above.

Installation steps

These steps assume local or remote installation of all related components. The latest DSX node package can be downloaded from the meshIQ software repository (under Deployment Pack/meshIQ Platform). A user-name and password are required.

1. Install the DSX_X.X.X_DPackVx.x.tar.Z package to the installation path of your choice.

This package contains the directory "meshiq" as a root directory.

DSX NODE PACKAGE:

DSX_X.X.X_DPackVx.x.tar.Z is a self-contained package for meshIQ-Grafana integration:

SHELL COMMAND: tar -zxvf DSX_X.X.X_DPackVx.x.tar.Z

2. First-time setup of meshIQ Platform DSX.

SHELL COMMAND: cd InstallationPATH/sbin/

SHELL COMMAND (sets domain server location): ./config.sh dsconn

The first time you run these commands, you may be asked to set the Installation Path.

Follow the instructions on the screen.

Press the "enter" key to set the install path automatically.

Then rerun:

SHELL COMMAND: ./config.sh dsconn

Continue to follow the onscreen instructions; the config.sh script will guide you with initial setup.

a) The final step is to start the DSX node:

SHELL COMMAND: ./start.sh all

3. Grafana Plugin Integration.
Using the packaged `meshIQ` Data-source Plug-in:

a) Install Grafana (if you have not already). Follow the instructions provided in the official Grafana documentation for your specific operating system.
b) Obtain the packaged `meshIQ` data-source plug-in for Grafana. You can find it in the following folder of the DSX tar file:

APIN_HOME/misc/plugins/

Unpack and place the plug-in in the Grafana plugins directory (e.g., /var/lib/grafana/plugins).
Remember to adjust the paths and configurations according to your specific setup.
SHELL COMMAND: tar -zxvf grafana-meshiq-plugin.tar.gz

c) Edit the `grafana.ini` configuration file (usually located at /etc/grafana/grafana.ini).
Add the plugin ID to the `allow_loading_unsigned_plugins` configuration option:

allow_loading_unsigned_plugins=meshiq-datasource

d) Save the configuration file

e) Restart Grafana using the appropriate method:

If you are using Grafana from meshIQ, navigate to /opt/meshiq/grafana-xx/bin and run the following:

./grafana-server --config etc/grafana/grafana.ini

If Grafana was locally installed using yum install (or apt-get), run the following:

sudo systemctl start grafana-server

f) Log into the Grafana UI.

g) To set the admin password in Grafana, run the following command from the bin directory:

./grafana-cli admin reset-admin-password <new password>

Now you are ready to use the `meshIQ` data source plug-in in Grafana.
Continue by following the instructions in the section below.

How to connect Grafana to the meshIQ DSX platform

If step 3 above has been completed, then proceed to the Step 1: Create a meshIQ data source section in Set up meshIQ-Grafana integration .

Show, start, or stop meshIQ services

Package scripts are located in the APIN_HOME/SBIN directory.

Show meshIQ services

You can verify whether the meshIQ services are running by using the following commands:

SHELL COMMAND: cd APIN_HOME/sbin

SHELL COMMAND: ./show.sh

Start meshIQ services

You can start all installed services by using the following commands:

SHELL COMMAND: cd APIN_HOME/sbin

SHELL COMMAND: ./start.sh all

You can also start a specific meshIQ service.

To see the list of valid parameters for starting a specific service, use the following command:

SHELL COMMAND: ./start.sh

Stop meshIQ services

You can stop all installed services by using the following commands:

SHELL COMMAND: cd APIN_HOME/sbin

SHELL COMMAND: ./stop.sh all

You can also stop a specific meshIQ service.

To see the list of valid parameters for stopping a specific service, use the following command:

SHELL COMMAND: ./stop.sh

Setting the installation path (Optional)

Setting the installation path using environment variables

To run startup scripts from anywhere, we recommend that you set the environment variables APIN_HOME and PATH in the user profile.

Copy and paste these two lines toward the end of the user profile file.

 export APIN_HOME=/opt/meshiq 
 export PATH=$PATH:$APIN_HOME/sbin

Change /opt/meshiq to the path to the root directory of your meshiq installation.

Set the installation path manually

To set the installation path manually, edit InstallationPath/sbin/apin_env.sh

Change the line: export APIN_HOME=ExistingPath and replace it with NewPath.

To get started, we recommend reading Set up meshIQ-Grafana integration.