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.
  16 These are exposed on the same port (2443) using different URLs:
  17 - Apex Policy Editor: https://localhost:2443/apex-editor
  18 - PDP Monitoring UI: https://localhost:2443/pdp-monitoring
  19 - CLAMP Designer UI: https://localhost:2443/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 without configuration.
  29 For the GUI container to start correctly, the CLAMP backend
  30 `policy-clamp-backend` should be started first.
  31
  32 For local testing, if the CLAMP backend is running on localhost port 8443,
  33 the policy-gui docker container can be started with:
  34 ```
  35 docker run -p 2443:2443 --add-host policy-clamp-backend:host-gateway onap/policy-gui
  36 ```
  37
  38 ## Client Credentials
  39 A certificate must be added in the browser and is required to log in properly:
  40
  41 [org.onap.clamp.p12 (from clamp master)](URL "https://gerrit.onap.org/r/gitweb?p=clamp.git;a=blob_plain;f=src/main/resources/clds/aaf/org.onap.clamp.p12;hb=refs/heads/master")
  42 (Password: "China in the Spring")
  43
  44 See onap/clamp repo README for details.