refactor: unify services definition structure

Byzanteam · Mar 8, 2024 · f128348 · f128348
1 parent e35b20b
commit f128348
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -36,10 +36,10 @@ A Helm chart template for byzanteam application
 | nameOverride | string | `""` |  |
 | replicaCount | int | `1` |  |
 | restartPolicy | string | `"Always"` |  |
-| service[].name | string | `"http"` |  |
-| service[].port | int | `80` |  |
-| service[].protocol | string | `TCP` |  |
-| serviceType | string | `"ClusterIP"` |  |
+| services.ports[].name | string | `"http"` |  |
+| services.ports[].port | int | `80` |  |
+| services.ports[].protocol | string | `TCP` |  |
+| services.type | string | `"ClusterIP"` |  |
 | volumeMounts | list | `[]` |  |
 | volumes | list | `[]` |  |
 | nodeSelector | object | `{}` |  |
@@ -79,7 +79,7 @@ appIngressroute:
     path: /example-path
     servicePortIndex: 0
 ```
-> 注： `servicePortIndex` 此值为 `.Values.services` 中子路径对应服务端口的索引值。值以 0 开始。
+> 注： `servicePortIndex` 此值为 `.Values.services.ports` 中子路径对应服务端口的索引值。值以 0 开始。
 
 ### 5. 设置外部服务代理规则
 

diff --git a/templates/deployment.yaml b/templates/deployment.yaml
@@ -44,10 +44,10 @@ spec:
               containerPort: {{ .Values.service.port }}
               protocol: TCP
             {{- else }}
-            {{- range $service := .Values.services }}
-            - name: {{ $service.name }}
-              containerPort: {{ $service.port }}
-              protocol: {{ $service.protocol }}
+            {{- range .Values.services.ports }}
+            - name: {{ .name }}
+              containerPort: {{ .port }}
+              protocol: {{ .protocol }}
             {{- end }}
             {{- end }}
           volumeMounts:

diff --git a/templates/service.yaml b/templates/service.yaml
@@ -14,13 +14,13 @@ spec:
       protocol: TCP
       name: {{ .Values.service.name }}
   {{- else }}
-  type: {{ .Values.serviceType }}
+  type: {{ .Values.services.type }}
   ports:
-  {{- range $service := .Values.services }}
-    - port: {{ $service.port }}
-      targetPort: {{ $service.name }}
-      protocol: {{ $service.protocol }}
-      name: {{ $service.name }}
+  {{- range .Values.services.ports }}
+    - port: {{ .port }}
+      targetPort: {{ .name }}
+      protocol: {{ .protocol }}
+      name: {{ .name }}
   {{- end }}
   {{- end }}
   selector:

diff --git a/templates/traefik/ingress-route.yaml b/templates/traefik/ingress-route.yaml
@@ -22,7 +22,7 @@ spec:
       kind: Rule
       services:
         - name: {{ include "application-chart-template.fullname" $ }}
-          port: {{ get (index $.Values.services (int .servicePortIndex)) "port" }}
+          port: {{ get (index $.Values.services.ports (int .servicePortIndex)) "port" }}
       middlewares:
         {{- include "application-chart-template.webMiddlewares" $ | nindent 8}}
     {{- end }}
@@ -52,7 +52,7 @@ spec:
       kind: Rule
       services:
         - name: {{ include "application-chart-template.fullname" $ }}
-          port: {{ get (index $.Values.services (int .servicePortIndex)) "port" }}
+          port: {{ get (index $.Values.services.ports (int .servicePortIndex)) "port" }}
       middlewares:
         {{- include "application-chart-template.websecureMiddlewares" $ | nindent 8}}
     {{- end }}

diff --git a/tests/application_ingressroute_test.yaml b/tests/application_ingressroute_test.yaml
@@ -33,10 +33,11 @@ tests:
           path: /example
           servicePortIndex: 1
       services:
-        - port: 80
-          name: product
-        - port: 8080
-          name: example
+        ports:
+          - port: 80
+            name: product
+          - port: 8080
+            name: example
     asserts:
       - hasDocuments:
           count: 3
@@ -69,7 +70,8 @@ tests:
           path: /app
           port: 0
       services:
-        - port: 80
+        ports:
+          - port: 80
     asserts:
       - equal:
           path: spec.routes[0].middlewares[0].name

diff --git a/values.yaml b/values.yaml
@@ -56,11 +56,11 @@ externalIngressroute: []
 
 # 应用服务配置
 services:
-  - name: http
-    port: 80
-    protocol: TCP
-
-serviceType: ClusterIP
+  type: ClusterIP
+  ports:
+    - name: http
+      port: 80
+      protocol: TCP
 
 # 覆盖 image command
 command: []