Skip to content

Commit

Permalink
docs: readme update (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
raffis authored Nov 9, 2023
1 parent 3e23327 commit e9548f7
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 19 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/pr-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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'.
```
```
11 changes: 0 additions & 11 deletions internal/controllers/suite_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package controllers
import (
"context"
"fmt"
"math/rand"
"testing"

. "github.com/onsi/ginkgo/v2"
Expand Down Expand Up @@ -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)
}

0 comments on commit e9548f7

Please sign in to comment.