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 Deployment architecture. Set to |
|
|
Sets the least important level of log messages to send to
Elasticsearch. Requires The default logging level is Note The |
|
|
Enables or disables Cerebro, a web UI for interacting with the Elasticsearch cluster that stores logs. To access the Cerebro web UI, see Access Elasticsearch clusters using Cerebro. Note Prior to enabling Cerebro, verify that your Container Cloud cluster has minimum 0.5-1 GB of free RAM and 1 vCPU available. |
|
Available since 2.10.0
Key |
Description |
Example values |
|---|---|---|
|
Defines the log verbosity level for all StackLight components if not
defined using |
|
|
Defines (overrides the |
component:
kubeStateMetrics: ""
prometheusAlertManager: ""
prometheusBlackboxExporter: ""
prometheusNodeExporter: ""
prometheusPushGateway: ""
prometheusServer: ""
alerta: ""
alertmanagerWebhookServicenow: ""
elasticsearchCurator: ""
postgresql: ""
prometheusEsExporter: ""
sfNotifier: ""
sfReporter: ""
fluentd: ""
fluentdElasticsearch: ""
telemeterClient: ""
telemeterServer: ""
tfControllerExporter: ""
tfVrouterExporter: ""
telegrafDs: ""
telegrafS: ""
elasticsearch: ""
grafana: ""
kibana: ""
metricbeat: ""
prometheusMsTeams: ""
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables remote logging to syslog. Disabled by default.
Requires |
|
|
Specifies the remote syslog host. |
|
|
Specifies the remote syslog port. |
|
|
Specifies the remote syslog protocol. Set to |
|
|
Optional. Disabled by default. Enables or disables TLS. Use TLS only for the TCP protocol. TLS will not be enabled if you set a protocol other than TCP. |
|
|
Enables or disables TLS verification. |
|
|
Defines how to pass the certificate.
|
certificate:
secret: ""
hostPath: "/etc/ssl/certs/ca-bundle.pem"
|
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables StackLight multiserver mode. For details, see
StackLight database modes in Deployment architecture.
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 Cluster releases (managed). |
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 Cluster releases (managed). |
resources:
alerta:
requests:
cpu: "50m"
memory: "200Mi"
limits:
memory: "500Mi"
Using the example above, each pod in the Note The logging mechanism performance depends on the cluster log
load. If the cluster components send an excessive amount of logs, the
default resource requests and limits for resources:
fluentdElasticsearch:
requests:
memory: "500Mi"
limits:
memory: "1500Mi"
|
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
|
On the managed clusters with limited Internet access, proxy is required for StackLight components that use HTTP and HTTPS and are disabled by default but need external access if enabled. The Salesforce reporter depends on the Internet access through HTTPS.
Key |
Description |
Example values |
|---|---|---|
|
Unique cluster identifier
The |
Do not modify |
|
Enables or disables reporting of Prometheus metrics to Salesforce. For details, see Deployment architecture. Disabled by default. |
|
|
Salesforce parameters and credentials for the metrics reporting integration. |
Note Modify this parameter if 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. The endpoints must successfully respond to a liveness probe. For success, a request to a specific endpoint must result in a 2xx HTTP response code. |
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. |
|
|
Defines whether to skip the chain and host verification. Set to
|
|
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
- https://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 |
|
On the managed clusters with limited Internet access, proxy is required for StackLight components that use HTTP and HTTPS and are disabled by default but need external access if enabled, for example, for the Salesforce integration and Alertmanager notifications external rules.
Key |
Description |
Example values |
|---|---|---|
|
Provides a generic 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
|
|
Disables or enables alert inhibition rules. If enabled, Alertmanager decreases alert noise by suppressing dependent alerts notifications to provide a clearer view on the cloud status and simplify troubleshooting. Enabled by default. For details, see Alert dependencies. For details on inhibition rules, see Prometheus documentation. |
|
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: []
|
On the managed clusters with limited Internet access, proxy is required for StackLight components that use HTTP and HTTPS and are disabled by default but need external access if enabled. The Salesforce integration depends on the Internet access through HTTPS.
Key |
Description |
Example values |
|---|---|---|
|
Unique cluster identifier
The |
Do not modify |
|
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:
severity: critical
match_re: {}
routes: []
Note Starting from Container Cloud 2.10.0, by default, only
|
On the managed clusters with limited Internet access, proxy is required for StackLight components that use HTTP and HTTPS and are disabled by default but need external access if enabled. The Slack integration depends on the Internet access through HTTPS.
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: []
|
On the managed clusters with limited Internet access, proxy is required for StackLight components that use HTTP and HTTPS and are disabled by default but need external access if enabled. The Microsoft Teams integration depends on the Internet access through HTTPS.
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables Alertmanager integration with Microsoft Teams.
Requires a set up Microsoft Teams channel and a channel connector. Set
to |
|
|
Defines the URL of an Incoming Webhook connector of a Microsoft Teams channel. For details about channel connectors, see Microsoft documentation. |
|
Caution
Prior to configuring the integration with ServiceNow, perform the following prerequisite steps using the ServiceNow documentation of the required version.
In a new or existing Incident table, add the Alert ID field as described in Add fields to a table. To avoid alerts duplication, select Unique.
Create an Access Control List (ACL) with read/write permissions for the Incident table as described in Securing table records.
Key |
Description |
Example values |
|---|---|---|
|
Enables or disables Alertmanager integration with ServiceNow. Set to
|
|
|
Defines the ServiceNow parameters and credentials for integration with Alertmanager:
|
serviceNow:
enabled: true
incident_table: "incident"
api_version: "v1"
alert_id_field: "u_alert_id"
auth:
instance: "https://dev00001.service-now.com"
username: "testuser"
password: "testpassword"
|