https://github.com/invit/vcreport
Display human readable report of version-checker metrics
https://github.com/invit/vcreport
Last synced: 6 months ago
JSON representation
Display human readable report of version-checker metrics
- Host: GitHub
- URL: https://github.com/invit/vcreport
- Owner: invit
- License: mit
- Created: 2021-05-29T13:36:01.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-29T14:51:20.000Z (about 5 years ago)
- Last Synced: 2025-01-19T13:16:16.988Z (over 1 year ago)
- Language: Go
- Size: 28.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vcreport
[](https://github.com/invit/vcreport/actions/workflows/build.yml)
CLI to display [version-checker](https://github.com/jetstack/version-checker) metrics in a human-readable way.
## Installation
Downloadable binaries are available from the [releases page](https://github.com/invit/vcreport/releases/latest).
## Usage
```
Usage:
vcreport metrics-url [flags]
Flags:
-a, --all Show all images, not just outdated ones
-b, --brief Just show images, but no pods
-h, --help help for vcreport
-v, --version version for vcreport
```
_metrics-url_ is the full URL to the metrics endpoint of version-checker.
### Examples
* Run locally
```shell
$ kubectl port-forward service/version-checker 8080:8080 --namespace=version-checker &
$ vcreport -a -b http://localhost:8080/metrics
+----------------------------------------------------------+----------------------+
| IMAGE | VERSION |
+----------------------------------------------------------+----------------------+
| some-vendor/image | 2.0.0 > 2.1.0 |
+----------------------------------------------------------+----------------------+
| quay.io/jetstack/version-checker | v0.2.1 (Up to date) |
+----------------------------------------------------------+----------------------+
| redis | 6.2.2-alpine > 6.2.3 |
+----------------------------------------------------------+----------------------+
| us.gcr.io/k8s-artifacts-prod/autoscaling/vpa-recommender | 0.9.2 (Up to date) |
+----------------------------------------------------------+----------------------+
```
* Run in Kubernetes cluster
```shell
$ kubectl run --namespace=version-checker -i --tty --rm vcreport --image=ghcr.io/invit/vcreport/vcreport:latest --restart=Never -- http://version-checker:8080/metrics
+----------------------------------------------------------+----------------------+--------------------------------------+
| IMAGE | VERSION | PODS |
+----------------------------------------------------------+----------------------+--------------------------------------+
| some-vendor/image | 2.0.0 > 2.1.0 | namespace/pod-1/container |
| | | namespace/pod-1/container |
+----------------------------------------------------------+----------------------+--------------------------------------+
| redis | 6.2.2-alpine > 6.2.3 | some-other-namespace/pod-1/container |
+----------------------------------------------------------+----------------------+--------------------------------------+
pod "vcreport" deleted
```
## Build
On Linux:
```
$ git clone github.com/invit/vcreport
$ cd vcreport
$ make
```
## License
vcreport is licensed under the [MIT License](http://opensource.org/licenses/MIT).