API Reference

Configuration details

Config

Customize the integration with a KubernetesCluster

Field	Description	Type	Required
`concurrency`	Concurrent processes to be executed to improve performance	int	false
`logLevel`	Log level to be used by the related Pod	string	false
`observability`	Observability configuration	ObservabilityConfig	false
`resources`	Resources to be assigned to the synchronization Pod	ResourceRequirements	false
`selectors`	Filter the list of resources to be listened	KubernetesClusterSelectors	false

ObservabilityConfig

Configure the synchronization process observability using Prometheus ServiceMonitor

Field	Description	Type	Required
`enabled`	Enable the Observability with a Prometheus ServiceMonitor	bool	false
`interval`	Configure the interval in the ServiceMonitor that Prometheus will use to scrape metrics	Duration	false

Duration

Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.

Field	Description	Type	Required

KubernetesClusterSelectors

Filter the Kubernetes objects that should be read from the cluster

Field	Description	Type	Required
`objectSelector`	Rules to filter Kubernetes objects by ObjectSelector	ObjectSelector	false
`namespaceSelector`	Rules to filter Kubernetes objects by NamespaceSelector	NamespaceSelector	false
`targets`	Kuberentes resourcs to be usedr	[]GroupVersionResources	false

ObjectSelector

Field	Description	Type	Required
`nameSelector`	Filter objects by their name	NameSelector	false
`labelSelector`	Filter objects by their labels	LabelSelector	false

NameSelector

Select object by their name

Field	Description	Type	Required
`includeRegex`	Include names that matches at least one regex	[]string	false
`excludeRegex`	Exlcude names that matches at least one regex	[]string	false

LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic

Field	Description	Type	Required
`matchLabels`	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabelsmap is equivalent to an element of matchExpressions, whose key field is “key”, theoperator is “In”, and the values array contains only “value”. The requirements are ANDed.+optional	map[string]string	false
`matchExpressions`	matchExpressions is a list of label selector requirements. The requirements are ANDed.+optional+listType=atomic	[]LabelSelectorRequirement	false

LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Field	Description	Type	Required
`key`	key is the label key that the selector applies to.	string	false
`operator`	operator represents a key’s relationship to a set of values.Valid operators are In, NotIn, Exists and DoesNotExist.	LabelSelectorOperator	false
`values`	values is an array of string values. If the operator is In or NotIn,the values array must be non-empty. If the operator is Exists or DoesNotExist,the values array must be empty. This array is replaced during a strategicmerge patch.+optional+listType=atomic	[]string	false

LabelSelectorOperator

A label selector operator is the set of operators that can be used in a selector requirement.

Field	Description	Type	Required

NamespaceSelector

Field	Description	Type	Required
`nameSelector`	Filter Namespaces by their name	NameSelector	false
`labelSelector`	Filter Namespaces by their labels	LabelSelector	false

GroupVersionResources

Select a set of GroupVersionResource

Field	Description	Type	Required
`group`	Kubernetes resource group. Example: apps	string	false
`version`	Kubernetes resource version. Example: v1	string	false
`resources`	Kubernetes resource names. Example: deployments	[]string	false