Skip to content
This repository was archived by the owner on May 2, 2023. It is now read-only.

Commit d99f87c

Browse files
authored
Merge pull request #2 from PhilsLab/improve-readme
Add Docker information and badges to README.md
2 parents 717e236 + f41e8cb commit d99f87c

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/genegatpure/pure-exporter)
2+
[![](https://images.microbadger.com/badges/image/genegatpure/pure-exporter.svg)](https://hub.docker.com/r/genegatpure/pure-exporter "Docker image on Docker Hub")
3+
![Current version](https://img.shields.io/github/v/tag/PureStorage-OpenConnect/pure-exporter?label=current%20version)
4+
15
# Pure Storage Prometheus exporter
26
Prometheus exporter for Pure Storage FlashArrays and FlashBlades.
37

@@ -15,6 +19,12 @@ To monitor your Pure Storage hosts, you will need to create a new dedicated user
1519

1620
The exporter is preferably built and launched via Docker. You can also scale the exporter deployment to multiple containers on Kubernetes thanks to the stateless nature of the application.
1721

22+
---
23+
24+
#### The official docker image is available at Docker Hub: [genegatpure/pure-exporter](https://hub.docker.com/r/genegatpure/pure-exporter)
25+
26+
---
27+
1828
To build and deploy the application via Docker, your local linux user should be added to the `docker` group in order to be able to communicate with the Docker daemon. (If this is not possible, you can still use <kbd>sudo</kbd>)
1929

2030
This can be done with this command in the context of your user:
@@ -160,13 +170,12 @@ Good examples for additional labels are:
160170

161171
In a typical production scenario, it is recommended to use a visual frontend for your metrics, such as [Grafana](https://github.com/grafana/grafana). Grafana allows you to use your Prometheus instance as a datasource, and create Graphs and other visualizations from PromQL queries. Grafana, Prometheus, are all easy to run as docker containers.
162172

163-
The latest built image is available on Docker Hub here https://hub.docker.com/r/genegatpure/pure-exporter.
164173
To spin up a very basic set of those containers, use the following commands:
165-
```
174+
```bash
166175
# Pure exporter
167176
docker run -d -p 9491:9491 --name pure-exporter genegatpure/pure-exporter:latest
168177

169-
# Prometheus with config via bind-volume
178+
# Prometheus with config via bind-volume (create config first!)
170179
docker run -d -p 9090:9090 --name=prometheus -v /tmp/prometheus-pure.yml:/etc/prometheus/prometheus.yml -v /tmp/prometheus-data:/prometheus prom/prometheus:latest
171180

172181
# Grafana

0 commit comments

Comments
 (0)