Merge branch 'main' into feat/214-Dataspace-Discovery-Service-handle-…

…multiple-EDC-Urls-received-for-BPN
eclipse-tractusx · Jan 31, 2024 · 8aa4c4b · 8aa4c4b
2 parents 672d797 + 49f1da9
commit 8aa4c4b
Show file tree

Hide file tree

Showing 15 changed files with 109 additions and 134 deletions.
diff --git a/README.md b/README.md
@@ -152,3 +152,13 @@ from the base distribution, along with any direct or indirect dependencies of th
 
 As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies
 with any relevant licenses for all software contained within.
+
+## Contact
+
+Contact the Eclipse Tractus-X developers via the developer mailing list.
+
+* https://accounts.eclipse.org/mailing-list/tractusx-dev
+
+Contact the project developers via eclipse matrix chat.
+
+* Eclipse Matrix Chat https://chat.eclipse.org/#/room/#tractusx-irs:matrix.eclipse.org
diff --git a/charts/irs-helm/CHANGELOG.md b/charts/irs-helm/CHANGELOG.md
@@ -5,11 +5,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-### Added
-- Added configuration parameters `oauth2.semantics.clientId`,`oauth2.semantics.clientSecret`, `oauth2.discovery.clientId`,`oauth2.discovery.clientSecret`, `oauth2.bpdm.clientId`,`oauth2.bpdm.clientSecret`
-
-### Removed
-- Removed configuration parameters `oauth2.clientId`,`oauth2.clientSecret`, `portal.oauth2.clientId`,`portal.oauth2.clientSecret`
 
 ## [6.13.0] - 2024-01-15
 - Update IRS version to 4.4.0

diff --git a/charts/irs-helm/templates/configmap-spring-app-config.yaml b/charts/irs-helm/templates/configmap-spring-app-config.yaml
@@ -56,21 +56,16 @@ data:
         oauth2:
           client:
             registration:
-              semantics:
-                client-id: "${SEMANTICS_OAUTH2_CLIENT_ID}" # taken from secret ENV
-                client-secret: "${SEMANTICS_OAUTH2_CLIENT_SECRET}" # taken from secret ENV
-              discovery:
-                client-id: ${DISCOVERY_OAUTH2_CLIENT_ID} # taken from secret ENV
-                client-secret: ${DISCOVERY_OAUTH2_CLIENT_SECRET} # taken from secret ENV
-              bpdm:
-                client-id: ${BPDM_OAUTH2_CLIENT_ID} # taken from secret ENV
-                client-secret: ${BPDM_OAUTH2_CLIENT_SECRET} # taken from secret ENV
+              common:
+                client-id: "${OAUTH2_CLIENT_ID}" # taken from secret ENV
+                client-secret: "${OAUTH2_CLIENT_SECRET}" # taken from secret ENV
+              portal:
+                client-id: ${PORTAL_OAUTH2_CLIENT_ID} # taken from secret ENV
+                client-secret: ${PORTAL_OAUTH2_CLIENT_SECRET} # taken from secret ENV
             provider:
-              semantics:
+              common:
                 token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }}
-              discovery:
-                token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }}
-              bpdm:
+              portal:
                 token-uri: {{ tpl (.Values.oauth2.clientTokenUri | default "http://localhost") . | quote }}
 
     digitalTwinRegistry:
@@ -134,7 +129,7 @@ data:
       irs:
         url: {{ tpl (.Values.irsUrl | default "") . | quote }}
       discovery:
-        oAuthClientId: {{ .Values.discovery.oAuthClientId | default "discovery" }}
+        oAuthClientId: {{ .Values.discovery.oAuthClientId | default "portal" }}
         {{- if .Values.ess.mockEdcResult }}
         mockEdcResult:
         {{- tpl (toYaml .Values.ess.mockEdcResult) . | nindent 10 }}

diff --git a/charts/irs-helm/templates/deployment.yaml b/charts/irs-helm/templates/deployment.yaml
@@ -81,36 +81,26 @@ spec:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
                   key: minioPassword
-            - name: SEMANTICS_OAUTH2_CLIENT_ID
+            - name: OAUTH2_CLIENT_ID
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: semanticsId
-            - name: SEMANTICS_OAUTH2_CLIENT_SECRET
+                  key: clientId
+            - name: OAUTH2_CLIENT_SECRET
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: semanticsSecret
-            - name: DISCOVERY_OAUTH2_CLIENT_ID
+                  key: clientSecret
+            - name: PORTAL_OAUTH2_CLIENT_ID
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: discoveryClientId
-            - name: DISCOVERY_OAUTH2_CLIENT_SECRET
+                  key: portalClientId
+            - name: PORTAL_OAUTH2_CLIENT_SECRET
               valueFrom:
                 secretKeyRef:
                   name: {{ template "irs.secretName" . }}
-                  key: discoveryClientSecret
-            - name: BPDM_OAUTH2_CLIENT_ID
-              valueFrom:
-                secretKeyRef:
-                  name: {{ template "irs.secretName" . }}
-                  key: bpdmClientId
-            - name: BPDM_OAUTH2_CLIENT_SECRET
-              valueFrom:
-                secretKeyRef:
-                  name: {{ template "irs.secretName" . }}
-                  key: bpdmClientSecret
+                  key: portalClientSecret
             - name: EDC_API_KEY_SECRET
               valueFrom:
                 secretKeyRef:

diff --git a/charts/irs-helm/templates/secrets.yaml b/charts/irs-helm/templates/secrets.yaml
@@ -35,12 +35,10 @@ type: Opaque
 data:
   minioUser: {{ .Values.minioUser | default "minio" | b64enc | quote }}
   minioPassword: {{ .Values.minioPassword | default "minioPass" | b64enc | quote }}
-  semanticsId: {{ .Values.oauth2.semantics.clientId | default "semanticsId" | b64enc | quote }}
-  semanticsSecret: {{ .Values.oauth2.semantics.clientSecret | default "semanticsSecret" | b64enc | quote }}
-  discoveryClientId: {{ .Values.oauth2.discovery.clientId | default "discoveryClientId" | b64enc | quote }}
-  discoveryClientSecret: {{ .Values.oauth2.discovery.clientSecret | default "discoveryClientSecret" | b64enc | quote }}
-  bpdmClientId: {{ .Values.oauth2.bpdm.clientId | default "bpdmClientId" | b64enc | quote }}
-  bpdmClientSecret: {{ .Values.oauth2.bpdm.clientSecret | default "bpdmClientSecret" | b64enc | quote }}
+  clientId: {{ .Values.oauth2.clientId | default "clientId" | b64enc | quote }}
+  clientSecret: {{ .Values.oauth2.clientSecret | default "clientSecret" | b64enc | quote }}
+  portalClientId: {{ .Values.portal.oauth2.clientId | default "portalClientId" | b64enc | quote }}
+  portalClientSecret: {{ .Values.portal.oauth2.clientSecret | default "portalClientSecret" | b64enc | quote }}
   edcApiSecret: {{ .Values.edc.controlplane.apikey.secret | toString | default "" | b64enc | quote }}
   {{- if .Values.grafana.enabled }}
   grafanaUser: {{ .Values.grafana.user | default "grafana" | b64enc | quote }}

diff --git a/charts/irs-helm/values.yaml b/charts/irs-helm/values.yaml
@@ -152,16 +152,13 @@ minioUser: "minio"  # <minio-username>
 minioPassword:  # <minio-password>
 minioUrl: "http://{{ .Release.Name }}-minio:9000"
 oauth2:
+  clientId:  # <oauth2-client-id>
+  clientSecret:  # <oauth2-client-secret>
   clientTokenUri:  # <oauth2-token-uri>
-  semantics:
-    clientId:  # <semantics-client-id>
-    clientSecret:  # <semantics-client-secret>
-  discovery:
-    clientId:  # <discovery-client-id>
-    clientSecret:  # <discovery-client-secret>
-  bpdm:
-    clientId:  # <bpdm-client-id>
-    clientSecret:  # <bpdm-client-secret>
+portal:
+  oauth2:
+    clientId:  # <portal-client-id>
+    clientSecret:  # <portal-client-secret>
 edc:
   controlplane:
     endpoint:
@@ -210,7 +207,7 @@ edc:
     cacheTTL: PT24H  # Time to live for ConnectorEndpointService for fetchConnectorEndpoints method cache
 
 discovery:
-  oAuthClientId: discovery  # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client
+  oAuthClientId: portal  # ID of the OAuth2 client registration to use, see config spring.security.oauth2.client
 
 ess:
   edc:

diff --git a/docs/logo/IRS_Logo.png b/docs/logo/IRS_Logo.png
diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml
@@ -7,7 +7,7 @@ info:
 servers:
   - url: http://localhost:8080
 security:
-  - api_key: []
+  - oAuth2: []
 paths:
   /ess/bpn/investigations:
     post:
@@ -58,7 +58,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Registers an IRS job to start an investigation if a given bpn is contained
         in a part chain of a given globalAssetId.
       tags:
@@ -123,7 +123,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Job with the requested jobId not found.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Return job with additional supplyChainImpacted information.
       tags:
         - Environmental and Social Standards
@@ -202,7 +202,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: "Registers an order for an ESS investigation with an array of {globalAssetIds}. 
       Each globalAssetId will be processed in an separate job, grouped in batches."
       tags:
@@ -292,7 +292,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Returns paginated jobs with state and execution times.
       tags:
         - Item Relationship Service
@@ -343,7 +343,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: "Register an IRS job to retrieve an item graph for given {globalAssetId}."
       tags:
         - Item Relationship Service
@@ -427,7 +427,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Job with the requested jobId not found.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Return job with optional item graph result for requested id.
       tags:
         - Item Relationship Service
@@ -492,7 +492,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Job for requested jobId not found.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Cancel job for requested jobId.
       tags:
         - Item Relationship Service
@@ -529,7 +529,7 @@ paths:
                 $ref: "#/components/schemas/ErrorResponse"
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Get all available aspect models from semantic hub or local models.
       tags:
         - Aspect Models
@@ -582,7 +582,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: "Registers an IRS order with an array of {globalAssetIds}.\
       \ Each globalAssetId will be processed in an IRS Job, grouped in batches."
       tags:
@@ -649,7 +649,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Batch Order with the requested orderId not found.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Get a batch order for a given orderId.
       tags:
         - Item Relationship Service
@@ -714,7 +714,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Batch Order with the requested orderId not found.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Cancel a batch order for a given orderId.
       tags:
         - Item Relationship Service
@@ -790,7 +790,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Batch with the requested orderId and batchId not found.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Get a batch with a given batchId for a given orderId.
       tags:
         - Item Relationship Service
@@ -826,7 +826,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Lists the registered policies that should be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
@@ -870,7 +870,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Register a policy that should be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
@@ -915,7 +915,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Removes a policy that should no longer be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
@@ -965,7 +965,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - api_key: []
+        - oAuth2: []
       summary: Updates an existing policy with new validUntil value.
       tags:
         - Item Relationship Service
@@ -2639,8 +2639,10 @@ components:
       required:
         - validUntil
   securitySchemes:
-    api_key:
-      description: Api Key access
-      in: header
-      name: X-API-KEY
-      type: apiKey
+    oAuth2:
+      flows:
+        clientCredentials:
+          scopes:
+            {}
+          tokenUrl: https://localhost
+      type: oauth2
diff --git a/docs/src/docs/administration/configuration.adoc b/docs/src/docs/administration/configuration.adoc
@@ -156,23 +156,11 @@ This is a list of all secrets used in the deployment.
 
 WARNING: Keep the values for these settings safe and do not publish them!
 
-=== <semantics-client-id>
-Semantic Hub client ID for OAuth2 provider. Request this from your OAuth2 operator.
+=== <common-client-id>
+Client ID for OAuth2 provider. Request this from your OAuth2 operator.
 
-=== <semantics-client-secret>
-Semantic Hub client secret for OAuth2 provider. Request this from your OAuth2 operator.
-
-=== <discovery-client-id>
-Dataspace Discovery  client ID for OAuth2 provider. Request this from your OAuth2 operator.
-
-=== <discovery-client-secret>
-Dataspace Discovery  client secret for OAuth2 provider. Request this from your OAuth2 operator.
-
-=== <bpdm-client-id>
-BPDM client ID for OAuth2 provider. Request this from your OAuth2 operator.
-
-=== <bpdm-client-secret>
-BPDM client secret for OAuth2 provider. Request this from your OAuth2 operator.
+=== <common-client-secret>
+Client secret for OAuth2 provider. Request this from your OAuth2 operator.
 
 === <minio-username>
 Login username for Minio. To be defined by you.