Skip to content

Latest commit

 

History

History
66 lines (60 loc) · 2.86 KB

INSTALL.md

File metadata and controls

66 lines (60 loc) · 2.86 KB

Project Installation

Running for development using mvn/npm or using docker

See the INSTALL.md files in the backend and frontend folder.

Running local integration testing user docker compose

See Install.md file in folder local for integration testing environment with two deployed applications and EDCs.

Running using helm (deployment)

  1. Configure the application:
    1. Open the values.yaml file in charts/puris.
    2. Edit the following properties to your requirements:
      • Ingress(if you want to enable ingress) for frontend/backend, under frontend.ingress. and backend.ingress.
      • EDC, under backend.puris.edc
      • Own data, under backend.puris.own
      • Current role for demonstrator, under backend.puris.demonstrator.role
      • Postgresql settings, under backend.puris.datasource (only necessary, if postgres.enabled is false - else autoconfigured).
      • Keycloak is disabled by default but can be configured under frontend.puris.keycloak.

    NOTE
    Further information on the individual properties can be found in the following README.md.

  2. Install dependencies
helm repo add bitnami https://charts.bitnami.com/bitnami
helm dependency update

Attention: When using postgres.enabled = false and bringing your own database, ensure to set backend.puris.jpa.hibernate.ddl-auto = validate to prevent DATA LOSS.

Run without Ingress

  1. Run the application:
helm install puris charts/puris \
    --namespace puris \
    --create-namespace
  1. Forward ports for services:
kubectl -n puris port-forward svc/frontend 8080:8080
kubectl -n puris port-forward svc/backend 8081:8081
  1. Done! The applications should be available at http://localhost:<forwarded-port>.

Run with Ingress

Precondition: please refer to your runtime environment's official documentation on how to enable ingress.

  1. Run the application:
helm install puris charts/puris \
    --namespace puris \
    --create-namespace \
    --set frontend.ingress.enabled=true \
    --set backend.ingress.enabled=true
  1. Edit /etc/hosts:
# If you are using minikube use minikube ip to get you clusterIp, for kind this is localhost (127.0.0.1)
sudo vim /etc/hosts
>> add entry for frontend "<cluster ip> <frontend-url.top-level-domain>"
>> add entry for backend "<cluster ip> <backend-url.top-level-domain>"
>> :wq! (save changes)
  1. Done! The applications should be available at:
    • (frontend) http://your-frontend-host-address.com
    • (backend) http://your-backend-host-address.com