Regenerate headroom-controller chart

Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>

Author: alexellis

.gitignore

@@ -34,7 +34,7 @@ of_kind_portforward.pid
 jwt_key
 jwt_key.pub
 /*.pid
-*.txt
+/*.txt
 /.secrets/*
 
 /pro.sh

chart/headroom-controller/README.md

@@ -1,6 +1,6 @@
 # Headroom Controller Helm Chart
 
-A Helm chart for deploying the headroom-controller controller, which manages Kubernetes resource reservations through custom Headroom resources.
+Speed up scaling up and rolling out of workloads by pre-provisioning headroom in your Kubernetes cluster.
 
 ## Prerequisites
 

chart/headroom-controller/templates/NOTES.txt

@@ -0,0 +1,48 @@
+1. Create a default priority priorityClassName
+
+kubectl apply -f - << EOF
+apiVersion: scheduling.k8s.io/v1
+kind: PriorityClass
+metadata:
+  name: default
+value: 1000
+globalDefault: true
+description: "Default priority class for all pods"
+EOF
+
+2. Create a low priority class for the headroom Custom Resources
+
+kubectl apply -f - <<EOF
+apiVersion: scheduling.k8s.io/v1
+kind: PriorityClass
+metadata:
+  name: headroom
+description: Low priority class for headroom pods
+globalDefault: false
+preemptionPolicy: Never
+value: -10
+EOF
+
+3. Create a headroom resource:
+
+kubectl apply -f - <<EOF
+apiVersion: openfaas.com/v1
+kind: Headroom
+metadata:
+  name: example
+spec:
+  replicas: 1
+  requests:
+    cpu: "100m"
+    memory: "128Mi"
+  priorityClassName: "headroom"
+EOF
+
+4. Check the status:
+
+   kubectl get headrooms
+
+5. Scale the headroom:
+
+   kubectl scale headroom example --replicas=2
+