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

chore: update cx-central realm config and release 3.0.0-rc.1 #91

Merged
merged 7 commits into from
Apr 11, 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
2 changes: 2 additions & 0 deletions .github/workflows/centralidp-chart-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ on:
push:
paths:
- 'charts/centralidp/**'
- 'import/**'
branches: [ main ]
pull_request:
paths:
- 'charts/centralidp/**'
- 'import/**'
workflow_dispatch:
inputs:
node_image:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ jobs:
uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
with:
context: .
file: {{ matrix.dockerfile }}
file: ${{ matrix.dockerfile }}
platforms: linux/amd64, linux/arm64
pull: true
push: ${{ github.event_name != 'pull_request' }}
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/sharedidp-chart-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@ on:
push:
paths:
- 'charts/sharedidp/**'
- 'import/**'
branches: [ main ]
pull_request:
paths:
- 'charts/sharedidp/**'
- 'import/**'
workflow_dispatch:
inputs:
node_image:
Expand Down
23 changes: 21 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

New features, fixed bugs, known defects and other noteworthy changes to each release of the Catena-X IAM * Keycloak instances.

## 3.0.0-rc.1

### Change

* [upgraded to Keycloak v23.0.7](https://github.com/eclipse-tractusx/portal-iam/issues/62)
* realm configuration (centralidp) - [updated CX-Central realm](https://github.com/eclipse-tractusx/portal-iam/issues/66)
* set postgres version of chart dependency to 15 (changed to major tag for image to get latest minor updates)
* set resource limits and increased requests for seeding job (centralidp)
* changed imagePullPolicy for initContainers to IfNotPresent

### Technical Support

* [added dependabot.yml file](https://github.com/eclipse-tractusx/portal/issues/219)
* [upgraded gh-actions and changed to pinned commit sha](https://github.com/eclipse-tractusx/portal/issues/225)
* helm test: updated version to upgrade from and k8s version
* helm-test: build images for init containers within workflow [(#89)](https://github.com/eclipse-tractusx/portal-iam/pull/89)
* combined helm chart release and image build for init containers [(#89)](https://github.com/eclipse-tractusx/portal-iam/pull/89)
* changed image build workflows for init containers: refactor those workflows to be only relevant for development phase, no latest tag anymore

Please be aware that **this version is still in Release Candidate phase**: especially documentation is still WIP.

## 2.1.0

### Change
Expand Down Expand Up @@ -74,8 +95,6 @@ The following issues were recently discovered:
* Refresh token rotation causes page reload in frontend apps when using multiple tabs, see [User Token Lifespan](docs/consultation/workshop-20231005.md#user-token-lifespan)
* Custom login themes break when inserting HTML/CSS/JavaScript code in the IdP display name

Please be aware that **this version is still in Release Candidate phase**: especially documentation is still WIP.

## 2.0.0

### Change
Expand Down
30 changes: 19 additions & 11 deletions charts/centralidp/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Helm chart for Catena-X Central Keycloak Instance
# Helm chart for Central Keycloak Instance

![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 22.0.3](https://img.shields.io/badge/AppVersion-22.0.3-informational?style=flat-square)
![Version: 3.0.0-rc.1](https://img.shields.io/badge/Version-3.0.0--rc.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 23.0.7](https://img.shields.io/badge/AppVersion-23.0.7-informational?style=flat-square)

This helm chart installs the Helm chart for Catena-X Central Keycloak Instance.
This helm chart installs the Helm chart for Central Keycloak Instance.

For further information please refer to the [technical documentation](../../docs/technical%20documentation).

Expand All @@ -29,14 +29,14 @@ To use the helm chart as a dependency:
dependencies:
- name: centralidp
repository: https://eclipse-tractusx.github.io/charts/dev
version: 2.1.0
version: 3.0.0-rc.1
```

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami | keycloak | 16.1.6 |
| https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami | keycloak | 19.3.0 |

## Values

Expand All @@ -59,8 +59,8 @@ dependencies:
| keycloak.extraVolumeMounts[1].name | string | `"realms"` | |
| keycloak.extraVolumeMounts[1].mountPath | string | `"/realms"` | |
| keycloak.initContainers[0].name | string | `"import"` | |
| keycloak.initContainers[0].image | string | `"docker.io/tractusx/portal-iam:v2.1.0"` | |
| keycloak.initContainers[0].imagePullPolicy | string | `"Always"` | |
| keycloak.initContainers[0].image | string | `"docker.io/tractusx/portal-iam:v3.0.0-rc.1"` | |
| keycloak.initContainers[0].imagePullPolicy | string | `"IfNotPresent"` | |
| keycloak.initContainers[0].command[0] | string | `"sh"` | |
| keycloak.initContainers[0].args[0] | string | `"-c"` | |
| keycloak.initContainers[0].args[1] | string | `"echo \"Copying themes...\"\ncp -R /import/themes/catenax-central/* /themes\necho \"Copying realms...\"\ncp -R /import/catenax-central/realms/* /realms\n"` | |
Expand Down Expand Up @@ -88,6 +88,8 @@ dependencies:
| keycloak.rbac.rules[0].verbs[0] | string | `"get"` | |
| keycloak.rbac.rules[0].verbs[1] | string | `"list"` | |
| keycloak.postgresql.enabled | bool | `true` | PostgreSQL chart configuration (recommended for demonstration purposes only); default configurations: host: "centralidp-postgresql-primary", port: 5432; Switch to enable or disable the PostgreSQL helm chart. |
| keycloak.postgresql.image | object | `{"tag":"15-debian-11"}` | Setting to Postgres version 15 as that is the aligned version, https://eclipse-tractusx.github.io/docs/release/trg-5/trg-5-07/#aligning-dependency-versions). Keycloak helm-chart from Bitnami has moved on to version 16. |
| keycloak.postgresql.commonLabels."app.kubernetes.io/version" | string | `"15"` | |
| keycloak.postgresql.auth.username | string | `"kccentral"` | Non-root username. |
| keycloak.postgresql.auth.database | string | `"iamcentralidp"` | Database name. |
| keycloak.postgresql.auth.existingSecret | string | `"centralidp-postgres"` | Secret containing the passwords for root usernames postgres and non-root username kccentral. |
Expand All @@ -104,7 +106,7 @@ dependencies:
| secrets.postgresql.auth.existingSecret.password | string | `""` | Password for the non-root username 'kccentral'. Secret-key 'password'. |
| secrets.postgresql.auth.existingSecret.replicationPassword | string | `""` | Password for the non-root username 'repl_user'. Secret-key 'replication-password'. |
| seeding.enabled | bool | `false` | Seeding job to upgrade CX_Central realm: enable to upgrade the configuration of the CX-Central realm from previous version; Please also refer to the 'Post-Upgrade Configuration' section in the README.md for configuration possibly not covered by the seeding job |
| seeding.image | string | `"docker.io/tractusx/portal-iam-seeding:v2.1.0-iam"` | |
| seeding.image | string | `"docker.io/tractusx/portal-iam-seeding:v3.0.0-rc.1-iam"` | |
| seeding.imagePullPolicy | string | `"IfNotPresent"` | |
| seeding.portContainer | int | `8080` | |
| seeding.authRealm | string | `"master"` | |
Expand All @@ -113,13 +115,13 @@ dependencies:
| seeding.instanceName | string | `"central"` | |
| seeding.excludedUserAttributes.attribute0 | string | `"bpn"` | |
| seeding.excludedUserAttributes.attribute1 | string | `"organisation"` | |
| seeding.resources | object | `{"requests":{"cpu":"15m","memory":"105M"}}` | We recommend not to specify default resource limits and to leave this as a conscious choice for the user. If you do want to specify resource limits, uncomment the following lines and adjust them as necessary. |
| seeding.resources | object | `{"limits":{"cpu":"225m","memory":"200M"},"requests":{"cpu":"75m","memory":"200M"}}` | We recommend to review the default resource limits as this should a conscious choice. |
| seeding.extraVolumes[0].name | string | `"realms"` | |
| seeding.extraVolumes[0].emptyDir | object | `{}` | |
| seeding.extraVolumeMounts[0].name | string | `"realms"` | |
| seeding.extraVolumeMounts[0].mountPath | string | `"app/realms"` | |
| seeding.initContainers[0].name | string | `"init-cx-central"` | |
| seeding.initContainers[0].image | string | `"docker.io/tractusx/portal-iam:v2.1.0"` | |
| seeding.initContainers[0].image | string | `"docker.io/tractusx/portal-iam:v3.0.0-rc.1"` | |
| seeding.initContainers[0].imagePullPolicy | string | `"IfNotPresent"` | |
| seeding.initContainers[0].command[0] | string | `"sh"` | |
| seeding.initContainers[0].args[0] | string | `"-c"` | |
Expand All @@ -146,13 +148,19 @@ This is done by setting the 'example.org' placeholder in the CX-Operator' Identi

Please see notes at [Values.seeding](values.yaml#L146) for upgrading the configuration of the CX-Central realm.

### To 3.0.0

This major changes from the Keycloak version from 22.0.3 to 23.0.7 and bumps the PostgresSQL version of the subchart from 15.4.0 to the latest available version of 15.

No major issues are expected during the upgrade.

### To 2.1.0

No specific upgrade notes.

### To 2.0.0

This major changes from Keycloak version 16.1.1 to version 22.0.3.
This major changes from the Keycloak version from 16.1.1 to version 22.0.3.

Please have a look at the [CHANGELOG](../../CHANGELOG.md#200) for a more detailed description.

Expand Down
6 changes: 3 additions & 3 deletions charts/centralidp/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ keycloak:
mountPath: "/realms"
initContainers:
- name: import
image: docker.io/tractusx/portal-iam:pr63
image: docker.io/tractusx/portal-iam:v3.0.0-rc.1
imagePullPolicy: IfNotPresent
command:
- sh
Expand Down Expand Up @@ -156,7 +156,7 @@ seeding:
# Please also refer to the 'Post-Upgrade Configuration' section in the README.md
# for configuration possibly not covered by the seeding job
enabled: false
image: "docker.io/tractusx/portal-iam-seeding:v2.1.0-iam"
image: "docker.io/tractusx/portal-iam-seeding:v3.0.0-rc.1-iam"
imagePullPolicy: "IfNotPresent"
portContainer: 8080
authRealm: "master"
Expand All @@ -183,7 +183,7 @@ seeding:
mountPath: "app/realms"
initContainers:
- name: init-cx-central
image: docker.io/tractusx/portal-iam:pr63
image: docker.io/tractusx/portal-iam:v3.0.0-rc.1
imagePullPolicy: IfNotPresent
command:
- sh
Expand Down
24 changes: 16 additions & 8 deletions charts/sharedidp/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Helm chart for Catena-X Shared Keycloak Instance
# Helm chart for Shared Keycloak Instance

![Version: 2.1.0](https://img.shields.io/badge/Version-2.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 22.0.3](https://img.shields.io/badge/AppVersion-22.0.3-informational?style=flat-square)
![Version: 3.0.0-rc.1](https://img.shields.io/badge/Version-3.0.0--rc.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 23.0.7](https://img.shields.io/badge/AppVersion-23.0.7-informational?style=flat-square)

This helm chart installs the Helm chart for Catena-X Shared Keycloak Instance.
This helm chart installs the Helm chart for Shared Keycloak Instance.

For further information please refer to the [technical documentation](../../docs/technical%20documentation).

Expand All @@ -29,14 +29,14 @@ To use the helm chart as a dependency:
dependencies:
- name: sharedidp
repository: https://eclipse-tractusx.github.io/charts/dev
version: 2.1.0
version: 3.0.0-rc.1
```

## Requirements

| Repository | Name | Version |
|------------|------|---------|
| https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami | keycloak | 16.1.6 |
| https://raw.githubusercontent.com/bitnami/charts/archive-full-index/bitnami | keycloak | 19.3.0 |

## Values

Expand All @@ -63,8 +63,8 @@ dependencies:
| keycloak.extraVolumeMounts[2].name | string | `"realms"` | |
| keycloak.extraVolumeMounts[2].mountPath | string | `"/realms"` | |
| keycloak.initContainers[0].name | string | `"import"` | |
| keycloak.initContainers[0].image | string | `"docker.io/tractusx/portal-iam:v2.1.0"` | |
| keycloak.initContainers[0].imagePullPolicy | string | `"Always"` | |
| keycloak.initContainers[0].image | string | `"docker.io/tractusx/portal-iam:v3.0.0-rc.1"` | |
| keycloak.initContainers[0].imagePullPolicy | string | `"IfNotPresent"` | |
| keycloak.initContainers[0].command[0] | string | `"sh"` | |
| keycloak.initContainers[0].args[0] | string | `"-c"` | |
| keycloak.initContainers[0].args[1] | string | `"echo \"Copying themes-catenax-shared...\"\ncp -R /import/themes/catenax-shared/* /themes-catenax-shared\necho \"Copying themes-catenax-shared-portal...\"\ncp -R /import/themes/catenax-shared-portal/* /themes-catenax-shared-portal\necho \"Copying realms...\"\ncp -R /import/catenax-shared/realms/* /realms\n"` | |
Expand Down Expand Up @@ -94,6 +94,8 @@ dependencies:
| keycloak.rbac.rules[0].verbs[0] | string | `"get"` | |
| keycloak.rbac.rules[0].verbs[1] | string | `"list"` | |
| keycloak.postgresql.enabled | bool | `true` | PostgreSQL chart configuration (recommended for demonstration purposes only); default configurations: host: "sharedidp-postgresql-primary", port: 5432; Switch to enable or disable the PostgreSQL helm chart. |
| keycloak.postgresql.image | object | `{"tag":"15-debian-11"}` | Setting to Postgres version 15 as that is the aligned version, https://eclipse-tractusx.github.io/docs/release/trg-5/trg-5-07/#aligning-dependency-versions). Keycloak helm-chart from Bitnami has moved on to version 16. |
| keycloak.postgresql.commonLabels."app.kubernetes.io/version" | string | `"15"` | |
| keycloak.postgresql.auth.username | string | `"kcshared"` | Non-root username. |
| keycloak.postgresql.auth.database | string | `"iamsharedidp"` | Database name. |
| keycloak.postgresql.auth.existingSecret | string | `"sharedidp-postgres"` | Secret containing the passwords for root usernames postgres and non-root username kcshared. |
Expand Down Expand Up @@ -136,13 +138,19 @@ Generate client-secrets for the service account with access type 'confidential'.

## Upgrade

### To 3.0.0

This major changes from the Keycloak version from 22.0.3 to 23.0.7 and bumps the PostgresSQL version of the subchart from 15.4.0 to the latest available version of 15.

No major issues are expected during the upgrade.

### To 2.1.0

No specific upgrade notes.

### To 2.0.0

This major changes from Keycloak version 16.1.1 to version 22.0.3.
This major changes from the Keycloak version from 16.1.1 to version 22.0.3.

Please have a look at the [CHANGELOG](../../CHANGELOG.md#200) for a more detailed description.

Expand Down
2 changes: 1 addition & 1 deletion charts/sharedidp/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ keycloak:
mountPath: "/realms"
initContainers:
- name: import
image: docker.io/tractusx/portal-iam:pr63
image: docker.io/tractusx/portal-iam:v3.0.0-rc.1
imagePullPolicy: IfNotPresent
command:
- sh
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
source:
path: charts/centralidp
repoURL: 'https://github.com/eclipse-tractusx/portal-iam.git'
targetRevision: v2.1.0
targetRevision: v3.0.0-rc.1
plugin:
env:
- name: AVP_SECRET
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
source:
path: charts/centralidp
repoURL: 'https://github.com/eclipse-tractusx/portal-iam.git'
targetRevision: v2.1.0
targetRevision: v3.0.0-rc.1
plugin:
env:
- name: AVP_SECRET
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
source:
path: charts/centralidp
repoURL: 'https://github.com/eclipse-tractusx/portal-iam.git'
targetRevision: v2.1.0
targetRevision: v3.0.0-rc.1
plugin:
env:
- name: AVP_SECRET
Expand Down
2 changes: 1 addition & 1 deletion consortia/argocd-app-templates/centralidp/appsetup-rc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
source:
path: charts/centralidp
repoURL: 'https://github.com/eclipse-tractusx/portal-iam.git'
targetRevision: v2.1.0
targetRevision: v3.0.0-rc.1
plugin:
env:
- name: AVP_SECRET
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ spec:
source:
path: ''
repoURL: 'https://eclipse-tractusx.github.io/charts/dev'
targetRevision: 2.1.0
targetRevision: 3.0.0-rc.1
plugin:
env:
- name: HELM_VALUES
value: |
keycloak:
initContainers:
- name: import
image: docker.io/tractusx/portal-iam-consortia:v2.1.0
image: docker.io/tractusx/portal-iam-consortia:v3.0.0-rc.1
imagePullPolicy: Always
command:
- sh
Expand Down Expand Up @@ -83,7 +83,7 @@ spec:
enabled: true
initContainers:
- name: init-cx-central
image: docker.io/tractusx/portal-iam-consortia:v2.1.0
image: docker.io/tractusx/portal-iam-consortia:v3.0.0-rc.1
imagePullPolicy: Always
command:
- sh
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
source:
path: charts/centralidp
repoURL: 'https://github.com/eclipse-tractusx/portal-iam.git'
targetRevision: v2.1.0
targetRevision: v3.0.0-rc.1
plugin:
env:
- name: AVP_SECRET
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ spec:
source:
path: charts/centralidp
repoURL: 'https://github.com/eclipse-tractusx/portal-iam.git'
targetRevision: v2.1.0
targetRevision: v3.0.0-rc.1
plugin:
env:
- name: AVP_SECRET
Expand Down
38 changes: 0 additions & 38 deletions consortia/argocd-app-templates/centralidp/appsetup-upgrade.yaml

This file was deleted.

Loading