Prometheus Blackbox Exporter Schema¶

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/prometheusBlackboxExporter

Configure Prometheus Blackbox Exporter, the exporter used for probing endpoints.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	config/schemas/config.yaml*

TYPE:

object (Prometheus Blackbox Exporter)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
targets	`object`	Optional	cannot be null	Welkin Apps Config
customKubeapiTargets	`array`	Optional	cannot be null	Welkin Apps Config
hostAliases	`array`	Optional	cannot be null	Welkin Apps Config
resources	`object`	Optional	cannot be null	Welkin Apps Config
tolerations	`array`	Optional	cannot be null	Welkin Apps Config
affinity	`object`	Optional	cannot be null	Welkin Apps Config

targets¶

Configure the targets Prometheus Blackbox Exporter should probe.

targets

is optional
Type: object (Prometheus Blackbox Exporter Targets)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Prometheus Blackbox Exporter Targets)

customKubeapiTargets¶

Configure custom Kube API targets Prometheus Blackbox Exporter should probe.

customKubeapiTargets

is optional
Type: object[] (Custom Kube API target)
cannot be null
defined in: Welkin Apps Config

TYPE:

object[] (Custom Kube API target)

hostAliases¶

Configure host aliases to resolve internally within the Pod.

hostAliases

is optional
Type: object[] (Host Alias)
cannot be null
defined in: Welkin Apps Config

TYPE:

object[] (Host Alias)

resources¶

Resource requests are used by the kube-scheduler to pick a node to schedule pods on.

Limits are enforced. Resources are commonly 'cpu' and 'memory'.

resources

is optional
Type: object (Kubernetes Resource Requirements)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

requests:
  memory: 128Mi
  cpu: 100m
limits:
  memory: 256Mi
  cpu: 250m

tolerations¶

Kubernetes Tolerations

Kubernetes taint and toleration

tolerations

is optional
Type: an array of merged types (Details)
cannot be null
defined in: Welkin Apps Config

TYPE:

an array of merged types (Details)

affinity¶

Affinity is a group of affinity scheduling rules.

affinity

is optional
Type: object (Affinity)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Affinity)

Return to the root config schema

Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main