Skip to content

Commit

Permalink
Merge pull request #48 from JoshVanL/update-0.2.0
Browse files Browse the repository at this point in the history
Update 0.2.0
  • Loading branch information
jetstack-bot authored Sep 1, 2020
2 parents 9c35b09 + 231865c commit aa25c7b
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 18 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
# 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.

> This tool is currently experimental.
## 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.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions deploy/charts/version-checker/Chart.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion deploy/charts/version-checker/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ replicaCount: 1

image:
repository: quay.io/jetstack/version-checker
tag: v0.1.1
tag: v0.2.0
pullPolicy: IfNotPresent

service:
Expand Down
2 changes: 1 addition & 1 deletion deploy/yaml/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit aa25c7b

Please sign in to comment.