Merge pull request #35 from genegr/master

New configuration example for the K8s Prometheus Operator

Author: sdodsley

README.md

@@ -13,7 +13,7 @@ We will address these as soon as we can, but there are no specific SLAs.
 
 This application aims to help monitor Pure Storage FlashArrays by providing an "exporter", which means it extracts data from the Purity API and converts it to the OpenMetrics format, which is for instance consumable by Prometheus, or other observability platforms.
 
-The stateless design of the exporter allows for easy configuration management as well as scalability for a whole fleet of Pure Storage arrays. Each time the OpenMetrics client scrapes metrics for a specific system, it should provide the hostname via GET parameter and the API token as Authorization token to this exporter.
+The stateless design of the exporter allows for easy configuration management as well as scalability for a whole fleet of Pure Storage arrays. The design follows almost completely the [multi-target-exporter](https://prometheus.io/docs/guides/multi-target-exporter/) pattern described in the Prometheus documentation, so the tool can be used to scrape multiple FlashArrays from a single instance or just act the front-end for a single FlashArray.
 
 To monitor your Pure Storage appliances, you will need to create a new dedicated user on your array, and assign read-only permissions to it. Afterwards, you also have to create a new API key.
 
@@ -67,7 +67,7 @@ docker build -t pure-fa-ome:$VERSION .
 ```
 
 
-**Authentication**
+### Authentication
 
 Authentication is used by the exporter as the mechanism to cross authenticate to the scraped appliance, therefore for each array it is required to provide the REST API token for an account that has a 'readonly' role. The api-token can be provided in two ways
 
@@ -125,6 +125,63 @@ The exporter uses a RESTful API schema to provide Prometheus scraping endpoints.
 
 Depending on the target array, scraping for the whole set of metrics could result into timeout issues, in which case it is suggested either to increase the scraping timeout or to scrape each single endpoint instead.
 
+### Prometheus configuration
+
+A sample of a basic configuration file for Prometheus is as follows.
+
+```shell
+
+global:
+  scrape_interval: 30s
+  scrape_timeout: 10s
+  evaluation_interval: 30s
+scrape_configs:
+- job_name: monitoring/pure-fa-probe
+  honor_timestamps: true
+  scrape_interval: 30s
+  scrape_timeout: 10s
+  metrics_path: /metrics/pods
+  scheme: http
+  follow_redirects: true
+  enable_http2: true
+  relabel_configs:
+  - source_labels: [job]
+    separator: ;
+    regex: (.*)
+    target_label: __tmp_prometheus_job_name
+    replacement: $1
+    action: replace
+  - separator: ;
+    regex: (.*)
+    target_label: job
+    replacement: pure-fa-probe
+    action: replace
+  - source_labels: [__address__]
+    separator: ;
+    regex: (.*)
+    target_label: __param_target
+    replacement: $1
+    action: replace
+  - source_labels: [__param_target]
+    separator: ;
+    regex: (.*)
+    target_label: instance
+    replacement: $1
+    action: replace
+  - separator: ;
+    regex: (.*)
+    target_label: __address__
+    replacement: pure-fa-exporter.your.domain:9490  #  <== your exporter address and port goes here
+    action: replace
+  static_configs:
+  - targets:           #  <== the list of your flasharrays goes here
+    - 10.11.12.80
+    - 10.11.12.82
+    - 10.11.12.90
+
+```
+
+See the kubernetes [examples](examples/config/k8s) for a similar configuration that uses a the additional config for a simple Prometheus kubernets deploymemt or the more interesting Prometheus operator.
 
 ### Usage examples
 

examples/config/k8s/operator/README.md

@@ -0,0 +1,4 @@
+# Deploying with the Prometheus Operator
+
+Install Prometheus using the [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator), then deploy 
+the Pure FlashArray Prometheus exporter using the deployment file [pure-fa-exporter-deployment.yaml](./pure-fa-exporter-deployment.yaml). Configure Prometheus using the Probe custom resouce defined in the [pure-fa-probe.yaml](./pure-fa-probe.yaml).

examples/config/k8s/operator/pure-fa-exporter-deployment.yaml

@@ -0,0 +1,58 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: pure-fa-om-exporter
+  namespace: monitoring
+  labels:
+    app: pure-fa-exporter
+spec:
+  replicas: 1
+  strategy:
+    rollingUpdate:
+      maxSurge: 1
+      maxUnavailable: 1
+    type: RollingUpdate
+  selector:
+    matchLabels:
+      app: pure-fa-exporter
+  template:
+    metadata:
+      labels:
+        app: pure-fa-exporter
+    spec:
+      containers:
+      - name: pure-fa-om-exporter
+        image: quay.io/purestorage/pure-fa-om-exporter/pure-fa-om-exporter:1.0.4
+        command: ["/pure-fa-om-exporter"]
+        imagePullPolicy: "Always"
+        args:
+        - '-t'
+        - '/var/pure-fa-om-exporter/api-tokens.yaml'
+        volumeMounts:
+          - mountPath: "/var/pure-fa-om-exporter"
+            name: pure-fa-secret
+            readOnly: true
+        ports:
+        - name: web
+          containerPort: 9490
+      restartPolicy: Always
+      volumes:
+        - name: pure-fa-secret
+          secret:
+            secretName: pure-fa-secret
+
+---
+
+apiVersion: v1
+kind: Service
+metadata:
+  name: pure-fa-exporter-svc
+  namespace: monitoring
+spec:
+  ports:
+  - port: 9490
+    protocol: TCP
+    targetPort: 9490
+  selector:
+    app: pure-fa-exporter
+  type: ClusterIP

examples/config/k8s/operator/pure-fa-probe.yaml

@@ -0,0 +1,17 @@
+apiVersion: monitoring.coreos.com/v1
+kind: Probe
+metadata:
+  name: pure-fa-probe
+  namespace: monitoring
+spec:
+  jobName: pure-fa-probe
+  prober:
+    url: pure-fa-exporter-svc:9490
+    path: /metrics/pods
+  interval: 15s
+  targets:
+    staticConfig:
+      static:
+        - 10.11.12.80
+        - 10.11.12.82
+        - 10.11.12.90