refactor: deprecate azure vault distribution

eclipse-tractusx · Oct 10, 2024 · 7366a0e · 7366a0e
1 parent f5006a9
commit 7366a0e
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 49 deletions.
diff --git a/.github/workflows/deployment-test.yaml b/.github/workflows/deployment-test.yaml
@@ -122,43 +122,3 @@ jobs:
             kubectl rollout status deployment tx-prod-dataplane
             
             # no helm test here, because the delegated auth won't work without an actual IdP
-
-  test-azure-vault-postgres:
-    runs-on: ubuntu-latest
-    needs: [ test-prepare, secret-presence ]
-    #    if: |
-    #      needs.secret-presence.outputs.AZURE_KV_CREDS
-
-    # DEACTIVATE this job for now because our Azure Credentials are expired
-    # TODO: reactivate once we have refreshed Azure Credentials
-    if: false
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: "Login to AZ CLI"
-        run: |
-          az login --service-principal -u="${{ secrets.AZURE_CLIENT_ID }}" --password="${{ secrets.AZURE_CLIENT_SECRET }}" --tenant="${{ secrets.AZURE_TENANT_ID }}"
-      - uses: ./.github/actions/run-deployment-test
-        name: "Run deployment test using KinD and Helm"
-        with:
-          imagename: "edc-controlplane-postgresql-azure-vault edc-dataplane-azure-vault"
-          rootDir: "edc-controlplane/edc-controlplane-postgresql-azure-vault edc-dataplane/edc-dataplane-azure-vault"
-          helm_command: |-
-            az keyvault secret set --vault-name ${{ secrets.AZURE_VAULT_NAME }} --name aes-keys --value "$(cat aes.key)" > /dev/null
-            az keyvault secret set --vault-name ${{ secrets.AZURE_VAULT_NAME }} --name client-secret --value "$(cat client.secret)" > /dev/null
-            
-            helm install tx-prod charts/tractusx-connector-azure-vault \
-             -f edc-tests/deployment/src/main/resources/helm/tractusx-connector-azure-vault-test.yaml \
-             --dependency-update \
-             --set vault.azure.name=${{ secrets.AZURE_VAULT_NAME }} \
-             --set vault.azure.client=${{ secrets.AZURE_CLIENT_ID }} \
-             --set vault.azure.secret=${{ secrets.AZURE_CLIENT_SECRET }} \
-             --set vault.azure.tenant=${{ secrets.AZURE_TENANT_ID }} \
-             --wait-for-jobs --timeout=120s
-
-            # wait for the pod to become ready
-            kubectl rollout status deployment tx-prod-controlplane
-            kubectl rollout status deployment tx-prod-dataplane
-
-            # execute the helm test
-            helm test tx-prod
diff --git a/.github/workflows/helm-lint.yaml b/.github/workflows/helm-lint.yaml
@@ -52,7 +52,7 @@ jobs:
       - name: python (setup)
         uses: actions/setup-python@v5
         with:
-          python-version: 3.7
+          python-version: 3.13
       - name: chart-testing (setup)
         uses: helm/[email protected]
       #####################

diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml
@@ -33,14 +33,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
-      - uses: addnab/docker-run-action@v3
-        with:
-          image: jnorwood/helm-docs:v1.10.0
-          options: -v ${{ github.workspace }}/charts:/helm-docs
-          run: helm-docs
-
       - run: |
+          docker run -v ${{ github.workspace }}/charts:/helm-docs jnorwood/helm-docs helm-docs
+          
           if $(git diff --quiet --exit-code); then
             echo "Helm chart docs up to date"
           else

diff --git a/charts/tractusx-connector-azure-vault/Chart.yaml b/charts/tractusx-connector-azure-vault/Chart.yaml
@@ -24,7 +24,10 @@
 ---
 apiVersion: v2
 name: tractusx-connector-azure-vault
+deprecated: true
 description: |
+  DEPRECATED: this chart will be no more available after version 0.8.0
+
   A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a
   Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and Azure KeyVault are included.
 

diff --git a/charts/tractusx-connector-azure-vault/README.md b/charts/tractusx-connector-azure-vault/README.md
@@ -1,7 +1,11 @@
 # tractusx-connector-azure-vault
 
+> **:exclamation: This Helm Chart is deprecated!**
+
 ![Version: 0.8.0-rc4](https://img.shields.io/badge/Version-0.8.0--rc4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.8.0-rc4](https://img.shields.io/badge/AppVersion-0.8.0--rc4-informational?style=flat-square)
 
+DEPRECATED: this chart will be no more available after version 0.8.0
+
 A Helm chart for Tractus-X Eclipse Data Space Connector. The connector deployment consists of two runtime consists of a
 Control Plane and a Data Plane. Note that _no_ external dependencies such as a PostgreSQL database and Azure KeyVault are included.
 

diff --git a/edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md b/edc-controlplane/edc-controlplane-postgresql-azure-vault/README.md
@@ -1,6 +1,8 @@
 # EDC Control-Plane PostgreSQL & Azure Key Vault
 
-This verison of the EDC Control-Plane is backed by [PostgreSQL](https://www.postgresql.org/) and [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview).
+DEPRECATED: this module won't be available anymore after version 0.8.0
+
+This version of the EDC Control-Plane is backed by [PostgreSQL](https://www.postgresql.org/) and [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview).
 
 ## Building
 

diff --git a/edc-dataplane/edc-dataplane-azure-vault/README.md b/edc-dataplane/edc-dataplane-azure-vault/README.md
@@ -1,5 +1,7 @@
 # EDC Data-Plane with Azure Key Vault
 
+DEPRECATED: this module won't be available anymore after version 0.8.0
+
 This build of the EDC Data-Plane utilizes [Azure Key Vault](https://azure.microsoft.com/en-us/services/key-vault/#product-overview) for secret storage.
 
 ## Building