Release docker images for policy/gui: 3.1.2
[policy/gui.git] / README.md
1 # Summary
2
3 Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
4 Copyright (C) 2021-2022 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 - CLAMP Designer UI: https://localhost:2443/clamp/
19
20 ## Building
21 You can use the following command to build the policy-gui docker image:
22 ```
23 mvn clean install -P docker
24 ```
25
26 ## Running
27 The gui-server module contains a server that hosts the GUIs.
28 There are helper scripts for running the gui-server JAR and Docker image.
29 They may be found under gui/gui-server/extra/bin-for-dev/
30
31 These scripts assume the clamp backend is running at https://localhost:8443
32
33 ## Client Credentials
34 For integration with AAF, gui-server requests client SSL cert.
35
36 A certificate must be added in the browser and is required to log in properly:
37
38 [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")
39 (Password: "China in the Spring")
40
41 See onap/clamp repo README for details.