Skip to main content
Version: 3.2

Installing OpenSearch Dashboards and Smart Monitor

Please note!

For OpenSearch Dashboards to work correctly, you need to specify the entire list of OpenSearch cluster nodes with the data role and Smart Monitor Engine installed.

General information​

The OpenSearch-Dashboards installer must be run as the root user, specifying the path to it:

/opt/smart-monitor-installer/opensearch-dashboards/install.sh

We recommend using a separate server for OpenSearch-Dashboards installation. For OpenSearch Dashboards, the default directory owner is opensearch and the group is opensearch.

Installing main directories​

The installer checks for the presence of running OpenSearch-Dashboards or Kibana services and, if found, asks about continuing the installation.

Beginning of installation

This image also shows the found installation archive and the OpenSearch-Dashboards version to be installed. By default, the installation will be canceled, to continue you need to enter "y". When continuing the installation, the running service is turned off.

At the first step, the main installation directories are set. We recommend storing all files related to Smart Monitor in one directory /app, this will simplify maintenance in the future.

If you are doing a test installation and plan to install all Smart Monitor components on one server, then you must specify separate directories for each component. You need to enter the following directories:

  • Home directory — OpenSearch-Dashboards installation directory
  • Conf directory — location of configuration files
  • Data directory — directory for storing various files used during OpenSearch-Dashboards operation
  • Logs directory — directory for storing logs

Setting installation directories

After completing the input, confirm the correctness of the entered data. The installer will analyze the existing directories and if they are not empty, it will issue a warning again:

Warning about non-empty directories

danger

If you continue, then all content of the specified directories will be deleted without possibility of recovery!

To continue the installation, you need to enter y again and press the Enter key.

Installing server parameters​

At this stage, basic OpenSearch-Dashboards parameters are entered:

  • Node name — name of the current OpenSearch Dashboards server
  • Bind address — interface that OpenSearch Dashboards will listen on, by default all available network interfaces are listened to, you can specify multiple IP addresses
  • OpenSearch host list — one or more addresses for connecting to OpenSearch nodes with the data role, listed in quotes separated by commas, the address must include the https protocol and port number for connection

Configuration example

After entering, you need to confirm the correctness of the data.

Installing certificate parameters​

note

When creating a private key, the RSA cryptographic algorithm with a length of 2048 bits is used, and the SHA-256 algorithm is used to create a digital fingerprint. Admin and current server certificates are created for 1095 days.

At this step, the key and certificate parameters of the current server are configured. You must specify the existing CA certificate and private key that was used when installing OpenSearch.

  • Do you want to use your existing certificates and keys? — do you want to use existing certificate and key files? You can specify your own files or use the built-in algorithm. If you use the built-in algorithm, answer n only for the first installation. For subsequent nodes, you should use files from the current configuration directory (by default: /app/opensearch/config/ca-cert.pem for certificate and /app/opensearch/config/ca-key.pem for private key)
  • Do you want to use an existing CA certificate and private key to generate certificates and keys for this node? — if you choose no, then you will need to manually provide all necessary certificates for the node to work. Otherwise, by choosing yes, the remaining certificates will be automatically generated based on the certification center certificate and key
  • Path to CA certificate — path to the root certificate. The certificate must be the same on all Smart Monitor components
  • Path to CA key — path to the private key. The key must be the same on all Smart Monitor components
  • CN for node certificate — common name for the current server
  • Country for node certificate — country name for the current server
  • State for node certificate — state name for the current server
  • Locality for node certificate — city name for the current server
  • Organization for node certificate — organization name for the current server
  • External IP — external IP address of the current server, which will be used for interaction with other components.

Below is an example with specified existing CA private key and certificate:

Setting SSL parameters

Forming configuration files​

At this stage, no actions are required from the administrator. The stage is conditionally divided into two:

  • Preparing temporary directories, performing checks, preparing templates
  • Forming configuration files from the specified parameters

Creating certificates​

At this stage, no actions are required from the administrator, the private key and certificate of the current server are created from the specified parameters.

Unpacking the archive and changing configuration files​

At this stage, no actions are required from the administrator, the archive with OpenSearch Dashboards is extracted, configuration files extracted from the archive are changed, preparatory processes before system changes.

Beginning changes in OS​

All operations until this moment are performed strictly within the installer directory and do not affect the OS, you can view the ready-to-install set of files in the staging directory. For this, the administrator will be asked for permission to continue the installation:

Warning about beginning changes in OS

Confirm the changes to continue the installation by pressing the y key and then Enter.

Installation​

At this stage, no actions are required from the administrator. Here several actions occur:

  • creating groups and users
  • creating directories
  • installing OpenSearch Dashboards
  • making visual appearance changes
  • installing plugins
  • changing owners of files and directories, as well as setting SELinux rules

Starting the service and enabling the new interface​

At this stage, no actions are required from the administrator.

Completing installation​

At the end of installation, a message about firewall configuration should appear as an example with firewalld, as well as a message about successful installation as in the image below. With any other form of installation completion, an error occurred and additional corrective actions are required.

When the installer completes successfully, the node is deployed and ready for use. The opensearch-dashboards.service service should be running on it. The service will start automatically after rebooting the OS.

Note that you need to configure the firewall for port 5601/tcp – port for accessing OpenSearch-Dashboards. To check operability, open the page https://<your-server-ip-address>:5601 in your browser and use the default account.

Example page output: Example page output