This section describes the StackLight configuration keys that you can specify
in the values section to change StackLight settings as required. Prior to
making any changes to StackLight configuration, perform the steps described in
Configure StackLight.
After changing StackLight configuration, verify the changes as described in
Verify StackLight after configuration.
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables Alerta. Set to |
|
Key |
Description |
Example values |
|---|---|---|
|
Defines the Elasticsearch |
|
Key |
Description |
Example values |
|---|---|---|
|
Disables Grafana Image Renderer. For example, for resource-limited environments. Enabled by default. |
|
|
Defines the home dashboard. Set to |
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables the StackLight logging stack. For details about the
logging components, see Reference Architecture:
StackLight deployment architecture. Set to |
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables StackLight multiserver mode. For details, see
StackLight database modes in Reference Architecture:
StackLight deployment architecture. Set to |
|
Key |
Description |
Example values |
|---|---|---|
|
Disables or enables the metric collector. Modify this parameter
for the management cluster only. Set to |
|
Key |
Description |
Example values |
|---|---|---|
|
Defines the Prometheus database retention period. Passed to the
|
|
|
Defines the Prometheus database retention size. Passed to the
|
|
|
Defines the minimum amount of time for Prometheus to wait before
resending an alert to Alertmanager. Passed to the
|
|
Key |
Description |
Example values |
|---|---|---|
|
Specifies the approximate expected cluster size. Set to
|
|
Key |
Description |
Example values |
|---|---|---|
|
Provides the capability to override the default resource requests or limits for any StackLight component for the predefined cluster sizes. For a list of StackLight components, see Components versions in Release Notes: Cluster releases. |
resourcesPerClusterSize:
elasticsearch:
small:
limits:
cpu: "1000m"
memory: "4Gi"
medium:
limits:
cpu: "2000m"
memory: "8Gi"
requests:
cpu: "1000m"
memory: "4Gi"
large:
limits:
cpu: "4000m"
memory: "16Gi"
|
|
Provides the capability to override the containers resource requests or limits for any StackLight component. For a list of StackLight components, see Components versions in Release Notes: Cluster releases. |
resources:
alerta:
requests:
cpu: "50m"
memory: "200Mi"
limits:
memory: "500Mi"
Using the example above, each pod in the |
Key |
Description |
Example values |
|---|---|---|
|
Kubernetes tolerations to add to all StackLight components. |
default:
- key: "com.docker.ucp.manager"
operator: "Exists"
effect: "NoSchedule"
|
|
Defines Kubernetes tolerations (overrides the default ones) for any StackLight component. |
component:
elasticsearch:
- key: "com.docker.ucp.manager"
operator: "Exists"
effect: "NoSchedule"
postgresql:
- key: "node-role.kubernetes.io/master"
operator: "Exists"
effect: "NoSchedule"
|
Key |
Description |
Example values |
|---|---|---|
|
Defines the |
|
|
Defines (overrides the |
componentStorageClasses:
elasticsearch: ""
fluentd: ""
postgresql: ""
prometheusAlertManager: ""
prometheusPushGateway: ""
prometheusServer: ""
|
Key |
Description |
Example values |
|---|---|---|
|
Defines the |
default:
role: stacklight
|
|
Defines the |
component:
alerta:
role: stacklight
component: alerta
kibana:
role: stacklight
component: kibana
|
Key |
Description |
Example values |
|---|---|---|
|
Unique cluster identifier, Cluster kubectl get cluster -n ``<namespace>`` \
``<name>`` -o jsonpath=\
'{.metadata.annotations.kaas\.mirantis\.com/uid}'
The |
|
|
Enables or disables reporting of Prometheus metrics to Salesforce. For details, see StackLight deployment architecture. Disabled by default. |
|
|
Salesforce parameters and credentials for the metrics reporting integration. |
Note Modify this parameter if sf-notifier is not configured or if you want to use a different Salesforce user account to send reports to. salesForceAuth:
url: "<SF instance URL>"
username: "<SF account email address>"
password: "<SF password>"
environment_id: "<Cloud identifier>"
organization_id: "<Organization identifier>"
sandbox_enabled: "<Set to true or false>"
|
|
Defines the Kubernetes cron job for sending metrics to Salesforce. By default, reports are sent at midnight server time. |
cronjob:
schedule: "0 0 * * *"
concurrencyPolicy: "Allow"
failedJobsHistoryLimit: ""
successfulJobsHistoryLimit: ""
startingDeadlineSeconds: 200
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables Ceph monitoring. Set to |
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables HTTP endpoints monitoring. If enabled, the
monitoring tool performs the probes against the defined endpoints every
15 seconds. Set to |
|
|
Defines the directory path with external endpoints certificates on host. |
|
|
Defines the list of HTTP endpoints to monitor. |
domains:
- https://prometheus.io_health
- http://example.com:8080_status
- http://example.net:8080_pulse
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables monitoring of bare metal Ironic. To enable, specify the Ironic API URL. |
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables StackLight to monitor and alert on the expiration
date of the TLS certificate of an HTTPS endpoint. If enabled, the
monitoring tool performs the probes against the defined endpoints every
hour. Set to |
|
|
Defines the list of HTTPS endpoints to monitor the certificates from. |
domains:
- https://prometheus.io
- http://example.com:8080
|
Key |
Description |
Example values |
|---|---|---|
|
On the clusters that run large-scale workloads, workload monitoring generates a big amount of resource-consuming metrics. To prevent generation of excessive metrics, you can disable workload monitoring in the StackLight metrics and monitor only the infrastructure. The |
metricFilter:
enabled: true
action: keep
namespaces:
- kaas
- kube-system
- stacklight
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables Mirantis Kubernetes Engine (MKE) monitoring.
Set to |
|
|
Defines the dockerd data root directory of persistent Docker state. For details, see Docker documentation: Daemon CLI (dockerd). |
|
Key |
Description |
Example values |
|---|---|---|
|
Defines custom alerts. Also, modifies or disables existing alert configurations. For the list of predefined alerts, see Available StackLight alerts. While adding or modifying alerts, follow the Alerting rules. |
customAlerts:
# To add a new alert:
- alert: ExampleAlert
annotations:
description: Alert description
summary: Alert summary
expr: example_metric > 0
for: 5m
labels:
severity: warning
# To modify an existing alert expression:
- alert: AlertmanagerFailedReload:
expr: alertmanager_config_last_reload_successful == 5
# To disable an existing alert:
- alert: TargetDown
enabled: false
An optional field |
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables the |
|
Key |
Description |
Example values |
|---|---|---|
|
Provides a genetic template for notifications receiver configurations. For a list of supported receivers, see Prometheus Alertmanager documentation: Receiver. |
For example, to enable notifications to OpsGenie: alertmanagerSimpleConfig:
genericReceivers:
- name: HTTP-opsgenie
enabled: true # optional
opsgenie_configs:
- api_url: "https://example.app.eu.opsgenie.com/"
api_key: "secret-key"
send_resolved: true
|
|
Provides a template for notifications route configuration. For details, see Prometheus Alertmanager documentation: Route. |
genericRoutes:
- receiver: HTTP-opsgenie
enabled: true # optional
match_re:
severity: major|critical
continue: true
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables Alertmanager integration with email. Set to
|
|
|
Defines the notification parameters for Alertmanager integration with email. For details, see Prometheus Alertmanager documentation: Email configuration. |
email:
enabled: false
send_resolved: true
to: "to@test.com"
from: "from@test.com"
smarthost: smtp.gmail.com:587
auth_username: "from@test.com"
auth_password: password
auth_identity: "from@test.com"
require_tls: true
|
|
Defines the route for Alertmanager integration with email. For details, see Prometheus Alertmanager documentation: Route. |
route:
match: {}
match_re: {}
routes: []
|
Key |
Description |
Example values |
|---|---|---|
|
Unique cluster identifier, Cluster kubectl get cluster -n ``<namespace>`` \
``<name>`` -o jsonpath=\
'{.metadata.annotations.kaas\.mirantis\.com/uid}'
The |
|
|
Enables or disables Alertmanager integration with Salesforce using the
|
|
|
Defines the Salesforce parameters and credentials for integration with Alertmanager. |
auth:
url: "<SF instance URL>"
username: "<SF account email address>"
password: "<SF password>"
environment_id: "<Cloud identifier>"
organization_id: "<Organization identifier>"
sandbox_enabled: "<Set to true or false>"
|
|
Defines the notifications route for Alertmanager integration with Salesforce. For details, see Prometheus Alertmanager documentation: Route. |
route:
match: {}
match_re: {}
routes: []
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables Alertmanager integration with Slack. For
details, see Prometheus Alertmanager documentation: Slack configuration.
Set to |
|
|
Defines the Slack webhook URL. |
|
|
Defines the Slack channel or user to send notifications to. |
|
|
Defines the notifications route for Alertmanager integration with Slack. For details, see Prometheus Alertmanager documentation: Route. |
route:
match: {}
match_re: {}
routes: []
|