Alertmanager Config 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/user/properties/alertmanager

Configuration for application developer controlled alertmanager.

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 (Alertmanager Config)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
affinity	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
enabled	`boolean`	Optional	cannot be null	Compliant Kubernetes Apps Config
nodeSelector	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
resources	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
tolerations	`array`	Optional	cannot be null	Compliant Kubernetes Apps Config
topologySpreadConstraints	`array`	Optional	cannot be null	Compliant Kubernetes Apps Config
ingress	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
image	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config

affinity¶

Affinity is a group of affinity scheduling rules.

affinity

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

TYPE:

object (Affinity)

enabled¶

enabled

is optional
Type: boolean (Enable User Alertmanager)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

boolean (Enable User Alertmanager)

nodeSelector¶

Kubernetes node selector

Kubernetes assign pod node

nodeSelector

is optional
Type: object (Kubernetes Node Selector)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Kubernetes Node Selector)

EXAMPLES:

kubernetes.io/os: linux

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: Compliant Kubernetes 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: Compliant Kubernetes Apps Config

TYPE:

an array of merged types (Details)

topologySpreadConstraints¶

TopologySpreadConstraints describes how pods should spread across topology domains.

topologySpreadConstraints

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

TYPE:

an array of merged types (Details)

ingress¶

Ingress configuration for user alertmanager.

Creates basic-auth protected ingress to alertmanager.

ingress

is optional
Type: object (Ingress for Alertmanager)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Ingress for Alertmanager)

image¶

Override the alertmanager container image.

image

is optional
Type: string (Alermanager Image Override Config)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Alermanager Image Override Config)

EXAMPLES:

quay.io/prometheus/alertmanager:vX.Y.Z

Return to the root config schema

Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main