gaspersic/kubedoom
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README and CHANGELOG for 0.6.0 release

Browse Source
This commit is contained in:
David Zuber 2022-02-06 13:52:04 +00:00
parent 89e84772f0
commit bf4b045aa0
2 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CHANGELOG.md
View File

@ -1,3 +1,12 @@
# 0.6.0
* New image ghcr.io/storax/kubedoom:0.6.0
* Latest image available as ghcr.io/storax/kubedoom:latest.
* Add support for building on different architectures.
* Update kubernetes to 1.23.2
* Update to Ubuntu 21.10
* Github Actions for building the image.
* VNC password can be configured during build via the `VNCPASSWORD` build argument.
# 0.5.0 # 0.5.0
* New image storaxdev/kubedoom:1.0.0 * New image storaxdev/kubedoom:1.0.0

26
README.md
View File

@ -20,27 +20,27 @@ In order to run locally you will need to
### With Docker ### With Docker
Run `storaxdev/kubedoom:0.5.0` with docker locally: Run `ghcr.io/storax/kubedoom:latest` with docker locally:
```console ```console
$ docker run -p5901:5900 \ $ docker run -p5901:5900 \
--net=host \ --net=host \
-v ~/.kube:/root/.kube \ -v ~/.kube:/root/.kube \
--rm -it --name kubedoom \ --rm -it --name kubedoom \
storaxdev/kubedoom:0.5.0 ghcr.io/storax/kubedoom:latest
``` ```
Optionally, if you set `-e NAMESPACE={your namespace}` you can limit Kubedoom to deleting pods in a single namespace Optionally, if you set `-e NAMESPACE={your namespace}` you can limit Kubedoom to deleting pods in a single namespace
### With Podman ### With Podman
Run `storaxdev/kubedoom:0.5.0` with podman locally: Run `ghcr.io/storax/kubedoom:latest` with podman locally:
```console ```console
$ podman run -it -p5901:5900/tcp \ $ podman run -it -p5901:5900/tcp \
-v ~/.kube:/tmp/.kube --security-opt label=disable \ -v ~/.kube:/tmp/.kube --security-opt label=disable \
--env "KUBECONFIG=/tmp/.kube/config" --name kubedoom --env "KUBECONFIG=/tmp/.kube/config" --name kubedoom
storaxdev/kubedoom:0.5.0 ghcr.io/storax/kubedoom:latest
``` ```
### Attaching a VNC Client ### Attaching a VNC Client
@ -66,7 +66,7 @@ $ docker run -p5901:5900 \
--net=host \ --net=host \
-v ~/.kube:/root/.kube \ -v ~/.kube:/root/.kube \
--rm -it --name kubedoom \ --rm -it --name kubedoom \
storaxdev/kubedoom:0.5.0 \ ghcr.io/storax/kubedoom:latest \
-mode namespaces -mode namespaces
``` ```
@ -79,7 +79,7 @@ example config from this repository:
```console ```console
$ kind create cluster --config kind-config.yaml $ kind create cluster --config kind-config.yaml
Creating cluster "kind" ... Creating cluster "kind" ...
✓ Ensuring node image (kindest/node:v1.19.1) 🖼 ✓ Ensuring node image (kindest/node:v1.23.0) 🖼
✓ Preparing nodes 📦 📦 ✓ Preparing nodes 📦 📦
✓ Writing configuration 📜 ✓ Writing configuration 📜
✓ Starting control-plane 🕹️ ✓ Starting control-plane 🕹️
@ -112,4 +112,16 @@ $ vncviewer viewer localhost:5900
``` ```
Kubedoom requires a service account with permissions to list all pods and delete Kubedoom requires a service account with permissions to list all pods and delete
them and uses kubectl 1.19.2. them and uses kubectl 1.23.2.
## Building Kubedoom
The repository contains a Dockerfile to build the kubedoom image. You have to
specify your systems architecture as the `TARGETARCH` build argument. For
example `amd64` or `arm64`.
```console
$ docker build --build-arg=TARGETARCH=amd64 -t kubedoom .
```
To change the default VNC password, use `--build-arg=VNCPASSWORD=differentpw`.