Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.29 KB

INSTALL.md

File metadata and controls

65 lines (48 loc) · 2.29 KB
Raw

Project Installation

The first steps are always the same:

  1. Clone the project
  2. Make sure the PURIS backend and the tractusx-edc is running with all its components

Depending on your needs of deployment, follow the following steps

Running using mvn (local development) and infrastructure services in kubernetes

  1. Change the src/main/resources/application.properties or the respective environment variables to configure the port, the URL of the EDC control plane, backend application etc.

  2. Run the application: mvn spring-boot:run -Dspring-boot.run.arguments=--spring.config.location="./src/main/resources/application.properties"

  3. It is highly suggested to install, configure and run the PURIS frontend afterward

Running using docker (deployment)

  1. First build a docker image:
cd backend

docker build -t puris-backend:dev .
  1. Optionally (one can set properties via environment variables to docker): Change the src/main/resources/application.properties or the respective environment variables to configure the port, the URL of the EDC control plane, backend application etc.
  2. Run the application:
cd backend

docker build -t puris-backend:dev .

# A use docker 
docker run -d --rm -p 8081:8081 --name backend -e server.port=8082 puris-backend:dev CONTAINERID

# B use docker-compose
cd ..
cd local
docker-compose up
  1. Done! The Swagger UI should be available at
    • (Java & Docker) http://YOURIP:8081/catena/swagger-ui/index.html
  2. It is highly suggested to install and run the PURIS frontend afterward (unless you're using local/docker-compose.yaml)

Running using helm (deployment)

  1. Run the application:
cd charts/puris/charts/backend

helm install backend --namespace puris --create-namespace . --set ingress.enabled=true
  1. Done! The Swagger UI should be available at
    • (Java & Docker) http://YOURIP:8081/catena/swagger-ui/index.html
    • (Kubernetes) http://CLUSTERIP:30001/catena/swagger-ui/index.html
  2. It is highly suggested to install and run the PURIS frontend afterward

NOTICE

This work is licensed under the Apache-2.0.