feat(registry-scanner): Add flag to enable mem profile dumps on a PVC (#1455)

Author: airadier

charts/registry-scanner/Chart.yaml

@@ -4,8 +4,8 @@ description: Sysdig Registry Scanner
 type: application
 home: https://sysdiglabs.github.io/registry-scanner/
 icon: https://478h5m1yrfsa3bbe262u7muv-wpengine.netdna-ssl.com/wp-content/uploads/2019/02/Shovel_600px.png
-version: 1.1.16
-appVersion: 0.2.54
+version: 1.1.17
+appVersion: 0.2.56
 maintainers:
   - name: giuse-sysdig
     email: [email protected]

charts/registry-scanner/README.md

@@ -115,6 +115,7 @@ The following table lists the configurable parameters of the Sysdig Registry Sca
 | scanOnStart.jobName                              | The name of the job created for the post-install scanner job                                                                                                                                                                               | <code>"registry-scanner-start-test"</code>   |
 | scanOnStart.asPostInstallHook                    | Specify whether to launch the job as a post-install helm hook. <br/>Used for testing purpose.                                                                                                                                              | <code>false</code>                           |
 | extraEnvVars                                     | The additional environment variables to be set.                                                                                                                                                                                            | <code>[]</code>                              |
+| memProfileToPersistentVolumeClaim                | Write memory profile dumps to Persistent Volume Claim (provide PVC name)                                                                                                                                                                   | <code>""</code>                              |
 
 ## On-Prem Deployment
 
@@ -126,7 +127,7 @@ Use the following command to deploy:
 helm upgrade --install registry-scanner \
    --namespace sysdig-agent \
    --create-namespace \
-   --version=1.1.16  \
+   --version=1.1.17  \
    --set config.secureBaseURL=<SYSDIG_SECURE_URL> \
    --set config.secureAPIToken=<SYSDIG_SECURE_API_TOKEN> \
    --set config.secureSkipTLS=true \

charts/registry-scanner/templates/_job.tpl

@@ -38,6 +38,10 @@
         - name: report-storage
           mountPath: "/output"
         {{- end }}
+        {{- if .Values.memProfileToPersistentVolumeClaim }}
+        - name: profile-storage
+          mountPath: "/profiling"
+        {{- end }}
         {{- if .Values.ssl.ca.certs }}
         - name: ca-certs
           mountPath: "/ca-certs"
@@ -120,6 +124,10 @@
           - name: GROUP_LIMIT
             value: "{{ .Values.config.parallelGoRoutines }}"
           {{- end }}
+          {{- if .Values.memProfileToPersistentVolumeClaim }}
+          - name: PROFILING_ENABLED
+            value: /profiling
+          {{- end }}
           {{- if .Values.extraEnvVars }}
           {{- toYaml .Values.extraEnvVars | nindent 10 }}
           {{- end }}
@@ -154,4 +162,9 @@
         persistentVolumeClaim:
           claimName: {{ .Values.reportToPersistentVolumeClaim }}
       {{- end }}
+      {{- if .Values.memProfileToPersistentVolumeClaim }}
+      - name: profile-storage
+        persistentVolumeClaim:
+          claimName: {{ .Values.memProfileToPersistentVolumeClaim }}
+      {{- end }}
 {{- end }}

charts/registry-scanner/values.yaml

@@ -224,3 +224,6 @@ scanOnStart:
 extraEnvVars: []
 #  - name: FOO
 #    value: bar
+
+# Write memory profile dumps to Persistent Volume Claim (provide PVC name)
+memProfileToPersistentVolumeClaim: ""