Skip to main content

Components are the building blocks of a Topology. The component specification provides a way for you to define the properties and characteristics of each Component in the Topology.

Component

FieldDescriptionSchemeRequired
checksSpecify checks based on inline and selector[]Check
componentsRawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or pre-compute a JSON encoding.[]Component
configsSpecify selectors for config items that should be associated with this component.[]Config
forEachOnly applies when using lookup. When specified, the components and properties specified under ForEach will be templated using the components returned by the lookup.ForEach
iconSpecify icon for componentstring
idSpecify unique ID for componentID
labelsLabels for the componentmap[string]string
lifecycleThe lifecycle state of the component e.g. production, staging, dev, etc.string
lookupLookup component definitions from an external source, use the forEach property to iterate over the results to further enrich each component.Lookup
nameSet name for componentstring
namespaceSet namespace for componentstring
orderSet integer order value for componentint
ownerSpecify owner of componentstring
propertiesCustomize component properties as to be visualized on Mission control UI[]Property
relationshipsSpecify relationship of component[]RelationshipSpec
selectorsSpecify component for topology based on fieldSelector and labelSelector[]ResourceSelector
tooltipSet tooltip outlining information pertaining to the componentstring
typeSet type of component e.g. service, API, website, library, database, etc.string

RelationshipSpec

FieldDescriptionSchemeRequired
refSet reference for components relationshipstring
typeSet the type of relationship, e.g. dependsOn, subcomponentOf, providesApis, consumesApisstring

ForEach

FieldDescriptionSchemeRequired
componentsSet name for component[]Component
propertiesSet name for property[]Property
configsSet name for config[]Config
relationshipSet name for relationship[]RelationshipSpec
checksSet name for check[]Check

Config Selector

FieldDescriptionSchemeRequired
idSpecify the name of the config item.[]string
nameSpecify the name of the config item.string
namespaceSpecify the namespace of the config item.string
typeSpecify type of config item.string
classSpecify type of config item.string
external_idSpecify type of config item.string
tagsSpecify tags of config item.map[string]string

Check

FieldDescriptionSchemeRequired
inlineDefine a new health check inlineCanarySpec
selectorSelect an existing health check[]ResourceSelector

Lookup

FieldDescriptionTypeRequired
catalogLookup catalogs in configDB.[]Catalog
execLookup by running (bash/powershell) scripts.[]Exec
kubernetesLookup kubernetes resources[]Kubernetes
httpLookup an HTTP endpoint.[]HTTP
mongodbQuery records from a MongoDB database.[]MongoDB
sqlQuery records from a MSSQL database.[]SQL
redisQuery records from a Redis server.[]Redis
prometheusQuery metrics from Prometheus.[]Prometheus