From 544a828417166b72d984923786784340c2948795 Mon Sep 17 00:00:00 2001 From: ashanmugavel Date: Wed, 19 Jun 2024 16:17:31 +0200 Subject: [PATCH 1/6] chore[xxx]: updated local deployment documentation --- tx-backend/INSTALL.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/tx-backend/INSTALL.md b/tx-backend/INSTALL.md index a77e5fb19e..19e2fdce78 100644 --- a/tx-backend/INSTALL.md +++ b/tx-backend/INSTALL.md @@ -6,16 +6,16 @@ ## Clone the source locally: ```sh -$ git clone git@github.com:catenax-ng/tx-traceability-foss.git -$ cd tx-traceability-foss/backend +$ git clone https://github.com/eclipse-tractusx/traceability-foss.git +$ cd traceability-foss ``` ## Local deployment -* Start the necessary infrastructure by running: ```docker-compose up``` inside [docker folder](https://github.com/eclipse-tractusx/traceability-foss/blob/main/backend//docker) +* Start the necessary infrastructure by running: ```docker-compose up``` * Export environment variables required by the service: * `SPRING_DATASOURCE_URL` - with value `jdbc:postgresql://localhost:5432/trace` - * `SPRING_DATASOURCE_USERNAME` - with value `trace` [see database initialization script](https://github.com/eclipse-tractusx/traceability-foss/blob/main/backend/docker/db-init/create_db.sql) - * `SPRING_DATASOURCE_PASSWORD` - with value `docker` [see docker-compose file](https://github.com/eclipse-tractusx/traceability-foss/blob/main/backend/docker/docker-compose.yml) + * `SPRING_DATASOURCE_USERNAME` - with value `trace` + * `SPRING_DATASOURCE_PASSWORD` - with value `docker` * `OAUTH2_CLIENT_ID` - with OAuth2 provider client registration id specific value * `OAUTH2_CLIENT_SECRET` - with OAuth2 provider client registration secret specific value * `OAUTH2_PROVIDER_TOKEN_URI` - with OAuth2 provider url to obtain tokens @@ -24,7 +24,7 @@ $ cd tx-traceability-foss/backend * `SPRING_PROFILES_ACTIVE` - with profile to be picked when starting the service. One of `[dev|int]`. * `EDC_PROVIDER_URL` - with url for the EDC provider * `TRACEABILITY_URL` - with url for the backend -* Start the service by invoking following command in project root directory `./gradlew bootRun` +* Start the service by invoking following command in project root directory `mvn spring-boot:run` ## OAuth2 configuration Product Traceability FOSS Backend relies on properly configured OAuth2 instance. In order to work, it must be configured with proper realm, clients and roles. From 8a9b9ca66b39c2d6971fa35e8fbe8a8edaf28f5a Mon Sep 17 00:00:00 2001 From: ashanmugavel Date: Fri, 21 Jun 2024 09:18:56 +0200 Subject: [PATCH 2/6] chore[xxx]: updated install.md --- tx-backend/INSTALL.md | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/tx-backend/INSTALL.md b/tx-backend/INSTALL.md index 19e2fdce78..3e35727978 100644 --- a/tx-backend/INSTALL.md +++ b/tx-backend/INSTALL.md @@ -9,22 +9,7 @@ $ git clone https://github.com/eclipse-tractusx/traceability-foss.git $ cd traceability-foss ``` - -## Local deployment -* Start the necessary infrastructure by running: ```docker-compose up``` -* Export environment variables required by the service: - * `SPRING_DATASOURCE_URL` - with value `jdbc:postgresql://localhost:5432/trace` - * `SPRING_DATASOURCE_USERNAME` - with value `trace` - * `SPRING_DATASOURCE_PASSWORD` - with value `docker` - * `OAUTH2_CLIENT_ID` - with OAuth2 provider client registration id specific value - * `OAUTH2_CLIENT_SECRET` - with OAuth2 provider client registration secret specific value - * `OAUTH2_PROVIDER_TOKEN_URI` - with OAuth2 provider url to obtain tokens - * `OAUTH2_JWK_SET_URI` - with OAuth2 provider certs url - * `JWT_RESOURCE_CLIENT` - with JWT resource client name - * `SPRING_PROFILES_ACTIVE` - with profile to be picked when starting the service. One of `[dev|int]`. - * `EDC_PROVIDER_URL` - with url for the EDC provider - * `TRACEABILITY_URL` - with url for the backend -* Start the service by invoking following command in project root directory `mvn spring-boot:run` +We do not support local deployment of the app. ## OAuth2 configuration Product Traceability FOSS Backend relies on properly configured OAuth2 instance. In order to work, it must be configured with proper realm, clients and roles. From 3ed6e39af5414ca9afb155183ff74e2e6a344b65 Mon Sep 17 00:00:00 2001 From: ashanmugavel Date: Fri, 21 Jun 2024 09:20:38 +0200 Subject: [PATCH 3/6] chore[xxx]: delete SubmodelController --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a306348c07..f061992bfe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ _**For better traceability add the corresponding GitHub issue number in each cha - #965 Implement proxy functionality of the IRS policy store - #962 Changed notification model to new one in frontend/backend - #753 Refactored message history in notification detail view +- XXX updated local deployment documentation ### Added - #832 added policymanagement list view, creator and editor From c684607a43f0227a5a2d63248ce40a0142802b7a Mon Sep 17 00:00:00 2001 From: ashanmugavel Date: Fri, 21 Jun 2024 09:20:38 +0200 Subject: [PATCH 4/6] chore[xxx]: updated install.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a306348c07..f061992bfe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ _**For better traceability add the corresponding GitHub issue number in each cha - #965 Implement proxy functionality of the IRS policy store - #962 Changed notification model to new one in frontend/backend - #753 Refactored message history in notification detail view +- XXX updated local deployment documentation ### Added - #832 added policymanagement list view, creator and editor From 5dc3002fe03827bdf6165507c06af3b8b5aea5b2 Mon Sep 17 00:00:00 2001 From: ashanmugavel Date: Fri, 21 Jun 2024 09:22:37 +0200 Subject: [PATCH 5/6] chore[xxx]: updated install.md --- tx-backend/INSTALL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tx-backend/INSTALL.md b/tx-backend/INSTALL.md index 3e35727978..332a853dd6 100644 --- a/tx-backend/INSTALL.md +++ b/tx-backend/INSTALL.md @@ -9,7 +9,7 @@ $ git clone https://github.com/eclipse-tractusx/traceability-foss.git $ cd traceability-foss ``` -We do not support local deployment of the app. +Please note: Local deployment of the app is not supported. ## OAuth2 configuration Product Traceability FOSS Backend relies on properly configured OAuth2 instance. In order to work, it must be configured with proper realm, clients and roles. From 2be192de0d7dbed64c5d8ebbf1be39417bbcdf85 Mon Sep 17 00:00:00 2001 From: Maximilian Wesener <124587888+ds-mwesener@users.noreply.github.com> Date: Fri, 21 Jun 2024 09:30:43 +0200 Subject: [PATCH 6/6] Update tx-backend/INSTALL.md --- tx-backend/INSTALL.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tx-backend/INSTALL.md b/tx-backend/INSTALL.md index 332a853dd6..7acf28aed0 100644 --- a/tx-backend/INSTALL.md +++ b/tx-backend/INSTALL.md @@ -9,7 +9,9 @@ $ git clone https://github.com/eclipse-tractusx/traceability-foss.git $ cd traceability-foss ``` -Please note: Local deployment of the app is not supported. +Please note: Local deployment of the app is not supported. + +For deployment please find our helm chart github actions here: https://github.com/eclipse-tractusx/traceability-foss/actions/workflows/helm-upgrade.yaml and https://github.com/eclipse-tractusx/traceability-foss/actions/workflows/helm-test-backwards-compatability.yaml. Within this actions the full application is configured to start up. ## OAuth2 configuration Product Traceability FOSS Backend relies on properly configured OAuth2 instance. In order to work, it must be configured with proper realm, clients and roles.