Skip to main content
Version: 5.0

Installing Inventory

Prerequisites​

The following files are required for installation:

  • Archive with sm-inventory module files for OpenSearch
  • Archive with smartMonitorInventory module files for OpenSearch Dashboards

Installation Process​

Installation on OpenSearch servers is performed using the following command:

sudo -u opensearch $OPENSEARCH_HOME/bin/opensearch-plugin install file://<path to module archive>

Installation on OpenSearch Dashboards servers is performed using the following command:

sudo -u opensearch $OPENSEARCH_DASHBOARDS_HOME/bin/opensearch-dashboards-plugin install file://<path to module archive>

Inventory Initialization​

To initialize the module, go to System Settings - Module Configuration - Inventory - Initialization:

Inventory Initialization

Integration with SAF​

In the User field, enter the OpenSearch account name.

warning

The Password field is non-editable and is managed via the OpenSearch keystore.

Integration with PostgreSQL​

PostgreSQL integration is required for the Inventory module to function properly according to the updated calculation algorithm.

By default, this option is disabled — in that case, the fields are not mandatory. Once the option is enabled, all fields become required.

To configure the connection, fill in the following form fields:

  • Host — the database server's IP address

  • Port — the port for connecting to PostgreSQL

  • Database — the name of the database to use

  • User — the username for connecting

warning

The Password field is non-editable and is managed via the OpenSearch keystore.

Node Execution Filtering​

By default, tasks will be executed on all servers where the Inventory module is installed. Filters allow you to control the set of nodes used for task execution. This parameter is optional.

The following filter types are available:

  • Include – at least one condition must be met

  • Exclude – none of the conditions must be met

  • Require – all conditions must be met

The following attribute types are available:

  • Node Name

  • Host IP Address

  • Public Host IP Address

  • IP Address

  • Host Name

  • Node Identifier

  • Custom Attribute

The node parameter is entered in the Value field.

note

When using a custom attribute, an additional input field will appear for entering its name:

Custom Attribute

Editing Inventory Settings​

After initializing the module, you can edit its parameters and add additional settings on the same tab.

Example of a completed form:

Inventory Settings

Adding a Section to the Main Menu​

To add the module component to the menu, navigate to Main Menu - Settings - Management - Navigation - JSON. Add the JSON dictionary below to the data list.

Inventory Menu
{
  "itemType": "module",
  "name": "inventory",
  "show": false,
  "id": "39afa001-b528-4488-bd55-58b09c0bded9",
  "title": "Inventory",
  "sections": [
    {
      "itemType": "page",
      "name": "inventory-configs",
      "show": true,
      "id": "f8518eba-cdf9-4341-bd14-51644f09c620",
      "title": "Assets",
      "enabled": true
    }
  ],
  "enabled": true
}