fix(pvc): split PVC configuration between Deployments

cryostatio · Nov 29, 2024 · 1c3eb11 · 1c3eb11
1 parent b91e9bd
commit 1c3eb11
Show file tree

Hide file tree

Showing 9 changed files with 169 additions and 113 deletions.
diff --git a/charts/cryostat/README.md b/charts/cryostat/README.md
diff --git a/charts/cryostat/templates/db_deployment.yaml b/charts/cryostat/templates/db_deployment.yaml
@@ -85,12 +85,12 @@ spec:
         {{- toYaml . | nindent 8 }}
       {{- end }}
       volumes:
-      {{- if ((.Values.pvc).enabled) }}
+      {{- if ((.Values.db.resources.pvc).enabled) }}
       - name: {{ .Chart.Name }}-db
         persistentVolumeClaim:
           claimName: {{ .Release.Name }}-db
       {{- end }}
-      {{- if not ((.Values.pvc).enabled) }}
+      {{- if not ((.Values.db.resources.pvc).enabled) }}
       - name: {{ .Chart.Name }}-db
         emptyDir: {}
       {{- end }}
diff --git a/charts/cryostat/templates/db_pvc.yaml b/charts/cryostat/templates/db_pvc.yaml
@@ -1,26 +1,26 @@
-{{- if ((.Values.pvc).enabled) }}
+{{- if ((.Values.db.pvc).enabled) }}
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   name: {{ include "cryostat.fullname" . }}-db
   {{- $labels := include "cryostat.labels" $ | nindent 4 }}
   labels: {{ $labels }}
-  {{- with .Values.pvc.annotations }}
+  {{- with .Values.db.pvc.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}
   {{- end }}
 spec:
-  {{- with .Values.pvc.accessModes }}
+  {{- with .Values.db.pvc.accessModes }}
   accessModes:
     {{- toYaml . | nindent 4 }}
   {{- end }}
   resources:
     requests:
-      storage: {{ .Values.pvc.storage }}
-  {{- if kindIs "string" .Values.pvc.storageClassName }}
-  storageClassName: {{ .Values.pvc.storageClassName | quote }}
+      storage: {{ .Values.db.pvc.storage }}
+  {{- if kindIs "string" .Values.db.pvc.storageClassName }}
+  storageClassName: {{ .Values.db.pvc.storageClassName | quote }}
   {{- end }}
-  {{- with .Values.pvc.selector }}
+  {{- with .Values.db.pvc.selector }}
   selector:
     {{- toYaml . | nindent 4 }}
   {{- end }}

diff --git a/charts/cryostat/templates/storage_deployment.yaml b/charts/cryostat/templates/storage_deployment.yaml
@@ -99,12 +99,12 @@ spec:
         {{- toYaml . | nindent 8 }}
       {{- end }}
       volumes:
-      {{- if ((.Values.pvc).enabled) }}
+      {{- if ((.Values.storage.resources.pvc).enabled) }}
       - name: {{ .Chart.Name }}-storage
         persistentVolumeClaim:
           claimName: {{ .Release.Name }}-storage
       {{- end }}
-      {{- if not ((.Values.pvc).enabled) }}
+      {{- if not ((.Values.storage.resources.pvc).enabled) }}
       - name: {{ .Chart.Name }}-storage
         emptyDir: {}
       {{- end }}
diff --git a/charts/cryostat/templates/storage_pvc.yaml b/charts/cryostat/templates/storage_pvc.yaml
@@ -1,26 +1,26 @@
-{{- if ((.Values.pvc).enabled) }}
+{{- if ((.Values.storage.pvc).enabled) }}
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   name: {{ include "cryostat.fullname" . }}-storage
   {{- $labels := include "cryostat.labels" $ | nindent 4 }}
   labels: {{ $labels }}
-  {{- with .Values.pvc.annotations }}
+  {{- with .Values.storage.pvc.annotations }}
   annotations:
     {{- toYaml . | nindent 4 }}
   {{- end }}
 spec:
-  {{- with .Values.pvc.accessModes }}
+  {{- with .Values.storage.pvc.accessModes }}
   accessModes:
     {{- toYaml . | nindent 4 }}
   {{- end }}
   resources:
     requests:
-      storage: {{ .Values.pvc.storage }}
-  {{- if kindIs "string" .Values.pvc.storageClassName }}
-  storageClassName: {{ .Values.pvc.storageClassName | quote }}
+      storage: {{ .Values.storage.pvc.storage }}
+  {{- if kindIs "string" .Values.storage.pvc.storageClassName }}
+  storageClassName: {{ .Values.storage.pvc.storageClassName | quote }}
   {{- end }}
-  {{- with .Values.pvc.selector }}
+  {{- with .Values.storage.pvc.selector }}
   selector:
     {{- toYaml . | nindent 4 }}
   {{- end }}

diff --git a/charts/cryostat/tests/db_pvc_test.yaml b/charts/cryostat/tests/db_pvc_test.yaml
@@ -5,7 +5,7 @@ templates:
 tests:
   - it: should create a PersistentVolumeClaim with correct settings
     set:
-      pvc:
+      db.pvc:
         enabled: true
         storage: "10Gi"
         accessModes:
@@ -50,7 +50,7 @@ tests:
 
   - it: should not create a PersistentVolumeClaim when PVC is disabled
     set:
-      pvc:
+      db.pvc:
         enabled: false
     asserts:
       - hasDocuments:

diff --git a/charts/cryostat/tests/storage_pvc_test.yaml b/charts/cryostat/tests/storage_pvc_test.yaml
@@ -5,7 +5,7 @@ templates:
 tests:
   - it: should create a PersistentVolumeClaim with correct settings
     set:
-      pvc:
+      storage.pvc:
         enabled: true
         storage: "10Gi"
         accessModes:
@@ -50,7 +50,7 @@ tests:
 
   - it: should not create a PersistentVolumeClaim when PVC is disabled
     set:
-      pvc:
+      storage.pvc:
         enabled: false
     asserts:
       - hasDocuments:

diff --git a/charts/cryostat/values.schema.json b/charts/cryostat/values.schema.json
@@ -374,31 +374,6 @@
         "db": {
             "type": "object",
             "properties": {
-                "securityContext": {
-                    "type": "object",
-                    "properties": {
-                        "capabilities": {
-                            "type": "object",
-                            "properties": {
-                                "drop": {
-                                    "type": "array",
-                                    "description": "",
-                                    "default": [
-                                        "ALL"
-                                    ],
-                                    "items": {
-                                        "type": "string"
-                                    }
-                                }
-                            }
-                        },
-                        "allowPrivilegeEscalation": {
-                            "type": "boolean",
-                            "description": "",
-                            "default": false
-                        }
-                    }
-                },
                 "image": {
                     "type": "object",
                     "properties": {
@@ -453,12 +428,7 @@
                             }
                         }
                     }
-                }
-            }
-        },
-        "storage": {
-            "type": "object",
-            "properties": {
+                },
                 "securityContext": {
                     "type": "object",
                     "properties": {
@@ -484,6 +454,42 @@
                         }
                     }
                 },
+                "pvc": {
+                    "type": "object",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "description": "Specify whether to use persistentVolumeClaim (true) or EmptyDir storage (false). This is recommended to be enabled, but the storage size and selector should be chosen carefully first.",
+                            "default": false
+                        },
+                        "storage": {
+                            "type": "string",
+                            "description": "Storage size to request for the persistentVolumeClaim",
+                            "default": "500Mi"
+                        },
+                        "accessModes": {
+                            "type": "array",
+                            "description": "Access mode for the persistentVolumeClaim. See: [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)",
+                            "default": [
+                                "ReadWriteOnce"
+                            ],
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "storageClassName": {
+                            "type": "string",
+                            "description": "The name of the StorageClass for the persistentVolumeClaim. See: [Class](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)",
+                            "default": "",
+                            "nullable": true
+                        }
+                    }
+                }
+            }
+        },
+        "storage": {
+            "type": "object",
+            "properties": {
                 "storageSecretName": {
                     "type": "string",
                     "description": "Name of the secret containing the object storage secret access key. This secret must contain a STORAGE_ACCESS_KEY secret which is the object storage secret access key. It must not be updated across chart upgrades, or else the connection between Cryostat components and object storage will not be able to initialize. It is recommended that the secret should be marked as immutable to avoid accidental changes to secret's data. More details: https://kubernetes.io/docs/concepts/configuration/secret/#secret-immutable",
@@ -519,6 +525,31 @@
                         }
                     }
                 },
+                "securityContext": {
+                    "type": "object",
+                    "properties": {
+                        "capabilities": {
+                            "type": "object",
+                            "properties": {
+                                "drop": {
+                                    "type": "array",
+                                    "description": "",
+                                    "default": [
+                                        "ALL"
+                                    ],
+                                    "items": {
+                                        "type": "string"
+                                    }
+                                }
+                            }
+                        },
+                        "allowPrivilegeEscalation": {
+                            "type": "boolean",
+                            "description": "",
+                            "default": false
+                        }
+                    }
+                },
                 "service": {
                     "type": "object",
                     "properties": {
@@ -553,6 +584,37 @@
                             }
                         }
                     }
+                },
+                "pvc": {
+                    "type": "object",
+                    "properties": {
+                        "enabled": {
+                            "type": "boolean",
+                            "description": "Specify whether to use persistentVolumeClaim (true) or EmptyDir storage (false). This is recommended to be enabled, but the storage size and selector should be chosen carefully first.",
+                            "default": false
+                        },
+                        "storage": {
+                            "type": "string",
+                            "description": "Storage size to request for the persistentVolumeClaim",
+                            "default": "500Mi"
+                        },
+                        "accessModes": {
+                            "type": "array",
+                            "description": "Access mode for the persistentVolumeClaim. See: [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)",
+                            "default": [
+                                "ReadWriteOnce"
+                            ],
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "storageClassName": {
+                            "type": "string",
+                            "description": "The name of the StorageClass for the persistentVolumeClaim. See: [Class](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)",
+                            "default": "",
+                            "nullable": true
+                        }
+                    }
                 }
             }
         },
@@ -1012,31 +1074,6 @@
             "description": "Tolerations for the Cryostat Pod. See: [Tolerations](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling)",
             "default": [],
             "items": {}
-        },
-        "pvc": {
-            "type": "object",
-            "properties": {
-                "enabled": {
-                    "type": "boolean",
-                    "description": "Specify whether to use persistentVolumeClaim or EmptyDir storage",
-                    "default": false
-                },
-                "storage": {
-                    "type": "string",
-                    "description": "Storage size to request for the persistentVolumeClaim",
-                    "default": "500Mi"
-                },
-                "accessModes": {
-                    "type": "array",
-                    "description": "Access mode for the persistentVolumeClaim. See: [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)",
-                    "default": [
-                        "ReadWriteOnce"
-                    ],
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            }
         }
     }
 }
diff --git a/charts/cryostat/values.yaml b/charts/cryostat/values.yaml
@@ -145,6 +145,20 @@ db:
       cpu: 25m
       ## @param db.resources.requests.memory Memory resource request for the database container.
       memory: 64Mi
+  pvc:
+    ## @param db.pvc.enabled Specify whether to use persistentVolumeClaim (true) or EmptyDir storage (false). This is recommended to be enabled, but the storage size and selector should be chosen carefully first.
+    enabled: false
+    ## @param db.pvc.annotations [object] Annotations to add to the persistentVolumeClaim
+    annotations: {}
+    ## @param db.pvc.storage Storage size to request for the persistentVolumeClaim
+    storage: 500Mi
+    ## @param db.pvc.accessModes Access mode for the persistentVolumeClaim. See: [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
+    accessModes:
+      - ReadWriteOnce
+    ## @param db.pvc.selector [object] Selector for the persistentVolumeClaim. See: [Selector](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
+    selector: {}
+    ## @param db.pvc.storageClassName [string, nullable] The name of the StorageClass for the persistentVolumeClaim. See: [Class](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
+    storageClassName: ""
   ## @param db.securityContext [object] Security Context for the database container. Defaults to meet "restricted" [Pod Security Standard](https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted). See: [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1)
   securityContext:
     ## @skip db.securityContext.allowPrivilegeEscalation
@@ -180,6 +194,20 @@ storage:
       cpu: 50m
       ## @param storage.resources.requests.memory Memory resource request for the object storage container.
       memory: 256Mi
+  pvc:
+    ## @param storage.pvc.enabled Specify whether to use persistentVolumeClaim (true) or EmptyDir storage (false). This is recommended to be enabled, but the storage size and selector should be chosen carefully first.
+    enabled: false
+    ## @param storage.pvc.annotations [object] Annotations to add to the persistentVolumeClaim
+    annotations: {}
+    ## @param storage.pvc.storage Storage size to request for the persistentVolumeClaim
+    storage: 500Mi
+    ## @param storage.pvc.accessModes Access mode for the persistentVolumeClaim. See: [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
+    accessModes:
+      - ReadWriteOnce
+    ## @param storage.pvc.selector [object] Selector for the persistentVolumeClaim. See: [Selector](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
+    selector: {}
+    ## @param storage.pvc.storageClassName [string, nullable] The name of the StorageClass for the persistentVolumeClaim. See: [Class](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
+    storageClassName: ""
   ## @param storage.securityContext [object] Security Context for the storage container. Defaults to meet "restricted" [Pod Security Standard](https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted). See: [SecurityContext](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1)
   securityContext:
     ## @skip storage.securityContext.allowPrivilegeEscalation
@@ -370,18 +398,3 @@ tolerations: []
 
 ## @param affinity [object] Affinity for the Cryostat Pod. See: [Affinity](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling)
 affinity: {}
-
-pvc:
-  ## @param pvc.enabled Specify whether to use persistentVolumeClaim or EmptyDir storage
-  enabled: false
-  ## @param pvc.annotations [object] Annotations to add to the persistentVolumeClaim
-  annotations: {}
-  ## @param pvc.storage Storage size to request for the persistentVolumeClaim
-  storage: 500Mi
-  ## @param pvc.accessModes Access mode for the persistentVolumeClaim. See: [Access Modes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
-  accessModes:
-    - ReadWriteOnce
-  ## @param pvc.selector [object] Selector for the persistentVolumeClaim. See: [Selector](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
-  selector: {}
-  ## @param pvc.storageClassName [string, nullable] The name of the StorageClass for the persistentVolumeClaim. See: [Class](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims)
-  # storageClassName: