Skip to content

Commit dc5475e

Browse files
committed
chore(docs):[#511] add install instructions for local umbrella integration
1 parent f4b4322 commit dc5475e

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

INSTALL.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,52 @@
77
## Installation Instructions Backend
88

99
- [Installation Instructions Backend](tx-backend/INSTALL.md)
10+
11+
## Installation Instructions Local Umbrella
12+
13+
### Install Umbrella
14+
15+
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.
16+
17+
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).
18+
19+
Clone the [Umbrella repo](https://github.com/eclipse-tractusx/tractus-x-umbrella) (only required once):
20+
21+
```
22+
git clone https://github.com/eclipse-tractusx/tractus-x-umbrella.git
23+
```
24+
25+
Check out the [Trace-X umbrella integration branch](https://github.com/eclipse-tractusx/tractus-x-umbrella/tree/chore/trace-x-integration):
26+
27+
```
28+
cd tractus-x-umbrella/
29+
git fetch origin
30+
git checkout -b chore/trace-x-integration origin/chore/trace-x-integration
31+
```
32+
33+
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)
34+
35+
```
36+
helm dependency update charts/tx-data-provider/
37+
helm dependency update charts/umbrella/
38+
helm install umbrella charts/umbrella/ -n umbrella --create-namespace -f charts/umbrella/values-adopter-trace-x.yaml
39+
```
40+
41+
### Local Frontend with Umbrella Trace-X backend
42+
43+
To use the frontend locally, follow the [installation instructions](frontend/INSTALL.md).
44+
45+
To integrate with the umbrella services, run the frontend with `start:auth:localUmbrella`
46+
47+
Afterward, use one of the following users to log into the CX-Operator realm:
48+
49+
| Role | Username | Password |
50+
|------------|---------------------------|-------------------------------|
51+
| Supervisor | [email protected] | tractusx-umbr3lla!-supervisor |
52+
| Admin | [email protected] | tractusx-umbr3lla!-admin |
53+
| User | [email protected] | tractusx-umbr3lla!-user |
54+
55+
### Out of scope
56+
57+
- Sending notifications is currently not supported
58+
- IRS Asset Sync requires a new release of IRS which provides a fix for callback url validation

0 commit comments

Comments
 (0)