Merge pull request #1 from fabiante/feat/minimal-controller

Add minimal working controller to kill non-running pods

Author: fabiante

.golangci.yml

@@ -8,6 +8,8 @@ issues:
   exclude-use-default: false
   # restore some of the defaults
   # (fill in the rest as needed)
+  exclude-dirs:
+    - "test/e2e/*"
   exclude-rules:
     - path: "api/*"
       linters:

Makefile

@@ -120,10 +120,10 @@ PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 docker-buildx: ## Build and push docker image for the manager for cross-platform support
 	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
 	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
-	- $(CONTAINER_TOOL) buildx create --name podreaper-builder
-	$(CONTAINER_TOOL) buildx use podreaper-builder
+	- $(CONTAINER_TOOL) buildx create --name podbouncer-builder
+	$(CONTAINER_TOOL) buildx use podbouncer-builder
 	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
-	- $(CONTAINER_TOOL) buildx rm podreaper-builder
+	- $(CONTAINER_TOOL) buildx rm podbouncer-builder
 	rm Dockerfile.cross
 
 .PHONY: build-installer
@@ -140,11 +140,11 @@ endif
 
 .PHONY: install
 install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
-	$(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f -
+	# $(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f -
 
 .PHONY: uninstall
 uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
-	$(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
+	# $(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
 
 .PHONY: deploy
 deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.

PROJECT

@@ -5,6 +5,11 @@
 domain: fabitee.de
 layout:
 - go.kubebuilder.io/v4
-projectName: podreaper
+projectName: podbouncer
 repo: github.com/fabiante/podbouncer
+resources:
+- controller: true
+  domain: fabitee.de
+  kind: Pod
+  version: v1alpha1
 version: "3"

README.md

@@ -1,11 +1,11 @@
-# podreaper
+# podbouncer
 
-Podreaper is a [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
+Podbouncer is a [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/)
 responsible for deleting non-running pods after a configurable grace period.
 
 ## Description
 
-Using podreaper in your cluster will result in the deletion of all pods in one of
+Using podbouncer in your cluster will result in the deletion of all pods in one of
 these states: `Pending`, `Completed`, `Failed`
 
 This operator acts on pods of all namespaces, except the `kube-system` namespace.
@@ -24,7 +24,7 @@ This operator acts on pods of all namespaces, except the `kube-system` namespace
 **Build and push your image to the location specified by `IMG`:**
 
 ```sh
-make docker-build docker-push IMG=<some-registry>/podreaper:tag
+make docker-build docker-push IMG=<some-registry>/podbouncer:tag
 ```
 
 **NOTE:** This image ought to be published in the personal registry you specified.
@@ -40,7 +40,7 @@ make install
 **Deploy the Manager to the cluster with the image specified by `IMG`:**
 
 ```sh
-make deploy IMG=<some-registry>/podreaper:tag
+make deploy IMG=<some-registry>/podbouncer:tag
 ```
 
 > **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
@@ -81,7 +81,7 @@ Following are the steps to build the installer and distribute this project to us
 1. Build the installer for the image built and published in the registry:
 
 ```sh
-make build-installer IMG=<some-registry>/podreaper:tag
+make build-installer IMG=<some-registry>/podbouncer:tag
 ```
 
 NOTE: The makefile target mentioned above generates an 'install.yaml'
@@ -94,15 +94,26 @@ its dependencies.
 Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.:
 
 ```sh
-kubectl apply -f https://raw.githubusercontent.com/<org>/podreaper/<tag or branch>/dist/install.yaml
+kubectl apply -f https://raw.githubusercontent.com/<org>/podbouncer/<tag or branch>/dist/install.yaml
+```
+
+## Testing
+
+### Create Test Pods
+
+To test podbouncer, you must have some non-running pods in your cluster:
+
+```shell
+kubectl run --restart=Never --image busybox some-pod
+kubectl run --restart=Never --image busybox some-other-pod
 ```
 
 ## Contributing
-// TODO(user): Add detailed information on how you would like others to contribute to this project
 
-**NOTE:** Run `make help` for more information on all potential `make` targets
+This project is a personal learning project.
 
-More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
+You are welcome to use it, learn from it. You are welcome to submit pull requests,
+but I do not guarantee any level of activity on this project.
 
 ## License
 

api/.gitkeep

@@ -0,0 +1,3 @@
+This directory is required by the Dockerfile.
+
+Let's rather keep this empty dir instead of chaning the Dockerfile.

cmd/main.go

@@ -34,6 +34,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
+
+	"github.com/fabiante/podbouncer/internal/controller"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -138,6 +140,13 @@ func main() {
 		os.Exit(1)
 	}
 
+	if err = (&controller.PodReconciler{
+		Client: mgr.GetClient(),
+		Scheme: mgr.GetScheme(),
+	}).SetupWithManager(mgr); err != nil {
+		setupLog.Error(err, "unable to create controller", "controller", "Pod")
+		os.Exit(1)
+	}
 	// +kubebuilder:scaffold:builder
 
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {

config/default/kustomization.yaml

@@ -1,12 +1,12 @@
 # Adds namespace to all resources.
-namespace: podreaper-system
+namespace: podbouncer-system
 
 # Value of this field is prepended to the
 # names of all resources, e.g. a deployment named
 # "wordpress" becomes "alices-wordpress".
 # Note that it should also match with the prefix (text before '-') of the namespace
 # field above.
-namePrefix: podreaper-
+namePrefix: podbouncer-
 
 # Labels to add to all resources and selectors.
 #labels:

config/default/metrics_service.yaml

@@ -3,7 +3,7 @@ kind: Service
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-service
   namespace: system

config/manager/kustomization.yaml

@@ -1,2 +1,8 @@
 resources:
 - manager.yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+images:
+- name: controller
+  newName: fabiante/podbouncer
+  newTag: latest

config/manager/manager.yaml

@@ -3,7 +3,7 @@ kind: Namespace
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: system
 ---
@@ -14,7 +14,7 @@ metadata:
   namespace: system
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
 spec:
   selector:

config/network-policy/allow-metrics-traffic.yaml

@@ -5,7 +5,7 @@ apiVersion: networking.k8s.io/v1
 kind: NetworkPolicy
 metadata:
   labels:
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: allow-metrics-traffic
   namespace: system

config/prometheus/monitor.yaml

@@ -4,7 +4,7 @@ kind: ServiceMonitor
 metadata:
   labels:
     control-plane: controller-manager
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager-metrics-monitor
   namespace: system

config/rbac/leader_election_role.yaml

@@ -3,7 +3,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   labels:
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: leader-election-role
 rules:

config/rbac/leader_election_role_binding.yaml

@@ -2,7 +2,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
   labels:
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: leader-election-rolebinding
 roleRef:

config/rbac/role.yaml

@@ -1,11 +1,32 @@
+---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRole
 metadata:
-  labels:
-    app.kubernetes.io/name: podreaper
-    app.kubernetes.io/managed-by: kustomize
   name: manager-role
 rules:
-- apiGroups: [""]
-  resources: ["pods"]
-  verbs: ["get", "list", "watch"]
+- apiGroups:
+  - ""
+  resources:
+  - pods
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+- apiGroups:
+  - ""
+  resources:
+  - pods/finalizers
+  verbs:
+  - update
+- apiGroups:
+  - ""
+  resources:
+  - pods/status
+  verbs:
+  - get
+  - patch
+  - update

config/rbac/role_binding.yaml

@@ -2,7 +2,7 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding
 metadata:
   labels:
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: manager-rolebinding
 roleRef:

config/rbac/service_account.yaml

@@ -2,7 +2,7 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   labels:
-    app.kubernetes.io/name: podreaper
+    app.kubernetes.io/name: podbouncer
     app.kubernetes.io/managed-by: kustomize
   name: controller-manager
   namespace: system

go.mod

@@ -5,6 +5,8 @@ go 1.22.0
 require (
 	github.com/onsi/ginkgo/v2 v2.19.0
 	github.com/onsi/gomega v1.33.1
+	github.com/stretchr/testify v1.9.0
+	k8s.io/api v0.31.0
 	k8s.io/apimachinery v0.31.0
 	k8s.io/client-go v0.31.0
 	sigs.k8s.io/controller-runtime v0.19.1
@@ -49,6 +51,7 @@ require (
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/prometheus/client_golang v1.19.1 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/common v0.55.0 // indirect
@@ -84,7 +87,6 @@ require (
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-	k8s.io/api v0.31.0 // indirect
 	k8s.io/apiextensions-apiserver v0.31.0 // indirect
 	k8s.io/apiserver v0.31.0 // indirect
 	k8s.io/component-base v0.31.0 // indirect