Skip to main content
Version: 3.2

Overview

In a production (combat) environment, we strongly recommend using a separate server for each component. This documentation covers installation using the Smart Monitor installer, and all recommendations will be provided for this installation type.

For all tested operating systems, configuration of all important parameters occurs automatically and requires no additional action from the administrator. Certain preinstalled packages are required, as described in the following section.

The Smart Monitor installer is an archive containing all software packages and their modules and includes separate installers for:

  • OpenSearch version 2.11.1
  • OpenSearch-Dashboards version 2.11.1
  • Logstash version 8.9.1.

You must also have a license available. The license location does not affect the operation of the installers. During OpenSearch installer operation, the license is copied and must be located in the $HOME_OPENSEARCH/config/sme directory.

Smart Monitor Engine (SME) is installed together with OpenSearch. It is used in almost all modules and also includes the Smart Monitor Engine Remote Execution (SME-RE) component, used for running various scripts written in Python. It can use the memcached software package to save intermediate script results or store variables.

All installers are located in the corresponding directories, are named install.sh, and work with the bash command-line interpreter. The installer is an interactive script. After launching the installer, you will need to enter installation parameters. When specifying paths, you can use the Tab key for autocompletion if the directory or file already exists.

The following directories may be present in the installer root:

  • branding – images and logos for OpenSearch-Dashboards
  • certs – parameters for creating private keys and certificates; it is recommended to place the private key and CA certificate in this directory
  • config – system configuration templates, Java, and others
  • plugins – set of plugins for installation, installed automatically when using the installer
  • services – service configuration templates
  • source – contains tar.gz archive with source files for OpenSearch, OpenSearch-Dashboards, or Logstash
  • staging – directory appears after launching the installer and contains preliminary settings depending on the selected parameters
  • utils – sets of additional scripts, utilities, configuration examples.

The installer must be run as a superuser, preferably root. The installer has built-in checks for existing installation directories and will notify you accordingly.

IMPORTANT

If you specify existing directories during installation, all existing files in these directories will be deleted.

Default values or selection options will be indicated in square brackets when you need to specify "yes" (y) or "no" (n).

At the end of each stage, before proceeding, a list of parameters for the current stage is displayed. You can confirm the correctness of the input by typing "y", pressing "Enter", and the installation will continue, or you can decline and be prompted to re-enter the stage parameters. Therefore, if you make a mistake, it is not necessary to completely abort the installation.

Before final changes to the operating system, a confirmation prompt will be displayed. During installation, a default user is created:

  • Username: admin
  • Password: P@ssWoRdElastic
IMPORTANT

After installation, it is recommended to change the admin user password.

Prerequisites​

For correct operation of the Smart Monitor installer, the following packages are required:

  • zip version 3.0 and higher
  • openssl version 1.0.2k and higher

For RHEL 8, the following additional packages are required:

  • libnsl2 version 1.2.0 or higher
  • lobnsl version 2.28 and higher

Additionally, for the sme-re component, memcached version 1.5.22 and higher can be optionally installed.

The Smart Monitor installer archive is downloaded to the server and then extracted using the command line as the root user:

tar -xzf smart-monitor-installer.tar.gz -C /opt/

Installation​

To install Smart Monitor, you need to download the installation package from the provided link. The further installation procedure is provided in the articles at the links below:

IMPORTANT

It is strongly recommended to perform the post-installation settings in the Smart Monitor Post-Installation Configuration section.