1 unstable release
0.1.0 | Apr 19, 2021 |
---|
#26 in #kubernetes-cluster
22KB
176 lines
kimager
kimager
is a service that logs the existence of container images in a Kubernetes cluster.
Container image "existence" is determined by pod creation and deletion events.
Container image "loggging" involves using the log crate to record the timestamp, log level, and a message indicating what image is new to the cluster, or is no longer being used by any pods in the cluster.
[user at host in ~]
% kubectl get pods -A
NAMESPACE NAME READY STATUS RESTARTS AGE
kube-system metrics-server-86cbb8457f-pqgj6 1/1 Running 0 6m3s
kube-system local-path-provisioner-5ff76fc89d-s2tj2 1/1 Running 0 6m3s
kube-system coredns-854c77959c-fmf47 1/1 Running 0 6m3s
kube-system helm-install-traefik-jpzgk 0/1 Completed 0 6m4s
kube-system svclb-traefik-cxr7s 2/2 Running 0 5m50s
kube-system traefik-6f9cbd9bd4-jqg4t 1/1 Running 0 5m50s
kimager-system kimager-7d67dc9ff9-mfll9 1/1 Running 0 12s
[user at host in ~]
% kubectl logs -n kimager-system $(kubectl get pods -n kimager-system --no-headers -o custom-columns=":metadata.name") --follow
[2021-04-19T04:54:28Z INFO ] [+|image] nickgerace/kimager:unstable [kimager-system|kimager-7d67dc9ff9-mfll9]
[2021-04-19T04:54:28Z INFO ] [+|image] rancher/klipper-helm:v0.4.3 [kube-system|helm-install-traefik-jpzgk]
[2021-04-19T04:54:28Z INFO ] [+|image] rancher/metrics-server:v0.3.6 [kube-system|metrics-server-86cbb8457f-pqgj6]
[2021-04-19T04:54:28Z INFO ] [+|image] rancher/local-path-provisioner:v0.0.19 [kube-system|local-path-provisioner-5ff76fc89d-s2tj2]
[2021-04-19T04:54:28Z INFO ] [+|image] rancher/coredns-coredns:1.8.0 [kube-system|coredns-854c77959c-fmf47]
[2021-04-19T04:54:28Z INFO ] [+|image] rancher/library-traefik:1.7.19 [kube-system|traefik-6f9cbd9bd4-jqg4t]
[2021-04-19T04:54:28Z INFO ] [+|image] rancher/klipper-lb:v0.1.2 [kube-system|svclb-traefik-cxr7s]
[2021-04-19T04:54:28Z INFO ] [+|image] rancher/klipper-lb:v0.1.2 [kube-system|svclb-traefik-cxr7s]
Installation
Clone the repository, and cd
into it.
You can change the namespace name to whatever you prefer.
helm install -n kimager-system --create-namespace --wait kimager ./chart
You can also set the log level with --set logLevel
.
This sets the RUST_LOG
environment variable in the container (e.g. DEBUG
).
Usage
You can follow logs via the container's STDOUT within the pod. You may have to run the nested command (below) separately depending on your system.
kubectl logs -n kimager-system $(kubectl get pods -n kimager-system --no-headers -o custom-columns=":metadata.name") --follow
When reading or parsing the logs, reference the following format:
[TIMESTAMP LOG_LEVEL ] [ADDED_OR_DELETED_SYMBOL|RESOURCE_TYPE] IMAGE_NAME:IMAGE_TAG [POD_NAMESPACE|POD_NAME]
Why not use labels to follow logs?
Using the label selector does not provide an up-to-date stream. Following the logs of the pod itself is preferred.
Uninstallation
Uninstall the helm chart and delete the namespace to return to where you started. This will clean up all artifacts from installation and usage.
helm uninstall -n kimager-system kimager
kubectl delete namespace kimager-system
Security Implications
This service aims to be as secure as possible, and it is able to get
and watch
pods at a cluster
scope.
This means that information can be read (not written) from any pod in any namespace.
Please look at the chart for more information.
Other Documentation
- CHANGELOG.md: follows the Keep a Changelog format
- DEVELOPING.md: developer tips, tricks, and notes
- RELEASE.md: release process notes
Code of Conduct
This repository follows and enforces the Rust programming language's Code of Conduct.
Additional Information
- Author: Nick Gerace
- License: Apache 2.0
Reaching "Stable" (Version 1.0.0)
The following prerequisites must be met before version 1.0.0
is released:
- Helm install without needing to clone repository
- GitHub action that runs
fmt
andclippy
forx86_64-unknown-linux-gnu
, andbuild
forx86_64-unknown-linux-musl
- Publish a
latest
, and at least one "released" (e.g.0.1.0
), Dockerhub image - Publish to crates.io (
0.1.0
tag first) - Re-add unit tests
Special Thanks
Description | Status |
---|---|
@joshimoo for the recommendation on using undirected graphs | in progress |
@steveklabnik and many members of the Rust community on Twitter for discussions around node weights in undirected graphs | in progress, but there's some influence in the current design |
Dependencies
~68MB
~1M SLoC