Skip to main content

Component

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.

Field	Description	Scheme
`id`	ID for component	`uuid`
`name`	Set name for component	`string`
`tooltip`	Set tooltip outlining information pertaining to the component	`string`
`type`	Set type of component e.g. service, API, website, library, database, etc.	`string`
`icon`	Specify icon for component	`string`
`lifecycle`	The lifecycle state of the component e.g. production, staging, dev, etc.	`string`
`owner`	Specify owner of component	`string`
`order`	Set integer order value for component	`int`
`components`	RawMessage is a raw encoded JSON value. It implements Marshaler and Unmarshaler and can be used to delay JSON decoding or precompute a JSON encoding.	`[]Component`
`checks`	Specify checks based on `inline` and `selector`	`[]Check`
`configs`	Specify selectors for config items that should be associated with this component.	`[]Config`
`lookup`	Lookup component definitions from an external source, use the `forEach` property to iterate over the results to further enrich each component.	`Lookup`
`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`
`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`

Field	Description	Scheme
`ref`	Set reference for components relationship	`string`
`type`	Set the type of relationship, e.g. dependsOn, subcomponentOf, providesApis, consumesApis	`string`

ResourceSelector

Field	Description	Scheme
`name`	Set name for selector	`string`
`fieldSelector`	Select Kubernetes or Canary object based on the value of specified resource field	`string`
`labelSelector`	Select Kubernetes or Canary object based on label. e.g. app, canary.	`string`

ForEach

Field	Description	Scheme
`components`	Set name for component	`[]Component`
`properties`	Set name for property	`[]Property`
`configs`	Set name for config	`[]Config`
`relationshisp`	Set name for relationship	`[]RelationshipSpec`
`checks`	Set name for check	`[]Check`

ResourceSelector
ForEach