feat(helm): configure inspect flag for server via helm chart (#1593)

specklesystems · Jun 1, 2023 · e71f382 · e71f382
1 parent ebdb30d
commit e71f382
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 3 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -44,7 +44,7 @@ repos:
   - repo: local
     hooks:
       - id: helm-documentation
-        name: Helm documentation
+        name: Helm Json Schema
         language: system
         files: utils/helm/speckle-server/values.yaml
         entry: utils/helm/update-schema-json.sh

diff --git a/packages/server/Dockerfile b/packages/server/Dockerfile
@@ -77,4 +77,5 @@ COPY --from=build-stage /speckle-server/packages/server/dist ./dist
 COPY --from=build-stage /speckle-server/packages/server/assets ./assets
 COPY --from=build-stage /speckle-server/packages/server/bin ./bin
 
-CMD ["node", "--inspect=7000", "bin/www"]
+ENTRYPOINT ["node"]
+CMD ["bin/www"]
diff --git a/utils/helm/speckle-server/templates/server/deployment.yml b/utils/helm/speckle-server/templates/server/deployment.yml
@@ -22,7 +22,11 @@ spec:
       - name: main
         image: speckle/speckle-server:{{ .Values.docker_image_tag }}
         imagePullPolicy: {{ .Values.imagePullPolicy }}
-
+        args: #overwrites the Dockerfile CMD statement
+        {{- if .Values.server.inspect.enabled }}
+          - {{ printf "--inspect=%s" .Values.server.inspect.port }}
+        {{- end }}
+          - "bin/www"
         ports:
           - name: http
             containerPort: {{ include "server.port" $ }}

diff --git a/utils/helm/speckle-server/values.schema.json b/utils/helm/speckle-server/values.schema.json
@@ -461,6 +461,21 @@
           "description": "The minimum level of logs which will be output. Suitable values are trace, debug, info, warn, error, fatal, or silent",
           "default": "info"
         },
+        "inspect": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "If enabled, indicates that the Speckle server should be deployed with the nodejs inspect feature enabled",
+              "default": false
+            },
+            "port": {
+              "type": "string",
+              "description": "The port on which the nodejs inspect feature should be exposed",
+              "default": "7000"
+            }
+          }
+        },
         "adminOverrideEnabled": {
           "type": "boolean",
           "description": "Enables the server side admin authz override",

diff --git a/utils/helm/speckle-server/values.yaml b/utils/helm/speckle-server/values.yaml
@@ -373,6 +373,12 @@ server:
   ##
   logLevel: 'info'
 
+  inspect:
+    ## @param server.inspect.enabled If enabled, indicates that the Speckle server should be deployed with the nodejs inspect feature enabled
+    enabled: false
+    ## @param server.inspect.port The port on which the nodejs inspect feature should be exposed
+    port: '7000'
+
   ## @param server.adminOverrideEnabled Enables the server side admin authz override
   adminOverrideEnabled: false
   ## @param server.onboardingStreamId The id of the stream to be used for onboarding new users