Follow below steps to get started with the meshIQ setup.
Before running this procedure, please verify the prerequisites below.
Prerequisites
Linux System:
- Operating System: Linux 64 bit OS
- CPU: Minimum 8 virtual CPUs
- Memory: Minimum 32GB RAM
- File System: Minimum 100 GB free space, SSD preferred
- Recommended Install folder: /opt/meshiq
- Required: Dedicated Server Instance
Some steps below require root access.
- USERID:
Create the Linux user ID (UID) and group which will be used to start all meshIQ services.
The Recommended user and group are meshiq:meshiq, this can be changed to any preferred user product owner.
The UID and group must own all files and directories under $APIN_HOME
- SWAP:
It is highly recommended to turn Swap off within the operating system on all virtual machine servers running meshIQ Track.
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.
- LIMITS:
Modify /etc/security/limits.conf and add below for your user:
Replace meshiq with the user that will start Track processes.
meshiq soft nofile 65536 meshiq hard nofile 65536
meshiq soft nproc 65536
meshiq hard nproc 65536
- SOFTWARE REQUIREMENTS:
Ensure 'curl' is installed, curl is required to run sbin/config.shscript
Ensure 'python' version >= 2.7 is installed, If planning to run STORM or Machine Learning.
Ensure native 'PostgreSQL' is not running, Installation using its own PostgreSQL database implementation.
As of version 1.3, platform requires Structured Query database server to run job scheduler.
This meshIQ Deployment pack is pre-configured to use PostgreSQL database as default and requires to run Track.
- NETWORK PORTS:
The following list contains all processes network ports that are involved in meshIQ deployment.
DOMAIN SERVER (ATPNAMES): .............2323, 3000 (TCP)
CEP SERVER (ATPNODE): ................ 3005 (TCP)
STREAMING: ........................... 6585 OR HTTPS(443) (TCP)
WEB SERVER (apache-tomcat): .......... 443, 8080 (TCP)
ZOOKEEPER: ........................... 2181 (TCP)
ACTIVEMQ SERVER: ..................... 61616 (TCP)
ACTIVEMQ WEB CONSOLE: ................ 8161 (TCP)
KAFKA SERVER: ........................ 9092 (TCP)
SOLR: ................................ 8983 (TCP)
POSTGRESQL (postgres): ............... 5432 (TCP)
WORKGROUP SERVER: .................... 4010 (TCP & UDP)
REST API: ............................ 8019 (TCP)
STREAMING: ........................... 6585 OR HTTPS(443) (TCP)
MQ AGENT (nsqmq): .................... 5010 (TCP & UDP)
MQ AGENT JAVA (nsqcmmq.jar): ......... 5015 (TCP & UDP)
MQ CONNECTION MANAGER (nsqcmmq.jar): ............ 5025 (TCP)
IBM Listeners: --------- 1414 (TCP)
IIB/ACE CONNECTION MANAGER (nsqcmace.jar): ...... 5577 (TCP)
IIB/Ace node: ---------- 4414 (TCP)
EMS CONNECTION MANAGER (nsqcmems.jar) ........... 5556 (TCP)
Tibco EMS URL: --------- 7222 (TCP)
KAFKA CONNECTION MANAGER (nsqcmkafka.jar) ....... 5566 (TCP)
Kafka Server: ---------- 9092 (TCP)
SOLACE CONNECTION MANAGER (nsqcmsolace.jar) ..... 5588 (TCP)
Solace URL PORT: ------- 8980 (TCP)
RABITMQ CONNECTION MANAGER (nsqcmrabbitmq.jar) .. 5599 (TCP)
RabitMQ URL PORT: ------- 15672 (TCP)
The machine on which the install will be done respects all prerequisites for installation described above.
For more information and to get started, please refer to the URL link:
https://customers.meshiq.com/hc/en-us/sections/41902118859795-Management
https://customers.meshiq.com/hc/en-us/sections/41902120341011-Tracking
Setup Steps:
These steps assume local installation for all related components.
You only need first 3 steps below to get everything configured and up and running.
FOR SINGLE-NODE DEPLOMENENT ONLY, (WHERE ALL SERVICES ARE RUN ON ONE SERVER):
1. Untar/unzip the meshIQ_x.x.x_Full_DPackVx.x.tar.Z package to the installation path of your choice.
This package contains the directory "meshiq" as a root directory
SHELL COMMAND: tar -zxvf meshIQ_x.x.x_Full_DPackVx.x.tar.Z
2. Review, verify and enable/disable local running services:
Change to $APIN_HOME/sbin/ folder and modify file "installed_services.conf"
"yes" for enabled and "no" for disabled.
syntax: Service_Name=yes (with no spaces)
3. To start the manage services, and for initial setup:
Run below command from APIN_HOME/sbin/ directory and follow on screen instructions.
SHELL COMMAND: cd APIN_HOME/sbin
SHELL COMMAND: ./start.sh all
Press enter key to set the install path automatically.
First time command run will ask you to specify untared/unzipped directory location, after which you will need to re-run command ./start.sh all.
You have completed the installation, please check $APIN_HOME/logs for any errors.
Xray/Track Clustered Deployment Setup
For clustered Solr XRAY/TRACK deployment only (where XRAY/TRACK services are run on two or more servers):
Initial, first-time setup of XRAY/TRACK.
Ensure ZOOKEEPER service is running before proceeding further.
On Zookeeper Node
SHELL COMMAND: cd APIN_HOME/sbin
SHELL COMMAND: ./start.sh zoo
First time run may ask you to set Working Installation Path.
Follow the instructions on the screen.
Press "enter" to set the install path automatically.
Then rerun:
SHELL COMMAND: ./start.sh zoo
On All Slor Nodes
You may use TRACK_SOLR_v1.5.tar.Z package for SOLR deployments.
This package contains SOLR only distribution.
Latest Solr package can be downloaded from:
(user-name and password required), https://data.meshiq.com/AP6/Deployment_Pack/meshiq_platform/Track_Solr/
Installation Steps
Install the TRACK_SOLR_vx.x.tar.Z package to the installation path of your choice.
This package contains the directory "meshiq" as a root directory.
SHELL COMMAND: tar -zxvf TRACK_SOLR_vx.x.tar.Z
SHELL COMMAND: cd APIN_HOME/sbin
SHELL COMMAND: ./config.sh solr
First time run will ask you to set Working Installation Path.
Follow the instructions on the screen.
If ./config.sh solr command completes successfully it will attempt to start solr Automatically.
Start Solr Manually:
SHELL COMMAND: APIN_HOME/sbin/start.sh solr
Before proceeding further, please complete above steps on all participating cluster SOLR nodes.
Proceed further; Solr installation and setup are complete.
On Web Server Node
Steps below are to be performed only if Web Server is separated from compute node.
SHELL COMMAND: cd APIN_HOME/platform/apache-tomcat/conf
edit: 'server.xml' file.
Look for text: brokerURL="tcp://localhost:61616 and replace localhost with activemq server host location.
On Compute Node
SHELL COMMAND: cd APIN_HOME/sbin
SHELL COMMAND: ./config.sh all
Follow the instructions on the screen.
For any locally running services config.sh script will start necessary services automatically.
During execution of config.sh script it will ask you to load a license key, please have it ready.
LICENSE
To update the XRAY/TRACK license file please execute:
SHELL COMMAND: ./config.sh lic
YOU HAVE COMPLETED THE INSTALLATION AND SETUP OF XRAY/TRACK.
Access meshIQ Manage
To access the meshIQ manage UI from a web browser, use the following address:
http://<serverip>:8080/manage/
Use the following default log in credentials:
- User Name: Admin (case sensitive)
- Password: admin (case sensitive)
Access meshIQ Track
To access the meshIQ track UI from a web browser, use the following address:
http://<serverip>:8080/track/login.jsp
Use the following default log in credentials:
- User Name: Admin (case sensitive)
- Password: password that was set during the deployment
Streaming Data to Track:
In order to stream data to Track, a token id is needed.
- DEFAULT TOKEN ID: DefaultToken
- DEFAULT STREAM URL: http://<serverip>:6580
If you are new to meshIQ Platform, to get started it is recommended to check out this web page:
https://customers.meshiq.com/hc/en-us/categories/360002654154
Setting the Installation Path (Optional)
To run startup scripts from anywhere, it is recommended to set APIN_HOME and PATH to sbin directory in user profile.
Copy and paste these two lines towards the end of the user profile file.
export APIN_HOME=/opt/meshiq
export PATH=$PATH:$APIN_HOME/sbin
Change /opt/meshiq to the path of root directory of meshiq installation
Set the Installation Path Manually ( Optional)
To set working path manually, Edit APIN_HOME/sbin/apin_env.sh
Change line: export APIN_HOME=ExistingPath and replace ExistingPath it with NewPath.
Optional Link Reference:
- SOLR WEB ADMIN:
http://<serverip>:8983/solr - ACTIVEMQ WEB ADMIN:
http://<serverip>:8161/admin
How to Start, Stop, or Show XRAY/TRACK Services
Deployment pack scripts are located in APIN_HOME/SBIN directory.
Show Running Services:
SHELL COMMAND: cd APIN_HOME/sbin
SHELL COMMAND: ./show.sh
Start Enabled Services:
SHELL COMMAND: cd APIN_HOME/sbin
SHELL COMMAND: ./start.sh all
Alternatively, you can START any specific meshIQ service.
To see the list of valid parameters use the following command:
SHELL COMMAND: ./start.sh
Stop Running Services:
SHELL COMMAND: cd APIN_HOME/sbin
SHELL COMMAND: ./stop.sh all
Alternatively, you can STOP any specific meshIQ service.
To see the list of valid parameters use the following command:
SHELL COMMAND: ./stop.sh