Clean Linux OS

RHEL / Rocky Linux
Debian / Ubuntu
SUSE
XorMon app install

SLES 15 SP6 / openSUSE Leap 15.6

Overview of XorMon requirements:

Node.js 20
PostgreSQL 16
Python 3.10+
TimescaleDB Community Edition (latest)

Prerequisites

HW sizing
Supported Linux OS
Access to internet repositories
5 GB of free space in the "/home" filesystem for the application
Enough free space in the "/var" filesystem for the data (see Sizing)

Host OS installation procedure

Create xormon user (as root)

groupadd xormon
useradd -m -g xormon xormon
passwd xormon

Increase user system limits (as root)

vi /etc/security/limits.conf

Append following lines before the end of the file

xormon          hard    stack           -1
xormon          soft    stack           -1
xormon          hard    data            -1
xormon          soft    data            -1
xormon          hard    nofile          32768
xormon          soft    nofile          32768
xormon          hard    nproc           64000
xormon          soft    nproc           64000

Enable repositories (as root)

SLES 15 SP6

suseconnect -p sle-module-basesystem/15.6/x86_64
suseconnect -p sle-module-desktop-applications/15.6/x86_64
suseconnect -p sle-module-development-tools/15.6/x86_64
suseconnect -p sle-module-server-applications/15.6/x86_64
suseconnect -p sle-module-web-scripting/15.6/x86_64
suseconnect -p sle-module-python3/15.6/x86_64
suseconnect -p sle-module-systems-management/15.6/x86_64
suseconnect -p PackageHub/15.6/x86_64

Check activated repositories

zypper repos

#  | Alias                                                                                             | Name                                                      | Enabled | GPG Check | Refresh
---+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------+---------+-----------+--------
 3 | Basesystem_Module_15_SP6_x86_64:SLE-Module-Basesystem15-SP6-Pool                                  | SLE-Module-Basesystem15-SP6-Pool                          | Yes     | (r ) Yes  | No
 5 | Basesystem_Module_15_SP6_x86_64:SLE-Module-Basesystem15-SP6-Updates                               | SLE-Module-Basesystem15-SP6-Updates                       | Yes     | (r ) Yes  | Yes
 8 | Desktop_Applications_Module_15_SP6_x86_64:SLE-Module-Desktop-Applications15-SP6-Pool              | SLE-Module-Desktop-Applications15-SP6-Pool                | Yes     | (r ) Yes  | No
10 | Desktop_Applications_Module_15_SP6_x86_64:SLE-Module-Desktop-Applications15-SP6-Updates           | SLE-Module-Desktop-Applications15-SP6-Updates             | Yes     | (r ) Yes  | Yes
13 | Development_Tools_Module_15_SP6_x86_64:SLE-Module-DevTools15-SP6-Pool                             | SLE-Module-DevTools15-SP6-Pool                            | Yes     | (r ) Yes  | No
15 | Development_Tools_Module_15_SP6_x86_64:SLE-Module-DevTools15-SP6-Updates                          | SLE-Module-DevTools15-SP6-Updates                         | Yes     | (r ) Yes  | Yes
18 | Python_3_Module_15_SP6_x86_64:SLE-Module-Python3-15-SP6-Pool                                      | SLE-Module-Python3-15-SP6-Pool                            | Yes     | (r ) Yes  | No
20 | Python_3_Module_15_SP6_x86_64:SLE-Module-Python3-15-SP6-Updates                                   | SLE-Module-Python3-15-SP6-Updates                         | Yes     | (r ) Yes  | Yes
24 | SUSE_Linux_Enterprise_Server_15_SP6_x86_64:SLE-Product-SLES15-SP6-Pool                            | SLE-Product-SLES15-SP6-Pool                               | Yes     | (r ) Yes  | No
26 | SUSE_Linux_Enterprise_Server_15_SP6_x86_64:SLE-Product-SLES15-SP6-Updates                         | SLE-Product-SLES15-SP6-Updates                            | Yes     | (r ) Yes  | Yes
29 | SUSE_Package_Hub_15_SP6_x86_64:SLE-Module-Packagehub-Subpackages15-SP6-Pool                       | SLE-Module-Packagehub-Subpackages15-SP6-Pool              | Yes     | (r ) Yes  | No
31 | SUSE_Package_Hub_15_SP6_x86_64:SLE-Module-Packagehub-Subpackages15-SP6-Updates                    | SLE-Module-Packagehub-Subpackages15-SP6-Updates           | Yes     | (r ) Yes  | Yes
33 | SUSE_Package_Hub_15_SP6_x86_64:SUSE-PackageHub-15-SP6-Backports-Pool                              | SUSE-PackageHub-15-SP6-Backports-Pool                     | Yes     | (r ) Yes  | No
34 | SUSE_Package_Hub_15_SP6_x86_64:SUSE-PackageHub-15-SP6-Pool                                        | SUSE-PackageHub-15-SP6-Pool                               | Yes     | (r ) Yes  | No
37 | Server_Applications_Module_15_SP6_x86_64:SLE-Module-Server-Applications15-SP6-Pool                | SLE-Module-Server-Applications15-SP6-Pool                 | Yes     | (r ) Yes  | No
39 | Server_Applications_Module_15_SP6_x86_64:SLE-Module-Server-Applications15-SP6-Updates             | SLE-Module-Server-Applications15-SP6-Updates              | Yes     | (r ) Yes  | Yes
42 | Systems_Management_Module_15_SP6_x86_64:SLE-Module-Systems-Management-15-SP6-Pool                 | SLE-Module-Systems-Management-15-SP6-Pool                 | Yes     | (r ) Yes  | No
44 | Systems_Management_Module_15_SP6_x86_64:SLE-Module-Systems-Management-15-SP6-Updates              | SLE-Module-Systems-Management-15-SP6-Updates              | Yes     | (r ) Yes  | Yes
47 | Web_and_Scripting_Module_15_SP6_x86_64:SLE-Module-Web-Scripting15-SP6-Pool                        | SLE-Module-Web-Scripting15-SP6-Pool                       | Yes     | (r ) Yes  | No
49 | Web_and_Scripting_Module_15_SP6_x86_64:SLE-Module-Web-Scripting15-SP6-Updates                     | SLE-Module-Web-Scripting15-SP6-Updates                    | Yes     | (r ) Yes  | Yes

openSUSE Leap 15.6

Make sure following repositories are enabled in Zypper:

openSUSE-Leap-15.6-1 (openSUSE-Leap-15.6-1)
Update repository with updates from SUSE Linux Enterprise 15 (repo-sle-update)

zypper repos

#  | Alias                       | Name                                                                                        | Enabled | GPG Check | Refresh
---+-----------------------------+---------------------------------------------------------------------------------------------+---------+-----------+--------
 1 | openSUSE-Leap-15.6-1        | openSUSE-Leap-15.6-1                                                                        | Yes     | (r ) Yes  | Yes
... 
12 | repo-sle-update             | Update repository with updates from SUSE Linux Enterprise 15                                | Yes     | (r ) Yes  | Yes      
...

Install additional packages (as root)

zypper install vim sudo perl ed libxml2-2 wget curl gpg2 sblim-wbemcli libaio1 strace \
perl-TimeDate perl-XML-Simple perl-XML-SAX perl-XML-LibXML perl-CGI \
perl-LWP-Protocol-https perl-libwww-perl perl-IO-Tty openldap2-client \
perl-JSON perl-JSON-XS perl-Net-SNMP net-snmp perl-DBI perl-DBD-ODBC unixODBC unixODBC-devel \
perl-DBD-Pg libcap-progs \
python3-virtualenv python3-pip  python3-devel gcc-c++ gcc

Java 11 Installation
Required only by Hitachi Export Tool for Hitachi VSP monitoring.
Skip if you don't need to monitor Hitachi VSP storage systems.
Install Node.js (as root)

XorMon requires Nodde.js 20 or newer.
```
zypper install nodejs20
```

Install PostgeSQL 16 (as root)

Install packages

zypper install postgresql16 postgresql16-contrib postgresql16-server postgresql16-server-devel postgresql16-devel

Enable and start PostgeSQL service

systemctl enable --now postgresql.service

Enable access from localhost

Single command

sed -i 's/^\(host \+all \+all \+127.0.0.1\/32 \+\)ident/\1scram-sha-256/g' /var/lib/pgsql/data/pg_hba.conf

Edit configuration manually

vi /var/lib/pgsql/data/pg_hba.conf

# replace 
host    all             all             127.0.0.1/32            ident

# with
host    all             all             127.0.0.1/32            scram-sha-256

Set postgres user password

sudo -u postgres psql

postgres=# \password postgres
postgres=# ALTER USER postgres VALID UNTIL 'infinity';
postgres=# \q

Install PostgreSQL and TimescaleDB extension (as root)

XorMon requires TimescaleDB Community Edition.

Do NOT install TimescaleDB extension from PostgreSQL PGDG repository (Apache 2 edition).
This version is missing some key features required by XorMon.

Timescale DB Community Edition has to be built from source, because there are no pre-built packages for SUSE.

Install additional packages
```
zypper install git cmake
```

Clone Timescale DB Git repository

cd ~; git clone https://github.com/timescale/timescaledb

Build the extension

cd ~/timescaledb
git checkout 2.24.0
./bootstrap
cd build && make
make install

Add Timescale DB extension to PostgeSQL

Single command

sed -i "s/^#shared_preload_libraries =.*/shared_preload_libraries = 'timescaledb'/g" /var/lib/pgsql/data/postgresql.conf

Edit configuration manually

vi /var/lib/pgsql/data/postgresql.conf

# replace
#shared_preload_libraries = ''

# with
shared_preload_libraries = 'timescaledb'

Tune DB

'timescaledb-tune' script has to be installed using 'go'

zypper install go
go install github.com/timescale/timescaledb-tune/cmd/timescaledb-tune@latest
/root/go/bin/timescaledb-tune -yes -conf-path /var/lib/pgsql/data/postgresql.conf
sed -i 's/#synchronous_commit = on/synchronous_commit = off/' /var/lib/pgsql/data/postgresql.conf
sed -i 's/#password_encryption/password_encryption/' /var/lib/pgsql/data/postgresql.conf
sed -ie 's/32\s ident/32 scram-sha-256/' /var/lib/pgsql/data/pg_hba.conf

Restart PostgeSQL service
```
systemctl restart postgresql.service
```

Configure firewall (optional, as root)

Open XorMon port in the firewall 8443 TCP (XorMon UI) and 8162 TCP (OS agent communication).

firewall-cmd --zone=public --add-port=8443/tcp --permanent
firewall-cmd --zone=public --add-port=8162/tcp --permanent
firewall-cmd --reload
firewall-cmd --list-port

Follow XorMon application install

XorMon Installation

Once you have your operating system ready, install the XorMon program itself.

Log in as 'xormon' and create installation directory
```
su - xormon
mkdir xormon-ng
cd xormon-ng
```
Download latest XorMon package to /home/xormon/xormon-ng
```
tar zxf xormon-ng-<ver>.tar.gz
./xormon.sh start
```
Ignore message "PM2 fail to start" at the end of the start procedure if apears.

Provide database password created during OS configuration when you are prompted

APP_PORT[8443]=

DB_HOST[127.0.0.1]=
DB_PORT[5432]=
DB_USERNAME[postgres]=
DB_DATABASE[xormon]=
DB_PASSWORD[]= <password>

Optional: change default port

XorMon uses port 8443 by default.
It can be configured to use any other port, e.g. 443 (https).
- Make sure the selected port is free
  
  Following command should not provide any output, if it does, then the port is being used by some other application.
```
netstat -an| grep LISTEN |grep ":443 "
```
  Note: netstat is gradually being phased out in some Linux distributions.
  You can use 'ss' command instead:
```
ss -ltn | grep -w 443
```
- Allow the application to use low port number (as root)
  
  This is necessary if you want to use port 443 or any other port lower than 1024.
  Note: you have to re-run this command after each Node.js upgrade
```
su -
setcap 'cap_net_bind_service=+ep' `which node`
```
  Some Linux distributions set command alternatives for multiple verions.
  In this case, set the port binding capability for the default alternative as well.
  
  SLES / openSUSE
  - check for alternatives
```
update-alternatives --get-selections | grep node
node-default                   auto     /usr/bin/node20
```
  - set port binding capability
```
setcap 'cap_net_bind_service=+ep' /usr/bin/node
setcap 'cap_net_bind_service=+ep' /usr/bin/node20
```
  Note: Sometimes you need to restart the system for the settings to take effect.
- Configure application port (as xormon)
```
vi ~/xormon-ng/server-nest/.env
APP_PORT=443
```
- Restart XorMon (as xormon)
```
cd ~/xormon-ng
./xormon.sh stop
./xormon.sh start 
./xormon.sh status 
```
  Ignore message "PM2 fail to start" at the end of the start procedure if apears.
- Add newly selected port to firewall configuraiton.

Configure Python3 virtual environment (as xormon)

Prediction graphs and Anomaly detection require Python 3.10 or newer.
You can run XorMon without it if you have trouble downloading necessary Python modules.

Install the version of Python corresponding to your operating system
Required python packages: venv/virtualenv, dev/develop, pip
(Detailed procedure is beyond the scope of this guide.)

Check installed Python versions

ls -ls /usr/bin/python*

Example:

lrwxrwxrwx 1 root root     9 Aug  4 13:28 /usr/bin/python3 -> python3.6
-rwxr-xr-x 1 root root  6288 Nov 24 15:30 /usr/bin/python3.12
-rwxr-xr-x 1 root root  3378 Nov 24 15:30 /usr/bin/python3.12-config
-rwxr-xr-x 2 root root 10560 Aug  4 13:28 /usr/bin/python3.6
lrwxrwxrwx 1 root root    17 Aug  4 13:28 /usr/bin/python3.6-config -> python3.6m-config
-rwxr-xr-x 2 root root 10560 Aug  4 13:28 /usr/bin/python3.6m
-rwxr-xr-x 1 root root  3440 Aug  4 13:28 /usr/bin/python3.6m-config
lrwxrwxrwx 1 root root    16 Aug  4 13:28 /usr/bin/python3-config -> python3.6-config

python3.12 is available in the above example.

Log in as 'xormon' and create Python3 virtual environment

Use the version of Python obtained in the previous step.
We will use python3.12 in our example.

cd ~/xormon-ng/server-nest/
python3.12 -m venv venv
venv/bin/python3 -m ensurepip --upgrade
venv/bin/python3 -m pip install --upgrade pip
venv/bin/python3 -m pip install -r microservices/analyzer/requirements/requirements.txt

If you get this error:

Retrying (Retry(total=4, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError(': Failed to establish a new connection: [Errno 101] Network is unreachable')': /simple/pip/

Then try to avoid it by using internal proxy for Python packages installation

venv/bin/python3 -m pip install --proxy http://<username>:<password>@<hostname>:<port> --upgrade pip
venv/bin/python3 -m pip install --proxy http://<username>:<password>@<hostname>:<port> -r microservices/analyzer/requirements/requirements.txt

Restart XorMon
```
cd ~/xormon-ng
./xormon.sh stop
./xormon.sh start
```
Ignore message "PM2 fail to start" at the end of the start procedure if apears.

Setup XorMon startup script (as root)

env PATH=$PATH:/usr/bin /home/xormon/xormon-ng/server-nest/node_modules/pm2/bin/pm2 startup systemd -u xormon --hp /home/xormon

Navigate to XorMon GUI

https://<IP>:8443/

Installing XorMon on a server where already LPAR2RRD is running

documentation