From ede85f19a404ef206ecf8c3149a6589285d5f819 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Thu, 28 Sep 2023 14:36:29 +0200 Subject: [PATCH 1/2] feat(docs):[TRI-1640] Add documentation on how to use IRS with external EDC --- .../docs/administration/configuration.adoc | 53 +++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/docs/src/docs/administration/configuration.adoc b/docs/src/docs/administration/configuration.adoc index c2564f8b5e..1cd9ca342b 100644 --- a/docs/src/docs/administration/configuration.adoc +++ b/docs/src/docs/administration/configuration.adoc @@ -24,6 +24,31 @@ include::../../../../charts/irs-helm/values.yaml[lines=104..287] ==== The hostname where the IRS will be made available. +=== +To expose the IRS service, you need to add an ingress for the default port 8080. +You can do this by adding this to ingress: + +[source,yaml] +---- +ingress: + enabled: true + className: "nginx" + annotations: + nginx.ingress.kubernetes.io/ssl-passthrough: "false" + nginx.ingress.kubernetes.io/backend-protocol: "HTTP" + nginx.ingress.kubernetes.io/force-ssl-redirect: "true" + hosts: + - host: "public.irs.hostname" + paths: + - path: / + pathType: Prefix + port: 8080 + tls: + - hosts: + - "public.irs.hostname" + secretName: tls-secret +---- + ==== The URL of the Digital Twin Registry. The IRS uses this service to fetch AAS shells. @@ -62,6 +87,34 @@ If you want to use local schema files, you need to provide them directly in the The *key* of each entry is the `Base64` encoded URN of the model. The *value* is the `Base64` encoded content of the schema file itself. The entries will then be mounted into the IRS container and used on demand. For reference, see the example comment in the default `values.yaml`. +== Use existing EDC consumer +If you want to use an existing EDC as consumer, you need to add the management endpoint URL of this edc to `edc.controlplane.endpoint.data`. +You also have to add an ingress for the IRS EDC EDR Token callback endpoint (default port: 8181): + +[source,yaml] +---- +ingress: + enabled: true + className: "nginx" + annotations: + nginx.ingress.kubernetes.io/ssl-passthrough: "false" + nginx.ingress.kubernetes.io/backend-protocol: "HTTP" + nginx.ingress.kubernetes.io/force-ssl-redirect: "true" + hosts: + - host: "public.irs.hostname" + paths: + - path: / + pathType: Prefix + port: 8080 + - path: /internal + port: 8181 + pathType: Prefix + tls: + - hosts: + - "public.irs.hostname" + secretName: tls-secret +---- + == EDC consumer configuration If you want to provide your own EDC consumer, add the EDC Helm Chart as dependency to your Chart.yaml. The helm chart and documentation can be found here: https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector[tractusx-connector] From 1a79d4359388f5d2ee769dadc732530e9af44ae0 Mon Sep 17 00:00:00 2001 From: Jaro Hartmann Date: Thu, 28 Sep 2023 16:37:18 +0200 Subject: [PATCH 2/2] feat(charts):[TRI-1640] Added toString template for 'edc.controlplane.apikey.secret' --- charts/irs-helm/CHANGELOG.md | 2 ++ charts/irs-helm/templates/secrets.yaml | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/charts/irs-helm/CHANGELOG.md b/charts/irs-helm/CHANGELOG.md index 0d49a8b0e2..8582a58453 100644 --- a/charts/irs-helm/CHANGELOG.md +++ b/charts/irs-helm/CHANGELOG.md @@ -5,6 +5,8 @@ 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] +### Changed +- Added toString template for `edc.controlplane.apikey.secret` ## [6.7.0] - 2023-09-28 ### Changed diff --git a/charts/irs-helm/templates/secrets.yaml b/charts/irs-helm/templates/secrets.yaml index d283cb3852..599e17c129 100644 --- a/charts/irs-helm/templates/secrets.yaml +++ b/charts/irs-helm/templates/secrets.yaml @@ -39,7 +39,7 @@ data: keycloakClientSecret: {{ .Values.keycloak.oauth2.clientSecret | default "keycloakClientSecret" | 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 | default "" | b64enc | quote }} + edcApiSecret: {{ .Values.edc.controlplane.apikey.secret | toString | default "" | b64enc | quote }} {{- if .Values.grafana.enabled }} grafanaUser: {{ .Values.grafana.user | default "grafana" | b64enc | quote }} grafanaPassword: {{ .Values.grafana.password | default "grafana" | b64enc | quote }}