Skip to content

API Reference#

Note: You can find the complete API reference in the docs/CRD_DESCRIPTION.md file in the chart package, accessible by using: 

helm pull https://binary.mirantis.com/stacklight/helm/stacklight-operator-0.1.0-mcp-16.tgz --untar

Packages:#

  • monitoring.mirantis.com/v1alpha1

Resource Types:#

StackLight#

↩ Parent

StackLight is the Schema for the StackLight API.

Name Type Description Required
apiVersion string monitoring.mirantis.com/v1alpha1 true
kind string StackLight true
metadata object Refer to the Kubernetes API documentation for the fields of the `metadata` field. true
spec object StackLightSpec defines the desired state of StackLight
 false
status object StackLightStatus defines the observed state of StackLight
 false

StackLight.spec#

↩ Parent

StackLightSpec defines the desired state of the StackLight object.

Name Type Description Required
alerta object Alerta definition.
 false
alertmanager object Alertmanager definition.
 false
blackboxExporter object Blackbox Exporter definition.
 false
cadvisor object cAdvisor definition.
 false
curator object curator definition.
 false
exposeLoadBalancers boolean This parameter enables the creation of LoadBalancer services for multiple components, allowing external access to these components. This setting exposes the services on external IPs. The following services are exposed:
- alerta
- alertmanager
- grafana
- opensearch-dashboards
- prometheus
WARNING: This option is unsafe as it does not provide any form of authentication or authorization, making the exposed components accessible to anyone with network access to the service. It is recommended that you use this setting only in controlled environments or behind an external authentication layer.
 false
fluentd object Fluentd definition.
 false
grafana object Grafana definition.
 false
highAvailabilityEnabled boolean This parameter controls whether the StackLight is deployed in High Availability (HA) mode or Non-HA mode. In HA mode, a minimum of 3 nodes is required for StackLight pods. The differences between HA and Non-HA modes are as follows:
- Alerta: 2 replicas in HA mode (1 replica in Non-HA mode)
- Kube State Metrics: 2 replicas in HA mode (1 replica in Non-HA mode)
- Prometheus: 2 replicas in HA mode (1 replica in Non-HA mode)
- Alertmanager: 2 replicas in HA mode (1 replica in Non-HA mode)
- Spilo: 3 replicas in HA mode (1 replica in Non-HA mode)
- Prometheus Relay: 2 replicas in HA mode (1 replica in Non-HA mode)
- OpenSearch: 3 replicas in HA mode (1 replica in Non-HA mode)
 false
kubeStateMetrics object Kube State Metrics definition.
 false
kubernetes object Parameters specific to the Kubernetes cluster, such as distribution, and other configuration details.
 false
kubevirtMonitoringEnabled boolean Enables or disables monitoring for KubeVirt virtual machines and related components. Defaults to false.
 false
nodeExporter object Node Exporter definition.
 false
opensearch object OpenSearch definition.
 false
opensearchDashboards object OpenSearch Dashboards definition.
 false
prometheus object Prometheus definition.
 false
prometheusRelay object Prometheus Relay definition.
 false
registry string The base container registry URL used for all images in StackLight. This parameter allows you to specify a default registry that will be prepended to each image's repository. If omitted, a default registry will be used. Defaults to "mirantis.azurecr.io".
 false
salesforceNotifier object Salesforce Notifier definition.
 false
spilo object Spilo definition.
 false
storageClassName string What StorageClass will be used for all StackLight PVCs. Components can override this by setting their own storageClassName parameter. If nothing is set, the default StorageClass is used (if it is defined).
 false

StackLight.spec.alerta#

↩ Parent

Alerta definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the Alerta pods are scheduled on.
 false
resources object Define resource requests and limits for the alerta container. Default values:
- requests.cpu: 50m
- requests.memory: 150Mi
- limits.cpu: -
- limits.memory: 500Mi
 false
tolerations []object Alerta pod's tolerations.
 false

StackLight.spec.alerta.resources#

↩ Parent

Define resource requests and limits for the alerta container. Default values:
- requests.cpu: 50m
- requests.memory: 150Mi
- limits.cpu: -
- limits.memory: 500Mi

Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.alerta.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.alerta.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.alertmanager#

↩ Parent

Alertmanager definition.

Name Type Description Required
extraReceivers string Provides the ability to add additional notification receivers to the Alertmanager. These custom receivers are merged with the default receivers defined by StackLight. Use this parameter to specify additional receivers that are not included in the default configuration. The receivers must be provided in a valid YAML list format, following Alertmanager's configuration file syntax. Example of a sample receiver:
extraReceivers: |
  - name: sample-slack
    slackConfigs:
    - apiUrl: https://hooks.slack.com/services/...
      channel: "#sample"
      sendResolved: true
WARNING: Ensure that the notification receivers are valid and properly formatted to avoid configuration issues.
 false
extraRoutes string Provides the ability to add additional notification routes to the Alertmanager. These custom routes are merged with the default routes defined by StackLight. Use this parameter to specify additional routes that are not included in the default configuration. The routes must be provided in a valid YAML list format, following Alertmanager's configuration file syntax. Example of a sample route:
extraRoutes: |
  - receiver: sample-slack
    matchers:
    - severity="critical"
    continue: true
WARNING: Ensure that the routes are valid and properly formatted to avoid configuration issues.
 false
nodeSelector map[string]string Define which nodes the Alertmanager pods are scheduled on.
 false
resources object Define resource requests and limits for the Alertmanager containers. Default values:
- requests.cpu: 50m
- requests.memory: 50Mi
- limits.cpu: 200m
- limits.memory: 200Mi
 false
storageClassName string What StorageClass will be used for Alertmanager PVC(s). Defaults to the storageClassName parameter value defined at the top level. If nothing is set, the default StorageClass is used (if it is defined).
 false
tolerations []object Alertmanager pod's tolerations.
 false

StackLight.spec.alertmanager.resources#

↩ Parent

Define resource requests and limits for the Alertmanager containers. Default values:

  • requests.cpu: 50m
  • requests.memory: 50Mi
  • limits.cpu: 200m
  • limits.memory: 200Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.alertmanager.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.alertmanager.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.blackboxExporter#

↩ Parent

Blackbox Exporter definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the Blackbox Exporter pods are scheduled on.
 false
resources object Define resource requests and limits for the Blackbox Exporter containers. Default values:
- requests.cpu: 50m
- requests.memory: 50Mi
- limits.cpu: 100m
- limits.memory: 100Mi
 false
tolerations []object Blackbox Exporter pod's tolerations.
 false

StackLight.spec.blackboxExporter.resources#

↩ Parent

Define resource requests and limits for the Blackbox Exporter containers. Default values:

  • requests.cpu: 50m
  • requests.memory: 50Mi
  • limits.cpu: 100m
  • limits.memory: 100Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.blackboxExporter.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.blackboxExporter.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.cadvisor#

↩ Parent

cAdvisor definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the cAdvisor pods are scheduled on.
 false
resources object Define resource requests and limits for the cAdvisor containers. Default values:
- requests.cpu: 100m
- requests.memory: 100Mi
- limits.cpu: 500m
- limits.memory: 500Mi
 false
tolerations []object cAdvisor pod's tolerations. By default the following taints are tolerated:
- node-role.kubernetes.io/control-plane:NoSchedule
- node-role.kubernetes.io/master:NoSchedule
- com.docker.ucp.manager:NoSchedule
 false

StackLight.spec.cadvisor.resources#

↩ Parent

Define resource requests and limits for the cAdvisor containers. Default values:

  • requests.cpu: 100m
  • requests.memory: 100Mi
  • limits.cpu: 500m
  • limits.memory: 500Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.cadvisor.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.cadvisor.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.curator#

↩ Parent

curator definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the curator pods are scheduled on.
 false
resources object Define resource requests and limits for the curator container. Default values: - requests.cpu: 20m
- requests.memory: 100Mi
- limits.cpu: -
- limits.memory: 400Mi
 false
tolerations []object curator pod's tolerations.
 false

StackLight.spec.curator.resources#

↩ Parent

Define resource requests and limits for the curator container. Default values:

  • requests.cpu: 20m
  • requests.memory: 100Mi
  • limits.cpu: -
  • limits.memory: 400Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.curator.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.curator.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.fluentd#

↩ Parent

Fluentd definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the Fluentd pods are scheduled on.
 false
resources object Define resource requests and limits for the fluentd container. Default values:
- requests.cpu: 500m
- requests.memory: 200Mi
- limits.cpu: 1000m
- limits.memory: 800Mi
 false
tolerations []object Fluentd pod's tolerations. By default the following taints are tolerated:
- node-role.kubernetes.io/control-plane:NoSchedule
- node-role.kubernetes.io/master:NoSchedule
- com.docker.ucp.manager:NoSchedule
 false

StackLight.spec.fluentd.resources#

↩ Parent

Define resource requests and limits for the fluentd container. Default values:

  • requests.cpu: 500m
  • requests.memory: 200Mi
  • limits.cpu: 1000m
  • limits.memory: 800Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.fluentd.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.fluentd.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.grafana#

↩ Parent

Grafana definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the Grafana pods are scheduled on.
 false
resources object Define resource requests and limits for the grafana container. Default values:
- requests.cpu: 50m
- requests.memory: 200Mi
- limits.cpu: -
- limits.memory: 400Mi
 false
tolerations []object Grafana pod's tolerations.
 false

StackLight.spec.grafana.resources#

↩ Parent

Define resource requests and limits for the grafana container. Default values:

  • requests.cpu: 50m
  • requests.memory: 200Mi
  • limits.cpu: -
  • limits.memory: 400Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.grafana.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.grafana.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.kubeStateMetrics#

↩ Parent

Kube State Metrics definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the Kube State Metrics pods are scheduled on.
 false
resources object Define resource requests and limits for the Kube State Metrics containers. Default values:
- requests.cpu: 50m
- requests.memory: 100Mi
- limits.cpu: -
- limits.memory: 800Mi
 false
tolerations []object Kube State Metrics pod's tolerations.
 false

StackLight.spec.kubeStateMetrics.resources#

↩ Parent

Define resource requests and limits for the Kube State Metrics containers. Default values:

  • requests.cpu: 50m
  • requests.memory: 100Mi
  • limits.cpu: -
  • limits.memory: 800Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.kubeStateMetrics.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.kubeStateMetrics.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.kubernetes#

↩ Parent

Parameters specific to the Kubernetes cluster, such as distribution, and other configuration details.

Name Type Description Required
distribution enum This parameter specifies the Kubernetes distribution used in the cluster. This information allows monitoring components to adapt and apply distribution-specific configurations or metrics collection methods. Valid values are:
- "MKE3" for Mirantis Kubernetes Engine v3.7+
- "k0s" for k0s Defaults to MKE3.

Enum: MKE3, k0s
 false

StackLight.spec.nodeExporter#

↩ Parent

Node Exporter definition.

Name Type Description Required
extraCollectors []string Define Node Exporter collectors that have to be enabled in addition to the collectors enabled in StackLight. Collectors enabled in StackLight out of the box:
- arp
- conntrack
- cpu
- diskstats
- entropy
- filefd
- filesystem
- hwmon
- loadavg
- meminfo
- netclass
- netdev
- netstat
- stat
- sockstat
- textfile
- time
- timex
- uname
- vmstat
 false
nodeSelector map[string]string Define which nodes the Node Exporter pods are scheduled on.
 false
port integer Port on which to expose metrics and web interface. Defaults to 19100.

Format: int32
 false
resources object Define resource requests and limits for the Node Exporter containers. Default values:
- requests.cpu: 50m
- requests.memory: 50Mi
- limits.cpu: -
- limits.memory: 150Mi
 false
tolerations []object Node Exporter pod's tolerations. By default the following taints are tolerated:
- node-role.kubernetes.io/control-plane:NoSchedule
- node-role.kubernetes.io/master:NoSchedule
- com.docker.ucp.manager:NoSchedule
 false

StackLight.spec.nodeExporter.resources#

↩ Parent

Define resource requests and limits for the Node Exporter containers. Default values:

  • requests.cpu: 50m
  • requests.memory: 50Mi
  • limits.cpu: -
  • limits.memory: 150Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.nodeExporter.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.nodeExporter.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.opensearch#

↩ Parent

OpenSearch definition.

Name Type Description Required
editMaxMapCount boolean Enables init container that runs "sysctl -w vm.max_map_count=262144" to satisfy OpenSearch requirements. It is better have this parameter disabled and preconfigure vm.max_map_count on the nodes using native kernel parameters modification tools. Min value of vm.max_map_count for OpenSearch is 262144.
 false
nodeSelector map[string]string Define which nodes the OpenSearch pods are scheduled on.
 false
persistentVolumeClaimSize string OpenSearch PersistentVolumeClaim(s) size. This field is immutable, its value can't be changed once set. Defaults to 30Gi.
 false
resources object Define resource requests and limits for the OpenSearch containers. Default values:
- requests.cpu: 500m
- requests.memory: 6Gi
- limits.cpu: 2000m
- limits.memory: 8Gi
 false
storageClassName string What StorageClass will be used for OpenSearch PVC(s). Defaults to the storageClassName parameter value defined at the top level. If nothing is set, the default StorageClass is used (if it is defined).
 false
tolerations []object OpenSearch pod's tolerations.
 false

StackLight.spec.opensearch.resources#

↩ Parent

Define resource requests and limits for the OpenSearch containers. Default values:

  • requests.cpu: 500m
  • requests.memory: 6Gi
  • limits.cpu: 2000m
  • limits.memory: 8Gi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.opensearch.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.opensearch.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.opensearchDashboards#

↩ Parent

OpenSearch Dashboards definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the OpenSearch Dashboards pods are scheduled on.
 false
resources object Define resource requests and limits for the OpenSearch Dashboards containers. Default values:
- requests.cpu: 500m
- requests.memory: 500Mi
- limits.cpu: 1000m
- limits.memory: 1500Mi
 false
tolerations []object OpenSearch Dashboards pod's tolerations.
 false

StackLight.spec.opensearchDashboards.resources#

↩ Parent

Define resource requests and limits for the OpenSearch Dashboards containers. Default values:

  • requests.cpu: 500m
  • requests.memory: 500Mi
  • limits.cpu: 1000m
  • limits.memory: 1500Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.opensearchDashboards.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.opensearchDashboards.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.prometheus#

↩ Parent

Prometheus definition.

Name Type Description Required
extraAlertingRules string Provides the ability to add additional alerting rules to the Prometheus. These custom rules are merged with the default alerting rules defined by StackLight. Use this parameter to specify additional alerts that are not included in the default configuration. The rules must be provided in a valid YAML list format, following Prometheus' alerting rule syntax. Example of a sample alerting rule: 
extraAlertingRules: |
  - alert: SampleAlert
    expr: sample_metric > 100
    for: 10m
    labels:
      severity: warning
    annotations:
      summary: "Sample alert triggered"
      description: "The sample_metric has exceeded the threshold for more than 10 minutes."
WARNING: Ensure that the alerting rules are valid and properly formatted to avoid configuration issues.
 false
extraScrapeConfigs string Provides the ability to add additional scrape configurations to the Prometheus. These configurations are merged with the default scrape configurations defined by StackLight. Use this parameter to specify custom targets for scraping metrics that are not covered by the default settings. The scrape configurations must be provided in a valid YAML list format, following Prometheus' scrape configuration syntax. Example of a sample scrape configuration: 
extraScrapeConfigs: |
  - job_name: 'sample-scrape-job'
    static_configs:
    - targets: ['localhost:9090']
WARNING: Ensure that the scrape configurations are valid and properly formatted to avoid configuration issues.
 false
globalExternalLabels map[string]string Labels to add to any time series or alerts when communicating with external systems (such as federation, remote storage, or Alertmanager). WARNING: Ensure that the label names are unique enough to avoid conflicts or intersections with labels that already exist in metrics and alerts, as overlapping labels can lead to unexpected behavior in metrics aggregation and alert routing.
 false
nodeSelector map[string]string Define which nodes the Prometheus pods are scheduled on.
 false
persistentVolumeClaimSize string Prometheus PersistentVolumeClaim(s) size. This field is immutable, its value can't be changed once set. Defaults to 15Gi.
 false
resources object Define resource requests and limits for the Prometheus containers. Default values:
- requests.cpu: 500m
- requests.memory: 2Gi
- limits.cpu: 1000m
- limits.memory: 8Gi
 false
retentionSize string The maximum number of bytes of storage blocks to retain. The value is passed to the --storage.tsdb.retention.size flag. Defaults to 14GB.
 false
retentionTime string How long to retain samples in storage. The value is passed to the --storage.tsdb.retention.time flag.
 false
storageClassName string What StorageClass will be used for Prometheus PVC(s). Defaults to the storageClassName parameter value defined at the top level. If nothing is set, the default StorageClass is used (if it is defined).
 false
tolerations []object Prometheus pod's tolerations.
 false

StackLight.spec.prometheus.resources#

↩ Parent

Define resource requests and limits for the Prometheus containers. Default values:

  • requests.cpu: 500m
  • requests.memory: 2Gi
  • limits.cpu: 1000m
  • limits.memory: 8Gi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.prometheus.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.prometheus.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.prometheusRelay#

↩ Parent

Prometheus Relay definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the Prometheus Relay pods are scheduled on.
 false
resources object Define resource requests and limits for the Prometheus Relay container. Default values:
- requests.cpu: 50m
- requests.memory: 100Mi
- limits.cpu: 200m
- limits.memory: 500Mi
 false
tolerations []object Prometheus Relay pod's tolerations.
 false

StackLight.spec.prometheusRelay.resources#

↩ Parent

Define resource requests and limits for the Prometheus Relay container. Default values:

  • requests.cpu: 50m
  • requests.memory: 100Mi
  • limits.cpu: 200m
  • limits.memory: 500Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.prometheusRelay.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.prometheusRelay.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.salesforceNotifier#

↩ Parent

Salesforce Notifier definition.

Name Type Description Required
credentialsSecretName string Specifies the name of the Kubernetes Secret that contains the Salesforce authentication details, such as the authentication URL, username, password, organization ID, and environment ID. The Secret must be in the same namespace as the custom resource. Ensure the Secret is created and populated with valid credentials before enabling the Salesforce Notifier. The Secret's data must contain the following keys with corresponding values:
- SFDC_AUTH_URL
- SFDC_USERNAME
- SFDC_PASSWORD
- SFDC_ORGANIZATION_ID
- SFDC_ENVIRONMENT_ID
 false
enabled boolean Controls whether the Salesforce Notifier is enabled or disabled. Defaults to false.
 false
nodeSelector map[string]string Define which nodes the Salesforce Notifier pods are scheduled on.
 false
resources object Define resource requests and limits for the Salesforce Notifier containers. Default values: - requests.cpu: 600m
- requests.memory: 300Mi
- limits.cpu: 1200m
- limits.memory: 600Mi
 false
tolerations []object Salesforce Notifier pod's tolerations.
 false

StackLight.spec.salesforceNotifier.resources#

↩ Parent

Define resource requests and limits for the Salesforce Notifier containers. Default values:

  • requests.cpu: 600m
  • requests.memory: 300Mi
  • limits.cpu: 1200m
  • limits.memory: 600Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.salesforceNotifier.resources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.salesforceNotifier.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.spec.spilo#

↩ Parent

Spilo definition.

Name Type Description Required
nodeSelector map[string]string Define which nodes the Spilo pods are scheduled on.
 false
patroniExporterResources object Define resource requests and limits for the patroni-exporter container. Default values:
- requests.cpu: 100m
- requests.memory: 40Mi
- limits.cpu: 150m
- limits.memory: 80Mi
 false
postgresExporterResources object Define resource requests and limits for the postgres-exporter container. Default values:
- requests.cpu: 150m
- requests.memory: 40Mi
- limits.cpu: 450m
- limits.memory: 80Mi
 false
spiloResources object Define resource requests and limits for the spilo container. Default values:
- requests.cpu: 300m
- requests.memory: 300Mi
- limits.cpu: 600m
- limits.memory: 2Gi
 false
storageClassName string What StorageClass will be used for Spilo PVC(s). Defaults to the storageClassName parameter value defined at the top level. If nothing is set, the default StorageClass is used (if it is defined).
 false
tolerations []object Spilo pod's tolerations.
 false

StackLight.spec.spilo.patroniExporterResources#

↩ Parent

Define resource requests and limits for the patroni-exporter container. Default values:

  • requests.cpu: 100m
  • requests.memory: 40Mi
  • limits.cpu: 150m
  • limits.memory: 80Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.spilo.patroniExporterResources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.spilo.postgresExporterResources#

↩ Parent

Define resource requests and limits for the postgres-exporter container. Default values:

  • requests.cpu: 150m
  • requests.memory: 40Mi
  • limits.cpu: 450m
  • limits.memory: 80Mi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.spilo.postgresExporterResources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.spilo.spiloResources#

↩ Parent

Define resource requests and limits for the spilo container. Default values:

  • requests.cpu: 300m
  • requests.memory: 300Mi
  • limits.cpu: 600m
  • limits.memory: 2Gi
Name Type Description Required
claims []object Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers.
 false
limits map[string]int or string Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false
requests map[string]int or string Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
 false

StackLight.spec.spilo.spiloResources.claims[index]#

↩ Parent

ResourceClaim references one entry in PodSpec.ResourceClaims.

Name Type Description Required
name string Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
 true

StackLight.spec.spilo.tolerations[index]#

↩ Parent

The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .

Name Type Description Required
effect string Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
 false
key string Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
 false
operator string Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
 false
tolerationSeconds integer TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

Format: int64
 false
value string Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.
 false

StackLight.status#

↩ Parent

StackLightStatus defines the observed state of StackLight

Name Type Description Required
alerta object Alerta status.
 false
alertmanager object Alertmanager status.
 false
blackboxExporter object Blackbox Exporter status.
 false
cadvisor object cAdvisor status.
 false
curator object curator status.
 false
fluentd object Fluentd status.
 false
grafana object Grafana status.
 false
kubeStateMetrics object Kube State Metrics status.
 false
nodeExporter object Node Exporter status.
 false
opensearch object OpenSearch status.
 false
opensearchDashboards object OpenSearch Dashboards status.
 false
prometheus object Prometheus status.
 false
prometheusRelay object Prometheus Relay status.
 false
salesforceNotifier object Salesforce Notifier status.
 false
spilo object Spilo status.
 false

StackLight.status.alerta#

↩ Parent

Alerta status.

Name Type Description Required
version string Alerta version.
 false

StackLight.status.alertmanager#

↩ Parent

Alertmanager status.

Name Type Description Required
version string Alertmanager version.
 false

StackLight.status.blackboxExporter#

↩ Parent

Blackbox Exporter status.

Name Type Description Required
version string Blackbox Exporter version.
 false

StackLight.status.cadvisor#

↩ Parent

cAdvisor status.

Name Type Description Required
version string cAdvisor version.
 false

StackLight.status.curator#

↩ Parent

curator status.

Name Type Description Required
version string curator version.
 false

StackLight.status.fluentd#

↩ Parent

Fluentd status.

Name Type Description Required
version string Fluentd version.
 false

StackLight.status.grafana#

↩ Parent

Grafana status.

Name Type Description Required
version string Grafana version.
 false

StackLight.status.kubeStateMetrics#

↩ Parent

Kube State Metrics status.

Name Type Description Required
version string Kube State Metrics version.
 false

StackLight.status.nodeExporter#

↩ Parent

Node Exporter status.

Name Type Description Required
version string Node Exporter version.
 false

StackLight.status.opensearch#

↩ Parent

OpenSearch status.

Name Type Description Required
version string OpenSearch version.
 false

StackLight.status.opensearchDashboards#

↩ Parent

OpenSearch Dashboards status.

Name Type Description Required
version string OpenSearch Dashboards version.
 false

StackLight.status.prometheus#

↩ Parent

Prometheus status.

Name Type Description Required
version string Prometheus version.
 false

StackLight.status.prometheusRelay#

↩ Parent

Prometheus Relay status.

Name Type Description Required
version string Prometheus Relay version.
 false

StackLight.status.salesforceNotifier#

↩ Parent

Salesforce Notifier status.

Name Type Description Required
version string Salesforce Notifier version.
 false

StackLight.status.spilo#

↩ Parent

Spilo status.

Name Type Description Required
version string Spilo version.
 false