Managing alerts as a Developer

From the Developer perspective of the OpenShift Container Platform web console, go to Observe and go to the Alerts tab.

Select the project that you want to silence an alert for from the Project: list.

If necessary, expand the details for the alert by clicking a greater than symbol (>) next to the alert name.

Click the alert message in the expanded view to open the Alert details page for the alert.

Click Silence alert to open the Silence alert page with a default configuration for the alert.

Optional: Change the default configuration details for the silence.

To save the silence, click Silence.

From the Developer perspective of the OpenShift Container Platform web console, go to Observe and go to the Silences tab.

Select the project that you want to silence alerts for from the Project: list.

Click Create silence.

On the Create silence page, set the duration and label details for an alert.

To create silences for alerts that match the labels that you entered, click Silence.

From the Developer perspective of the OpenShift Container Platform web console, go to Observe and go to the Silences tab.

Select the project that you want to edit silences for from the Project: list.

For the silence you want to modify, click and select Edit silence.

On the Edit silence page, make changes and click Silence. Doing so expires the existing silence and creates one with the updated configuration.

From the Developer perspective of the OpenShift Container Platform web console, go to Observe and go to the Silences tab.

Select the project that you want to expire a silence for from the Project: list.

For the silence or silences you want to expire, select the checkbox in the corresponding row.

Click Expire 1 silence to expire a single selected silence or Expire <n> silences to expire multiple selected silences, where <n> is the number of silences you selected.

Create a YAML file for alerting rules. In this example, it is called example-app-alerting-rule.yaml.

Add an alerting rule configuration to the YAML file. The following example creates a new alerting rule named example-alert. The alerting rule fires an alert when the version metric exposed by the sample service becomes 0:

apiVersion: monitoring.coreos.com/v1
kind: PrometheusRule
metadata:
  name: example-alert
  namespace: ns1
spec:
  groups:
  - name: example
    rules:
    - alert: VersionAlert (1)
      for: 1m (2)
      expr: version{job="prometheus-example-app"} == 0 (3)
      labels:
        severity: warning (4)
      annotations:
        message: This is an example alert. (5)

Apply the configuration file to the cluster:

$ oc apply -f example-app-alerting-rule.yaml

Edit the user-workload-monitoring-config config map in the openshift-user-workload-monitoring project:

$ oc -n openshift-user-workload-monitoring edit configmap user-workload-monitoring-config

Configure projects in which you want to create alerting rules that are not bound to a specific project:

apiVersion: v1
kind: ConfigMap
metadata:
  name: user-workload-monitoring-config
  namespace: openshift-user-workload-monitoring
data:
  config.yaml: |
    namespacesWithoutLabelEnforcement: [ <namespace> ] (1)
    # ...

Create a YAML file for alerting rules. In this example, it is called example-cross-project-alerting-rule.yaml.

Add an alerting rule configuration to the YAML file. The following example creates a new cross-project alerting rule called example-security. The alerting rule fires when a user project does not enforce the restricted pod security policy:

apiVersion: monitoring.coreos.com/v1
kind: PrometheusRule
metadata:
  name: example-security
namespace: ns1 (1)
spec:
  groups:
    - name: pod-security-policy
      rules:
        - alert: "ProjectNotEnforcingRestrictedPolicy" (2)
          for: 5m (3)
          expr: kube_namespace_labels{namespace!~"(openshift|kube).*|default",label_pod_security_kubernetes_io_enforce!="restricted"} (4)
          annotations:
            message: "Restricted policy not enforced. Project {{ $labels.namespace }} does not enforce the restricted pod security policy." (5)
          labels:
            severity: warning (6)

Apply the configuration file to the cluster:

$ oc apply -f example-cross-project-alerting-rule.yaml

To list alerting rules in <project>:

$ oc -n <project> get prometheusrule

To list the configuration of an alerting rule, run the following:

$ oc -n <project> get prometheusrule <rule> -o yaml