Update README and CHANGELOG for 0.6.0 release

Namespace restrictions & quality of life enhancements

.github/workflows/container.yaml

@@ -0,0 +1,32 @@
+---
+name: Container Build
+
+on:
+  push:
+    tags: ['[0-9]+.[0-9]+.[0-9]+']
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v2
+      - uses: docker/setup-qemu-action@v1
+      - uses: docker/setup-buildx-action@v1
+      - uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - id: version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+      - uses: docker/build-push-action@v2
+        with:
+          platforms: linux/amd64, linux/arm64
+          push: true
+          tags: |-
+            ghcr.io/${{ github.repository }}:latest
+            ghcr.io/${{ github.repository }}:${{ steps.version.outputs.VERSION }}

CHANGELOG.md

@@ -1,3 +1,19 @@
+# 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
+
+* New image storaxdev/kubedoom:1.0.0
+* New default VNC password is `idbehold`. 
+* Update kubernetes to 1.19.1
+* Update to Ubuntu 20.10
+
 # 0.4.0
 
 * New image storadev/kubedoom:0.4.0

Dockerfile

@@ -1,56 +1,58 @@
-FROM golang:1.14-alpine AS gobuild
+FROM golang:1.17-alpine AS build-kubedoom
-
 WORKDIR /go/src/kubedoom
+ADD go.mod .
 ADD kubedoom.go .
 RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o kubedoom .
 
-FROM ubuntu:19.10 AS ubuntu
+FROM ubuntu:21.10 AS build-essentials
-# make sure the package repository is up to date
+ARG TARGETARCH
-RUN apt-get update
+ARG KUBECTL_VERSION=1.23.2
-
+RUN apt-get update && apt-get install -y \
-FROM ubuntu AS ubuntu-deps
-# Install dependencies
-RUN apt-get install -y \
   -o APT::Install-Suggests=0 \
   --no-install-recommends \
   wget ca-certificates
 RUN wget http://distro.ibiblio.org/pub/linux/distributions/slitaz/sources/packages/d/doom1.wad
-RUN wget -O /usr/bin/kubectl https://storage.googleapis.com/kubernetes-release/release/$(wget -O- https://storage.googleapis.com/kubernetes-release/release/stable.txt)/bin/linux/amd64/kubectl \
+RUN echo "TARGETARCH is $TARGETARCH"
+RUN echo "KUBECTL_VERSION is $KUBECTL_VERSION"
+RUN wget -O /usr/bin/kubectl "https://storage.googleapis.com/kubernetes-release/release/v${KUBECTL_VERSION}/bin/linux/${TARGETARCH}/kubectl" \
   && chmod +x /usr/bin/kubectl
 
-FROM ubuntu AS ubuntu-build
+FROM ubuntu:21.10 AS build-doom
-
 ENV DEBIAN_FRONTEND=noninteractive
-RUN apt-get install -y \
+RUN apt-get update && apt-get install -y \
   -o APT::Install-Suggests=0 \
   --no-install-recommends \
   build-essential \
   libsdl-mixer1.2-dev \
   libsdl-net1.2-dev \
   gcc
-
-# Setup doom
 ADD /dockerdoom /dockerdoom
-RUN cd /dockerdoom/trunk && ./configure && make && make install
+WORKDIR /dockerdoom/trunk
+RUN ./configure && make && make install
 
-FROM ubuntu
+FROM ubuntu:21.10 as build-converge
-RUN apt-get install -y \
+WORKDIR /build
+RUN mkdir -p \
+  /build/root \
+  /build/usr/bin \
+  /build/usr/local/games
+COPY --from=build-essentials /doom1.wad /build/root
+COPY --from=build-essentials /usr/bin/kubectl /build/usr/bin
+COPY --from=build-kubedoom /go/src/kubedoom/kubedoom /build/usr/bin
+COPY --from=build-doom /usr/local/games/psdoom /build/usr/local/games
+
+FROM ubuntu:21.10
+ARG VNCPASSWORD=idbehold
+RUN apt-get update && apt-get install -y \
   -o APT::Install-Suggests=0 \
   --no-install-recommends \
   libsdl-mixer1.2 \
   libsdl-net1.2 \
   x11vnc \
   xvfb \
-  netcat-openbsd
+  netcat-openbsd \
-
+  && rm -rf /var/lib/apt/lists/*
-WORKDIR /root/
+RUN mkdir /root/.vnc && x11vnc -storepasswd "${VNCPASSWORD}" /root/.vnc/passwd
-
+COPY --from=build-converge /build /
-# Setup a password
+WORKDIR /root
-RUN mkdir ~/.vnc && x11vnc -storepasswd 1234 ~/.vnc/passwd
+ENTRYPOINT ["/usr/bin/kubedoom"]
-
-COPY --from=ubuntu-deps /doom1.wad .
-COPY --from=ubuntu-deps /usr/bin/kubectl /usr/bin/
-COPY --from=ubuntu-build /usr/local/games/psdoom /usr/local/games/
-COPY --from=gobuild /go/src/kubedoom/kubedoom .
-
-ENTRYPOINT ["/root/kubedoom"]

README.md

@@ -11,19 +11,41 @@ which was forked from psdoom.
 
 ![DOOM](assets/doom.jpg)
 
-## Usage
+## Running Locally
 
-Run `storaxdev/kubedoom:0.4.0` locally:
+In order to run locally you will need to
+
+1. Run the kubedoom container
+2. Attach a VNC client to the appropriate port (5901)
+
+### With Docker
+
+Run `ghcr.io/storax/kubedoom:latest` with docker locally:
 
 ```console
 $ docker run -p5901:5900 \
   --net=host \
   -v ~/.kube:/root/.kube \
   --rm -it --name kubedoom \
-  storaxdev/kubedoom:0.4.0
+  ghcr.io/storax/kubedoom:latest
 ```
 
-Now start a VNC viewer and connect to `localhost:5901`. The password is `1234`:
+Optionally, if you set `-e NAMESPACE={your namespace}` you can limit Kubedoom to deleting pods in a single namespace
+
+### With Podman
+
+Run `ghcr.io/storax/kubedoom:latest` with podman locally:
+
+```console
+$ podman run -it -p5901:5900/tcp \
+  -v ~/.kube:/tmp/.kube --security-opt label=disable \
+  --env "KUBECONFIG=/tmp/.kube/config" --name kubedoom
+  ghcr.io/storax/kubedoom:latest
+```
+
+### Attaching a VNC Client
+
+Now start a VNC viewer and connect to `localhost:5901`. The password is `idbehold`:
 ```console
 $ vncviewer viewer localhost:5901
 ```
@@ -44,7 +66,7 @@ $ docker run -p5901:5900 \
   --net=host \
   -v ~/.kube:/root/.kube \
   --rm -it --name kubedoom \
-  storaxdev/kubedoom:0.4.0 \
+  ghcr.io/storax/kubedoom:latest \
   -mode namespaces
 ```
 
@@ -57,7 +79,7 @@ example config from this repository:
 ```console
 $ kind create cluster --config kind-config.yaml
 Creating cluster "kind" ...
- ✓ Ensuring node image (kindest/node:v1.18.2) 🖼
+ ✓ Ensuring node image (kindest/node:v1.23.0) 🖼
  ✓ Preparing nodes 📦 📦
  ✓ Writing configuration 📜
  ✓ Starting control-plane 🕹️
@@ -69,7 +91,7 @@ You can now use your cluster with:
 
 kubectl cluster-info --context kind-kind
 
-Not sure what to do next? 😅 Check out https://kind.sigs.k8s.io/docs/user/quick-start/
+Not sure what to do next? 😅  Check out https://kind.sigs.k8s.io/docs/user/quick-start/
 ```
 
 This will spin up a 2 node cluster inside docker, with port 5900 exposed from
@@ -77,8 +99,7 @@ the worker node. Then run kubedoom inside the cluster by applying the manifest
 provided in this repository:
 
 ```console
-$ export KUBECONFIG="$(kind get kubeconfig-path --name="kind")"
+$ kubectl apply -k manifest/
-$ kubectl apply -f manifest/
 namespace/kubedoom created
 deployment.apps/kubedoom created
 serviceaccount/kubedoom created
@@ -91,4 +112,16 @@ $ vncviewer viewer localhost:5900
 ```
 
 Kubedoom requires a service account with permissions to list all pods and delete
-them and uses kubectl 1.18.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`.

dockerdoom/trunk/setup/configfile.c

@@ -512,7 +512,7 @@ static void LoadDefaultCollection(default_collection_t *collection)
     
     while (!feof(f))
     {
-        if (fscanf (f, "%79s %[^\n]\n", defname, strparm) != 2)
+        if (fscanf (f, "%79s %99[^\n]\n", defname, strparm) != 2)
         {
             // This line doesn't match
           

dockerdoom/trunk/src/m_config.c

@@ -1312,7 +1312,7 @@ static void LoadDefaultCollection(default_collection_t *collection)
     
     while (!feof(f))
     {
-        if (fscanf (f, "%79s %[^\n]\n", defname, strparm) != 2)
+        if (fscanf (f, "%79s %99[^\n]\n", defname, strparm) != 2)
         {
             // This line doesn't match
           

go.mod

@@ -0,0 +1,3 @@
+module kubedoom
+
+go 1.17

kind-config.yaml

@@ -2,9 +2,9 @@ kind: Cluster
 apiVersion: kind.x-k8s.io/v1alpha4
 nodes:
 - role: control-plane
-  image: kindest/node:v1.18.2@sha256:7b27a6d0f2517ff88ba444025beae41491b016bc6af573ba467b70c5e8e0d85f
+  image: kindest/node:v1.23.0@sha256:49824ab1727c04e56a21a5d8372a402fcd32ea51ac96a2706a12af38934f81ac
 - role: worker
-  image: kindest/node:v1.18.2@sha256:7b27a6d0f2517ff88ba444025beae41491b016bc6af573ba467b70c5e8e0d85f
+  image: kindest/node:v1.23.0@sha256:49824ab1727c04e56a21a5d8372a402fcd32ea51ac96a2706a12af38934f81ac
   extraPortMappings:
   - containerPort: 5900
     hostPort: 5900

kubedoom.go

@@ -25,7 +25,7 @@ func hash(input string) int32 {
 
 func runCmd(cmdstring string) {
 	parts := strings.Split(cmdstring, " ")
-	cmd := exec.Command(parts[0], parts[1:len(parts)]...)
+	cmd := exec.Command(parts[0], parts[1:]...)
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 	err := cmd.Run()
@@ -35,7 +35,7 @@ func runCmd(cmdstring string) {
 }
 
 func outputCmd(argv []string) string {
-	cmd := exec.Command(argv[0], argv[1:len(argv)]...)
+	cmd := exec.Command(argv[0], argv[1:]...)
 	cmd.Stderr = os.Stderr
 	output, err := cmd.Output()
 	if err != nil {
@@ -46,7 +46,7 @@ func outputCmd(argv []string) string {
 
 func startCmd(cmdstring string) {
 	parts := strings.Split(cmdstring, " ")
-	cmd := exec.Command(parts[0], parts[1:len(parts)]...)
+	cmd := exec.Command(parts[0], parts[1:]...)
 	cmd.Stdout = os.Stdout
 	cmd.Stderr = os.Stderr
 	cmd.Stdin = os.Stdin
@@ -65,7 +65,12 @@ type podmode struct {
 }
 
 func (m podmode) getEntities() []string {
-	args := []string{"kubectl", "get", "pods", "-A", "-o", "go-template", "--template={{range .items}}{{.metadata.namespace}}/{{.metadata.name}} {{end}}"}
+	var args []string
+	if namespace, exists := os.LookupEnv("NAMESPACE"); exists {
+		args = []string{"kubectl", "get", "pods", "--namespace", namespace, "-o", "go-template", "--template={{range .items}}{{.metadata.namespace}}/{{.metadata.name}} {{end}}"}
+	} else {
+		args = []string{"kubectl", "get", "pods", "-A", "-o", "go-template", "--template={{range .items}}{{.metadata.namespace}}/{{.metadata.name}} {{end}}"}
+	}
 	output := outputCmd(args)
 	outputstr := strings.TrimSpace(output)
 	pods := strings.Split(outputstr, " ")
@@ -97,7 +102,7 @@ func (m nsmode) deleteEntity(entity string) {
 }
 
 func socketLoop(listener net.Listener, mode Mode) {
-	for true {
+	for {
 		conn, err := listener.Accept()
 		if err != nil {
 			panic(err)
@@ -169,6 +174,6 @@ func main() {
 	log.Print("You can now connect to it with a VNC viewer at port 5900")
 
 	log.Print("Trying to start DOOM ...")
-	startCmd("/usr/bin/env DISPLAY=:99 /usr/local/games/psdoom -warp -E1M1")
+	startCmd("/usr/bin/env DISPLAY=:99 /usr/local/games/psdoom -warp -E1M1 -skill 1 -nomouse")
 	socketLoop(listener, mode)
 }

manifest/deployment.yaml

@@ -1,3 +1,4 @@
+---
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -18,8 +19,11 @@ spec:
       hostNetwork: true
       serviceAccountName: kubedoom
       containers:
-      - image: storaxdev/kubedoom:0.4.0
+        - image: ghcr.io/storax/kubedoom:latest
-        name: kubedoom
+          env:
-        ports:
+            - name: NAMESPACE
-        - containerPort: 5900
+              value: default
-          name: vnc
+          name: kubedoom
+          ports:
+            - containerPort: 5900
+              name: vnc

manifest/kustomization.yaml

@@ -0,0 +1,5 @@
+---
+resources:
+  - namespace.yaml
+  - deployment.yaml
+  - rbac.yaml

manifest/namespace.yaml

@@ -1,3 +1,4 @@
+---
 apiVersion: v1
 kind: Namespace
 metadata:

manifest/rbac.yaml

@@ -1,3 +1,4 @@
+---
 apiVersion: v1
 kind: ServiceAccount
 metadata: