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/prometheus/properties/alertmanagerSpec

Configure service cluster Alertmanager.

Alertmanager receives alerts from Prometheus and Thanos and forwards them to the configured notification channel.

Note

Alertmanager is installed in both service cluster and workload cluster, however this configuration key only applies to the service cluster, use user.alertmanager to configure it in the workload cluster.

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
replicas	`number`	Optional	cannot be null	Welkin Apps Config
storage	`object`	Optional	cannot be null	Welkin Apps Config
groupBy	`array`	Optional	cannot be null	Welkin Apps Config
resources	`object`	Optional	cannot be null	Welkin Apps Config
topologySpreadConstraints	`array`	Optional	cannot be null	Welkin Apps Config
affinity	`object`	Optional	cannot be null	Welkin Apps Config

replicas¶

replicas

is optional
Type: number (Alertmanager Replicas)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (Alertmanager Replicas)

DEFAULTS:

The default value is:

storage¶

Configure persistent storage for Alertmanager.

storage

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

TYPE:

object (Alertmanager Storage)

groupBy¶

Configure Alertmanager to group certain alerts based on labels.

Note

See the upstream documentation for reference.

groupBy

is optional
Type: string[]
cannot be null
defined in: Welkin Apps Config

TYPE:

string[]

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

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: 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