Merge pull request #309 from wallrj/pdb-tweaks

Production readiness Helm chart tweaks
cert-manager · Feb 28, 2024 · 34bb21e · 34bb21e
2 parents 67d4784 + 63535c8
commit 34bb21e
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/deploy/charts/trust-manager/README.md b/deploy/charts/trust-manager/README.md
@@ -428,7 +428,7 @@ Additional labels to add to the ServiceMonitor.
 
 Enable or disable the PodDisruptionBudget resource.  
   
-This prevents downtime during voluntary disruptions such as during a Node upgrade. For example, the PodDisruptionBudget will block `kubectl drain` if it is used on the Node where the only remaining cert-manager  
+This prevents downtime during voluntary disruptions such as during a Node upgrade. For example, the PodDisruptionBudget will block `kubectl drain` if it is used on the Node where the only remaining trust-manager  
 Pod is currently running.
 #### **podDisruptionBudget.minAvailable** ~ `unknown`
 

diff --git a/deploy/charts/trust-manager/templates/NOTES.txt b/deploy/charts/trust-manager/templates/NOTES.txt
@@ -1,3 +1,11 @@
+{{- if (lt (int .Values.replicaCount) 2) }}
+⚠️  WARNING: Consider increasing the Helm value `replicaCount` to 2 if you require high availability.
+{{- end }}
+
+{{- if (not .Values.podDisruptionBudget.enabled) }}
+⚠️  WARNING: Consider setting the Helm value `podDisruptionBudget.enabled` to true if you require high availability.
+{{- end }}
+
 trust-manager {{ .Chart.AppVersion }} has been deployed successfully!
 
 {{- if .Values.defaultPackage.enabled }}

diff --git a/deploy/charts/trust-manager/values.schema.json b/deploy/charts/trust-manager/values.schema.json
@@ -530,7 +530,7 @@
       "additionalProperties": false
     },
     "helm-values.podDisruptionBudget.enabled": {
-      "description": "Enable or disable the PodDisruptionBudget resource.\n\nThis prevents downtime during voluntary disruptions such as during a Node upgrade. For example, the PodDisruptionBudget will block `kubectl drain` if it is used on the Node where the only remaining cert-manager\nPod is currently running.",
+      "description": "Enable or disable the PodDisruptionBudget resource.\n\nThis prevents downtime during voluntary disruptions such as during a Node upgrade. For example, the PodDisruptionBudget will block `kubectl drain` if it is used on the Node where the only remaining trust-manager\nPod is currently running.",
       "type": "boolean",
       "default": false
     },

diff --git a/deploy/charts/trust-manager/values.yaml b/deploy/charts/trust-manager/values.yaml
@@ -185,7 +185,7 @@ app:
     port: 6443
     # Timeout of webhook HTTP request.
     timeoutSeconds: 5
-    
+
     service:
       # The type of Kubernetes Service used by the Webhook.
       type: ClusterIP
@@ -237,7 +237,7 @@ podDisruptionBudget:
   #
   # This prevents downtime during voluntary disruptions such as during a Node upgrade.
   # For example, the PodDisruptionBudget will block `kubectl drain`
-  # if it is used on the Node where the only remaining cert-manager
+  # if it is used on the Node where the only remaining trust-manager
   # Pod is currently running.
   enabled: false