Merge pull request #544 from intershop/release/develop/icm

Release icm-as:minor
intershop · Feb 26, 2024 · cba0227 · cba0227
2 parents 32da65a + 3862650
commit cba0227
Show file tree

Hide file tree

Showing 13 changed files with 201 additions and 25 deletions.
diff --git a/charts/icm-as/.bumpversion.toml b/charts/icm-as/.bumpversion.toml
@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "1.7.0"
+current_version = "1.8.0"
 
 [[tool.bumpversion.files]]
 filename = "Chart.yaml"

diff --git a/charts/icm-as/CHANGELOG.md b/charts/icm-as/CHANGELOG.md
@@ -1,11 +1,31 @@
 
+<a name="icm-as-1.8.0"></a>
+## [icm-as-1.8.0](https://github.com/intershop/helm-charts/compare/icm-as-1.7.0...icm-as-1.8.0)
+
+> 2024-02-26
+
+### Chore
+
+* bump versions of icm-as:minor
+
+### Feat
+
+* **icm:** New Relic license via secretKeyRef ([#540](https://github.com/intershop/helm-charts/issues/540))
+* **icm:** Database password via secretKeyRef ([#143](https://github.com/intershop/helm-charts/issues/143))
+
+### Fix
+
+* **icm:** Deprecate icm-as.newrelic.license_key ([#543](https://github.com/intershop/helm-charts/issues/543))
+
+
 <a name="icm-as-1.7.0"></a>
 ## [icm-as-1.7.0](https://github.com/intershop/helm-charts/compare/icm-as-1.6.1...icm-as-1.7.0)
 
 > 2023-12-11
 
 ### Chore
 
+* generated changelog+release notes for icm:minor icm-as:minor
 * bump versions of icm:minor icm-as:minor
 
 ### Feat

diff --git a/charts/icm-as/Chart.yaml b/charts/icm-as/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 # name and version must be in this exact order, otherwise bump2version won't work
 name: icm-as
-version: 1.7.0
+version: 1.8.0
 description: Intershop Commerce Management - AppServer
 type: application
 appVersion: 11.2.1
diff --git a/charts/icm-as/RELEASE_NOTES.md b/charts/icm-as/RELEASE_NOTES.md
@@ -1,14 +1,19 @@
 
-<a name="icm-as-1.7.0"></a>
-## [icm-as-1.7.0](https://github.com/intershop/helm-charts/compare/icm-as-1.6.1...icm-as-1.7.0)
+<a name="icm-as-1.8.0"></a>
+## [icm-as-1.8.0](https://github.com/intershop/helm-charts/compare/icm-as-1.7.0...icm-as-1.8.0)
 
-> 2023-12-11
+> 2024-02-26
 
 ### Chore
 
-* bump versions of icm:minor icm-as:minor
+* bump versions of icm-as:minor
 
 ### Feat
 
-* **icm:** circumvent liveness probe ([#491](https://github.com/intershop/helm-charts/issues/491))
+* **icm:** New Relic license via secretKeyRef ([#540](https://github.com/intershop/helm-charts/issues/540))
+* **icm:** Database password via secretKeyRef ([#143](https://github.com/intershop/helm-charts/issues/143))
+
+### Fix
+
+* **icm:** Deprecate icm-as.newrelic.license_key ([#543](https://github.com/intershop/helm-charts/issues/543))
 
diff --git a/charts/icm-as/templates/_environments.tpl b/charts/icm-as/templates/_environments.tpl
@@ -42,6 +42,15 @@ env:
 {{- else }}
   value: "false"
 {{- end }}
+- name: NEW_RELIC_LICENSE_KEY
+{{- /* licenseKeySecretKeyRef has precedence over license_key */ -}}
+{{- if .Values.newrelic.licenseKeySecretKeyRef }}
+  valueFrom:
+    secretKeyRef:
+{{- toYaml .Values.newrelic.licenseKeySecretKeyRef | nindent 6 }}
+{{- else }}
+  value: "{{ .Values.newrelic.license_key }}"
+{{- end }}
 {{- end }}
 {{- if .Values.mssql.enabled }}
 - name: INTERSHOP_DATABASETYPE
@@ -51,7 +60,14 @@ env:
 - name: INTERSHOP_JDBC_USER
   value: "{{ .Values.mssql.user }}"
 - name: INTERSHOP_JDBC_PASSWORD
+{{- /* passwordSecretKeyRef has precedence over password */ -}}
+{{- if .Values.mssql.passwordSecretKeyRef }}
+  valueFrom:
+    secretKeyRef:
+{{- toYaml .Values.mssql.passwordSecretKeyRef | nindent 6 }}
+{{- else }}
   value: "{{ .Values.mssql.password }}"
+{{- end }}
 {{- else }}
 - name: INTERSHOP_DATABASETYPE
   value: "{{ .Values.database.type }}"
@@ -60,8 +76,15 @@ env:
 - name: INTERSHOP_JDBC_USER
   value: "{{ .Values.database.jdbcUser }}"
 - name: INTERSHOP_JDBC_PASSWORD
+{{- /* jdbcPasswordSecretKeyRef has precedence over jdbcPassword */ -}}
+{{- if .Values.database.jdbcPasswordSecretKeyRef }}
+  valueFrom:
+    secretKeyRef:
+{{- toYaml .Values.database.jdbcPasswordSecretKeyRef | nindent 6 }}
+{{- else }}
   value: "{{ .Values.database.jdbcPassword }}"
 {{- end }}
+{{- end }}
 {{- if .Values.replication.enabled }}
 - name: STAGING_SYSTEM_TYPE
   {{- if eq .Values.replication.role "source" }}

diff --git a/charts/icm-as/templates/config-newrelic-yaml-cm.yaml b/charts/icm-as/templates/config-newrelic-yaml-cm.yaml
@@ -9,6 +9,5 @@ metadata:
 data:
   newrelic.yml:  |-
     common: &default_settings
-      license_key : "{{ .Values.newrelic.license_key }}"
       app_name : "{{ .Values.newrelic.app_name | default (include "icm-as.operationalContextName" .) }}"
 {{- end -}}
diff --git a/charts/icm-as/tests/environment_test.yaml b/charts/icm-as/tests/environment_test.yaml
@@ -105,6 +105,72 @@ tests:
             name: INTERSHOP_JDBC_USER
             value: "databaseguy"
 
+  - it: should fallback to JDBC plain text password if no password secret key ref is provided
+    release:
+      name: icm-as
+    chart:
+      version: 0.8.15
+    values:
+      - ../values.yaml
+    set:
+      database.jdbcPasswordSecretKeyRef: null
+      database.jdbcPassword: "thisisverysecret"
+    template: templates/as-deployment.yaml
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: INTERSHOP_JDBC_PASSWORD
+            value: "thisisverysecret"
+
+  - it: should use JDBC password secret key ref if provided
+    release:
+      name: icm-as
+    chart:
+      version: 0.8.15
+    values:
+      - ../values.yaml
+    set:
+      database.jdbcPasswordSecretKeyRef.name: "your-company-prd-secrets"
+      database.jdbcPasswordSecretKeyRef.key: "thisisverysecret"
+    template: templates/as-deployment.yaml
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: INTERSHOP_JDBC_PASSWORD
+            valueFrom:
+              secretKeyRef:
+                key: thisisverysecret
+                name: your-company-prd-secrets
+
+  - it: should take JDBC password secret key ref precedence over plain text password
+    release:
+      name: icm-as
+    chart:
+      version: 0.8.15
+    values:
+      - ../values.yaml
+    set:
+      database.jdbcPassword: "should-not-appear"
+      database.jdbcPasswordSecretKeyRef.name: "your-company-prd-secrets"
+      database.jdbcPasswordSecretKeyRef.key: "thisisverysecret"
+    template: templates/as-deployment.yaml
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: INTERSHOP_JDBC_PASSWORD
+            valueFrom:
+              secretKeyRef:
+                key: thisisverysecret
+                name: your-company-prd-secrets
+      - notContains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: INTERSHOP_JDBC_PASSWORD
+            value: "should-not-appear"
+
   - it: two additional values
     release:
       name: icm-as

diff --git a/charts/icm-as/tests/newrelic_test.yaml b/charts/icm-as/tests/newrelic_test.yaml
@@ -71,7 +71,7 @@ tests:
             prometheus.io/path: /metrics
             prometheus.io/port: "7744"
             prometheus.io/scrape: "false"
-  - it: newrelic license
+  - it: newrelic license key
     release:
       name: icm-as
     chart:
@@ -81,14 +81,61 @@ tests:
     set:
       newrelic.enabled: true
       newrelic.license_key: "secret-license-test"
-    template: templates/config-newrelic-yaml-cm.yaml
+    template: templates/as-deployment.yaml
     asserts:
-      - isKind:
-          of: ConfigMap
-      - matchRegex:
-          path: data["newrelic.yml"]
-          pattern: .*(secret-license-test).*
-
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: NEW_RELIC_LICENSE_KEY
+            value: "secret-license-test"
+  - it: newrelic license key secret key ref
+    release:
+      name: icm-as
+    chart:
+      version: 0.8.15
+    values:
+      - ../values.yaml
+    set:
+      newrelic.enabled: true
+      newrelic.licenseKeySecretKeyRef.name: "your-company-prd-secrets"
+      newrelic.licenseKeySecretKeyRef.key: "secret-license-test"
+    template: templates/as-deployment.yaml
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: NEW_RELIC_LICENSE_KEY
+            valueFrom:
+              secretKeyRef:
+                key: secret-license-test
+                name: your-company-prd-secrets
+  - it: should take newrelic license key secret key ref precedence over plain text license key
+    release:
+      name: icm-as
+    chart:
+      version: 0.8.15
+    values:
+      - ../values.yaml
+    set:
+      newrelic.enabled: true
+      newrelic.license_key: "should-not-appear"
+      newrelic.licenseKeySecretKeyRef.name: "your-company-prd-secrets"
+      newrelic.licenseKeySecretKeyRef.key: "secret-license-test"
+    template: templates/as-deployment.yaml
+    asserts:
+      - contains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: NEW_RELIC_LICENSE_KEY
+            valueFrom:
+              secretKeyRef:
+                key: secret-license-test
+                name: your-company-prd-secrets
+      - notContains:
+          path: spec.template.spec.containers[0].env
+          content:
+            name: NEW_RELIC_LICENSE_KEY
+            value: "should-not-appear"
   - it: newrelic app_name from operationalContext (default values)
     release:
       name: icm-as
@@ -106,8 +153,7 @@ tests:
       - matchRegex:
           path: data["newrelic.yml"]
           pattern: ".*(app_name : \"n_a-int_01-icm-standalone\").*"
-
-  - it: newrelic custom app_name 
+  - it: newrelic custom app_name
     release:
       name: icm-as
     chart:

diff --git a/charts/icm-as/values.yaml b/charts/icm-as/values.yaml
@@ -80,7 +80,14 @@ newrelic:
   enabled: false
   #   application name (~= environment name): calculated from operationalContext section, set to override
   # app_name: "icm"
+  # provide license key as plain text
+  # "license_key" deprecated since ICM-AS Helm Charts 1.8.0, will be removed in a future version.
+  # Use licenseKeySecretKeyRef instead.
   license_key: "secret"
+  # instead use secret key reference (recommended) - takes precedence over license_key
+  # licenseKeySecretKeyRef:
+  #  name: <your-company-prd-secrets>
+  #  key: <licenseKey>
   metrics:
     # fine grade possibility to disable metrics for cost reduction
     enabled: true
@@ -155,7 +162,12 @@ database:
   # or for oracle "jdbc:oracle:thin:@<ipaddress or hostname>:1521:intershop"
   jdbcURL: "jdbc:sqlserver://<ipaddress or hostname>:1433;databaseName=intershop"
   jdbcUser: "intershop"
+  # provide pwd as plain text
   jdbcPassword: "intershop"
+  # instead use secret key reference (recommended) - takes precedence over jdbcPassword
+  # jdbcPasswordSecretKeyRef:
+  #  name: <your-company-prd-secrets>
+  #  key: <jdbcpasswd>
 
 # environment variables to be propagated to the icm-as-container
 environment:
@@ -248,7 +260,12 @@ mssql:
   saPassword: "1nstershop5A"
   databaseName: "icmdb"
   user: "icmdbuser"
+  # provide pwd as plain text
   password: "icmdbpassword"
+  # instead use secret key reference (recommended) - takes precedence over password
+  # passwordSecretKeyRef:
+  #  name: <your-company-prd-secrets>
+  #  key: <passwd>
   persistence:
     data:
       size: 5Gi

diff --git a/charts/icm-replication/.bumpversion.toml b/charts/icm-replication/.bumpversion.toml
@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "1.5.0"
+current_version = "1.6.0"
 
 [[tool.bumpversion.files]]
 filename = "Chart.yaml"

diff --git a/charts/icm-replication/Chart.yaml b/charts/icm-replication/Chart.yaml
@@ -3,16 +3,16 @@ appVersion: "11.0.0"
 description: Intershop Commerce Management - ICM Replication
 # name and version must be in this exact order, otherwise bump2version won't work
 name: icm-replication
-version: 1.5.0
+version: 1.6.0
 annotations:
   requestedMemoryQuota: 10Gi
   requestedCpuQuotaInMinutes: 2200
 dependencies:
   - name: icm
-    version: 1.8.0
+    version: 1.9.0
     repository: file://../icm
     alias: icm-live
   - name: icm
-    version: 1.8.0
+    version: 1.9.0
     repository: file://../icm
     alias: icm-edit
diff --git a/charts/icm/.bumpversion.toml b/charts/icm/.bumpversion.toml
@@ -1,5 +1,5 @@
 [tool.bumpversion]
-current_version = "1.8.0"
+current_version = "1.9.0"
 
 [[tool.bumpversion.files]]
 filename = "Chart.yaml"

diff --git a/charts/icm/Chart.yaml b/charts/icm/Chart.yaml
@@ -3,14 +3,14 @@ appVersion: "11.2.1"
 description: Intershop Commerce Management - ICM
 # name and version must be in this exact order, otherwise bump2version won't work
 name: icm
-version: 1.8.0
+version: 1.9.0
 # test related annotations
 annotations:
   requestedMemoryQuota: 5900Mi
   requestedCpuQuotaInMinutes: "2500"
 dependencies:
   - name: icm-as
-    version: 1.7.0
+    version: 1.8.0
     repository: file://../icm-as
   - name: icm-web
     version: 0.8.0