Skip to main content

Properties

A topology view can be customized using properties.

properties:
- icon: github
text: https://github.com/spring-petclinic/spring-petclinic-microservices
type: url
- icon: aws
text: eu-west-1
- icon: git
text: vaev6ae (updated 2h ago)
- headline: true
name: Pets
text: '15000'
- headline: true
name: Vets
text: '125'
- color: green
headline: true
name: Visitors
text: '447'

Properties Displayed

Property

FieldDescriptionSchemeRequired
nameSet name for component property.string
valueMutually exclusive with textint64
textMutually exclusive with valuestring
typeSpecify type of component property, one of currency, number, urlstring
unitUnit for component property e.g. milliseconds, bytes, millicores, epoch etc.string
colorSet color for component property.string
headlineToggle headline for component property.bool
iconSpecify icon for component.string
labelSpecify label for component property.string
linksSet links pertaining to component.[]Link
maxSet maximum value for components to display.int64optional
minSet minimum value for components to display.int64
orderSet integer value order for component property.int
statusSpecify status for component property.string
summarySet Summary for component property e.g Healthy, Unhealthy, Warning, and Info.Templateoptional
tooltipSet tooltip outlining information pertaining to the component.string
configLookupSpecify lookup for component config.ConfigLookupoptional

Configuration Lookup

Property values can be looked up from configuration items using the configLookup field:

config-lookup.yaml
apiVersion: canaries.flanksource.com/v1
kind: SystemTemplate
metadata:
name: application-config-lookup
spec:
components:
- name: Application
properties:
- headline: true
name: Version
configLookup:
config:
labels:
namespace: ${.properties.namespace}
name: Configuration.properties
type: File
field: $["application.buildversion"]

This config object is used to find the config item to lookup a value from, if there are multiple matches, the first match is used.

FieldDescriptionSchemeRequired
config.nameThe name of the config item.string
config.typeThe type of config item.string
config.labelsMatch labels of the config item, all labels must matchmap[string]string
fieldA JSONPath expression to lookup the value in the config.stringRequired
displayApply transformations to the value.Display
idThe UUID of config item, rarely usedstring
FieldDescriptionSchemeRequired
iconSet icon for link.string
labelSet label for link.string
textSet text of choice for link.string
tooltipSet tooltip outlining information pertaining to the link.string
typeSpecify type of link e.g. documentation, support, playbook.string
urlSpecify URL for link.string