|
1 | 1 | # Installation Instructions |
2 | 2 |
|
| 3 | +## Installation Instructions Helm |
| 4 | + |
| 5 | +### Install Helm chart from the Helm chart repository |
| 6 | + |
| 7 | +``` |
| 8 | +# 1. Add the helm chart repository: |
| 9 | +helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev |
| 10 | +``` |
| 11 | + |
| 12 | +``` |
| 13 | +# 2. Install traceability-foss chart into your cluster: |
| 14 | +helm install traceability-foss tractusx-dev/traceability-foss |
| 15 | +``` |
| 16 | +### Use Helm chart as dependency on your own Helm chart |
| 17 | + |
| 18 | +``` |
| 19 | + dependencies: |
| 20 | + - name: traceability-foss |
| 21 | + repository: https://eclipse-tractusx.github.io/traceability-foss |
| 22 | + version: 1.x.x |
| 23 | +``` |
| 24 | + |
| 25 | +### Configure product-example Helm chart on your needs |
| 26 | + |
| 27 | +Please have a look into our [Helm chart documentation](charts/traceability-foss/README.md) for more information about the configuration options. |
| 28 | + |
3 | 29 | ## Installation Instructions Frontend |
4 | 30 |
|
5 | | -- [Installation Instructions Frontend](frontend/INSTALL.md) |
| 31 | +### Prerequisites |
| 32 | + |
| 33 | +* [Node.js 18](https://nodejs.org/en) |
| 34 | +* [Angular CLI](https://angular.io/cli) |
| 35 | +* [YARN](https://yarnpkg.com/) |
| 36 | + |
| 37 | +### Getting started |
| 38 | + |
| 39 | +Clone the source locally: |
| 40 | + |
| 41 | +```bash |
| 42 | +$ git clone [email protected]:eclipse-tractusx/traceability-foss.git |
| 43 | +$ cd traceability-foss/frontend |
| 44 | +``` |
| 45 | + |
| 46 | +#### Install prerequisites: |
| 47 | + |
| 48 | +install [node.js](https://nodejs.org/en/download/package-manager) |
| 49 | +```bash |
| 50 | +$ npm install --global yarn |
| 51 | +$ npm install -g @angular/cli |
| 52 | +$ yarn install |
| 53 | +``` |
| 54 | + |
| 55 | +Start application with ``yarn start`` and navigate to ``http://localhost:4200``. |
| 56 | + |
| 57 | +To run the frontend locally with an already existing backend, use the run configs in [frontend/package.json](frontend/package.json). |
| 58 | + |
| 59 | +Add a run config by creating a new entry in [package.json](frontend/package.json) similar to `"start:auth": "ng serve --configuration=dev,auth"` and adding a entry in [angular.json](frontend/angular.json) at "projects.trace-x.architect.build.configuratns" and "projects.trace-x.architect.serve.configurations". |
| 60 | + |
| 61 | +Add an environment by creating new file in [frontend/src/environments](frontend/src/environments) and reference it in the [package.json](frontend/package.json) build configuration. |
| 62 | + |
| 63 | +## Installation Instructions Local Umbrella |
| 64 | + |
| 65 | +### Install Umbrella |
| 66 | + |
| 67 | +Using the [eclipse-tractusx/tractus-x-umbrella](https://github.com/eclipse-tractusx/tractus-x-umbrella) helm chart, all traceability-foss dependencies can be installed locally. |
| 68 | + |
| 69 | +For detailed instructions on how to set up the umbrella chart, see the chapters "Cluster setup" and "Network setup" in the umbrella [README.md](https://github.com/eclipse-tractusx/tractus-x-umbrella/blob/main/charts/umbrella/README.md). |
| 70 | + |
| 71 | +Clone the [Umbrella repo](https://github.com/eclipse-tractusx/tractus-x-umbrella) (only required once): |
| 72 | + |
| 73 | +``` |
| 74 | +git clone https://github.com/eclipse-tractusx/tractus-x-umbrella.git |
| 75 | +``` |
| 76 | + |
| 77 | +Check out the [Trace-X umbrella integration branch](https://github.com/eclipse-tractusx/tractus-x-umbrella/tree/chore/trace-x-integration): |
| 78 | + |
| 79 | +``` |
| 80 | +cd tractus-x-umbrella/ |
| 81 | +git fetch origin |
| 82 | +git checkout -b chore/trace-x-integration origin/chore/trace-x-integration |
| 83 | +``` |
| 84 | + |
| 85 | +Build the required images for Idp and IATP mock. |
| 86 | + |
| 87 | +#### Powershell |
| 88 | +```powershell |
| 89 | +& minikube -p minikube docker-env --shell powershell | Invoke-Expression |
| 90 | +docker build init-container/ -t init-container:testing |
| 91 | +docker build iatp-mock/ -t tractusx/iatp-mock:testing --platform linux/amd64 |
| 92 | +``` |
| 93 | + |
| 94 | +#### Bash |
| 95 | +```bash |
| 96 | +eval $(minikube docker-env) |
| 97 | +docker build init-container/ -t init-container:testing |
| 98 | +docker build iatp-mock/ -t tractusx/iatp-mock:testing --platform linux/amd64 |
| 99 | +``` |
| 100 | + |
| 101 | +Install the umbrella chart using the [values-adopter-trace-x.yaml](https://github.com/eclipse-tractusx/tractus-x-umbrella/blob/chore/trace-x-integration/charts/umbrella/values-adopter-trace-x.yaml) |
| 102 | + |
| 103 | +``` |
| 104 | +helm dependency update charts/tx-data-provider/ |
| 105 | +helm dependency update charts/umbrella/ |
| 106 | +helm install umbrella charts/umbrella/ -n umbrella --create-namespace -f charts/umbrella/values-adopter-trace-x.yaml |
| 107 | +``` |
| 108 | + |
| 109 | +### Local Frontend with Umbrella Trace-X backend |
| 110 | + |
| 111 | +To integrate with the umbrella services, run the frontend with `start:auth:localUmbrella` |
| 112 | + |
| 113 | +Afterward, use one of the following users to log into the CX-Operator realm: |
| 114 | + |
| 115 | +| Role | Username | Password | |
| 116 | +|------------|---------------------------|-------------------------------| |
| 117 | +| Supervisor | [email protected] | tractusx-umbr3lla!-supervisor | |
| 118 | +| Admin | [email protected] | tractusx-umbr3lla!-admin | |
| 119 | +| User | [email protected] | tractusx-umbr3lla!-user | |
6 | 120 |
|
7 | | -## Installation Instructions Backend |
| 121 | +### Out of scope |
8 | 122 |
|
9 | | -- [Installation Instructions Backend](tx-backend/INSTALL.md) |
| 123 | +- Sending/receiving of quality notifications is not supported, since it would require another tracex instance. |
| 124 | +- IRS Asset Sync does not yet work with IRS 5.4.0. It requires a new release of IRS which provides a fix for callback url validation. |
0 commit comments