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[xxx]: updated local deployment documentation #1063

Merged
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 4 additions & 17 deletions tx-backend/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,12 @@
## 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
```
Please note: Local deployment of the app is not supported.

## 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make clear that we do not support local deployment of the app.

* 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)
* `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 `./gradlew bootRun`
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.
Expand Down
Loading