This page explains the reasoning behind introducing enforced identifier convention and provides guidelines on how to use Identifiers in the configuration of StackState.
Identifier in StackState is a URN that matches the following convention:
Identifiers are structured around the
<type-name> to reflect the the StackGraph having indices per type, as well as the
type is a sensible part of identifications of nodes. Above format allows to have consistent namespaces and control of what Identifiers represent.
free-form part of the Identifier is where it is possible to provide custom taxonomies that are useful in specific configurations.
Please note that using the
: character is not allowed in any segment of the Identifier.
prefix is a required part of the identifier naming the scope the identifier belongs to, purely for organizational purposes. Currently recognized prefixes are:
stackpack:<name>- objects belonging to StackPacks
stackpack:<name>:shared- objects shared between instances of a StackPack
stackpack:<name>:instance:<instanceId>- objects belonging to a specific instance of a StackPack
system:auto- objects created by the system that do not belong to any specific StackPacks
<type-name>:<free-form> is the uniquely identifying part of the identifier. The type-name must match the domain object type of the object the identifier is assigned to (sans the letter case), while the free-form is arbitrary as long as it is unique for the type. The free-form doesn’t need to match the name of the object (if any is present) and can consist of multiple segments. It’s up to the user to decide on the format of the free-form.
Examples of the uniquely identifying segments:
view-health-state-configuration-function:minimum-health-statesfor Minimum Health States in the
AWS event run statecheck function that is shared across AWS StackPack instances
cmdb_ci_netgearComponent Type in the ServiceNow StackPack
urn:stackpack:common:view-health-state-configuration-function:minimum-health-statesfor Minimum Health States
ViewHealthStateConfigurationFunctionin the Common StackPack