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
Field | Description | Scheme | Required |
---|---|---|---|
checks | Specify checks based on inline and selector | []Check | |
components | RawMessage 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 | |
configs | Specify selectors for config items that should be associated with this component. | []Config | |
forEach | Only applies when using lookup. When specified, the components and properties specified under ForEach will be templated using the components returned by the lookup. | ForEach | |
icon | Specify icon for component | string | |
id | Specify unique ID for component | ID | |
labels | Labels for the component | map[string]string | |
lifecycle | The lifecycle state of the component e.g. production, staging, dev, etc. | string | |
lookup | Lookup component definitions from an external source, use the forEach property to iterate over the results to further enrich each component. | Lookup | |
name | Set name for component | string | |
namespace | Set namespace for component | string | |
order | Set integer order value for component | int | |
owner | Specify owner of component | string | |
properties | Customize component properties as to be visualized on Mission control UI | []Property | |
relationships | Specify relationship of component | []RelationshipSpec | |
selectors | Specify component for topology based on fieldSelector and labelSelector | []ResourceSelector | |
tooltip | Set tooltip outlining information pertaining to the component | string | |
type | Set type of component e.g. service, API, website, library, database, etc. | string |
RelationshipSpec
Field | Description | Scheme | Required |
---|---|---|---|
ref | Set reference for components relationship | string | |
type | Set the type of relationship, e.g. dependsOn, subcomponentOf, providesApis, consumesApis | string |
ForEach
Field | Description | Scheme | Required |
---|---|---|---|
components | Set name for component | []Component | |
properties | Set name for property | []Property | |
configs | Set name for config | []Config | |
relationship | Set name for relationship | []RelationshipSpec | |
checks | Set name for check | []Check |
Config Selector
Field | Description | Scheme | Required |
---|---|---|---|
id | Specify the name of the config item. | []string | |
name | Specify the name of the config item. | string | |
namespace | Specify the namespace of the config item. | string | |
type | Specify type of config item. | string | |
class | Specify type of config item. | string | |
external_id | Specify type of config item. | string | |
tags | Specify tags of config item. | map[string]string |
Check
Field | Description | Scheme | Required |
---|---|---|---|
inline | Define a new health check inline | CanarySpec | |
selector | Select an existing health check | []ResourceSelector |
Lookup
Field | Description | Type | Required |
---|---|---|---|
catalog | Lookup catalogs in configDB. | []Catalog | |
exec | Lookup by running (bash/powershell) scripts. | []Exec | |
kubernetes | Lookup kubernetes resources | []Kubernetes | |
http | Lookup an HTTP endpoint. | []HTTP | |
mongodb | Query records from a MongoDB database. | []MongoDB | |
sql | Query records from a MSSQL database. | []SQL | |
redis | Query records from a Redis server. | []Redis | |
prometheus | Query metrics from Prometheus. | []Prometheus |