feat(doc): Move On-prem deployment instruction to the registry scanne…

…r chart (#1260) Signed-off-by: radhikapc <[email protected]> Co-authored-by: Adam Roberts <[email protected]>
sysdiglabs · Jul 31, 2023 · 2ed2f68 · 2ed2f68
1 parent dde754d
commit 2ed2f68
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 1 deletion.
diff --git a/charts/registry-scanner/Chart.yaml b/charts/registry-scanner/Chart.yaml
@@ -4,7 +4,7 @@ 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.2
+version: 1.1.3
 appVersion: 0.2.42
 maintainers:
   - name: airadier

diff --git a/charts/registry-scanner/README.md b/charts/registry-scanner/README.md
@@ -117,3 +117,22 @@ 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>                              |
+## On-Prem Deployment
+
+If you are using a Sysdig on-prem version greater than 6.2, you need to configure legacy VM engine while setting up registry scanner.
+
+Use the following command to deploy:
+
+```
+helm upgrade --install registry-scanner \
+   --version=0.1.39 \
+   --set config.secureBaseURL=<SYSDIG_SECURE_URL> \
+   --set config.secureAPIToken=<SYSDIG_SECURE_API_TOKEN> \
+   --set config.secureSkipTLS=true \
+   --set config.registryURL=<REGISTRY_URL> \
+   --set config.registryUser=admin \
+   --set config.registryPassword=<REGISTRY_PASSWORD> \
+  sysdig/registry-scanner
+```
+
+Use `config.secureSkipTLS=true` if you are using self-signed certificates.
diff --git a/charts/registry-scanner/README.tpl b/charts/registry-scanner/README.tpl
@@ -50,3 +50,23 @@ The following table lists the configurable parameters of the Sysdig Registry Sca
 
 {{ .Chart.Values }}
 {{- end -}}
+
+## On-Prem Deployment
+
+If you are using a Sysdig on-prem version greater than 6.2, you need to configure legacy VM engine while setting up registry scanner.
+
+Use the following command to deploy:
+
+```
+helm upgrade --install registry-scanner \
+   --version=0.1.39 \
+   --set config.secureBaseURL=<SYSDIG_SECURE_URL> \
+   --set config.secureAPIToken=<SYSDIG_SECURE_API_TOKEN> \
+   --set config.secureSkipTLS=true \
+   --set config.registryURL=<REGISTRY_URL> \
+   --set config.registryUser=admin \
+   --set config.registryPassword=<REGISTRY_PASSWORD> \
+  sysdig/registry-scanner
+```
+
+Use `config.secureSkipTLS=true` if you are using self-signed certificates.