meshIQ XRay Installation readme.txt =============================================================================================================== Follow below steps to get started with the meshIQ XRay setup. IMPORTANT: Before running this procedure, please verify these prerequisites: =============================================================================================================== Prerequisites: Linux System: - Operating System: Linux 64 bit OS, Ubuntu, RedHat (or equivalent, e.g. Fedora, CentOS, Rocky Linux, etc). - CPU: Minimum 8 virtual CPUs - Memory: Minimum 32GB RAM - File System: Minimum 1 TB free space, SSD preferred - Recommended installation directory: /opt/meshIQ NOTE: Some steps below require root access. 1. USERID: Create the Linux user ID (UID) and group which will be used to start all meshIQ XRay services. The default 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 the installation directory, $APIN_HOME 2. SWAP: It is highly recommended to turn Swap off within the operating system on all virtual machine servers running meshIQ XRay. 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 below for your user: Replace meshiq with the user that will start XRay processes. meshiq soft nofile 65536 meshiq hard nofile 65536 meshiq soft nproc 65536 meshiq hard nproc 65536 4. SOFTWARE REQUIREMENTS: Ensure 'curl' is installed, curl is required to run sbin/config.sh script Ensure 'python' version >= 2.7 is installed, If planning to run STORM or Machine Learning. NOTE: As of version 1.3, XRay requires Structured Query database server to run job scheduler. This XRay Deployment pack is pre-configured to use PostgreSQL database as default and requires to run XRay. 5. NETWORK PORTS: The following list contains all processes network ports that are involved in XRay 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) =============================================================================================================== IMPORTANT: THE MACHINE ON WHICH THE INSTALL WILL BE DONE RESPECTS ALL PREREQUISITES FOR INSTALLATION DESCRIBED ABOVE. For more information please refer to the: meshIQ XRay's Users Guide: https://customers.meshIQ.com/hc/en-us/articles/360033617134-Nastel-XRay-Documentation-Library INSTALLATION STEPS: These steps assume local or remote installation of all related components. 1. Install the XRay_x.x.xx_UIv.xx_Full_DPackVx.x.tar.Z package to the installation path of your choice ... NOTE: This package contains the directory "meshiq" as a root directory. COMPUTE NODE PACKAGE: XRay_x.x.xx_UIv.xx_Full_DPackVx.x.tar.Z is the full package that contains all meshIQ XRay services: SHELL COMMAND: XRay_x.x.xx_UIv.xx_Full_DPackVx.x.tar.Z Latest compute node package can be downloaded from: (user-name and password required), https://data.meshiq.com/AP6/Deployment_Pack/XRay/ ---------------------------------------------------------------------- 2. VERIFY AND ENABLE/DISABLE LOCAL RUNNING SERVICES: Change to InstallationPath/sbin/ folder and review file "installed_services.conf" NOTE: This file is pre-configured for XRay with single node deployment. Ensure to review the requirements up above under SOFTWARE REQUIREMENTS section. Within a file review running services under # XRAY/JKOOL SERVICES: yes for enabled and no for disabled syntax: Service_Name=yes (with no spaces) This XRay Deployment Pack includes the PostgreSQL database server. In the file "installed_services.conf", the service PostgreSQL is enabled by default: pgsql=yes ---------------------------------------------------------------------- 3A. FOR SINGLE-NODE XRAY DEPLOMENENT ONLY,(WHERE ALL XRAY SERVICES ARE RUN ON ONE SERVER): INITIAL, FIRST TIME SETUP OF XRAY ... SHELL COMMAND: cd APIN_HOME/sbin/ SHELL COMMAND: ./config.sh all NOTE: First time run may ask you to set Working Installation Path. Follow the instructions on the screen. Press the "enter" key to set the install path automatically. Then rerun: SHELL COMMAND: ./config.sh all Follow the instructions on the screen, config.sh script will guide you with initial setup. NOTE: For any locally running services "config.sh" script will start necessary services automatically. NOTE: Wait for config.sh script to complete and once finished then: YOU HAVE COMPLETED THE INSTALLATION AND SETUP FOR XRAY. PROCEED BELOW TO STEP 4 AND FURTHER FOR MORE DETAILS. ---------------------------------------------------------------------- =============================================================================================================== 3B. FOR CLUSTERED SOLR XRAY DEPLOMENENT ONLY (WHERE XRAY SERVICES ARE RUN ON TWO OR MORE SERVERS): INITIAL, FIRST TIME SETUP OF XRAY ... ENSURE: ZOOKEEPER service is running before proceeding further. ------------------- ON ZOOKEEPER NODE: ------------------- SHELL COMMAND: cd APIN_HOME/sbin SHELL COMMAND: ./start.sh zoo NOTE: 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 SOLR NODES: ------------------- You may use XRay_SOLR_v1.3.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/XRay/ Install the XRay_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 XRay_SOLR_vx.x.tar.Z SHELL COMMAND: cd APIN_HOME/sbin SHELL COMMAND: ./config.sh solr NOTE: First time run will ask you to set Working Installation Path. Follow the instructions on the screen. NOTE: If ./config.sh solr command completes successfully it will attempt to start solr Automatically. To Start Solr Manually: SHELL COMMAND: APIN_HOME/sbin/start.sh solr IMPORTANT: Before proceeding further, please complete above steps on all participating cluster SOLR nodes. PROCEED FURTHER, SOLR INSTALLATION AND SETUP IS COMPLETE. ------------------- ON COMPUTE NODE: ------------------- SHELL COMMAND: cd APIN_HOME/sbin SHELL COMMAND: ./config.sh all Follow the instructions on the screen. NOTE: For any locally running services "config.sh" script will start necessary services automatically. YOU HAVE COMPLETED THE INSTALLATION AND SETUP OF XRAY. ---------------------------------------------------------------------- 4. START THE REST OF THE SERVICES: ON COMPUTE NODE: SHELL COMMAND: cd APIN_HOME/sbin SHELL COMMAND: ./start.sh all =============================================================================================================== USING MESHIQ XRAY - THE XRAY USER INTERFACE: To access the meshIQ XRay UI from a web browser, use the following address: http://:8080/xray/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 MESHIQ XRAY: IMPORTANT: In order to stream data to meshIQ XRay, a token id is needed. DEFAULT TOKEN ID: DefaultToken DEFAULT STREAM URL: http://:6580 =============================================================================================================== IF YOU ARE NEW TO XRAY, TO GET STARTED IT IS RECOMMENDED TO CHECK OUT THIS WEB PAGE: https://customers.meshiq.com/hc/en-us/categories/360002083773 =============================================================================================================== PACKAGE SCRIPTS IN APIN_HOME/SBIN DIRECTORY. SHOW, START OR STOP XRAY SERVICES: ------------------- SHOW XRAY SERVICES: ------------------- On any XRay Node (i.e. a "COMPUTE NODE", a "ZOOKEEPER NODE", or a "SOLR NODE"), you can VERIFY whether the XRay services are RUNNING by using the command: SHELL COMMAND: cd APIN_HOME/sbin SHELL COMMAND: ./show.sh ------------------- START XRAY SERVICES: ------------------- On any XRay Node (i.e. a "COMPUTE NODE", a "ZOOKEEPER NODE", or a "SOLR NODE"), you can START all installed XRay services by using the command: SHELL COMMAND: cd APIN_HOME/sbin SHELL COMMAND: ./start.sh all NOTE: Alternatively, you can START a specific meshIQ XRay service. To see the list of valid parameters for starting a specific XRay service, use the following command: SHELL COMMAND: ./start.sh ------------------- STOP XRAY SERVICES: ------------------- On any XRay Node (i.e. a "COMPUTE NODE", a "ZOOKEEPER NODE", or a "SOLR NODE"), you can STOP all installed XRay services by using the command: SHELL COMMAND: cd APIN_HOME/sbin SHELL COMMAND: ./stop.sh all NOTE: Alternatively, you can STOP a specfic meshIQ XRay service. To see the list of valid parameters for stopping a specific XRay service, use the following command: SHELL COMMAND: ./stop.sh =============================================================================================================== ADDITIONAL NOTES: ---------------------------------------------------------------------- OPTIONAL: To run startup scripts from anywhere, it is recommended to set environment variables APIN_HOME and PATH 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 NOTE: change /opt/meshiq to the path to root directory of meshiq XRay installation. ---------------------------------------------------------------------- OPTIONAL: To set the installation path manually, Edit InstallationPath/sbin/apin_env.sh Change line: export APIN_HOME=ExistingPath and replace it with NewPath. --------------------------------------------------------------------------