feat: make service nodePort configurable and add some doc descriptions (#33)

* feat: make service nodePort configurable

* feat: bump version to 3.0.6

* docs: add descriptions for secret and service fields

* feat: add comments in clearml-kind.yaml of README.md

Co-authored-by: 黄维啸 <huangweixiao@megvii.com>

charts/clearml/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: clearml
 description: MLOps platform
 type: application
-version: "3.0.5"
+version: "3.0.6"
 appVersion: "1.1.1"
 home: https://clear.ml
 icon: https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg

charts/clearml/README.md

@@ -1,6 +1,6 @@
 # ClearML Ecosystem for Kubernetes
 
-![Version: 3.0.5](https://img.shields.io/badge/Version-3.0.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.1](https://img.shields.io/badge/AppVersion-1.1.1-informational?style=flat-square)
+![Version: 3.0.6](https://img.shields.io/badge/Version-3.0.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.1](https://img.shields.io/badge/AppVersion-1.1.1-informational?style=flat-square)
 
 MLOps platform
 
@@ -39,14 +39,20 @@ apiVersion: kind.x-k8s.io/v1alpha4
 nodes:
 - role: control-plane
   extraPortMappings:
+  # API server's default nodePort is 30008. If you customize it in helm values by
+  # `apiserver.service.nodePort`, `containerPort` should match it
   - containerPort: 30008
     hostPort: 30008
     listenAddress: "127.0.0.1"
     protocol: TCP
+  # Web server's default nodePort is 30080. If you customize it in helm values by
+  # `webserver.service.nodePort`, `containerPort` should match it
   - containerPort: 30080
     hostPort: 30080
     listenAddress: "127.0.0.1"
     protocol: TCP
+  # File server's default nodePort is 30081. If you customize it in helm values by
+  # `fileserver.service.nodePort`, `containerPort` should match it
   - containerPort: 30081
     hostPort: 30081
     listenAddress: "127.0.0.1"
@@ -199,8 +205,9 @@ For detailed instructions, see the [Optional Configuration](https://github.com/a
 | apiserver.readinessDelay | int | `60` |  |
 | apiserver.replicaCount | int | `1` |  |
 | apiserver.resources | object | `{}` |  |
+| apiserver.service.nodePort | int | `30008` | If service.type set to NodePort, this will be set to service's nodePort field. If service.type is set to others, this field will be ignored |
 | apiserver.service.port | int | `8008` |  |
-| apiserver.service.type | string | `"NodePort"` |  |
+| apiserver.service.type | string | `"NodePort"` | This will set to service's spec.type field |
 | apiserver.tolerations | list | `[]` |  |
 | clearml.defaultCompany | string | `"d1bd92a3b039400cbafc60a7a5b1e52b"` |  |
 | elasticsearch.clusterHealthCheckParams | string | `"wait_for_status=yellow&timeout=1s"` |  |
@@ -247,8 +254,9 @@ For detailed instructions, see the [Optional Configuration](https://github.com/a
 | fileserver.podAnnotations | object | `{}` |  |
 | fileserver.replicaCount | int | `1` |  |
 | fileserver.resources | object | `{}` |  |
+| fileserver.service.nodePort | int | `30081` | If service.type set to NodePort, this will be set to service's nodePort field. If service.type is set to others, this field will be ignored |
 | fileserver.service.port | int | `8081` |  |
-| fileserver.service.type | string | `"NodePort"` |  |
+| fileserver.service.type | string | `"NodePort"` | This will set to service's spec.type field |
 | fileserver.storage.data.class | string | `"standard"` |  |
 | fileserver.storage.data.size | string | `"50Gi"` |  |
 | fileserver.tolerations | list | `[]` |  |
@@ -281,12 +289,12 @@ For detailed instructions, see the [Optional Configuration](https://github.com/a
 | redis.master.persistence.size | string | `"5Gi"` |  |
 | redis.master.port | int | `6379` |  |
 | redis.usePassword | bool | `false` |  |
-| secret.authToken | string | `"1SCf0ov3Nm544Td2oZ0gXSrsNx5XhMWdVlKz1tOgcx158bD5RV"` |  |
+| secret.authToken | string | `"1SCf0ov3Nm544Td2oZ0gXSrsNx5XhMWdVlKz1tOgcx158bD5RV"` | Set for auth_token field |
-| secret.credentials.apiserver.accessKey | string | `"5442F3443MJMORWZA3ZH"` |  |
+| secret.credentials.apiserver.accessKey | string | `"5442F3443MJMORWZA3ZH"` | Set for apiserver_key field |
-| secret.credentials.apiserver.secretKey | string | `"BxapIRo9ZINi8x25CRxz8Wdmr2pQjzuWVB4PNASZqCtTyWgWVQ"` |  |
+| secret.credentials.apiserver.secretKey | string | `"BxapIRo9ZINi8x25CRxz8Wdmr2pQjzuWVB4PNASZqCtTyWgWVQ"` | Set for apiserver_secret field |
-| secret.credentials.tests.accessKey | string | `"ENP39EQM4SLACGD5FXB7"` |  |
+| secret.credentials.tests.accessKey | string | `"ENP39EQM4SLACGD5FXB7"` | Set for tests_user_key field |
-| secret.credentials.tests.secretKey | string | `"lPcm0imbcBZ8mwgO7tpadutiS3gnJD05x9j7afwXPS35IKbpiQ"` |  |
+| secret.credentials.tests.secretKey | string | `"lPcm0imbcBZ8mwgO7tpadutiS3gnJD05x9j7afwXPS35IKbpiQ"` | Set for tests_user_secret field |
-| secret.httpSession | string | `"9Tw20RbhJ1bLBiHEOWXvhplKGUbTgLzAtwFN2oLQvWwS0uRpD5"` |  |
+| secret.httpSession | string | `"9Tw20RbhJ1bLBiHEOWXvhplKGUbTgLzAtwFN2oLQvWwS0uRpD5"` | Set for http_session field |
 | webserver.affinity | object | `{}` |  |
 | webserver.extraEnvs | list | `[]` |  |
 | webserver.image.pullPolicy | string | `"IfNotPresent"` |  |
@@ -296,6 +304,7 @@ For detailed instructions, see the [Optional Configuration](https://github.com/a
 | webserver.podAnnotations | object | `{}` |  |
 | webserver.replicaCount | int | `1` |  |
 | webserver.resources | object | `{}` |  |
+| webserver.service.nodePort | int | `30080` | If service.type set to NodePort, this will be set to service's nodePort field. If service.type is set to others, this field will be ignored |
 | webserver.service.port | int | `80` |  |
-| webserver.service.type | string | `"NodePort"` |  |
+| webserver.service.type | string | `"NodePort"` | This will set to service's spec.type field |
 | webserver.tolerations | list | `[]` |  |

charts/clearml/README.md.gotmpl

@@ -36,14 +36,20 @@ apiVersion: kind.x-k8s.io/v1alpha4
 nodes:
 - role: control-plane
   extraPortMappings:
+  # API server's default nodePort is 30008. If you customize it in helm values by
+  # `apiserver.service.nodePort`, `containerPort` should match it
   - containerPort: 30008
     hostPort: 30008
     listenAddress: "127.0.0.1"
     protocol: TCP
+  # Web server's default nodePort is 30080. If you customize it in helm values by
+  # `webserver.service.nodePort`, `containerPort` should match it
   - containerPort: 30080
     hostPort: 30080
     listenAddress: "127.0.0.1"
     protocol: TCP
+  # File server's default nodePort is 30081. If you customize it in helm values by
+  # `fileserver.service.nodePort`, `containerPort` should match it
   - containerPort: 30081
     hostPort: 30081
     listenAddress: "127.0.0.1"

charts/clearml/templates/service-apiserver.yaml

@@ -9,7 +9,9 @@ spec:
   ports:
     - port: {{ .Values.apiserver.service.port }}
       targetPort: {{ .Values.apiserver.service.port }}
-      nodePort: 30008
+{{- if eq .Values.apiserver.service.type "NodePort" }}
+      nodePort: {{ .Values.apiserver.service.nodePort }}
+{{- end }}
       protocol: TCP
   selector:
     {{- include "clearml.selectorLabelsApiServer" . | nindent 4 }}

charts/clearml/templates/service-fileserver.yaml

@@ -9,7 +9,9 @@ spec:
   ports:
     - port: {{ .Values.fileserver.service.port }}
       targetPort: {{ .Values.fileserver.service.port }}
-      nodePort: 30081
+{{- if eq .Values.fileserver.service.type "NodePort" }}
+      nodePort: {{ .Values.fileserver.service.nodePort }}
+{{- end }}
       protocol: TCP
   selector:
     {{- include "clearml.selectorLabelsFileServer" . | nindent 4 }}

charts/clearml/templates/service-webserver.yaml

@@ -9,7 +9,9 @@ spec:
   ports:
     - port: {{ .Values.webserver.service.port }}
       targetPort: {{ .Values.webserver.service.port }}
-      nodePort: 30080
+{{- if eq .Values.webserver.service.type "NodePort" }}
+      nodePort: {{ .Values.webserver.service.nodePort }}
+{{- end }}
       protocol: TCP
   selector:
     {{- include "clearml.selectorLabelsWebServer" . | nindent 4 }}

charts/clearml/values.yaml

@@ -15,14 +15,20 @@ ingress:
     tlsSecretName: ""
 
 secret:
+  # -- Set for http_session field
   httpSession: "9Tw20RbhJ1bLBiHEOWXvhplKGUbTgLzAtwFN2oLQvWwS0uRpD5"
+  # -- Set for auth_token field
   authToken: "1SCf0ov3Nm544Td2oZ0gXSrsNx5XhMWdVlKz1tOgcx158bD5RV"
   credentials:
     apiserver:
+      # -- Set for apiserver_key field
       accessKey: "5442F3443MJMORWZA3ZH"
+      # -- Set for apiserver_secret field
       secretKey: "BxapIRo9ZINi8x25CRxz8Wdmr2pQjzuWVB4PNASZqCtTyWgWVQ"
     tests:
+      # -- Set for tests_user_key field
       accessKey: "ENP39EQM4SLACGD5FXB7"
+      # -- Set for tests_user_secret field
       secretKey: "lPcm0imbcBZ8mwgO7tpadutiS3gnJD05x9j7afwXPS35IKbpiQ"
 
 apiserver:
@@ -32,8 +38,12 @@ apiserver:
   configDir: /opt/clearml/config
 
   service:
+    # -- This will set to service's spec.type field
     type: NodePort
     port: 8008
+    # -- If service.type set to NodePort, this will be set to service's nodePort field.
+    # If service.type is set to others, this field will be ignored
+    nodePort: 30008
 
   livenessDelay: 60
   readinessDelay: 60
@@ -80,8 +90,12 @@ apiserver:
 
 fileserver:
   service:
+    # -- This will set to service's spec.type field
     type: NodePort
     port: 8081
+    # -- If service.type set to NodePort, this will be set to service's nodePort field.
+    # If service.type is set to others, this field will be ignored
+    nodePort: 30081
 
   replicaCount: 1
 
@@ -121,8 +135,12 @@ webserver:
   extraEnvs: []
 
   service:
+    # -- This will set to service's spec.type field
     type: NodePort
     port: 80
+    # -- If service.type set to NodePort, this will be set to service's nodePort field.
+    # If service.type is set to others, this field will be ignored
+    nodePort: 30080
 
   replicaCount: 1