style(cf-common): rename services to service (#9)

mikhail-klimko · web-flow · commit 8a53d374667b · 2023-02-22T12:33:04.000+03:00
* style(cf-common): rename services to service
diff --git a/charts/cf-common-test/README.md b/charts/cf-common-test/README.md
@@ -37,7 +37,7 @@ Codefresh library chart - test chart - not for deployment!
 | podSecurityContext | object | `{}` |  |
 | rbac.serviceAccount | object | `{}` |  |
 | secrets | object | `{}` |  |
-| services | object | `{}` |  |
+| service | object | `{}` |  |
 | tolerations | list | `[]` |  |
 | volumes | object | `{}` |  |
 
diff --git a/charts/cf-common-test/templates/service.yaml b/charts/cf-common-test/templates/service.yaml
@@ -1 +1 @@
-{{- include "cf-common.services" . -}}
+{{- include "cf-common.service" . -}}
diff --git a/charts/cf-common-test/tests/deployment/container_test.yaml b/charts/cf-common-test/tests/deployment/container_test.yaml
@@ -60,6 +60,65 @@ tests:
           path: spec.template.spec.containers[0].env[0].value
           value: BOB
 
+  - it: Test main container with .Values.global.env
+    values:
+      - values.yaml
+    set:
+      global:
+        env:
+          GLOBAL_VAR: somevalue
+    asserts:
+      - lengthEqual:
+          path: spec.template.spec.containers[0].env
+          count: 2
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: GLOBAL_VAR
+            value: somevalue
+
+  - it: Test main container with .Values.global.env with override
+    values:
+      - values.yaml
+    set:
+      global:
+        env:
+          ALICE: globalvalue
+      container:
+        env:
+          ALICE: localvalue
+    asserts:
+      - lengthEqual:
+          path: spec.template.spec.containers[0].env
+          count: 1
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: ALICE
+            value: localvalue
+
+  - it: Test main container with .Values.global.env with override and legacy .Values.env
+    values:
+      - values.yaml
+    set:
+      global:
+        env:
+          ALICE: globalvalue
+      container:
+        env:
+          ALICE: localvalue
+      env:
+        ALICE: legacyenv
+    asserts:
+      - lengthEqual:
+          path: spec.template.spec.containers[0].env
+          count: 1
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: ALICE
+            value: legacyenv
+
   # For backward compatibility
   - it: Test .Values.env precedence over .Values.container.env
     values:
diff --git a/charts/cf-common-test/tests/deployment/values.yaml b/charts/cf-common-test/tests/deployment/values.yaml
@@ -3,7 +3,6 @@ global:
   imagePullSecrets:
     - global-pull-secret
   volumeName: some-existing-volume
-
 imagePullSecrets:
   - my-pull-secret
 
diff --git a/charts/cf-common-test/tests/service/error_test.yaml b/charts/cf-common-test/tests/service/error_test.yaml
@@ -7,20 +7,20 @@ tests:
     values:
       - values.yaml
     set:
-      services:
+      service:
         main:
           ports:
             http:
               protocol: ICMP
     asserts:
       - failedTemplate:
-          errorMessage: "services.main.ports.http.protocol is invalid!"
+          errorMessage: "service.main.ports.http.protocol is invalid!"
 
   - it: Test metrics service with no port specified
     values:
       - values.yaml
     set:
-      services:
+      service:
         metrics:
           enabled: true
           ports:
@@ -29,23 +29,23 @@ tests:
               protocol: HTTP
     asserts:
       - failedTemplate:
-          errorMessage: "services.metrics.ports.metrics.port number is required!"
+          errorMessage: "service.metrics.ports.metrics.port number is required!"
 
   - it: Test invalid service type
     values:
       - values.yaml
     set:
-      services:
+      service:
          main:
           type: Something
     asserts:
       - failedTemplate:
-          errorMessage: "services.main.type is invalid service type!"
+          errorMessage: "service.main.type is invalid service type!"
 
   - it: Test disabled service
     template: templates/service.yaml
     set:
-      services:
+      service:
          main:
           enabled: false
     asserts:
@@ -55,7 +55,7 @@ tests:
   - it: Test services items as list (not map)
     template: templates/service.yaml
     set:
-      services:
+      service:
         - main:
             primary: true
             type: ClusterIP
@@ -65,4 +65,4 @@ tests:
                 protocol: HTTP
     asserts:
       - failedTemplate:
-          errorMessage: "services block must be a map!"
+          errorMessage: "service block must be a map!"
diff --git a/charts/cf-common-test/tests/service/metadata_test.yaml b/charts/cf-common-test/tests/service/metadata_test.yaml
@@ -28,7 +28,7 @@ tests:
     values:
       - values.yaml
     set:
-      services:
+      service:
         main:
           labels:
             alice: bob
@@ -56,7 +56,7 @@ tests:
     values:
       - values.yaml
     set:
-      services:
+      service:
         metrics:
           enabled: true
           type: ClusterIP
diff --git a/charts/cf-common-test/tests/service/spec_test.yaml b/charts/cf-common-test/tests/service/spec_test.yaml
@@ -50,7 +50,7 @@ tests:
     values:
       - values.yaml
     set:
-      services:
+      service:
         main:
           extraSelectorLabels:
             extra: label
@@ -69,7 +69,7 @@ tests:
     values:
       - values.yaml
     set:
-      services:
+      service:
         main:
           ports:
             http:
@@ -92,7 +92,7 @@ tests:
     values:
       - values.yaml
     set:
-      services:
+      service:
         metrics:
           enabled: true
           type: ClusterIP
@@ -116,7 +116,7 @@ tests:
       - values.yaml
     documentIndex: 1
     set:
-      services:
+      service:
         metrics:
           enabled: true
           ports:
@@ -133,7 +133,7 @@ tests:
     values:
       - values.yaml
     set:
-      services:
+      service:
         metrics:
           enabled: true
           type: ClusterIP
diff --git a/charts/cf-common-test/tests/service/values.yaml b/charts/cf-common-test/tests/service/values.yaml
@@ -14,7 +14,7 @@ container:
     tag: master
     pullPolicy: Always
 
-services:
+service:
   main:
     enabled: true
     primary: true
diff --git a/charts/cf-common-test/values.yaml b/charts/cf-common-test/values.yaml
@@ -11,7 +11,7 @@ configMaps: {}
 
 secrets: {}
 
-services: {}
+service: {}
 
 ingress: {}
 
diff --git a/charts/cf-common/Chart.yaml b/charts/cf-common/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: v0.0.0
 description: Codefresh library chart
 name: cf-common
-version: 0.0.8
+version: 0.0.9
 type: library
 keywords:
   - codefresh
diff --git a/charts/cf-common/README.md b/charts/cf-common/README.md
@@ -2,7 +2,7 @@
 
 Codefresh library chart
 
-![Version: 0.0.8](https://img.shields.io/badge/Version-0.0.8-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
+![Version: 0.0.9](https://img.shields.io/badge/Version-0.0.9-informational?style=flat-square) ![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square) ![AppVersion: v0.0.0](https://img.shields.io/badge/AppVersion-v0.0.0-informational?style=flat-square)
 
 ## Installing the Chart
 
@@ -18,7 +18,7 @@ Include this chart as a dependency in your `Chart.yaml` e.g.
 # Chart.yaml
 dependencies:
 - name: cf-common
-  version: 0.0.8
+  version: 0.0.9
   repository: https://chartmuseum.codefresh.io/cf-common
 ```
 
@@ -31,19 +31,13 @@ dependencies:
 | additionalContainers | list | `[]` | Array of extra (sidecar) containers to add |
 | affinity | object | `{}` | Set affinity constrains |
 | automountServiceAccountToken | bool | `true` | Specifies whether a service account token should be automatically mounted. |
-| autoscaling | object | `{"enabled":false,"maxReplicas":null,"metrics":[],"minReplicas":null,"targetCPUUtilizationPercentage":null}` | Configure autoscaling (Horizontal Pod Autoscaler) |
-| autoscaling.enabled | bool | `false` | Enable HPA |
-| autoscaling.maxReplicas | string | `nil` | Set maximum autoscaling replicas |
-| autoscaling.metrics | list | `[]` | Set custom metrics |
-| autoscaling.minReplicas | string | `nil` | Set minimum autoscaling replicas |
-| autoscaling.targetCPUUtilizationPercentage | string | `nil` | Set target CPU utilization percentage |
-| configMaps | object | `{"config":{"annotations":{},"data":{},"enabled":false,"labels":{}}}` | Create configMap with the values you provide. Additional configMaps can be added by adding a dictionary key similar to the 'config' object. |
+| configMaps | object | See below | Create configMap with the values you provide. Additional configMaps can be added by adding a dictionary key similar to the 'config' object. |
 | configMaps.config | object | `{"annotations":{},"data":{},"enabled":false,"labels":{}}` | ConfigMap name. Make sure to use the same name in `volumes` and `container.volumeMounts` |
 | configMaps.config.annotations | object | `{}` | Add additional annotations to the configMap |
 | configMaps.config.data | object | `{}` | ConfigMap data content. |
 | configMaps.config.enabled | bool | `false` | Enable the configMap |
 | configMaps.config.labels | object | `{}` | Add additional labels to the configMap |
-| container | object | `{"args":[],"command":[],"containerSecurityContext":{},"env":{},"envFrom":[],"image":{"pullPolicy":null,"registry":null,"repository":null,"tag":null},"lifecycle":{},"probes":{"liveness":{"enabled":false,"exec":{"command":[]},"httpGet":{"path":null,"port":null},"spec":{"failureThreshold":null,"initialDelaySeconds":null,"periodSeconds":null,"successThreshold":null,"timeoutSeconds":null},"type":null},"readiness":{"enabled":false},"startup":{"enabled":false}},"resources":{"limits":{},"requests":{}},"volumeMounts":{}}` | Main Container parameters |
+| container | object | See below | Main Container parameters |
 | container.args | list | `[]` | Override args for the container |
 | container.command | list | `[]` | Override commands for the container |
 | container.containerSecurityContext | object | `{}` | Set security context for container |
@@ -67,7 +61,7 @@ dependencies:
 | container.probes.liveness.type | string | `nil` | Set liveness probe type (httpGet/exec) |
 | container.resources | object | `{"limits":{},"requests":{}}` | Set the resources (requests/limits) for the container |
 | container.volumeMounts | object | `{}` | Set volume mounts for container |
-| controller | object | `{"annotations":{},"deployment":{"rollingUpdate":{"maxSurge":null,"maxUnavailable":null},"strategy":null},"labels":{},"replicas":null,"revisionHistoryLimit":null,"type":null}` | Controller parameters |
+| controller | object | See below | Controller parameters |
 | controller.annotations | object | `{}` | Set annotations on controller |
 | controller.deployment.rollingUpdate.maxSurge | string | `nil` | Set RollingUpdate max surge (absolute number or percentage) |
 | controller.deployment.rollingUpdate.maxUnavailable | string | `nil` | Set RollingUpdate max unavailable (absolute number or percentage) |
@@ -77,31 +71,38 @@ dependencies:
 | controller.revisionHistoryLimit | string | `nil` | Set ReplicaSet revision history limit |
 | controller.type | string | `nil` | Define the controller type (`deployment`) |
 | extraResources | list | `[]` | Array of extra objects to deploy with the release |
-| global | object | `{"imagePullSecrets":[],"imageRegistry":""}` | Global parameters |
+| global | object | `{"env":{},"imagePullSecrets":[],"imageRegistry":""}` | Global parameters |
+| global.env | object | `{}` | Global Env vars. NO precedence over `.Values.container.env` |
 | global.imagePullSecrets | list | `[]` | Global Docker registry secret names as array |
 | global.imageRegistry | string | `""` | Global Docker image registry |
+| hpa | object | See below | Configure autoscaling (Horizontal Pod Autoscaler) |
+| hpa.enabled | bool | `false` | Enable HPA |
+| hpa.maxReplicas | string | `nil` | Set maximum autoscaling replicas |
+| hpa.metrics | list | `[]` | Set custom metrics |
+| hpa.minReplicas | string | `nil` | Set minimum autoscaling replicas |
+| hpa.targetCPUUtilizationPercentage | string | `nil` | Set target CPU utilization percentage |
 | imagePullSecrets | list | `[]` | Set image pull secrets as array |
 | ingress | object | See below | Configure the Ingresses for the chart. Additional Ingresses can be added by adding a dictionary key similar to the 'main' ingress. |
 | ingress.main.annotations | object | `{}` | Add additional annotations for ingress. |
 | ingress.main.enabled | bool | `false` | Enables or disables the ingress |
 | ingress.main.hosts[0].host | string | `"domain.example.com"` | Host address. Helm template can be passed. |
 | ingress.main.hosts[0].paths[0].path | string | `"/"` | Path. Helm template can be passed. |
-| ingress.main.hosts[0].paths[0].pathType | string | `"Prefix"` | Path Type (`Prefix`/`ImplementationSpecific`/`Exact`) |
+| ingress.main.hosts[0].paths[0].pathType | string | `nil` | Path Type (`Prefix`/`ImplementationSpecific`(default)/`Exact`) |
 | ingress.main.hosts[0].paths[0].service.name | string | `nil` | Set the service name reference for this path. Helm template can be passed. |
 | ingress.main.hosts[0].paths[0].service.port | string | `nil` | Set the service port reference for this path. Helm template can be passed. |
 | ingress.main.ingressClassName | string | `nil` | Set the ingressClass that is used for the ingress. |
 | ingress.main.labels | object | `{}` | Add additional labels for ingress. |
 | ingress.main.tls | list | `[]` | Configure TLS for the ingress. Both secretName and hosts can process a Helm template. |
 | initContainers | list | `[]` | Array of init containers to add |
 | nodeSelector | object | `{}` | Set node selection constrains |
-| pdb | object | `{"enabled":false,"maxUnavailable":"","minAvailable":""}` | Configure Pod Disruption Budget |
+| pdb | object | See below | Configure Pod Disruption Budget |
 | pdb.enabled | bool | `false` | Enable PDB |
 | pdb.maxUnavailable | string | `""` | Set number of pods that are unavailable after eviction as number of percentage |
 | pdb.minAvailable | string | `""` | Set number of pods that are available after eviction as number of percentage |
 | podAnnotations | object | `{}` | Set additional pod annotations |
 | podLabels | object | `{}` | Set additional pod labels |
 | podSecurityContext | object | `{}` | Set security context for the pod |
-| rbac | object | `{"enabled":false,"rules":[],"serviceAccount":{"annotations":{},"enabled":false,"nameOverride":""}}` | Configure RBAC parameters |
+| rbac | object | See below | Configure RBAC parameters |
 | rbac.enabled | bool | `false` | Enable RBAC resources |
 | rbac.rules | list | `[]` | Create custom rules |
 | rbac.serviceAccount | object | `{"annotations":{},"enabled":false,"nameOverride":""}` | Configure Service Account |
@@ -114,22 +115,22 @@ dependencies:
 | secrets.secret.labels | object | `{}` | Add additional labels to the secret |
 | secrets.secret.stringData | object | `{}` | Secret data content. Plain text (not base64). Helm template supported. Passed through `tpl`, should be configured as string |
 | secrets.secret.type | string | `"Opaque"` | Set secret type (`Opaque`/`kubernetes.io/tls`) |
-| services | object | `{"main":{"annotations":{},"enabled":false,"extraSelectorLabels":{},"labels":{},"ports":{"http":{"port":null,"protocol":"HTTP","targetPort":null}},"primary":true,"type":"ClusterIP"}}` | Configure services fo the chart. Additional services can be added by adding a dictionary key similar to the 'main' service. |
-| services.main | object | `{"annotations":{},"enabled":false,"extraSelectorLabels":{},"labels":{},"ports":{"http":{"port":null,"protocol":"HTTP","targetPort":null}},"primary":true,"type":"ClusterIP"}` | Service name |
-| services.main.annotations | object | `{}` | Add additional annotations for the service |
-| services.main.enabled | bool | `false` | Enabled the service |
-| services.main.extraSelectorLabels | object | `{}` | Allow adding additional match labels |
-| services.main.labels | object | `{}` | Add additional labels for the service |
-| services.main.ports | object | `{"http":{"port":null,"protocol":"HTTP","targetPort":null}}` | Configure ports for the service |
-| services.main.ports.http | object | `{"port":null,"protocol":"HTTP","targetPort":null}` | Port name |
-| services.main.ports.http.port | string | `nil` | Port number |
-| services.main.ports.http.protocol | string | `"HTTP"` | Port protocol (`HTTP`/`HTTPS`/`TCP`/`UDP`) |
-| services.main.ports.http.targetPort | string | `nil` | Set a service targetPort if you wish to differ the service port from the application port. |
-| services.main.primary | bool | `true` | Make this the primary service (used in probes, notes, etc...). If there is more than 1 service, make sure that only 1 service is marked as primary. |
-| services.main.type | string | `"ClusterIP"` | Set the service type |
+| service | object | See below | Configure services fo the chart. Additional services can be added by adding a dictionary key similar to the 'main' service. |
+| service.main | object | `{"annotations":{},"enabled":false,"extraSelectorLabels":{},"labels":{},"ports":{"http":{"port":null,"protocol":"HTTP","targetPort":null}},"primary":true,"type":"ClusterIP"}` | Service name |
+| service.main.annotations | object | `{}` | Add additional annotations for the service |
+| service.main.enabled | bool | `false` | Enabled the service |
+| service.main.extraSelectorLabels | object | `{}` | Allow adding additional match labels |
+| service.main.labels | object | `{}` | Add additional labels for the service |
+| service.main.ports | object | `{"http":{"port":null,"protocol":"HTTP","targetPort":null}}` | Configure ports for the service |
+| service.main.ports.http | object | `{"port":null,"protocol":"HTTP","targetPort":null}` | Port name |
+| service.main.ports.http.port | string | `nil` | Port number |
+| service.main.ports.http.protocol | string | `"HTTP"` | Port protocol (`HTTP`/`HTTPS`/`TCP`/`UDP`) |
+| service.main.ports.http.targetPort | string | `nil` | Set a service targetPort if you wish to differ the service port from the application port. |
+| service.main.primary | bool | `true` | Make this the primary service (used in probes, notes, etc...). If there is more than 1 service, make sure that only 1 service is marked as primary. |
+| service.main.type | string | `"ClusterIP"` | Set the service type |
 | tolerations | list | `[]` | Set tolerations constrains |
 | topologySpreadConstraints | list | `[]` | Set topologySpreadConstraints rules. Helm template supported. Passed through `tpl`, should be configured as string |
-| volumes | object | `{"config":{"enabled":false,"type":"configMap"},"secret":{"enabled":false,"type":"secret"}}` | Configure volume for the controller. Additional items can be added by adding a dictionary key similar to the 'config'/`secret` key. |
+| volumes | object | See below | Configure volume for the controller. Additional items can be added by adding a dictionary key similar to the 'config'/`secret` key. |
 | volumes.config | object | `{"enabled":false,"type":"configMap"}` | Volume name. Make sure to use the same name in `configMaps`/`secrets` and `container.volumeMounts` |
 | volumes.config.enabled | bool | `false` | Enable the volume |
 | volumes.config.type | string | `"configMap"` | Volume type (configMap/secret) |
diff --git a/charts/cf-common/templates/container/_container.tpl b/charts/cf-common/templates/container/_container.tpl
@@ -54,13 +54,16 @@ Usage:
     {{- end }}
   {{- end }}
 
-  {{- with .Values.env }}
+  {{- if or (.Values.env) ($.Values.global.env) }}
+    {{- $mergedEnv := .Values.env }}
 {{- /*
 For backward compatibility (.Values.env takes precedence over .Values.container.env)
 */}}
-  {{- $mergedEnv := . }}
     {{- if $.Values.env }}
-  {{- $mergedEnv = mergeOverwrite . $.Values.env }}
+  {{- $mergedEnv = mergeOverwrite $mergedEnv $.Values.env }}
+    {{- end }}
+    {{- if $.Values.global.env }}
+  {{- $mergedEnv = merge $mergedEnv $.Values.global.env }}
     {{- end }}
   env:
   {{- include "cf-common.env-vars" (dict "Values" $mergedEnv "context" $) | trim | nindent 2 }}
diff --git a/charts/cf-common/templates/container/_ports.tpl b/charts/cf-common/templates/container/_ports.tpl
diff --git a/charts/cf-common/templates/ingress/_ingress.tpl b/charts/cf-common/templates/ingress/_ingress.tpl
diff --git a/charts/cf-common/templates/render/_all.tpl b/charts/cf-common/templates/render/_all.tpl
diff --git a/charts/cf-common/templates/render/_services.tpl b/charts/cf-common/templates/render/_services.tpl
diff --git a/charts/cf-common/values.yaml b/charts/cf-common/values.yaml

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{{- include "cf-common.services" . -}}`
	`1`	`+{{- include "cf-common.service" . -}}`