Configuration Installation and Setup

The make_apm.py script is used for automated deployment of infrastructure objects for the APM module. It is included in the apm_ko_maker package and located in the bin directory.

Utility Core Functions

• deployment of knowledge objects (Search Anywhere Framework entities)
• creation of index templates
• creation of index patterns
• inventory settings

---

Requirements

• Python 3.12 or higher
• utility dependencies are installed by the bin/install_dependencies.sh script, which creates .venv and installs the smpy and httpx libraries
• access to Search Anywhere Framework cluster with admin privileges

---

Project Structure

./
├── bin/                   # Installation and deployment scripts
├── data/                  # Configuration files
│   ├── core/              # Asset Service Model (ASM) layers
│   ├── index-patterns/    # Index patterns
│   ├── indexes/           # Index configurations
│   ├── inv/               # Inventory settings
│   ├── sm_*/              # Search Anywhere Framework entities
│   ├── index_templates/   # Index templates
│   └── ism_policies/      # ISM policies
├── templates/             # ASM metric templates

---

Configuration File Formats

Search Anywhere Framework Entities (saf_*)

{
  "_meta": { 
	  // metadata
  },
  // configuration
}

Index Templates (index_templates)

{
  "name": "template_name",
  "index_template": {
    // template configuration
  }
}

ASM Layers (core/rsm/layers)

{
  "title": "layer_name",
  "description": "layer_description"
}

Index Patterns (index-patterns)

{
  "attributes": {
    "title": "pattern_name"
  },
  "references": []
}

Inventory (inv)

• inv/inventories — asset configurations
• inv/relationSettings — relationships between assets

---

Installation Sequence

Step 1. Install Utility Dependencies

./bin/install_dependencies.sh

The script creates the .venv virtual environment and installs utility dependencies, including the smpy and httpx libraries.

Step 2. Run Configuration Installation

./bin/make_apm.py \
  --sm_host <SAF_HOST> \
  --sm_api_port <SAF_API_PORT> \
  --sm_cluster_port <OPENSEARCH_PORT> \
  --sm_user <SAF_USER> \
  --sm_password '<SAF_PASSWORD>'

Parameter	Required	Type	Default	Description
--sm_host	Yes	string	—	Search Anywhere Framework cluster host
--sm_api_port	No	int	5601	Frontend API port (saved objects, ASM, inventory)
--sm_cluster_port	No	int	9200	OpenSearch API port (index templates, saf entities)
--sm_user	Yes	string	—	Username
--sm_password	Yes	string	—	User password

Example

./bin/make_apm.py --sm_host sm-host.my_company.ru --sm_api_port 5601 --sm_cluster_port 9200 --sm_user admin --sm_password securepassword

Attention!

--sm_api_port is used for the frontend API, saved objects, ASM, and inventory. --sm_cluster_port is used for the OpenSearch API (index templates and saf entities). If the frontend API and OpenSearch are published on different servers, you can explicitly set --sm_api_host and --sm_cluster_host.

Step 3. Verify Results in the Interface

After execution, verify the applied configurations:

1. Indexes

   • navigation: Main Menu - Settings - Index Management - Indexes
   • 

2. Index policies

   • navigation: Main Menu - Settings - Index Management - Index policies
   • policy otel-apm-ism-policy
   • 

3. Managed indices

   • navigation: Main Menu - Settings - Index Management - Managed indices
   • 

4. Templates

   • navigation: Main Menu - Settings - Index Management - Templates
   • 

5. Lookups

   • navigation: Main Menu - Lookup Manager - Lookups
   • should include:
     • dim_apm_service
     • link_apm_source_service_dest_service

Step 4. Register the Module Incident Type

After importing the APM content module, run the apply_incident_types.py script from the same apm_ko_maker utility. The script registers incident card fields (investigation playbook), idempotently creates the IT Incident incident type, and then assigns it to the module jobs.

./bin/apply_incident_types.py \
  --sm_host <SAF_HOST> \
  --sm_api_port <SAF_API_PORT> \
  --sm_user <SAF_USER> \
  --sm_password '<SAF_PASSWORD>'

After execution, verify that:

• the IT Incident incident type appears in Main Menu - Incident Manager - Incident Types
• the type is available in the Incident Type dropdown list in the job editor
• incident jobs of the APM module received this type
• the incident card displays the playbook fields