Monitoring Addons

The monitoring addon provides the ability for clients to add monitoring solutions like Grafana, Prometheus, or Alertmanager. This ensure that concerns are accurately identified, reasons are exposed and mainly, that repairs are implemented in a timely manner which improves overall product quality. For a full accounting of monitoring options and how to enable them, visit our monitoring pages.

YAML Specifications

YAML
    
 
apiVersion: sunpike.platform9.com/v1alpha2kind: ClusterAddonmetadata:  labels:    sunpike.pf9.io/cluster: '<clsuuid>'    type: monitoring  name: <clsuuid>-monitoring  namespace: defaultspec:  clusterID: '<clsuuid>'  override:    params:    # storageClassName and pvcSize are optional params, if storage backend     # is not configured the prometheus pod will remain in Pending state    - name: storageClassName        value: default    - name: pvcSize      value: "1Gi"    - name: retentionTime      value: "7d"  type: monitoring  version: 0.46.0  watch: true
Copy

The corresponding Addon object created on the cluster will look similar to this.

YAML
    
 
apiVersion: agent.pf9.io/v1kind: Addonmetadata:  name: <clsuuid>-monitoring  namespace: pf9-addonsspec:  clusterID: <clsuuid>  type: monitoring  version: 0.46.0  watch: true  override:    params:    - name: storageClassName      value: default    - name: pvcSize      value: "1Gi"    - name: retentionTime      value: "7d"
Copy

Prometheus YAML

When the Prometheus object is deployed by the addon operator, it introduces the following templatized yaml.

YAML
    
 
apiVersion: monitoring.coreos.com/v1kind: Prometheusmetadata:  name: system  namespace: pf9-monitoringspec:  image: {{ .QuayRegistry }}/prometheus/prometheus  additionalScrapeConfigs:    key: additional-scrape-config.yaml    name: scrapeconfig  alerting:    alertmanagers:    - name: sys-alertmanager      namespace: pf9-monitoring      port: web  replicas: 1  resources:    requests:      cpu: 500m      memory: 512Mi  retention: {{ .retentionTime }}  ruleSelector:    matchLabels:      prometheus: system      role: alert-rules  scrapeInterval: 2m  serviceAccountName: system-prometheus{{- if .storageClassName }}    storage:    volumeClaimTemplate:      spec:        accessModes:        - ReadWriteOnce        resources:          requests:            storage: {{ .pvcSize }}        storageClassName: {{ .storageClassName }}{{- end }}    serviceMonitorSelector:    matchLabels:      prometheus: system      role: service-monitor
Copy

It should be noted that these addons are updated along with the pf9-kube version and can be referenced in the Support Matrix article. For additional assistance, please contact our support team

Last updated on Mar 29, 2022

Was this page helpful?