Merge pull request #834 from catenax-ng/chore/489-rename-helm-chart

Chore/489 rename helm chart

.github/workflows/helm-chart-release.yaml

@@ -25,13 +25,13 @@ jobs:
       - name: Get helm charts latest tag version
         id: step1
         run: |
-          latestVersion=$(git tag | grep "irs-helm-[1-9]" | tail -1)
+          latestVersion=$(git tag | grep "item-relationship-service-[1-9]" | sort -V | tail -1)
           echo "::set-output name=latest_version::$latestVersion"
           echo "Exported $latestVersion latest helm charts version"
       - name: Get helm charts current version
         id: step2
         run: |
-          chartVersion=irs-helm-$(cat ./charts/irs-helm/Chart.yaml | grep "version:" | head -1 | cut -d ":" -d " " -f2)
+          chartVersion=item-relationship-service-$(cat ./charts/item-relationship-service/Chart.yaml | grep "version:" | head -1 | cut -d ":" -d " " -f2)
           echo "::set-output name=current_version::$chartVersion"
           echo "Exported $chartVersion helm charts version"
 
@@ -60,7 +60,7 @@ jobs:
           version: v3.9.3
 
       - name: Update helm dependencies for irs
-        working-directory: charts/irs-helm/
+        working-directory: charts/item-relationship-service/
         run: |
           helm repo add bitnami https://charts.bitnami.com/bitnami
           helm repo add minio https://charts.min.io/
@@ -69,11 +69,11 @@ jobs:
           helm dependency update
 
       - name: Create temporary CHANGELOG file for helm release
-        working-directory: charts/irs-helm/
+        working-directory: charts/item-relationship-service/
         run: |
           touch CHANGELOG-temp.md
           
-          currentVersionNumber=$(echo ${{ needs.get-helm-charts-versions-irs.outputs.current_version }} | sed -e "s/^irs-helm-//" )
+          currentVersionNumber=$(echo ${{ needs.get-helm-charts-versions-irs.outputs.current_version }} | sed -e "s/^item-relationship-service-//" )
           echo currentVersionNumber=$currentVersionNumber
           
           sed -n -e '/## \['"${currentVersionNumber}"'\]/,/## \[/ p' CHANGELOG.md | head -n -1 | tail -n +2 >> CHANGELOG-temp.md

.github/workflows/helm-test.yaml

@@ -72,5 +72,5 @@ jobs:
           helm repo add minio https://charts.min.io/
           helm repo add prometheus-community https://prometheus-community.github.io/helm-charts
           helm repo add grafana https://grafana.github.io/helm-charts
-          ct install --charts charts/irs-helm --helm-extra-set-args "--set=image.tag=testing --set=image.repository=kind-registry:5000/irs-api"
+          ct install --charts charts/item-relationship-service --helm-extra-set-args "--set=image.tag=testing --set=image.repository=kind-registry:5000/irs-api"
         if: steps.list-changed.outputs.changed == 'true'

.github/workflows/helm-upgrade.yaml

@@ -3,7 +3,7 @@ name: Upgrade Charts
 on:
   pull_request:
     paths:
-      - 'charts/irs-helm/**'
+      - 'charts/item-relationship-service/**'
   workflow_dispatch:
 
 jobs:
@@ -32,12 +32,12 @@ jobs:
           helm repo add irs https://eclipse-tractusx.github.io/item-relationship-service
 
       - name: Run helm install
-        # Install latest released irs-helm version
+        # Install latest released item-relationship-service version
         run: |
-          helm install irs irs/irs-helm
+          helm install irs irs/item-relationship-service 
 
       - name: Run helm upgrade
-        # Upgrade the installed irs-helm version with the locally available charts
+        # Upgrade the installed item-relationship-service version with the locally available charts
         run: |
-          helm dependency update charts/irs-helm
-          helm upgrade irs charts/irs-helm
+          helm dependency update charts/item-relationship-service
+          helm upgrade irs charts/item-relationship-service 

.github/workflows/release.yaml

@@ -13,17 +13,17 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Calculate Helm release version from CHANGELOG
-        run: echo HELM_VERSION=$(cat charts/irs-helm/CHANGELOG.md | sed -n 's/.*\[\([0-9]\+\.[0-9]\+\.[0-9]\+\)\].*/\1/p' | head -n 1) >> $GITHUB_ENV
+        run: echo HELM_VERSION=$(cat charts/item-relationship-service/CHANGELOG.md | sed -n 's/.*\[\([0-9]\+\.[0-9]\+\.[0-9]\+\)\].*/\1/p' | head -n 1) >> $GITHUB_ENV
 
       - name: Update Chart.yaml appVersion
         uses: mikefarah/yq@v4.40.5
         with:
-          cmd: yq -i eval '.appVersion = "${{ github.ref_name }}"' charts/irs-helm/Chart.yaml
+          cmd: yq -i eval '.appVersion = "${{ github.ref_name }}"' charts/item-relationship-service/Chart.yaml
 
       - name: Update Chart.yaml version
         uses: mikefarah/yq@v4.40.5
         with:
-          cmd: yq -i eval '.version = "${{ env.HELM_VERSION }}"' charts/irs-helm/Chart.yaml
+          cmd: yq -i eval '.version = "${{ env.HELM_VERSION }}"' charts/item-relationship-service/Chart.yaml
 
       - name: Prepare Helm release
         uses: peter-evans/create-pull-request@v5

.gitignore

@@ -71,7 +71,7 @@ docs/src/diagram-replacer/package.json
 docs/src/diagram-replacer/plantuml.jar
 
 # Helm Chart Dependencies
-/charts/irs-helm/Chart.lock
-/charts/irs-helm/charts/
+/charts/item-relationship-service/Chart.lock
+/charts/item-relationship-service/charts/
 
 

CHANGELOG.md

@@ -20,8 +20,14 @@ _**For better traceability add the corresponding GitHub issue number in each cha
 - IRS now supports Asset Administration Shell v3.1 - adjusted lookup shells endpoint changes (assetIds query param is encoded). #359
 - Support of building relationships based on SingleLevelBomAsBuilt v3.0.0 #488
 
+### Changed
+
+- Renamed item relationship service Helm chart from "irs-helm" to "item-relationship-service". #489
+
+
 ## [4.8.0] - 2024-03-18
 ### Changed
+
 - Improved maintainability in EdcSubmodelClientImpl by reduced method visibility and better naming (in context of #448).
 - EdcPolicyDefinitionService, EdcContractDefinitionService and EdcAssetService throw AlreadyExist exceptions when
   conflict is returned from EDC
@@ -137,7 +143,7 @@ _**For better traceability add the corresponding GitHub issue number in each cha
   - Added `impactedSuppliersOnFirstTier` parameter to Supply SupplyChainImpacted Aspect model - contains information of first level supply chain impacted
 - Exported health endpoints to prometheus (see HealthMetricsExportConfiguration,
   DependenciesHealthMetricsExportConfiguration) and
-  added [system health dashboard](charts/irs-helm/dashboards/system-health-dashboard.json)
+  added [system health dashboard](charts/item-relationship-service/dashboards/system-health-dashboard.json)
   in order to visualize health metrics of IRS and its dependencies. #283
 
 ### Fixed

CONTRIBUTING.md

@@ -171,26 +171,27 @@ https://github.com/google/google-java-format/blob/master/README.md#intellij-jre-
 1. Choose a release version using [semantic versioning](https://semver.org/spec/v2.0.0.html)
    and create a corresponding branch according to the template: `chore/prepare-release-x.x.x`.
 2. Add release notes for new version in [CHANGELOG.md](CHANGELOG.md)
-   and [charts/irs-helm/CHANGELOG.md](charts/irs-helm/CHANGELOG.md)
+   and [charts/item-relationship-service/CHANGELOG.md](charts/item-relationship-service/CHANGELOG.md)
    (for an example [see here](https://github.com/eclipse-tractusx/item-relationship-service/pull/429))
    - Check if the changelog entries for the release are complete.
    - Add the corresponding GitHub issue numbers to each entry if missing.
 3. Update [COMPATIBILITY_MATRIX.md](COMPATIBILITY_MATRIX.md).
 4. Update IRS API version in IrsApplication class and irs-api.yaml
-5. Create pull request from [release preparation branch to main](https://github.com/eclipse-tractusx/item-relationship-service/compare/chore/prepare-release-x.x.x) and merge to main.
-6. Create Git tag for the desired release version `git tag x.x.x`
-   (note: the irs-helm tag will be created automatically by the GitHub workflow based on the version in the irs-helm changelog). 
-7. Push Git tag to repository `git push origin x.x.x` (this will trigger the GitHub release workflow).
-8. Wait for release workflow to complete.
-9. Merge the automatically opened PR by GitHub actions bot.
-10. Notify about the release in IRS Matrix Chat using the following template: 
+5. Create pull request from [release preparation branch to main](https://github.com/eclipse-tractusx/item-relationship-service/compare/chore/prepare-release-x.x.x) 
+6. Merge this pull request to main.
+7. Create Git tag for the desired release version `git tag x.x.x`
+   (note: the _item-relationship-service_ tag will be created automatically by the GitHub workflow based on the version in the [helm chart changelog](charts/item-relationship-service/CHANGELOG.md)). 
+8. Push Git tag to repository `git push origin x.x.x` (this will trigger the GitHub release workflow).
+9. Wait for release workflow to complete.
+10. Merge the pull request that was automatically opened by GitHub actions bot.
+11. Notify about the release in IRS Matrix Chat using the following template: 
 
    >   **IRS Release x.x.x**
    >
    >   IRS version x.x.x is released. 
    >
    >   https://github.com/eclipse-tractusx/item-relationship-service/releases/tag/x.x.x<br>
-   >   https://github.com/eclipse-tractusx/item-relationship-service/releases/tag/irs-helm-y.y.y<br>
+   >   https://github.com/eclipse-tractusx/item-relationship-service/releases/tag/item-relationship-service-y.y.y<br>
    >   **Full Changelog:** https://github.com/eclipse-tractusx/item-relationship-service/compare/w.w.w...x.x.x
 
    _(replace x.x.x with IRS version to release, y.y.y with IRS helm version to release and w.w.w with previous IRS version)_

INSTALL.md

@@ -2,7 +2,7 @@
 
 The deployment contains the components required to connect the IRS to an existing Catena-X network. This includes:
 
-- IRS with Minio - part of the "irs-helm" Helm chart
+- IRS with Minio - part of the "item-relationship-service" Helm chart
 - EDC Consumer (controlplane & dataplane) - part of the "irs-edc-consumer" Helm chart
 
 Everything else needs to be provided externally.
@@ -16,7 +16,7 @@ Instructions can be found here: [Data Chain Kit](https://eclipse-tractusx.github
 
 The IRS Helm repository can be found here: [index.yaml](https://eclipse-tractusx.github.io/item-relationship-service/index.yaml)
 
-Use the latest release of the "irs-helm" chart.
+Use the latest release of the "item-relationship-service" Helm chart.
 It contains all required dependencies.
 
 If you also want to set up your own EDC consumer, use the "irs-edc-consumer" chart.
@@ -35,14 +35,14 @@ Add the IRS Helm repository:
 Then install the Helm chart into your cluster:
 
 ```(shell)
-    helm install -f your-values.yaml irs-app irs/irs-helm
+    helm install -f your-values.yaml irs-app irs/item-relationship-service
 ```
 
 Or create a new Helm chart and use the IRS as a dependency.
 
 ```(yaml)
     dependencies:
-      - name: irs-helm
+      - name: item-relationship-service
         repository: https://eclipse-tractusx.github.io/item-relationship-service
         version: 6.x.x
       - name: tractusx-connector

README.md

@@ -51,7 +51,7 @@ The IRS project consists of several different parts:
 | .idea                            | Configuration for development via [IntelliJ](https://www.jetbrains.com/idea/).                                                                                                 |                                                                              |
 | .run                             | Run configurations for running the IRS in [IntelliJ](https://www.jetbrains.com/idea/).                                                                                         |                                                                              |
 | charts                           | [HELM](https://helm.sh/) charts.                                                                                                                                               |                                                                              |
-| charts/irs-helm                  | IRS [HELM](https://helm.sh/) chart for running the IRS with and its direct dependencies in [kubernetes](https://kubernetes.io/).                                               | [IRS HELM charts documentation](charts/irs-helm/README.md)                   |
+| charts/item-relationship-service | IRS [HELM](https://helm.sh/) chart for running the IRS with and its direct dependencies in [kubernetes](https://kubernetes.io/).                                               | [IRS HELM charts documentation](charts/item-relationship-service/README.md)  |
 | docs                             | Concepts and documentation.                                                                                                                                                    | [Docs README](docs/README.md)                                                |
 | irs-api                          | The IRS API.                                                                                                                                                                   |                                                                              |
 | irs-common                       | Common classes of the IRS.                                                                                                                                                     |                                                                              |
@@ -131,7 +131,7 @@ See [TESTS](TESTS.md).
 ## Changelog and Compatibility Matrix
 
 - [Changelog IRS](CHANGELOG.md)
-- [Changelog IRS Helm](charts/irs-helm/CHANGELOG.md)
+- [Changelog IRS Helm](charts/item-relationship-service/CHANGELOG.md)
 - [Compatibility Matrix](COMPATIBILITY_MATRIX.md)
 
 

charts/irs-helm/CHANGELOG.md → charts/item-relationship-service/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Renamed item relationship service Helm chart from "irs-helm" to "item-relationship-service". #489
+
+
 ## [6.18.0] - 2024-04-03
 
 ### Changed

charts/irs-helm/Chart.yaml → charts/item-relationship-service/Chart.yaml

@@ -20,8 +20,8 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 apiVersion: v2
-name: irs-helm
-description: IRS Helm chart for Kubernetes
+name: item-relationship-service
+description: Tractus-X Item Relationship Service Helm Chart
 home: https://eclipse-tractusx.github.io/
 sources:
   - https://github.com/eclipse-tractusx/item-relationship-service

charts/irs-helm/README.md → charts/item-relationship-service/README.md

@@ -19,9 +19,9 @@ This includes:
 
 ```
 helm repo add irs https://eclipse-tractusx.github.io/item-relationship-service
-helm install irs-app irs/irs-helm
+helm install irs-app irs/item-relationship-service
 ```
 
 ## Default configuration values
 
-See [the configuration docs](https://eclipse-tractusx.github.io/item-relationship-service/docs/administration/administration-guide.html#_helm_configuration_irs_values_yaml) or run `helm show values irs/irs-helm` for the default values.
+See [the configuration docs](https://eclipse-tractusx.github.io/item-relationship-service/docs/administration/administration-guide.html#_helm_configuration_irs_values_yaml) or run `helm show values irs/item-relationship-service` for the default values.

docs/src/docs/administration/configuration.adoc

@@ -14,7 +14,7 @@ include::irs-spring-config.adoc[leveloffset=+1]
 
 [source,yaml]
 ----
-include::../../../../charts/irs-helm/values.yaml[lines=104..302]
+include::../../../../charts/item-relationship-service/values.yaml[lines=104..302]
 ----
 
 <1> Use this to enable or disable the monitoring components

docs/src/docs/administration/installation.adoc

@@ -3,7 +3,7 @@
 The IRS Helm repository can be found here:
 https://eclipse-tractusx.github.io/item-relationship-service/index.yaml
 
-Use the latest release of the "irs-helm" chart.
+Use the latest release of the "item-relationship-service" chart.
 It contains all required dependencies.
 
 If you also want to set up your own EDC consumer, use the https://github.com/eclipse-tractusx/tractusx-edc/tree/main/charts/tractusx-connector[tractusx-connector] chart.
@@ -20,7 +20,7 @@ $ helm repo add irs https://eclipse-tractusx.github.io/item-relationship-service
 Then install the Helm chart into your cluster:
 
 [listing]
-$ helm install -f your-values.yaml irs-app irs/irs-helm
+$ helm install -f your-values.yaml irs-app irs/item-relationship-service
 
 == Deployment using ArgoCD
 
@@ -29,7 +29,7 @@ Create a new Helm chart and use the IRS as a dependency.
 [source,yaml]
 ----
 dependencies:
-  - name: irs-helm
+  - name: item-relationship-service
     repository: https://eclipse-tractusx.github.io/item-relationship-service
     version: 6.x.x
   - name: tractusx-connector # optional

docs/src/docs/administration/system-overview.adoc

@@ -2,7 +2,7 @@
 
 The deployment contains the components required to connect the IRS to an existing Catena-X network. This includes:
 
-* IRS with Minio - part of the "irs-helm" Helm chart
+* IRS with Minio - part of the "item-relationship-service" Helm chart
 * EDC Consumer (controlplane & dataplane) - part of the "irs-edc-consumer" Helm chart
 
 Everything else needs to be provided externally.

local/deployment/full-irs/Chart.yaml

@@ -98,7 +98,7 @@ dependencies:
     condition: install.irs.providerBackend
 
   # IRS
-  - name: irs-helm
+  - name: item-relationship-service
     alias: irs
     repository: https://catenax-ng.github.io/tx-item-relationship-service
     version: 5.0.9

local/deployment/irs-local/Chart.yaml

@@ -16,7 +16,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 apiVersion: v2
-name: irs-helm-local
+name: item-relationship-service-local
 description: IRS Helm chart for local Kubernetes
 home: https://eclipse-tractusx.github.io/
 sources:
@@ -26,6 +26,6 @@ version: 6.14.0
 appVersion: "4.5.0"
 
 dependencies:
-  - name: irs-helm
+  - name: item-relationship-service
     repository: https://eclipse-tractusx.github.io/item-relationship-service
     version: 6.14.0

local/deployment/irs-local/README.md

@@ -9,7 +9,7 @@
 3. Any Kubernetes cluster is installed and running, eg. [Minikube](https://minikube.sigs.k8s.io/docs/start/)
 4. [kubectl](https://kubernetes.io/docs/tasks/tools/) is installed
 
-### Step 2: Update and build the irs-helm chart
+### Step 2: Update and build the item-relationship-service helm chart
 
 ```bash
 $ helm dependency build
@@ -22,7 +22,7 @@ Hang tight while we grab the latest from your chart repositories...
 ...Successfully got an update from the "prometheus-community" chart repository
 Update Complete. ⎈Happy Helming!⎈
 Saving 1 charts
-Downloading irs-helm from repo https://eclipse-tractusx.github.io/item-relationship-service
+Downloading item-relationship-service Helm chart from repo https://eclipse-tractusx.github.io/item-relationship-service
 Deleting outdated charts
 ```
 Please note that irs repository has to be added to helm repo list
@@ -43,21 +43,21 @@ To deploy IRS on kubernetes with helm run
 $ helm install irs-local .
 ```
 
-##### 1.1 Get the Status of the deployment
+##### 1.1 Get the Status of the Deployment
 
 Helm can give you feedback on the release status:
 
 ```bash
 $ helm list
-NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                   APP VERSION
-irs-local       default         1               2024-02-26 11:36:46.399546 +0100 CET    deployed        irs-helm-local-6.14.0   4.5.0
+NAME            NAMESPACE       REVISION        UPDATED                                 STATUS          CHART                                    APP VERSION
+irs-local       default         1               2024-02-26 11:36:46.399546 +0100 CET    deployed        item-relationship-service-local-6.14.0   4.5.0
 ```
 Kubectl can give you feedback on how the status of the deployment currently is, there should be two pods deployed - IRS and Minio:
 ```bash
 $ kubectl get pods
-NAME                                 READY   STATUS    RESTARTS      AGE
-irs-local-minio-7cc78d8985-qggrx     1/1     Running   0             10m
-irs-local-irs-helm-c84f98ffb-zg59z   1/1     Running   0             10m
+NAME                                                  READY   STATUS    RESTARTS      AGE
+irs-local-minio-7cc78d8985-qggrx                      1/1     Running   0             10m
+irs-local-item-relationship-service-c84f98ffb-zg59z   1/1     Running   0             10m
 
 ```
 
@@ -66,7 +66,7 @@ irs-local-irs-helm-c84f98ffb-zg59z   1/1     Running   0             10m
 When the deployment has been finished please use the command to forward the port:
 
 ```bash
-$  kubectl port-forward svc/irs-local-irs-helm 8080:8080
+$  kubectl port-forward svc/irs-local-item-relationship-service 8080:8080
 ```
 
 After that you can access the Swagger UI page: