Sort envs in templates (#2029)

* Sort environment variables in deployment.yaml for broker configuration

* Workflow

* Fix sorting of environment variables in deployment.yaml

* Enhance environment variable sorting validation in deployment.yaml

* Fix environment variable sorting validation in KEB integration tests workflow

* Enforce locale setting for environment variable sorting in KEB integration tests

* Fix environment variable sorting to enforce case-insensitive order in deployment.yaml

* Fix environment variable sorting to ensure case-insensitive order in KEB integration tests

* Fix environment variable sorting to ensure case-insensitive order in KEB integration tests

* Make a mess

* Fix

* Enhance environment variable management in KEB templates by enforcing alphabetical order across multiple YAML files and updating variable definitions for clarity and consistency.

* Enforce alphabetical order for environment variables in additional KEB YAML files

* Refactor environment variable definitions in KEB templates for consistency and clarity

* Refactor DATABASE_EMBEDDED environment variable handling in migrator-job.yaml for improved clarity and maintainability

* Fix path in environment variable sorting checks for trial-cleanup-job.yaml, deprovision-retrigger-job.yaml, free-cleanup-job.yaml, and keb-db-job.yaml

* Remove alphabetical order enforcement for environment variables in keb-db-job.yaml from integration tests

* Remove enforcement of alphabetical order for environment variables in subaccount-cleanup-job.yaml

* Refactor environment variable definitions in globalaccounts.yaml and subaccount-sync-deployment.yaml for improved clarity and consistency

* Refactor environment variable definitions in migrator-job.yaml for improved clarity and consistency

* Remove cronJobs section from values.yaml

* Refactor environment variable sorting checks in KEB chart integration tests to use a dedicated script

* Change file permissions for check_env_alphabetical_order.sh to make it executable

* Sort

Author: MarekMichali

.github/workflows/run-keb-chart-integration-tests-reusable.yaml

@@ -36,7 +36,34 @@ jobs:
       run: |
         cd resources/keb
         helm template .
-  
+
+    - name: Enforce env alphabetical order in deployment.yaml (KEB)
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/deployment.yaml deployment_KEB ports
+
+    - name: Enforce env alphabetical order in runtime-reconciler-deployment.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/runtime-reconciler-deployment.yaml runtime_reconciler
+
+    - name: Enforce env alphabetical order in trial-cleanup-job.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/trial-cleanup-job.yaml trial_cleanup
+
+    - name: Enforce env alphabetical order in deprovision-retrigger-job.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/deprovision-retrigger-job.yaml deprovision_retrigger
+
+    - name: Enforce env alphabetical order in free-cleanup-job.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/free-cleanup-job.yaml free_cleanup
+
+    - name: Enforce env alphabetical order in service-binding-cleanup-job.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/service-binding-cleanup-job.yaml service_binding_cleanup
+
+    - name: Enforce env alphabetical order in globalaccounts.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/globalaccounts.yaml globalaccounts
+
+    - name: Enforce env alphabetical order in subaccount-sync-deployment.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/subaccount-sync-deployment.yaml subaccount_sync
+      
+    - name: Enforce env alphabetical order in migrator-job.yaml
+      run: scripts/check_env_alphabetical_order.sh resources/keb/templates/migrator-job.yaml migrator_job
+      
   prepare-tests:
     runs-on: ubuntu-latest
     needs: validate-keb-helm-chart

resources/keb/templates/deployment.yaml

@@ -24,57 +24,51 @@ spec:
           containers:
             - image: "{{ .Values.global.images.container_registry.path }}/{{ .Values.global.images.kyma_environment_deprovision_retrigger_job.dir }}kyma-environment-deprovision-retrigger-job:{{ .Values.global.images.kyma_environment_deprovision_retrigger_job.version }}"
               name: deprovision-retrigger-job
-              env:
-                {{if eq .Values.global.database.embedded.enabled true}}
-                - name: DATABASE_EMBEDDED
-                  value: "true"
-                {{end}}
-                {{if eq .Values.global.database.embedded.enabled false}}
-                - name: DATABASE_EMBEDDED
-                  value: "false"
-                {{end}} 
-                - name: APP_DRY_RUN
-                  value: "{{ .Values.deprovisionRetrigger.dryRun }}"
-                - name: APP_DATABASE_SECRET_KEY
+              env: 
+                - name: APP_BROKER_URL
+                  value: "http://{{ include "kyma-env-broker.fullname" . }}"              
+                - name: APP_DATABASE_HOST
                   valueFrom:
                     secretKeyRef:
-                      name: "{{ .Values.global.database.managedGCP.encryptionSecretName }}"
-                      key: secretKey
-                      optional: true
-                - name: APP_DATABASE_USER
+                      name: kcp-postgresql
+                      key: postgresql-serviceName
+                - name: APP_DATABASE_NAME
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
-                      key: postgresql-broker-username
+                      key: postgresql-broker-db-name
                 - name: APP_DATABASE_PASSWORD
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
                       key: postgresql-broker-password
-                - name: APP_DATABASE_HOST
-                  valueFrom:
-                    secretKeyRef:
-                      name: kcp-postgresql
-                      key: postgresql-serviceName
                 - name: APP_DATABASE_PORT
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
                       key: postgresql-servicePort
-                - name: APP_DATABASE_NAME
+                - name: APP_DATABASE_SECRET_KEY
                   valueFrom:
                     secretKeyRef:
-                      name: kcp-postgresql
-                      key: postgresql-broker-db-name
+                      name: "{{ .Values.global.database.managedGCP.encryptionSecretName }}"
+                      key: secretKey
+                      optional: true
                 - name: APP_DATABASE_SSLMODE
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
                       key: postgresql-sslMode
                 - name: APP_DATABASE_SSLROOTCERT
                   value: /secrets/cloudsql-sslrootcert/server-ca.pem
-                - name: APP_BROKER_URL
-                  value: "http://{{ include "kyma-env-broker.fullname" . }}"
+                - name: APP_DATABASE_USER
+                  valueFrom:
+                    secretKeyRef:
+                      name: kcp-postgresql
+                      key: postgresql-broker-username
+                - name: APP_DRY_RUN
+                  value: "{{ .Values.deprovisionRetrigger.dryRun }}"
+                - name: DATABASE_EMBEDDED
+                  value: "{{ .Values.global.database.embedded.enabled }}"
               command:
                 - "/bin/main"
               volumeMounts:

resources/keb/templates/deprovision-retrigger-job.yaml

@@ -25,64 +25,58 @@ spec:
             - image: "{{ .Values.global.images.container_registry.path }}/{{ .Values.global.images.kyma_environment_expirator_job.dir }}kyma-environment-expirator-job:{{ .Values.global.images.kyma_environment_expirator_job.version }}"
               name: free-cleanup-job
               env:
-                {{if eq .Values.global.database.embedded.enabled true}}
-                - name: DATABASE_EMBEDDED
-                  value: "true"
-                {{end}}
-                {{if eq .Values.global.database.embedded.enabled false}}
-                - name: DATABASE_EMBEDDED
-                  value: "false"
-                {{end}} 
-                - name: APP_DRY_RUN
-                  value: "{{ .Values.freeCleanup.dryRun }}"
-                - name: APP_EXPIRATION_PERIOD
-                  value: "{{ .Values.freeCleanup.expirationPeriod }}"
-                - name: APP_DATABASE_SECRET_KEY
+                - name: APP_BROKER_URL
+                  value: "http://{{ include "kyma-env-broker.fullname" . }}"
+                - name: APP_DATABASE_HOST
                   valueFrom:
                     secretKeyRef:
-                      name: "{{ .Values.global.database.managedGCP.encryptionSecretName }}"
-                      key: secretKey
-                      optional: true
-                - name: APP_DATABASE_USER
+                      name: kcp-postgresql
+                      key: postgresql-serviceName
+                - name: APP_DATABASE_NAME
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
-                      key: postgresql-broker-username
+                      key: postgresql-broker-db-name
                 - name: APP_DATABASE_PASSWORD
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
                       key: postgresql-broker-password
-                - name: APP_DATABASE_HOST
-                  valueFrom:
-                    secretKeyRef:
-                      name: kcp-postgresql
-                      key: postgresql-serviceName
                 - name: APP_DATABASE_PORT
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
                       key: postgresql-servicePort
-                - name: APP_DATABASE_NAME
+                - name: APP_DATABASE_SECRET_KEY
                   valueFrom:
                     secretKeyRef:
-                      name: kcp-postgresql
-                      key: postgresql-broker-db-name
+                      name: "{{ .Values.global.database.managedGCP.encryptionSecretName }}"
+                      key: secretKey
+                      optional: true
                 - name: APP_DATABASE_SSLMODE
                   valueFrom:
                     secretKeyRef:
                       name: kcp-postgresql
                       key: postgresql-sslMode
                 - name: APP_DATABASE_SSLROOTCERT
                   value: /secrets/cloudsql-sslrootcert/server-ca.pem
-                - name: APP_BROKER_URL
-                  value: "http://{{ include "kyma-env-broker.fullname" . }}"
+                - name: APP_DATABASE_USER
+                  valueFrom:
+                    secretKeyRef:
+                      name: kcp-postgresql
+                      key: postgresql-broker-username
+                - name: APP_DRY_RUN
+                  value: "{{ .Values.freeCleanup.dryRun }}"
+                - name: APP_EXPIRATION_PERIOD
+                  value: "{{ .Values.freeCleanup.expirationPeriod }}"
+                - name: APP_PLAN_ID
+                  value: "b1a5764e-2ea1-4f95-94c0-2b4538b37b55"
                 - name: APP_TEST_RUN
                   value: "{{ .Values.freeCleanup.testRun }}"
                 - name: APP_TEST_SUBACCOUNT_ID
                   value: "{{ .Values.freeCleanup.testSubaccountID }}"
-                - name: APP_PLAN_ID
-                  value: "b1a5764e-2ea1-4f95-94c0-2b4538b37b55"
+                - name: DATABASE_EMBEDDED
+                  value: "{{ .Values.global.database.embedded.enabled }}"
               command:
                 - "/bin/main"
               volumeMounts:

resources/keb/templates/free-cleanup-job.yaml

@@ -30,61 +30,60 @@ spec:
           image: "{{ .Values.global.images.container_registry.path }}/{{ .Values.global.images.kyma_environment_broker.dir }}{{ .Values.globalaccounts.name -}}:{{ .Values.global.images.kyma_environment_globalaccounts.version }}"
           imagePullPolicy: Always
           env:
-            - name: GLOBALACCOUNTS_DRY_RUN
-              value: {{ .Values.globalaccounts.dryRun | quote }}
-            - name: GLOBALACCOUNTS_DATABASE_SECRET_KEY
-              valueFrom:
-                secretKeyRef:
-                  name: kcp-storage-client-secret
-                  key: secretKey
-                  optional: true
-            - name: GLOBALACCOUNTS_DATABASE_USER
+            - name: GLOBALACCOUNTS_AUTH_URL
+              value: {{ .Values.cis.accounts.authURL | required "please specify .Values.cis.accounts.authURL" | quote }}
+            - name: GLOBALACCOUNTS_CLIENT_ID
               valueFrom:
                 secretKeyRef:
-                  key: postgresql-broker-username
-                  name: kcp-postgresql
-            - name: GLOBALACCOUNTS_DATABASE_PASSWORD
+                  name: {{ .Values.cis.accounts.secretName | required "please specify .Values.cis.accounts.secretName" | quote }}  
+                  key: id
+            - name: GLOBALACCOUNTS_CLIENT_SECRET
               valueFrom:
                 secretKeyRef:
-                  key: postgresql-broker-password
-                  name: kcp-postgresql
+                  name: {{ .Values.cis.accounts.secretName | required "please specify .Values.cis.accounts.secretName" | quote }}  
+                  key: secret
             - name: GLOBALACCOUNTS_DATABASE_HOST
               valueFrom:
                 secretKeyRef:
                   key: postgresql-serviceName
                   name: kcp-postgresql
-            - name: GLOBALACCOUNTS_DATABASE_PORT
+            - name: GLOBALACCOUNTS_DATABASE_NAME
               valueFrom:
                 secretKeyRef:
-                  key: postgresql-servicePort
+                  key: postgresql-broker-db-name
                   name: kcp-postgresql
-            - name: GLOBALACCOUNTS_DATABASE_NAME
+            - name: GLOBALACCOUNTS_DATABASE_PASSWORD
               valueFrom:
                 secretKeyRef:
-                  key: postgresql-broker-db-name
+                  key: postgresql-broker-password
                   name: kcp-postgresql
-            - name: GLOBALACCOUNTS_CLIENT_ID
+            - name: GLOBALACCOUNTS_DATABASE_PORT
               valueFrom:
                 secretKeyRef:
-                  name: {{ .Values.cis.accounts.secretName | required "please specify .Values.cis.accounts.secretName" | quote }}  
-                  key: id
-            - name: GLOBALACCOUNTS_CLIENT_SECRET
+                  key: postgresql-servicePort
+                  name: kcp-postgresql
+            - name: GLOBALACCOUNTS_DATABASE_SECRET_KEY
               valueFrom:
                 secretKeyRef:
-                  name: {{ .Values.cis.accounts.secretName | required "please specify .Values.cis.accounts.secretName" | quote }}  
-                  key: secret
-            - name: GLOBALACCOUNTS_AUTH_URL
-              value: {{ .Values.cis.accounts.authURL | required "please specify .Values.cis.accounts.authURL" | quote }}
-            - name: GLOBALACCOUNTS_SERVICE_URL
-              value: {{ .Values.cis.accounts.serviceURL | required "please specify .Values.cis.accounts.serviceURL" | quote }}
+                  name: kcp-storage-client-secret
+                  key: secretKey
+                  optional: true
             - name: GLOBALACCOUNTS_DATABASE_SSLMODE
               valueFrom:
                 secretKeyRef:
                   key: postgresql-sslMode
                   name: kcp-postgresql
             - name: GLOBALACCOUNTS_DATABASE_SSLROOTCERT
               value: /secrets/cloudsql-sslrootcert/server-ca.pem
-
+            - name: GLOBALACCOUNTS_DATABASE_USER
+              valueFrom:
+                secretKeyRef:
+                  key: postgresql-broker-username
+                  name: kcp-postgresql
+            - name: GLOBALACCOUNTS_DRY_RUN
+              value: {{ .Values.globalaccounts.dryRun | quote }}
+            - name: GLOBALACCOUNTS_SERVICE_URL
+              value: {{ .Values.cis.accounts.serviceURL | required "please specify .Values.cis.accounts.serviceURL" | quote }}
         {{- if and (eq .Values.global.database.embedded.enabled false) (eq .Values.global.database.cloudsqlproxy.enabled false)}}
           volumeMounts:
               - name: cloudsql-sslrootcert