diff --git a/Makefile b/Makefile index dcf1a6f5..cd596c70 100644 --- a/Makefile +++ b/Makefile @@ -17,7 +17,7 @@ verify: test build ## tests and builds version-checker image: ## build docker image GOARCH=$(ARCH) GOOS=linux CGO_ENABLED=0 go build -o ./bin/version-checker-linux ./cmd/. - docker build -t quay.io/jetstack/version-checker:v0.1.1 . + docker build -t quay.io/jetstack/version-checker:v0.2.0 . clean: ## clean up created files rm -rf \ diff --git a/README.md b/README.md index 77420f19..4183800d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # version-checker version-checker is a Kubernetes utility for observing the current versions of -images in use in the cluster, as well as the latest available upstream. These +images running in the cluster, as well as the latest available upstream. These checks get exposed as Prometheus metrics to be viewed on a dashboard, or _soft_ alert cluster operators. @@ -9,11 +9,17 @@ alert cluster operators. ## Registries -version-checker currently supports the following registries: +version-checker supports the following registries: -- docker (docker hub etc.) -- gcr (inc gcr facades such as k8s.gcr.io) -- quay +- [ACR](https://azure.microsoft.com/en-us/services/container-registry/) +- [Docker Hub](https://hub.docker.com/) +- [ECR](https://aws.amazon.com/ecr/) +- [GCR](https://cloud.google.com/container-registry/) (inc gcr facades such as k8s.gcr.io) +- [Quay](https://quay.io/) +- Self Hosted (Docker V2 API compliant registries, e.g. + [registry](https://hub.docker.com/_/registry), + [artifactory](https://jfrog.com/artifactory/) etc.). Multiple self hosted + registries can be configured at once. These registries support authentication. @@ -52,7 +58,7 @@ available to view the image versions as a table. ## Options -By default without the flag `-a, --test-all-containers`, version-checker will +By default, without the flag `-a, --test-all-containers`, version-checker will only test containers where the pod has the annotation `enable.version-checker.io/*my-container*`, where `*my-container*` is the `name` of the container in the pod. @@ -84,20 +90,15 @@ enrich version checking on image tags: example, the above annotation will only check against image tags which have the form of something like `v1.3.4-debian-r30`. `use-metadata.version-checker.io` is not required when this is set. All - other options are ignored when this is set. + other options, apart from URL overrides, are ignored when this is set. - `override-url.version-checker.io/my-container: docker.io/bitnami/etcd`: is used to change the URL for where to lookup where the latest image version is. In this example, the current version of `my-container` will be compared against the image versions in the `docker.io/bitnami/etcd` registry. + ## Metrics By default, version-checker will expose the version information as Prometheus metrics on `0.0.0.0:8080/metrics`. - -## Future Development - -- Support self hosted repositories. -- Image URL overwrites (to service registries which are mirroring images). -- Support more registry APIs. diff --git a/deploy/charts/version-checker/Chart.yaml b/deploy/charts/version-checker/Chart.yaml index e461d7ed..55513c28 100644 --- a/deploy/charts/version-checker/Chart.yaml +++ b/deploy/charts/version-checker/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v1 -appVersion: "v0.1.1" -version: 0.1.1 +appVersion: "v0.2.0" +version: 0.2.0 description: A Helm chart for version-checker home: https://github.com/joshvanl/verison-checker name: version-checker diff --git a/deploy/charts/version-checker/values.yaml b/deploy/charts/version-checker/values.yaml index 8a5994c5..9e7dd053 100644 --- a/deploy/charts/version-checker/values.yaml +++ b/deploy/charts/version-checker/values.yaml @@ -6,7 +6,7 @@ replicaCount: 1 image: repository: quay.io/jetstack/version-checker - tag: v0.1.1 + tag: v0.2.0 pullPolicy: IfNotPresent service: diff --git a/deploy/yaml/deploy.yaml b/deploy/yaml/deploy.yaml index c8546d6c..7ab1077f 100644 --- a/deploy/yaml/deploy.yaml +++ b/deploy/yaml/deploy.yaml @@ -49,7 +49,7 @@ spec: spec: serviceAccountName: version-checker containers: - - image: quay.io/jetstack/version-checker:v0.1.1 + - image: quay.io/jetstack/version-checker:v0.2.0 imagePullPolicy: Always ports: - containerPort: 8080