Skip to content

Commit

Permalink
fix(README):[#1070] appropriate README.md 2
Browse files Browse the repository at this point in the history
  • Loading branch information
mkanal committed Jul 22, 2024
1 parent 4beb262 commit 9b27cd2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,15 +141,15 @@ Please find [here](frontend/AUTHENTICATION.md) some important information about

### Application Architecture & Patterns

This [architecture](frontend/ARCHITECTURE.md) gives you a roadmap and best practices to follow when building an application
This [Architecture](frontend/ARCHITECTURE.md) gives you a roadmap and best practices to follow when building an application
so that you end up with a well-structured app.

### User Guide

A detailed [explanation](docs/user/user-manual.adoc) of how to use the application.

### Frontend Testing Strategy
See [TESTING](frontend/TESTING.md).
See [Testing](frontend/TESTING.md).

## Backend Application

Expand All @@ -163,7 +163,7 @@ See [TESTING](frontend/TESTING.md).
* see [Installation guide](tx-backend/INSTALL.md)

### Backend Testing Strategy
See [TESTING](tx-backend/TESTING.md).
See [Testing](tx-backend/TESTING.md).

## API Documentation
The project follows [OpenAPI Specification](https://swagger.io/specification/) in order to document implemented REST Endpoints. The documentation can be found under [/openapi directory](https://github.com/eclipse-tractusx/traceability-foss/blob/main/tx-backend/openapi/traceability-foss-backend.json)
Expand Down
12 changes: 6 additions & 6 deletions tx-backend/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +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.
For deployment please find our helm chart github actions here: [helm-upgrade.yaml](../.github/workflows/helm-upgrade.yaml) and [helm-test-backwards-compatability.yaml](../.github/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 All @@ -22,9 +22,10 @@ Users should have one of the following roles assigned:

## Helm secrets configuration
Product Traceability FOSS Backend ships with helm charts and utilize [helm dependency](https://helm.sh/docs/helm/helm_dependency/) functionality for 3rd party components.
In order to deploy the service following secrets needs to be provided for specific environment [see project helm environment specifc files](https://github.com/eclipse-tractusx/traceability-foss/blob/main/charts/traceability-foss-backend):

### OAuth2
### OAuth2 Properties
In order to deploy the service following secrets needs to be provided for specific environment [see project helm environment specifc files](../charts/traceability-foss/charts/backend/values.yaml):

* `oauth2.clientId` - OAuth2 client registration id credentials
* `oauth2.clientSecret` - OAuth2 client registration secret credentials

Expand All @@ -46,7 +47,7 @@ spring:
flyway:
clean-on-validation-error: false
```
Database scripts are executed with Flyway. Put the scripts at [migration](https://github.com/eclipse-tractusx/traceability-foss/blob/main/backend/src/main/resources/db/migration)
Database scripts are executed with Flyway. Put the scripts at [migration](src/main/resources/db/migration)
* `postgresql.secret.initUserDbSql` - database initialization script, contains username and password for databases used by the service.
Please note that the final script should be encoded using Base64 encoding and then added to a secret. Sample command:
Expand All @@ -62,7 +63,6 @@ echo -n 'CREATE ROLE trace WITH LOGIN PASSWORD 'yourPassword';\nCREATE DATABASE
## Helm installation
Add the Trace-X Backend Helm repository:


```sh
$ helm repo add traceability-foss-backend https://eclipse-tractusx.github.io/traceability-foss-backend
```
Expand Down

0 comments on commit 9b27cd2

Please sign in to comment.