Static Topology

Search…
Static Topology
This page describes StackState version 4.1. 
The StackState 4.1 version range is End of Life (EOL) and no longer supported. We encourage customers still running the 4.1 version range to upgrade to a more recent release.
Go to the documentation for the latest StackState release.
What is the Static Topology StackPack?
The Static Topology StackPack reads topology information from an external CSV file and synchronizes the data with StackState.
Configuration
Static topology is read from two CSV files:
1.A CSV file containing components
2.A CSV file containing relations
Both CSV files are read to form a topology. The component and relation CSV files require a CSV header. The header specification is as follows:
Component file specification
id - The component's unique identifier
name - The component's name
type - The type of a component, e.g. VM, datastore, rack, etc.
domain (Optional) - The StackState domain where the component should be visualized
layer (Optional) - The StackState layer in where the component should be visualized
environment (Optional) - The StackState environment in where the component should be visualized
All other fields are added as meta data on the component
Note: the fields are expected to be in lowercase letters.
Relation file specification
sourceid - The component's identifier that is used to create a relation from. The identifier has to match the component's id in the component CSV.
targetid - The component's identifier that is used to create a relation to. The identifier has to match the component's id in the component CSV.
type - The type of a relation, e.g. uses, 'depends on'
Note: the fields are expected to be in lowercase letters.
Example CSV files
Component csv:
1
id,name,type,layer,domain,environment
2
1,component1,vm,machines,mydomain,myenvironment
3
2,component2,vm,machines,mydomain,myenvironment
Copied!
Relation csv:
1
sourceid,targetid,type
2
1,2,uses
Copied!
Setup
Configuration
1.Configure the Agent to read CSV topology files. Edit conf.d/static_topology.yaml:
Static topology from file
init_config:
instances:
type: csv components_file: /path/to/components.csv relations_file: /path/to/relations.csv delimiter: ';'
tags:
- optional_tag1
- optional_tag2
Restart the Agent
Configuration Options
type - Set to csv for parsing CSV typed files
components_file - Absolute path to CSV file containing topology components
relations_file - Absolute path to CSV file containing topology relations
delimiter - CSV field delimiter
tags (Optional) - StackState labels to add to each component and relation read from the CSV files.
Validation
Execute the info command and verify that the integration check has passed. The output of the command should contain a section similar to the following:
Checks
[...]
static_topology
instance #0 [OK]
Splunk event
Traefik (BETA)
Last modified 5mo ago
Copy link
Contents
What is the Static Topology StackPack?