Merge pull request #71 from chrroberts-pure/make_containter_tokens

v1.0.8 - Add token support in the default docker image

Author: sdodsley

Makefile

@@ -4,7 +4,7 @@ GOTEST=$(GOCMD) test
 GOVET=$(GOCMD) vet
 BINARY_NAME=pure-fa-om-exporter
 MODULE_NAME=purestorage/fa-openmetrics-exporter
-VERSION?=1.0.7
+VERSION?=1.0.8
 SERVICE_PORT?=9490
 DOCKER_REGISTRY?= quay.io/purestorage/
 EXPORT_RESULT?=false # for CI please set EXPORT_RESULT to true

README.md

@@ -7,7 +7,6 @@ OpenMetrics exporter for Pure Storage FlashArray.
 This exporter is provided under Best Efforts support by the Pure Portfolio Solutions Group, Open Source Integrations team.
 For feature requests and bugs please use GitHub Issues.
 We will address these as soon as we can, but there are no specific SLAs.
-##
 
 ### Overview
 
@@ -51,19 +50,23 @@ git clone [email protected]:PureStorage-OpenConnect/pure-fa-openmetrics-exporter.gi
 cd pure-fa-openmetrics-exporter
 ...
 make build
-
 ```
 
 The newly built exporter executable can be found in the <kbd>./out/bin</kbd> directory.
 
-### Docker image
+### Docker Image
 
 The provided dockerfile can be used to generate a docker image of the exporter. The image can be built using docker as follows
 
 ```shell
-
 VERSION=<version>
 docker build -t pure-fa-ome:$VERSION .
+
+# You can also use the make file to build a docker-image
+
+cd pure-fa-openmetrics-exporter
+...
+make docker-build
 ```
 
 
@@ -110,6 +113,8 @@ The array token configuration file must have to following syntax:
 ```  
 When the array token configuration file is used, the <kbd>array_id</kbd> key must be used as the <kbd>endpoint</kbd> argument for the scraped URL.
 
+For usage a usage example of how to use this feature with a Docker container, see Docker Usage Examples below.
+
 ### Scraping endpoints
 
 The exporter uses a RESTful API schema to provide Prometheus scraping endpoints.
@@ -192,7 +197,7 @@ In a typical production scenario, it is recommended to use a visual frontend for
 
 To spin up a very basic set of those containers, use the following commands:
 ```bash
-# Pure exporter
+# Pure Storage OpenMetrics Exporter
 docker run -d -p 9490:9490 --name pure-fa-om-exporter quay.io/purestorage/pure-fa-om-exporter:<version>
 
 # Prometheus with config via bind-volume (create config first!)
@@ -201,6 +206,21 @@ docker run -d -p 9090:9090 --name=prometheus -v /tmp/prometheus-pure.yml:/etc/pr
 # Grafana
 docker run -d -p 3000:3000 --name=grafana -v /tmp/grafana-data:/var/lib/grafana grafana/grafana
 ```
+
+#### Docker: Passing tokens.yaml file to the container
+On starting the container, the Dockerfile will create an empty `/etc/pure-fa-om-exporter/tokens.yaml` file whether the users requires it or not. If the file is blank, the container will successfully start. If the container has a volume attached to the `/etc/pure-fa-om-exporter/` directory containing a valid `tokens.yaml` file the container will utilize the contents.
+
+```bash
+# Pure Storage OpenMetrics Exporter container with authentication tokens
+docker run -d -p 9490:9490 --name pure-fa-om-exporter --volume /hostpathtofile/tokens.yaml:/etc/pure-fa-om-exporter/tokens.yaml  quay.io/purestorage/pure-fa-om-exporter:<version>
+```
+
+Changes to the tokens.yaml file can be reloaded by restarting the Docker container.
+
+```bash
+docker restart pure-fa-om-exporter
+```
+
 Please have a look at the documentation of each image/application for adequate configuration examples.
 
 #### Kubernetes

build/docker/Dockerfile

@@ -1,5 +1,5 @@
 FROM golang:alpine as build
-#version should set to development unless another build arg is passed
+# version should set to development unless another build arg is passed
 ARG VERSION=development
 
 WORKDIR /usr/src/app
@@ -11,9 +11,14 @@ RUN go mod download && go mod verify
 COPY . .
 RUN CGO_ENABLED=1 go build -a -tags 'netgo osusergo static_build' -ldflags="-X main.version=v$VERSION" -v -o /usr/local/bin/pure-fa-om-exporter cmd/fa-om-exporter/main.go
 
+
 # alpine is used here as it seems to be the minimal image that passes quay.io vulnerability scan
 FROM alpine
 COPY --from=build  /usr/local/bin/pure-fa-om-exporter /pure-fa-om-exporter
+
+# create an empty tokens file for use with volumes if required. You can use a mounted volume to /etc/pure-fa-om-exporter/ to pass the `tokens.yaml` file. File must be named `tokens.yaml`.
+RUN mkdir /etc/pure-fa-om-exporter && touch /etc/pure-fa-om-exporter/tokens.yaml
+
 EXPOSE 9490
 ENTRYPOINT ["/pure-fa-om-exporter"]
-CMD ["--address", "0.0.0.0", "--port", "9490"]
+CMD ["--address", "0.0.0.0", "--port", "9490", "--tokens", "/etc/pure-fa-om-exporter/tokens.yaml"]

go.mod

@@ -18,8 +18,8 @@ require (
 	github.com/kr/text v0.2.0 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/prometheus/common v0.44.0 // indirect
-	github.com/prometheus/procfs v0.11.0 // indirect
-	golang.org/x/net v0.11.0 // indirect
-	golang.org/x/sys v0.9.0 // indirect
+	github.com/prometheus/procfs v0.11.1 // indirect
+	golang.org/x/net v0.13.0 // indirect
+	golang.org/x/sys v0.10.0 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 )

go.sum

@@ -26,17 +26,17 @@ github.com/prometheus/client_model v0.4.0 h1:5lQXD3cAg1OXBf4Wq03gTrXHeaV0TQvGfUo
 github.com/prometheus/client_model v0.4.0/go.mod h1:oMQmHW1/JoDwqLtg57MGgP/Fb1CJEYF2imWWhWtMkYU=
 github.com/prometheus/common v0.44.0 h1:+5BrQJwiBB9xsMygAB3TNvpQKOwlkc25LbISbrdOOfY=
 github.com/prometheus/common v0.44.0/go.mod h1:ofAIvZbQ1e/nugmZGz4/qCb9Ap1VoSTIO7x0VV9VvuY=
-github.com/prometheus/procfs v0.11.0 h1:5EAgkfkMl659uZPbe9AS2N68a7Cc1TJbPEuGzFuRbyk=
-github.com/prometheus/procfs v0.11.0/go.mod h1:nwNm2aOCAYw8uTR/9bWRREkZFxAUcWzPHWJq+XBB/FM=
+github.com/prometheus/procfs v0.11.1 h1:xRC8Iq1yyca5ypa9n1EZnWZkt7dwcoRPQwX/5gwaUuI=
+github.com/prometheus/procfs v0.11.1/go.mod h1:eesXgaPo1q7lBpVMoMy0ZOFTth9hBn4W/y0/p/ScXhY=
 github.com/rogpeppe/go-internal v1.10.0 h1:TMyTOH3F/DB16zRVcYyreMH6GnZZrwQVAoYjRBZyWFQ=
 golang.org/x/net v0.0.0-20211029224645-99673261e6eb/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
-golang.org/x/net v0.11.0 h1:Gi2tvZIJyBtO9SDr1q9h5hEQCp/4L2RQ+ar0qjx2oNU=
-golang.org/x/net v0.11.0/go.mod h1:2L/ixqYpgIVXmeoSA/4Lu7BzTG4KIyPIryS4IsOd1oQ=
+golang.org/x/net v0.13.0 h1:Nvo8UFsZ8X3BhAC9699Z1j7XQ3rsZnUUm7jfBEk1ueY=
+golang.org/x/net v0.13.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA=
 golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
-golang.org/x/sys v0.9.0 h1:KS/R3tvhPqvJvwcKfnBHJwwthS11LRhmM5D59eEXa0s=
-golang.org/x/sys v0.9.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
+golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=