feat: convert pvcs to dict (#381)

mikhail-klimko · web-flow · commit c4bdb6e71aae · 2023-08-09T12:57:36.000+03:00
diff --git a/charts/cf-runtime/Chart.yaml b/charts/cf-runtime/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 description: A Helm chart for Codefresh Runner
 name: cf-runtime
-version: 4.0.2
+version: 5.0.0
 keywords:
   - codefresh
   - runner
@@ -15,10 +15,10 @@ maintainers:
 annotations:
   artifacthub.io/changes: |
     - kind: added
-      description: Add external secrets template
-    - kind: fixed
-      description: Fix condition if existing secrets are provided (API and Agent tokens)
+      description: Update cf-common lib chart
+    - kind: changed
+      description: Change .runtime.dind.pvcs from list to dict
 dependencies:
   - name: cf-common
     repository: https://chartmuseum.codefresh.io/cf-common
-    version: 0.12.2
+    version: 0.12.3
diff --git a/charts/cf-runtime/README.md b/charts/cf-runtime/README.md
@@ -1,6 +1,6 @@
 ## Codefresh Runner
 
-![Version: 4.0.2](https://img.shields.io/badge/Version-4.0.2-informational?style=flat-square)
+![Version: 5.0.0](https://img.shields.io/badge/Version-5.0.0-informational?style=flat-square)
 
 Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/installation/codefresh-runner/) to Kubernetes.
 
@@ -13,6 +13,7 @@ Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/insta
   - [To 2.x](#to-2x)
   - [To 3.x](#to-3x)
   - [To 4.x](#to-4x)
+  - [To 5.x](#to-5x)
 - [Architecture](#architecture)
 - [Configuration](#configuration)
   - [EBS backend volume configuration](#ebs-backend-volume-configuration)
@@ -105,6 +106,38 @@ This major release adds **agentless inCluster** runtime mode (relevant only for
 Affected values:
 - `runtime.agent` / `runtime.inCluster` / `runtime.accounts` / `runtime.description` are added
 
+### To 5.x
+
+This major release converts `.runtime.dind.pvcs` from **list** to **dict**
+
+> 4.x chart's values example:
+```yaml
+runtime:
+  dind:
+    pvcs:
+      - name: dind
+        storageClassName: my-storage-class-name
+        volumeSize: 32Gi
+        reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName'
+        reuseVolumeSortOrder: pipeline_id
+```
+
+> 5.x chart's values example:
+```yaml
+runtime:
+  dind:
+    pvcs:
+      dind:
+        name: dind
+        storageClassName: my-storage-class-name
+        volumeSize: 32Gi
+        reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName'
+        reuseVolumeSortOrder: pipeline_id
+```
+
+Affected values:
+- `.runtime.dind.pvcs` converted from **list** to **dict**
+
 ## Architecture
 
 [Codefresh Runner architecture](https://codefresh.io/docs/docs/installation/codefresh-runner/#codefresh-runner-architecture)
@@ -213,9 +246,8 @@ volumeProvisioner:
     # -- Create service account
     create: true
     # -- Additional service account annotations
-    serviceAccount:
-      annotations:
-        eks.amazonaws.com/role-arn: "arn:aws:iam::<ACCOUNT_ID>:role/<IAM_ROLE_NAME>"
+    annotations:
+      eks.amazonaws.com/role-arn: "arn:aws:iam::<ACCOUNT_ID>:role/<IAM_ROLE_NAME>"
 ```
 
 ### Custom volume mounts
@@ -662,7 +694,7 @@ Go to [https://<YOUR_ONPREM_DOMAIN_HERE>/admin/runtime-environments/system](http
 
 | Repository | Name | Version |
 |------------|------|---------|
-| https://chartmuseum.codefresh.io/cf-common | cf-common | 0.12.2 |
+| https://chartmuseum.codefresh.io/cf-common | cf-common | 0.12.3 |
 
 ## Values
 
@@ -761,17 +793,18 @@ Go to [https://<YOUR_ONPREM_DOMAIN_HERE>/admin/runtime-environments/system](http
 | runtime.accounts | list | `[]` | (for On-Premise only) Assign accounts to runtime (list of account ids) |
 | runtime.agent | bool | `true` | (for On-Premise only) Enable agent |
 | runtime.description | string | `""` | Runtime description |
-| runtime.dind | object | `{"affinity":{},"env":{},"image":{"registry":"quay.io","repository":"codefresh/dind","tag":"20.10.18-1.25.7"},"nodeSelector":{},"podAnnotations":{},"pvcs":[{"name":"dind","reuseVolumeSelector":"codefresh-app,io.codefresh.accountName","reuseVolumeSortOrder":"pipeline_id","storageClassName":"{{ include \"dind-volume-provisioner.storageClassName\" . }}","volumeSize":"16Gi"}],"resources":{"limits":{"cpu":"400m","memory":"800Mi"},"requests":null},"schedulerName":"","serviceAccount":"codefresh-engine","tolerations":[],"userAccess":true,"userVolumeMounts":{},"userVolumes":{}}` | Parameters for DinD (docker-in-docker) pod (aka "runtime" pod). |
+| runtime.dind | object | `{"affinity":{},"env":{},"image":{"registry":"quay.io","repository":"codefresh/dind","tag":"20.10.18-1.25.7"},"nodeSelector":{},"podAnnotations":{},"pvcs":{"dind":{"name":"dind","reuseVolumeSelector":"codefresh-app,io.codefresh.accountName","reuseVolumeSortOrder":"pipeline_id","storageClassName":"{{ include \"dind-volume-provisioner.storageClassName\" . }}","volumeSize":"16Gi"}},"resources":{"limits":{"cpu":"400m","memory":"800Mi"},"requests":null},"schedulerName":"","serviceAccount":"codefresh-engine","tolerations":[],"userAccess":true,"userVolumeMounts":{},"userVolumes":{}}` | Parameters for DinD (docker-in-docker) pod (aka "runtime" pod). |
 | runtime.dind.affinity | object | `{}` | Set affinity |
 | runtime.dind.env | object | `{}` | Set additional env vars. |
 | runtime.dind.image | object | `{"registry":"quay.io","repository":"codefresh/dind","tag":"20.10.18-1.25.7"}` | Set dind image. |
 | runtime.dind.nodeSelector | object | `{}` | Set node selector. |
 | runtime.dind.podAnnotations | object | `{}` | Set pod annotations. |
-| runtime.dind.pvcs | list | `[{"name":"dind","reuseVolumeSelector":"codefresh-app,io.codefresh.accountName","reuseVolumeSortOrder":"pipeline_id","storageClassName":"{{ include \"dind-volume-provisioner.storageClassName\" . }}","volumeSize":"16Gi"}]` | PV claim spec parametes. |
-| runtime.dind.pvcs[0] | object | `{"name":"dind","reuseVolumeSelector":"codefresh-app,io.codefresh.accountName","reuseVolumeSortOrder":"pipeline_id","storageClassName":"{{ include \"dind-volume-provisioner.storageClassName\" . }}","volumeSize":"16Gi"}` | PVC name prefix. Keep `dind` as default! Don't change! |
-| runtime.dind.pvcs[0].reuseVolumeSelector | string | `"codefresh-app,io.codefresh.accountName"` | PV reuse selector. Ref: https://codefresh.io/docs/docs/installation/codefresh-runner/#volume-reuse-policy |
-| runtime.dind.pvcs[0].storageClassName | string | `"{{ include \"dind-volume-provisioner.storageClassName\" . }}"` | PVC storage class name. Change ONLY if you need to use storage class NOT from Codefresh volume-provisioner |
-| runtime.dind.pvcs[0].volumeSize | string | `"16Gi"` | PVC size. |
+| runtime.dind.pvcs | object | `{"dind":{"name":"dind","reuseVolumeSelector":"codefresh-app,io.codefresh.accountName","reuseVolumeSortOrder":"pipeline_id","storageClassName":"{{ include \"dind-volume-provisioner.storageClassName\" . }}","volumeSize":"16Gi"}}` | PV claim spec parametes. |
+| runtime.dind.pvcs.dind | object | `{"name":"dind","reuseVolumeSelector":"codefresh-app,io.codefresh.accountName","reuseVolumeSortOrder":"pipeline_id","storageClassName":"{{ include \"dind-volume-provisioner.storageClassName\" . }}","volumeSize":"16Gi"}` | Default dind PVC parameters |
+| runtime.dind.pvcs.dind.name | string | `"dind"` | PVC name prefix. Keep `dind` as default! Don't change! |
+| runtime.dind.pvcs.dind.reuseVolumeSelector | string | `"codefresh-app,io.codefresh.accountName"` | PV reuse selector. Ref: https://codefresh.io/docs/docs/installation/codefresh-runner/#volume-reuse-policy |
+| runtime.dind.pvcs.dind.storageClassName | string | `"{{ include \"dind-volume-provisioner.storageClassName\" . }}"` | PVC storage class name. Change ONLY if you need to use storage class NOT from Codefresh volume-provisioner |
+| runtime.dind.pvcs.dind.volumeSize | string | `"16Gi"` | PVC size. |
 | runtime.dind.resources | object | `{"limits":{"cpu":"400m","memory":"800Mi"},"requests":null}` | Set dind resources. |
 | runtime.dind.schedulerName | string | `""` | Set scheduler name. |
 | runtime.dind.serviceAccount | string | `"codefresh-engine"` | Set service account for pod. |
diff --git a/charts/cf-runtime/README.md.gotmpl b/charts/cf-runtime/README.md.gotmpl
@@ -13,6 +13,7 @@ Helm chart for deploying [Codefresh Runner](https://codefresh.io/docs/docs/insta
   - [To 2.x](#to-2x)
   - [To 3.x](#to-3x)
   - [To 4.x](#to-4x)
+  - [To 5.x](#to-5x)
 - [Architecture](#architecture)
 - [Configuration](#configuration)
   - [EBS backend volume configuration](#ebs-backend-volume-configuration)
@@ -105,6 +106,39 @@ This major release adds **agentless inCluster** runtime mode (relevant only for
 Affected values:
 - `runtime.agent` / `runtime.inCluster` / `runtime.accounts` / `runtime.description` are added
 
+### To 5.x
+
+This major release converts `.runtime.dind.pvcs` from **list** to **dict**
+
+> 4.x chart's values example:
+```yaml
+runtime:
+  dind:
+    pvcs:
+      - name: dind
+        storageClassName: my-storage-class-name
+        volumeSize: 32Gi
+        reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName'
+        reuseVolumeSortOrder: pipeline_id
+```
+
+> 5.x chart's values example:
+```yaml
+runtime:
+  dind:
+    pvcs:
+      dind:
+        name: dind
+        storageClassName: my-storage-class-name
+        volumeSize: 32Gi
+        reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName'
+        reuseVolumeSortOrder: pipeline_id
+```
+
+Affected values:
+- `.runtime.dind.pvcs` converted from **list** to **dict**
+
+
 ## Architecture
 
 [Codefresh Runner architecture](https://codefresh.io/docs/docs/installation/codefresh-runner/#codefresh-runner-architecture)
@@ -213,9 +247,8 @@ volumeProvisioner:
     # -- Create service account
     create: true
     # -- Additional service account annotations
-    serviceAccount:
-      annotations:
-        eks.amazonaws.com/role-arn: "arn:aws:iam::<ACCOUNT_ID>:role/<IAM_ROLE_NAME>"
+    annotations:
+      eks.amazonaws.com/role-arn: "arn:aws:iam::<ACCOUNT_ID>:role/<IAM_ROLE_NAME>"
 ```
 
 ### Custom volume mounts
diff --git a/charts/cf-runtime/templates/hooks/cm-update-runtime.yaml b/charts/cf-runtime/templates/hooks/cm-update-runtime.yaml
@@ -9,9 +9,6 @@ metadata:
   labels:
     {{- include "runtime.labels" . | nindent 4 }}
   annotations:
-    helm.sh/hook: post-install,post-upgrade
-    helm.sh/hook-weight: "-5"
-    helm.sh/hook-delete-policy: before-hook-creation
     {{- with $values.annotations }}
       {{- toYaml . | nindent 4 }}
     {{- end }}
diff --git a/charts/cf-runtime/templates/runtime/runtime-env-spec-tmpl.yaml b/charts/cf-runtime/templates/runtime/runtime-env-spec-tmpl.yaml
@@ -118,7 +118,11 @@ dockerDaemonScheduler:
   schedulerName: {{ $dindContext.schedulerName }}
   {{- end }}
   {{- if $dindContext.pvcs }}
-  pvcs: {{- include (printf "%v.tplrender" $cfCommonTplSemver) (dict "Values" $dindContext.pvcs "context" .) | nindent 4 }}
+  pvcs:
+  {{- range $index, $pvc := $dindContext.pvcs }}
+    - name: {{ $pvc.name }}
+  {{- include (printf "%v.tplrender" $cfCommonTplSemver) (dict "Values" (omit $pvc "name" ) "context" $) | nindent 6 }}
+  {{- end }}
   {{- end }}
   defaultDindResources:
   {{- with $dindContext.resources }}
diff --git a/charts/cf-runtime/tests/runtime/runtime_values.yaml b/charts/cf-runtime/tests/runtime/runtime_values.yaml
@@ -8,7 +8,8 @@ runtime:
         cpu: 1000m
         memory: 2048Mi
     pvcs:
-      - name: dind
+      dind:
+        name: dind
         storageClassName: my-custom-storage-class
         volumeSize: 8Gi
         reuseVolumeSelector: 'codefresh-app,io.codefresh.accountName'
diff --git a/charts/cf-runtime/values.yaml b/charts/cf-runtime/values.yaml
@@ -411,9 +411,11 @@ runtime:
         memory: 800Mi
     # -- PV claim spec parametes.
     pvcs:
+      # -- Default dind PVC parameters
+      dind:
         # -- PVC name prefix.
         # Keep `dind` as default! Don't change!
-      - name: dind
+        name: dind
         # -- PVC storage class name.
         # Change ONLY if you need to use storage class NOT from Codefresh volume-provisioner
         storageClassName: '{{ include "dind-volume-provisioner.storageClassName" . }}'
