README.md

   1 # Summary
   2
   3 Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
   4 Copyright (C) 2021 Nordix Foundation.
   5 This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
   6 Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
   7
   8 This source repository contains the ONAP Policy GUI code.
   9
  10 To build it using Maven 3, run: mvn clean install -P docker
  11
  12
  13 # Docker image
  14
  15 Maven produces a single docker image containing the policy GUIs. These are exposed on
  16 the same port (8080) using different URLs:
  17 - Apex Policy Editor: http://localhost:8080/apex-editor
  18 - PDP Monitoring UI: http://localhost:8080/pdp-monitoring
  19 - CLAMP Designer UI: http://localhost:8080/clamp
  20
  21 ## Building
  22 You can use the following command to build the policy-gui docker image:
  23 ```
  24 mvn clean install -P docker
  25 ```
  26
  27 ## Deployment
  28 Currently, the policy-gui docker image can be deployed with minimal configuration. As
  29 the clamp backend is required to use the clamp GUI, you can use the CLAMP_REST_URL
  30 environment variable to set its location.
  31
  32 By default, CLAMP_REST_URL is set to an invalid address (0.0.0.0), meaning the CLAMP GUI
  33 will not work without specifying CLAMP_REST_URL.
  34
  35 If running clamp as part of a docker network, where `policy-clamp-backend` is the CLAMP
  36 backend, then CLAMP_REST_URL should be set to `https://policy-clamp-backend:8443`.
  37
  38 If running clamp backend on localhost port 8443, the policy-gui docker image would be
  39 started like this:
  40 ```
  41 docker run -p 8080:8080 \
  42     --add-host host.docker.internal:host-gateway \
  43     --env CLAMP_REST_URL=https://host.docker.internal:8443 \
  44     onap/policy-gui
  45 ```