Skip to content

Latest commit

 

History

History
124 lines (86 loc) · 4.56 KB

INSTALL.md

File metadata and controls

124 lines (86 loc) · 4.56 KB
Raw

Installation Instructions

Installation Instructions Helm

Install Helm chart from the Helm chart repository

# 1. Add the helm chart repository:
helm repo add tractusx-dev https://eclipse-tractusx.github.io/charts/dev

# 2. Install traceability-foss chart into your cluster:
helm install traceability-foss tractusx-dev/traceability-foss

Use Helm chart as dependency on your own Helm chart

    dependencies:
      - name: traceability-foss
        repository: https://eclipse-tractusx.github.io/traceability-foss
        version: 1.x.x

Configure product-example Helm chart on your needs

Please have a look into our Helm chart documentation for more information about the configuration options.

Installation Instructions Frontend

Prerequisites

Getting started

Clone the source locally:

$ git clone [email protected]:eclipse-tractusx/traceability-foss.git
$ cd traceability-foss/frontend

Install prerequisites:

install node.js

$ npm install --global yarn
$ npm install -g @angular/cli
$ yarn install

Start application with yarn start and navigate to http://localhost:4200.

To run the frontend locally with an already existing backend, use the run configs in frontend/package.json.

Add a run config by creating a new entry in package.json similar to "start:auth": "ng serve --configuration=dev,auth" and adding a entry in angular.json at "projects.trace-x.architect.build.configuratns" and "projects.trace-x.architect.serve.configurations".

Add an environment by creating new file in frontend/src/environments and reference it in the package.json build configuration.

Installation Instructions Local Umbrella

Install Umbrella

Using the eclipse-tractusx/tractus-x-umbrella helm chart, all traceability-foss dependencies can be installed locally.

For detailed instructions on how to set up the umbrella chart, see the chapters "Cluster setup" and "Network setup" in the umbrella README.md.

Clone the Umbrella repo (only required once):

git clone https://github.com/eclipse-tractusx/tractus-x-umbrella.git

Check out the Trace-X umbrella integration branch:

cd tractus-x-umbrella/
git fetch origin
git checkout -b chore/trace-x-integration origin/chore/trace-x-integration

Build the required images for Idp and IATP mock.

Powershell

& minikube -p minikube docker-env --shell powershell | Invoke-Expression
docker build init-container/ -t init-container:testing
docker build iatp-mock/ -t tractusx/iatp-mock:testing --platform linux/amd64

Bash

eval $(minikube docker-env)
docker build init-container/ -t init-container:testing
docker build iatp-mock/ -t tractusx/iatp-mock:testing --platform linux/amd64

Install the umbrella chart using the values-adopter-trace-x.yaml

helm dependency update charts/tx-data-provider/
helm dependency update charts/umbrella/
helm install umbrella charts/umbrella/ -n umbrella --create-namespace -f charts/umbrella/values-adopter-trace-x.yaml

Local Frontend with Umbrella Trace-X backend

To integrate with the umbrella services, run the frontend with start:auth:localUmbrella

Afterward, use one of the following users to log into the CX-Operator realm:

Role Username Password
Supervisor [email protected] tractusx-umbr3lla!-supervisor
Admin [email protected] tractusx-umbr3lla!-admin
User [email protected] tractusx-umbr3lla!-user

Out of scope

  • Sending/receiving of quality notifications is not supported, since it would require another tracex instance.
  • 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.