From e9548f762b51ada16450a74ebc632def6a8d0085 Mon Sep 17 00:00:00 2001
From: raffis <raffael.sahli@doodle.com>
Date: Thu, 9 Nov 2023 15:49:40 +0100
Subject: [PATCH] docs: readme update (#13)

---
 .github/workflows/pr-build.yaml    |  4 ++--
 README.md                          | 12 ++++++------
 internal/controllers/suite_test.go | 11 -----------
 3 files changed, 8 insertions(+), 19 deletions(-)

diff --git a/.github/workflows/pr-build.yaml b/.github/workflows/pr-build.yaml
index 4a50909..d9d5904 100755
--- a/.github/workflows/pr-build.yaml
+++ b/.github/workflows/pr-build.yaml
@@ -30,7 +30,7 @@ jobs:
           python-version: 3.7
 
       - name: Set up chart-testing
-        uses: helm/chart-testing-action@e8788873172cb653a90ca2e819d79d65a66d4e76 # v2.4.0
+        uses: helm/chart-testing-action@e6669bcd63d7cb57cb4380c33043eebe5d111992 # v2.6.1
 
       - name: Run chart-testing (list-changed)
         id: list-changed
@@ -172,7 +172,7 @@ jobs:
           python-version: 3.7
 
       - name: Set up chart-testing
-        uses: helm/chart-testing-action@e8788873172cb653a90ca2e819d79d65a66d4e76 # v2.4.0
+        uses: helm/chart-testing-action@e6669bcd63d7cb57cb4380c33043eebe5d111992 # v2.6.1
 
       - name: Create kind cluster
         uses: helm/kind-action@dda0770415bac9fc20092cacbc54aa298604d140 # v1.8.0
diff --git a/README.md b/README.md
index fa5a948..869aca8 100755
--- a/README.md
+++ b/README.md
@@ -8,11 +8,11 @@
 
 Pod garbage collector controller.
 This controller cleans evicted/failed pods and can keep a configurable number of them.
-Unlike the vanialla gc collector this controller is workload aware and collects evicted pods overall namespaces and can keep
-a number of evicted pods for each owning workload.
-Despite this the vanilla is configured by default to collect only if there are more than `12500` evicted pods `--terminated-pod-gc-threshold`
-See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/. That said this flag might not even be configurable for 
-hosted kubernetes platforms.
+Unlike the vanilla gc collector this controller is workload aware and collects evicted pods by namespaces and can keep
+a number of evicted pods for each governing workload resource.
+Despite this the vanilla one is configured by default to collect only if there are more than `12500` evicted pods `--terminated-pod-gc-threshold`.
+See https://kubernetes.io/docs/reference/command-line-tools-reference/kube-controller-manager/. That said this flag is usually not not even configurable on
+hosted kubernetes platforms since the control plane can't be modified.
 
 ## Installation
 
@@ -51,4 +51,4 @@ You may change some settings using command line args.
 --min-retry-delay duration                  The minimum amount of time for which an object being reconciled will have to wait before a retry. (default 750ms)
 --watch-all-namespaces                      Watch for resources in all namespaces, if set to false it will only watch the runtime namespace. (default true)
 --watch-label-selector string               Watch for resources with matching labels e.g. 'sharding.fluxcd.io/shard=shard1'.
-```
\ No newline at end of file
+```
diff --git a/internal/controllers/suite_test.go b/internal/controllers/suite_test.go
index a26c6db..0ea53f5 100755
--- a/internal/controllers/suite_test.go
+++ b/internal/controllers/suite_test.go
@@ -19,7 +19,6 @@ package controllers
 import (
 	"context"
 	"fmt"
-	"math/rand"
 	"testing"
 
 	. "github.com/onsi/ginkgo/v2"
@@ -99,13 +98,3 @@ var _ = AfterSuite(func() {
 	err := testEnv.Stop()
 	Expect(err).ToNot(HaveOccurred())
 })
-
-var letterRunes = []rune("abcdefghijklmnopqrstuvwxyz1234567890")
-
-func randStringRunes(n int) string {
-	b := make([]rune, n)
-	for i := range b {
-		b[i] = letterRunes[rand.Intn(len(letterRunes))]
-	}
-	return string(b)
-}