refactor: Remove observability-api-customization and use upstream ext…

…ension (#553) * Remove observability-api-customization and use upstream extension. * Adapt also the other distributions. * - Regenerate charts README.md - Add changelog and migration info * fix markdown lint * fix markdown lint * fix format * trigger-ci
eclipse-tractusx · Jul 3, 2023 · 7819b9d · 7819b9d
1 parent 0e82830
commit 7819b9d
Show file tree

Hide file tree

Showing 43 changed files with 63 additions and 711 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Removed
+
+Removed the interim solution `observability-api-customization` and use the upstream extension `Observability API` instead
+
 ## [0.5.0-rc3] - 2023-06-30
 
 ### Fixed
@@ -22,7 +26,7 @@ Upgraded to EDC 0.1.2
 
 ## [0.5.0-rc1] - 2023-06-21
 
-## Fixed
+### Fixed
 
 Various fixes and improvements to our helm charts
 
@@ -31,11 +35,11 @@ Various fixes and improvements to our helm charts
 Support for SSI (centralized MiW) (#459, #510)
 Support for the JsonWebSignature2020 Crypto Suite (#483)
 
-## Changed
+### Changed
 
 All Helm charts now use SSI instead of DAPS (#511)
 
-## Removed
+### Removed
 
 Support for DAPS as identity provider (#511)
 

diff --git a/charts/tractusx-connector-azure-vault/README.md b/charts/tractusx-connector-azure-vault/README.md
@@ -78,7 +78,7 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0.
 | controlplane.debug.enabled | bool | `false` |  |
 | controlplane.debug.port | int | `1044` |  |
 | controlplane.debug.suspendOnStart | bool | `false` |  |
-| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"observability":{"insecure":true,"path":"/observability","port":8085},"protocol":{"path":"/api/v1/dsp","port":8084}}` | endpoints of the control plane |
+| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"protocol":{"path":"/api/v1/dsp","port":8084}}` | endpoints of the control plane |
 | controlplane.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not |
 | controlplane.endpoints.control.path | string | `"/control"` | path for incoming api calls |
 | controlplane.endpoints.control.port | int | `8083` | port for incoming api calls |
@@ -92,10 +92,6 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0.
 | controlplane.endpoints.metrics | object | `{"path":"/metrics","port":9090}` | metrics api, used for application metrics, must not be internet facing |
 | controlplane.endpoints.metrics.path | string | `"/metrics"` | path for incoming api calls |
 | controlplane.endpoints.metrics.port | int | `9090` | port for incoming api calls |
-| controlplane.endpoints.observability | object | `{"insecure":true,"path":"/observability","port":8085}` | observability api with unsecured access, must not be internet facing |
-| controlplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication |
-| controlplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints |
-| controlplane.endpoints.observability.port | int | `8085` | port for incoming API calls |
 | controlplane.endpoints.protocol | object | `{"path":"/api/v1/dsp","port":8084}` | ids api, used for inter connector communication and must be internet facing |
 | controlplane.endpoints.protocol.path | string | `"/api/v1/dsp"` | path for incoming api calls |
 | controlplane.endpoints.protocol.port | int | `8084` | port for incoming api calls |
@@ -193,9 +189,6 @@ helm install my-release tractusx-edc/tractusx-connector-azure-vault --version 0.
 | dataplane.endpoints.default.port | int | `8080` |  |
 | dataplane.endpoints.metrics.path | string | `"/metrics"` |  |
 | dataplane.endpoints.metrics.port | int | `9090` |  |
-| dataplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication |
-| dataplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints |
-| dataplane.endpoints.observability.port | int | `8085` | port for incoming API calls |
 | dataplane.endpoints.proxy.path | string | `"/proxy"` |  |
 | dataplane.endpoints.proxy.port | int | `8186` |  |
 | dataplane.endpoints.public.path | string | `"/api/public"` |  |

diff --git a/charts/tractusx-connector-azure-vault/templates/deployment-controlplane.yaml b/charts/tractusx-connector-azure-vault/templates/deployment-controlplane.yaml
@@ -76,8 +76,8 @@ spec:
           {{- if .Values.controlplane.livenessProbe.enabled }}
           livenessProbe:
             httpGet:
-              path: {{ .Values.controlplane.endpoints.observability.path }}/check/liveness
-              port: {{ .Values.controlplane.endpoints.observability.port }}
+              path: {{ .Values.controlplane.endpoints.default.path }}/check/liveness
+              port: {{ .Values.controlplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.controlplane.livenessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.controlplane.livenessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.controlplane.livenessProbe.timeoutSeconds }}
@@ -87,8 +87,8 @@ spec:
           {{- if .Values.controlplane.readinessProbe.enabled }}
           readinessProbe:
             httpGet:
-              path: {{ .Values.controlplane.endpoints.observability.path }}/check/readiness
-              port: {{ .Values.controlplane.endpoints.observability.port }}
+              path: {{ .Values.controlplane.endpoints.default.path }}/check/readiness
+              port: {{ .Values.controlplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.controlplane.readinessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.controlplane.readinessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.controlplane.readinessProbe.timeoutSeconds }}
@@ -152,12 +152,6 @@ spec:
               value: {{ .Values.controlplane.endpoints.protocol.port | quote }}
             - name: "WEB_HTTP_PROTOCOL_PATH"
               value: {{ .Values.controlplane.endpoints.protocol.path | quote }}
-            - name: "WEB_HTTP_OBSERVABILITY_PORT"
-              value: {{ .Values.controlplane.endpoints.observability.port | quote}}
-            - name: "WEB_HTTP_OBSERVABILITY_PATH"
-              value: {{ .Values.controlplane.endpoints.observability.path | quote}}
-            - name: "TRACTUSX_API_OBSERVABILITY_ALLOW-INSECURE"
-              value: {{ .Values.controlplane.endpoints.observability.insecure | quote }}
 
             #########
             ## DSP ##

diff --git a/charts/tractusx-connector-azure-vault/templates/deployment-dataplane.yaml b/charts/tractusx-connector-azure-vault/templates/deployment-dataplane.yaml
@@ -74,8 +74,8 @@ spec:
           {{- if .Values.dataplane.livenessProbe.enabled }}
           livenessProbe:
             httpGet:
-              path: {{ .Values.dataplane.endpoints.observability.path }}/check/liveness
-              port: {{ .Values.dataplane.endpoints.observability.port }}
+              path: {{ .Values.dataplane.endpoints.default.path }}/check/liveness
+              port: {{ .Values.dataplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.dataplane.livenessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.dataplane.livenessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.dataplane.livenessProbe.timeoutSeconds }}
@@ -85,8 +85,8 @@ spec:
           {{- if .Values.dataplane.readinessProbe.enabled }}
           readinessProbe:
             httpGet:
-              path: {{ .Values.dataplane.endpoints.observability.path }}/check/readiness
-              port: {{ .Values.dataplane.endpoints.observability.port }}
+              path: {{ .Values.dataplane.endpoints.default.path }}/check/readiness
+              port: {{ .Values.dataplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.dataplane.readinessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.dataplane.readinessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.dataplane.readinessProbe.timeoutSeconds }}
@@ -124,12 +124,6 @@ spec:
               value: {{ .Values.dataplane.endpoints.public.path | quote }}
             - name: "EDC_DATAPLANE_TOKEN_VALIDATION_ENDPOINT"
               value: {{ include "txdc.controlplane.url.validation" .}}
-            - name: "WEB_HTTP_OBSERVABILITY_PORT"
-              value: {{ .Values.dataplane.endpoints.observability.port | quote }}
-            - name: "WEB_HTTP_OBSERVABILITY_PATH"
-              value: {{ .Values.dataplane.endpoints.observability.path | quote }}
-            - name: "TRACTUSX_API_OBSERVABILITY_ALLOW-INSECURE"
-              value: {{ .Values.dataplane.endpoints.observability.insecure | quote }}
 
             #######
             # AWS #

diff --git a/charts/tractusx-connector-azure-vault/templates/service-controlplane.yaml b/charts/tractusx-connector-azure-vault/templates/service-controlplane.yaml
@@ -51,9 +51,5 @@ spec:
       targetPort: metrics
       protocol: TCP
       name: metrics
-    - port: {{ .Values.controlplane.endpoints.observability.port}}
-      targetPort: observability
-      protocol: TCP
-      name: observability
   selector:
     {{- include "txdc.controlplane.selectorLabels" . | nindent 4 }}
diff --git a/charts/tractusx-connector-azure-vault/templates/service-dataplane.yaml b/charts/tractusx-connector-azure-vault/templates/service-dataplane.yaml
@@ -40,10 +40,6 @@ spec:
       targetPort: public
       protocol: TCP
       name: public
-    - port: {{ .Values.dataplane.endpoints.observability.port }}
-      targetPort: observability
-      protocol: TCP
-      name: observability
     - port: {{ .Values.dataplane.endpoints.metrics.port }}
       targetPort: metrics
       protocol: TCP

diff --git a/charts/tractusx-connector-azure-vault/templates/tests/test-controlplane-readiness.yaml b/charts/tractusx-connector-azure-vault/templates/tests/test-controlplane-readiness.yaml
@@ -32,5 +32,5 @@ spec:
     - name: wget
       image: curlimages/curl
       command: [ 'curl' ]
-      args: [ '{{- printf "http://%s-controlplane:%v%s/check/readiness" (include "txdc.fullname" $ ) $.Values.controlplane.endpoints.observability.port $.Values.controlplane.endpoints.observability.path -}}' ]
+      args: [ '{{- printf "http://%s-controlplane:%v%s/check/readiness" (include "txdc.fullname" $ ) $.Values.controlplane.endpoints.default.port $.Values.controlplane.endpoints.default.path -}}' ]
   restartPolicy: Never
diff --git a/charts/tractusx-connector-azure-vault/templates/tests/test-dataplane-readiness.yaml b/charts/tractusx-connector-azure-vault/templates/tests/test-dataplane-readiness.yaml
@@ -32,5 +32,5 @@ spec:
     - name: wget
       image: curlimages/curl
       command: [ 'curl' ]
-      args: [ '{{- printf "http://%s-dataplane:%v%s/check/readiness" (include "txdc.fullname" $ ) $.Values.dataplane.endpoints.observability.port $.Values.dataplane.endpoints.observability.path -}}' ]
+      args: [ '{{- printf "http://%s-dataplane:%v%s/check/readiness" (include "txdc.fullname" $ ) $.Values.dataplane.endpoints.default.port $.Values.dataplane.endpoints.default.path -}}' ]
   restartPolicy: Never
diff --git a/charts/tractusx-connector-azure-vault/values.yaml b/charts/tractusx-connector-azure-vault/values.yaml
@@ -118,14 +118,7 @@ controlplane:
       port: 9090
       # -- path for incoming api calls
       path: /metrics
-    # -- observability api with unsecured access, must not be internet facing
-    observability:
-      # -- port for incoming API calls
-      port: 8085
-      # -- observability api, provides /health /readiness and /liveness endpoints
-      path: /observability
-      # -- allow or disallow insecure access, i.e. access without authentication
-      insecure: true
+
   businessPartnerValidation:
     log:
       agreementValidation: true
@@ -356,13 +349,6 @@ dataplane:
     proxy:
       port: 8186
       path: /proxy
-    observability:
-      # -- port for incoming API calls
-      port: 8085
-      # -- observability api, provides /health /readiness and /liveness endpoints
-      path: /observability
-      # -- allow or disallow insecure access, i.e. access without authentication
-      insecure: true
     metrics:
       port: 9090
       path: /metrics

diff --git a/charts/tractusx-connector-legacy/README.md b/charts/tractusx-connector-legacy/README.md
@@ -73,7 +73,7 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.5.0-rc3 \
 | controlplane.debug.enabled | bool | `false` |  |
 | controlplane.debug.port | int | `1044` |  |
 | controlplane.debug.suspendOnStart | bool | `false` |  |
-| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"observability":{"insecure":true,"path":"/observability","port":8085},"protocol":{"path":"/api/v1/dsp","port":8084}}` | endpoints of the control plane |
+| controlplane.endpoints | object | `{"control":{"path":"/control","port":8083},"default":{"path":"/api","port":8080},"management":{"authKey":"","path":"/management","port":8081},"metrics":{"path":"/metrics","port":9090},"protocol":{"path":"/api/v1/dsp","port":8084}}` | endpoints of the control plane |
 | controlplane.endpoints.control | object | `{"path":"/control","port":8083}` | control api, used for internal control calls. can be added to the internal ingress, but should probably not |
 | controlplane.endpoints.control.path | string | `"/control"` | path for incoming api calls |
 | controlplane.endpoints.control.port | int | `8083` | port for incoming api calls |
@@ -87,10 +87,6 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.5.0-rc3 \
 | controlplane.endpoints.metrics | object | `{"path":"/metrics","port":9090}` | metrics api, used for application metrics, must not be internet facing |
 | controlplane.endpoints.metrics.path | string | `"/metrics"` | path for incoming api calls |
 | controlplane.endpoints.metrics.port | int | `9090` | port for incoming api calls |
-| controlplane.endpoints.observability | object | `{"insecure":true,"path":"/observability","port":8085}` | observability api with unsecured access, must not be internet facing |
-| controlplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication |
-| controlplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints |
-| controlplane.endpoints.observability.port | int | `8085` | port for incoming API calls |
 | controlplane.endpoints.protocol | object | `{"path":"/api/v1/dsp","port":8084}` | ids api, used for inter connector communication and must be internet facing |
 | controlplane.endpoints.protocol.path | string | `"/api/v1/dsp"` | path for incoming api calls |
 | controlplane.endpoints.protocol.port | int | `8084` | port for incoming api calls |
@@ -191,9 +187,6 @@ helm install my-release tractusx-edc/tractusx-connector --version 0.5.0-rc3 \
 | dataplane.endpoints.default.port | int | `8080` |  |
 | dataplane.endpoints.metrics.path | string | `"/metrics"` |  |
 | dataplane.endpoints.metrics.port | int | `9090` |  |
-| dataplane.endpoints.observability.insecure | bool | `true` | allow or disallow insecure access, i.e. access without authentication |
-| dataplane.endpoints.observability.path | string | `"/observability"` | observability api, provides /health /readiness and /liveness endpoints |
-| dataplane.endpoints.observability.port | int | `8085` | port for incoming API calls |
 | dataplane.endpoints.proxy.path | string | `"/proxy"` |  |
 | dataplane.endpoints.proxy.port | int | `8186` |  |
 | dataplane.endpoints.public.path | string | `"/api/public"` |  |

diff --git a/charts/tractusx-connector-legacy/templates/deployment-controlplane.yaml b/charts/tractusx-connector-legacy/templates/deployment-controlplane.yaml
@@ -76,8 +76,8 @@ spec:
           {{- if .Values.controlplane.livenessProbe.enabled }}
           livenessProbe:
             httpGet:
-              path: {{ .Values.controlplane.endpoints.observability.path }}/check/liveness
-              port: {{ .Values.controlplane.endpoints.observability.port }}
+              path: {{ .Values.controlplane.endpoints.default.path }}/check/liveness
+              port: {{ .Values.controlplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.controlplane.livenessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.controlplane.livenessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.controlplane.livenessProbe.timeoutSeconds }}
@@ -87,8 +87,8 @@ spec:
           {{- if .Values.controlplane.readinessProbe.enabled }}
           readinessProbe:
             httpGet:
-              path: {{ .Values.controlplane.endpoints.observability.path }}/check/readiness
-              port: {{ .Values.controlplane.endpoints.observability.port }}
+              path: {{ .Values.controlplane.endpoints.default.path }}/check/readiness
+              port: {{ .Values.controlplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.controlplane.readinessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.controlplane.readinessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.controlplane.readinessProbe.timeoutSeconds }}
@@ -152,12 +152,6 @@ spec:
               value: {{ .Values.controlplane.endpoints.protocol.port | quote }}
             - name: "WEB_HTTP_PROTOCOL_PATH"
               value: {{ .Values.controlplane.endpoints.protocol.path | quote }}
-            - name: "WEB_HTTP_OBSERVABILITY_PORT"
-              value: {{ .Values.controlplane.endpoints.observability.port | quote}}
-            - name: "WEB_HTTP_OBSERVABILITY_PATH"
-              value: {{ .Values.controlplane.endpoints.observability.path | quote}}
-            - name: "TRACTUSX_API_OBSERVABILITY_ALLOW-INSECURE"
-              value: {{ .Values.controlplane.endpoints.observability.insecure | quote }}
 
             #########
             ## DSP ##

diff --git a/charts/tractusx-connector-legacy/templates/deployment-dataplane.yaml b/charts/tractusx-connector-legacy/templates/deployment-dataplane.yaml
@@ -74,8 +74,8 @@ spec:
           {{- if .Values.dataplane.livenessProbe.enabled }}
           livenessProbe:
             httpGet:
-              path: {{ .Values.dataplane.endpoints.observability.path }}/check/liveness
-              port: {{ .Values.dataplane.endpoints.observability.port }}
+              path: {{ .Values.dataplane.endpoints.default.path }}/check/liveness
+              port: {{ .Values.dataplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.dataplane.livenessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.dataplane.livenessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.dataplane.livenessProbe.timeoutSeconds }}
@@ -85,8 +85,8 @@ spec:
           {{- if .Values.dataplane.readinessProbe.enabled }}
           readinessProbe:
             httpGet:
-              path: {{ .Values.dataplane.endpoints.observability.path }}/check/readiness
-              port: {{ .Values.dataplane.endpoints.observability.port }}
+              path: {{ .Values.dataplane.endpoints.default.path }}/check/readiness
+              port: {{ .Values.dataplane.endpoints.default.port }}
             initialDelaySeconds: {{ .Values.dataplane.readinessProbe.initialDelaySeconds }}
             periodSeconds: {{ .Values.dataplane.readinessProbe.periodSeconds }}
             timeoutSeconds: {{ .Values.dataplane.readinessProbe.timeoutSeconds }}
@@ -124,12 +124,6 @@ spec:
               value: {{ .Values.dataplane.endpoints.public.path | quote }}
             - name: "EDC_DATAPLANE_TOKEN_VALIDATION_ENDPOINT"
               value: {{ include "txdc.controlplane.url.validation" .}}
-            - name: "WEB_HTTP_OBSERVABILITY_PORT"
-              value: {{ .Values.dataplane.endpoints.observability.port | quote }}
-            - name: "WEB_HTTP_OBSERVABILITY_PATH"
-              value: {{ .Values.dataplane.endpoints.observability.path | quote }}
-            - name: "TRACTUSX_API_OBSERVABILITY_ALLOW-INSECURE"
-              value: {{ .Values.dataplane.endpoints.observability.insecure | quote }}
 
             #######
             # AWS #

diff --git a/charts/tractusx-connector-legacy/templates/service-controlplane.yaml b/charts/tractusx-connector-legacy/templates/service-controlplane.yaml
@@ -51,9 +51,5 @@ spec:
       targetPort: metrics
       protocol: TCP
       name: metrics
-    - port: {{ .Values.controlplane.endpoints.observability.port}}
-      targetPort: observability
-      protocol: TCP
-      name: observability
   selector:
     {{- include "txdc.controlplane.selectorLabels" . | nindent 4 }}
diff --git a/charts/tractusx-connector-legacy/templates/service-dataplane.yaml b/charts/tractusx-connector-legacy/templates/service-dataplane.yaml
@@ -43,10 +43,6 @@ spec:
       targetPort: public
       protocol: TCP
       name: public
-    - port: {{ .Values.dataplane.endpoints.observability.port }}
-      targetPort: observability
-      protocol: TCP
-      name: observability
     - port: {{ .Values.dataplane.endpoints.metrics.port }}
       targetPort: metrics
       protocol: TCP

diff --git a/charts/tractusx-connector-legacy/templates/tests/test-controlplane-readiness.yaml b/charts/tractusx-connector-legacy/templates/tests/test-controlplane-readiness.yaml
@@ -32,5 +32,5 @@ spec:
     - name: wget
       image: curlimages/curl
       command: [ 'curl' ]
-      args: [ '{{- printf "http://%s-controlplane:%v%s/check/readiness" (include "txdc.fullname" $ ) $.Values.controlplane.endpoints.observability.port $.Values.controlplane.endpoints.observability.path -}}' ]
+      args: [ '{{- printf "http://%s-controlplane:%v%s/check/readiness" (include "txdc.fullname" $ ) $.Values.controlplane.endpoints.default.port $.Values.controlplane.endpoints.default.path -}}' ]
   restartPolicy: Never