Merge pull request #695 from snyk/fix/pvc-conflict

fix: introduce pvc.create flag in Helm chart

Author: ivanstanev

snyk-monitor/README.md

@@ -140,11 +140,20 @@ helm upgrade --install snyk-monitor snyk-charts/snyk-monitor \
 
 By default, `snyk-monitor` uses an emptyDir for temporary storage. If you prefer to have a PVC that uses a statically or
  dynamically provisioned PV that you have created, then set the following value
-* `pvc.enabled` `true`
+* `pvc.enabled`=`true`
+
+If you would also like to create the PVC (if not using an existing one) then set the following value
+* `pvc.create`=`true`
 
 The PVC's name defaults to `snyk-monitor-pvc`. If you prefer to override this, then use the following value:
 * `pvc.name`
 
+For example, run the following for first-time setup:
+`--set pvc.enabled=true --pvc.create=true`
+
+And run the following for subsequent upgrades:
+`--set pvc.enabled=true`
+
 ## PodSecurityPolicies
 **This should not be used when installing on OpenShift.**
 

snyk-monitor/templates/pvc.yaml

@@ -1,7 +1,5 @@
-# We create a PVC only if the default PVC name has not changed.
-# If the name has changed, it means our users want to use their own pre-provisioned PVC.
-# In such cases it would be an error to create a PVC as it would result in a conflict - the PVC already exists.
-{{- if .Values.pvc.enabled }}{{- if eq .Values.pvc.name "snyk-monitor-pvc" }}
+# We create a PVC only if requested.
+{{- if .Values.pvc.enabled }}{{- if .Values.pvc.create }}
 kind: PersistentVolumeClaim
 apiVersion: v1
 metadata:

snyk-monitor/values.yaml

@@ -37,10 +37,12 @@ clusterName: ""
 # This value controls how much disk storage _at most_ may be allocated for the snyk-monitor. Unless overridden by the `pvc` value, the snyk-monitor mounts an emptyDir for storage.
 temporaryStorageSize: 50Gi #  Applies to PVC too
 
-# Change to true to use a PVC instead of emptyDir for local storage
+# Change "enabled" to true to use a PVC instead of emptyDir for local storage.
+# Change "create" to true if you want to create the PVC (useful for first time run).
 pvc:
   enabled: false
   name: snyk-monitor-pvc
+  create: false
   ## snyk-monitor data Persistent Volume Storage Class
   ## If defined, storageClassName: <storageClass>
   ## If set to "-", storageClassName: "", which disables dynamic provisioning

snyk-operator/deploy/olm-catalog/snyk-operator/0.0.0/snyk-operator.v0.0.0.clusterserviceversion.yaml

@@ -23,6 +23,7 @@ metadata:
             "temporaryStorageSize": "50Gi",
             "pvc": {
               "enabled": false,
+              "create": false,
               "name": "snyk-monitor-pvc",
               "storageClassName": null
             },
@@ -121,6 +122,12 @@ spec:
             path: pvc.enabled
             x-descriptors:
               - "urn:alm:descriptor:com.tectonic.ui:booleanSwitch"
+          - description: >-
+              True to create the PVC, false to reference it (in cases it already exists).
+            displayName: Create PVC
+            path: pvc.create
+            x-descriptors:
+              - "urn:alm:descriptor:com.tectonic.ui:booleanSwitch"
           - description: >-
               The name of the PVC, when enabled.
             displayName: PVC name

snyk-operator/deploy/olm-catalog/snyk-operator/0.0.0/snykmonitors.charts.helm.k8s.io.crd.yaml

@@ -50,6 +50,8 @@ spec:
               properties:
                 enabled:
                   type: boolean
+                create:
+                  type: boolean
                 name:
                   type: string
                 storageClassName:

test/fixtures/operator/custom-resource-k8s.yaml

@@ -8,3 +8,4 @@ spec:
   temporaryStorageSize: 20Gi
   pvc:
     enabled: true
+    create: true

test/fixtures/operator/custom-resource.yaml

@@ -8,3 +8,4 @@ spec:
   temporaryStorageSize: 20Gi
   pvc:
     enabled: true
+    create: true

test/setup/deployers/helm.ts

@@ -33,6 +33,7 @@ async function deployKubernetesMonitor(
       '--set nodeSelector."kubernetes\\.io/os"=linux ' +
       '--set psp.enabled=true ' + 
       '--set pvc.enabled=true ' +
+      '--set pvc.create=true ' +
       '--set log_level="INFO"'
   );
   console.log(`Deployed ${imageOptions.nameAndTag} with pull policy ${imageOptions.pullPolicy}`);