Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: enable environment variables for frontend #438

Merged
merged 2 commits into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

New features, fixed bugs, known defects and other noteworthy changes to each release of the Catena-X Portal helm chart.

## Unreleased

### Change

* frontend environment variables
* added client id value for BPDM
* moved clearinghouseConnectDisabled from backend to global
* exported additional environment variables for frontend
* CLEARINGHOUSE_CONNECT_DISABLED
* CLIENT_ID_REGISTRATION
* CLIENT_ID_BPDM

## 2.3.0-alpha.1

### Change
Expand Down
2 changes: 1 addition & 1 deletion charts/localdev/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,7 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi
| portal.sdfactoryAddress | string | `"http://sdfactory.tx.test"` | |
| portal.clearinghouseAddress | string | `"http://validation.tx.test"` | |
| portal.clearinghouseTokenAddress | string | `"http://keycloak.tx.test/realms/example/protocol/openid-connect/token"` | |
| portal.clearinghouseConnectDisabled | bool | `false` | |
| portal.issuerComponentAddress | string | `"http://ssi-credential-issuer.tx.test"` | |
| portal.bpnDidResolver.managementApiAddress | string | `"http://bpn-did-resolution-service-bdrs-server:8081"` | |
| portal.bpnDidResolver.directoryApiAddress | string | `"http://bpn-did-resolution-service.tx.test/api/directory"` | |
Expand Down Expand Up @@ -672,7 +673,6 @@ See [cert-manager self-signed](https://cert-manager.io/docs/configuration/selfsi
| portal.backend.processesworker.onboardingServiceProvider.encryptionConfigs.index1.encryptionKey | string | `"8027152fe7a869c88acc86981760acd70ff1d660c2bd129eece94edef933caf7"` | |
| portal.backend.processesworker.invitation.encryptionConfigs.index0.encryptionKey | string | `"d84fea29d6eac0fa51e36682b164e7d61693cd4202ed04306d2d9c5d46655e2c"` | |
| portal.backend.processesworker.mailing.encryptionConfigs.index0.encryptionKey | string | `"d2e27d71b018cb36029184852f1baa3e26891be94718f77de4c7cc6c882fe317"` | |
| portal.backend.processesworker.clearinghouseConnectDisabled | bool | `false` | |
| portal.backend.mailing.host | string | `"smtp.tx.test"` | |
| portal.backend.mailing.port | string | `"587"` | |
| portal.backend.mailing.user | string | `"smtp-user"` | |
Expand Down
2 changes: 1 addition & 1 deletion charts/localdev/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ portal:
sdfactoryAddress: "http://sdfactory.tx.test"
clearinghouseAddress: "http://validation.tx.test"
clearinghouseTokenAddress: "http://keycloak.tx.test/realms/example/protocol/openid-connect/token"
clearinghouseConnectDisabled: false
issuerComponentAddress: "http://ssi-credential-issuer.tx.test"
bpnDidResolver:
managementApiAddress: "http://bpn-did-resolution-service-bdrs-server:8081"
Expand Down Expand Up @@ -197,7 +198,6 @@ portal:
encryptionConfigs:
index0:
encryptionKey: "d2e27d71b018cb36029184852f1baa3e26891be94718f77de4c7cc6c882fe317"
clearinghouseConnectDisabled: false
mailing:
host: "smtp.tx.test"
port: "587"
Expand Down
2 changes: 1 addition & 1 deletion charts/portal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ dependencies:
| sdfactoryAddress | string | `"https://sdfactory.example.org"` | Provide sdfactory base address. |
| clearinghouseAddress | string | `"https://validation.example.org"` | Provide clearinghouse base address. |
| clearinghouseTokenAddress | string | `"https://keycloak.example.org/realms/example/protocol/openid-connect/token"` | Provide clearinghouse token address. |
| clearinghouseConnectDisabled | bool | `false` | if set to true the self description document creation will be skipped for company registrations as well as connector registrations |
| issuerComponentAddress | string | `"https://ssi-credential-issuer.example.org"` | Provide issuer component base address |
| bpnDidResolver | object | `{"directoryApiAddress":"https://bpn-did-resolution-service.example.org/api/directory","managementApiAddress":"http://bpn-did-resolution-service-bdrs-server:8081"}` | Provide details about the BPN DID Resolver. |
| bpnDidResolver.managementApiAddress | string | `"http://bpn-did-resolution-service-bdrs-server:8081"` | Provide management api base address |
Expand Down Expand Up @@ -500,7 +501,6 @@ dependencies:
| backend.processesworker.mailing.encryptionConfigs.index0.cipherMode | string | `"CBC"` | |
| backend.processesworker.mailing.encryptionConfigs.index0.paddingMode | string | `"PKCS7"` | |
| backend.processesworker.mailing.encryptionConfigs.index0.encryptionKey | string | `""` | EncryptionKey to encrypt the parameters of mailing processes. Secret-key 'mailing-encryption-key0'. Expected format is 256 bit (64 digits) hex. |
| backend.processesworker.clearinghouseConnectDisabled | bool | `false` | if set to true the self description document creation will be skipped for company registrations as well as connector registrations |
| backend.placeholder | string | `"empty"` | |
| postgresql.enabled | bool | `true` | PostgreSQL chart configuration Switch to enable or disable the PostgreSQL helm chart |
| postgresql.image | object | `{"tag":"15-debian-11"}` | Setting image tag to major to get latest minor updates |
Expand Down
2 changes: 1 addition & 1 deletion charts/portal/templates/cronjob-backend-processes.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ spec:
- name: "APPLICATIONCHECKLIST__SDFACTORY__USERNAME"
value: "{{ .Values.backend.placeholder }}"
- name: "APPLICATIONCHECKLIST__SDFACTORY__CLEARINGHOUSECONNECTDISABLED"
value: "{{ .Values.backend.processesworker.clearinghouseConnectDisabled }}"
value: "{{ .Values.clearinghouseConnectDisabled }}"
- name: "APPLICATIONCHECKLIST__DIM__USERNAME"
value: "{{ .Values.backend.placeholder }}"
- name: "APPLICATIONCHECKLIST__DIM__PASSWORD"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ spec:
- name: "APPLICATIONCHECKLIST__SDFACTORY__SDFACTORYURL"
value: "{{ .Values.sdfactoryAddress }}{{ .Values.backend.processesworker.sdfactory.selfdescriptionPath }}"
- name: "APPLICATIONCHECKLIST__SDFACTORY__CLEARINGHOUSECONNECTDISABLED"
value: "{{ .Values.backend.processesworker.clearinghouseConnectDisabled }}"
value: "{{ .Values.clearinghouseConnectDisabled }}"
- name: "APPLICATIONCHECKLIST__SDFACTORY__USERNAME"
value: "{{ .Values.backend.placeholder }}"
- name: "APPLICATIONCHECKLIST__DIM__USERNAME"
Expand Down Expand Up @@ -281,7 +281,7 @@ spec:
- name: "CONNECTORS__SELFDESCRIPTIONDOCUMENTURL"
value: "{{ .Values.portalBackendAddress }}{{ .Values.backend.administration.connectors.selfDescriptionDocumentPath }}"
- name: "CONNECTORS__CLEARINGHOUSECONNECTDISABLED"
value: "{{ .Values.backend.processesworker.clearinghouseConnectDisabled }}"
value: "{{ .Values.clearinghouseConnectDisabled }}"
- name: "DOCUMENT__ENABLESEEDENDPOINT"
value: "True"
- name: "DOCUMENT__FRAMEDOCUMENTTYPEIDS__0"
Expand Down Expand Up @@ -448,7 +448,7 @@ spec:
- name: "REGISTRATION__USEDIMWALLET"
value: "{{ .Values.backend.useDimWallet }}"
- name: "REGISTRATION__CLEARINGHOUSECONNECTDISABLED"
value: "{{ .Values.backend.processesworker.clearinghouseConnectDisabled }}"
value: "{{ .Values.clearinghouseConnectDisabled }}"
- name: "SERVICEACCOUNT__CLIENTID"
value: "{{ .Values.backend.administration.serviceAccount.clientId }}"
- name: "SERVICEACCOUNT__ENCRYPTIONCONFIGINDEX"
Expand Down
6 changes: 6 additions & 0 deletions charts/portal/templates/deployment-frontend-portal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ spec:
env:
- name: REQUIRE_HTTPS_URL_PATTERN
value: "{{ .Values.frontend.portal.requireHttpsUrlPattern }}"
- name: CLEARINGHOUSE_CONNECT_DISABLED
value: "{{ .Values.clearinghouseConnectDisabled }}"
- name: PORTAL_ASSETS_URL
value: "{{ .Values.portalAddress }}{{ .Values.frontend.assets.path }}"
- name: PORTAL_BACKEND_URL
Expand All @@ -78,10 +80,14 @@ spec:
value: "{{ .Values.centralidp.realm }}"
- name: CLIENT_ID
value: "{{ .Values.centralidp.clients.portal }}"
- name: CLIENT_ID_REGISTRATION
value: "{{ .Values.centralidp.clients.registration }}"
- name: CLIENT_ID_SEMANTIC
value: "{{ .Values.centralidp.clients.semantic }}"
- name: CLIENT_ID_MIW
value: "{{ .Values.centralidp.clients.miw }}"
- name: CLIENT_ID_BPDM
value: "{{ .Values.centralidp.clients.bpdm }}"
- name: CLIENT_ID_SSI_CREDENTIAL
value: "{{ .Values.centralidp.clients.issuerComponent }}"
ports:
Expand Down
5 changes: 3 additions & 2 deletions charts/portal/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ centralidp:
registration: "Cl1-CX-Registration"
semantic: "Cl3-CX-Semantic"
miw: "Cl5-CX-Custodian"
bpdm: "Cl7-CX-BPDM"
technicalRolesManagement: "technical_roles_management"
issuerComponent: "Cl24-CX-SSI-CredentialIssuer"

Expand Down Expand Up @@ -63,6 +64,8 @@ sdfactoryAddress: "https://sdfactory.example.org"
clearinghouseAddress: "https://validation.example.org"
# -- Provide clearinghouse token address.
clearinghouseTokenAddress: "https://keycloak.example.org/realms/example/protocol/openid-connect/token"
# -- if set to true the self description document creation will be skipped for company registrations as well as connector registrations
clearinghouseConnectDisabled: false

# -- Provide issuer component base address
issuerComponentAddress: "https://ssi-credential-issuer.example.org"
Expand Down Expand Up @@ -953,8 +956,6 @@ backend:
# -- EncryptionKey to encrypt the parameters of mailing processes. Secret-key 'mailing-encryption-key0'.
# Expected format is 256 bit (64 digits) hex.
encryptionKey: ""
# -- if set to true the self description document creation will be skipped for company registrations as well as connector registrations
clearinghouseConnectDisabled: false
placeholder: "empty"

postgresql:
Expand Down