From be51d640c887edd34189fc3b154da9f0a708b773 Mon Sep 17 00:00:00 2001 From: sschalkowski Date: Thu, 31 Oct 2024 09:34:22 +0100 Subject: [PATCH] chore: [#1369] replaced/added eclipse-tractusx urls as requested --- dev/README.md | 81 +++++++++++++++++++++++++++++++++++++- frontend/AUTHENTICATION.md | 2 + 2 files changed, 82 insertions(+), 1 deletion(-) diff --git a/dev/README.md b/dev/README.md index 40fba703a9..6addb307dc 100644 --- a/dev/README.md +++ b/dev/README.md @@ -23,7 +23,86 @@ Wait until pvc and database pods are restored. Underneath all 'DELETE' directori Repeat those steps for registry, trace-x-provider-edcs, tracex-instances -## 2) Prepare trace-x +## 2) Data upload of assets + +In order to upload data to EDC Provider, please use [IRS project script](https://github.com/eclipse-tractusx/item-relationship-service/blob/main/local/testing/testdata/transform-and-upload.py) + +Keep in mind to always update DEV and TEST since they are dependend on each other. + +Sample invocation (DEV) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability.dev.demo.catena-x.net/api/submodel -edc https://trace-x-edc.dev.demo.catena-x.net -a https://trace-x-registry.dev.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-dataplane.dev.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC +``` + +Sample invocation (TEST) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-test.dev.demo.catena-x.net/api/submodel -edc https://trace-x-test-edc.dev.demo.catena-x.net -a https://trace-x-registry-test.dev.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-test-edc-dataplane.dev.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC +``` + +Sample invocation (E2E A) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-e2e-a.dev.demo.catena-x.net/api/submodel -edc https://trace-x-edc-e2e-a.dev.demo.catena-x.net -a https://trace-x-registry-e2e-a.dev.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-e2e-a-dataplane.dev.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC +``` + +Sample invocation (E2E B) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-e2e-b.dev.demo.catena-x.net/api/submodel -edc https://trace-x-edc-e2e-b.dev.demo.catena-x.net -a https://trace-x-registry-e2e-b.dev.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-e2e-b-dataplane.dev.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC +``` + +Sample invocation (INT A) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-int-a.int.demo.catena-x.net/api/submodel -edc https://trace-x-edc-int-a.int.demo.catena-x.net -a https://trace-x-registry-int-a.int.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-int-a-dataplane.int.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV +``` + +Sample invocation (INT B) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-int-b.int.demo.catena-x.net/api/submodel -edc https://trace-x-edc-int-b.int.demo.catena-x.net -a https://trace-x-registry-int-b.int.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-int-b-dataplane.int.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV +``` + +Sample invocation (STABLE A) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-stable-a.stable.demo.catena-x.net/api/submodel -edc https://trace-x-edc-stable-a.stable.demo.catena-x.net -a https://trace-x-registry-stable-a.stable.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-stable-a-dataplane.stable.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV +``` + +Sample invocation (STABLE B) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-stable-b.stable.demo.catena-x.net/api/submodel -edc https://trace-x-edc-stable-b.stable.demo.catena-x.net -a https://trace-x-registry-stable-b.stable.demo.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-stable-b-dataplane.stable.demo.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV --allowedBPNs BPNL00000003CML1 BPNL00000003CNKC BPNL00000003AZQP BPNL00000003CSGV +``` + +Sample invocation (ASSOCIATION INT A) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-int-a.int.catena-x.net/api/submodel -edc https://trace-x-edc-int-a.int.catena-x.net -a https://trace-x-registry-int-a.int.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-int-a-dataplane.int.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL000000000UKM BPNL000000000DWF BPNL000000000EVQ BPNL00000003CSGV --allowedBPNs BPNL000000000UKM BPNL000000000DWF BPNL00000003AZQP BPNL00000003CSGV +``` + +Sample invocation (ASSOCIATION INT B) + +``` +python transform-and-upload.py -f CX_Testdata_MessagingTest_v0.0.12.json -s https://traceability-int-b.int.catena-x.net/api/submodel -edc https://trace-x-edc-int-b.int.catena-x.net -a https://trace-x-registry-int-b.int.catena-x.net/semantics/registry/api/v3.0 -d https://trace-x-edc-int-b-dataplane.int.catena-x.net -p id-3.0-trace -k --aas3 --edcBPN BPNL000000000UKM BPNL000000000DWF BPNL000000000EVQ BPNL00000003CSGV --allowedBPNs BPNL000000000UKM BPNL000000000DWF BPNL00000003AZQP BPNL00000003CSGV +``` + +where: + +* -f file to be used for data provisioning /tx-backend/testdata/CX_Testdata_MessagingTest_vx.x.x.json +* -s submodel server url(s) -- ( currently pointing to our backend api as it was implemented under /api/submodel ) +* -edc edc url(s) to upload data to +* -a aas url(s) +* -p policies to add to the data +* -k edc api key (value from vault path) + +optional: + +* -bpns upload data only from a list of BPN + +## 3) Prepare trace-x - Registry reload ``` curl --request GET --url /api/registry/reload diff --git a/frontend/AUTHENTICATION.md b/frontend/AUTHENTICATION.md index 8c240d0b13..99c45a0c59 100644 --- a/frontend/AUTHENTICATION.md +++ b/frontend/AUTHENTICATION.md @@ -3,6 +3,8 @@ The user authentication is managed by the central keycloak instance managed by catena. You can configure your IDP there. +[Here is a link on how to do that.](https://github.com/eclipse-tractusx/portal-assets/blob/main/docs/developer/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Configure%20Company%20IdP.md) + In the app module, there is a function which is executed during the app bootstrap. That function retrieves the realm provided in the environment variables, which is used to set up the Keycloak configurations.