summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authordanielhanrahan <daniel.hanrahan@est.tech>2022-01-28 11:41:38 +0000
committerDaniel Hanrahan <daniel.hanrahan@est.tech>2022-02-28 13:33:32 +0000
commite56f12777c43885696a98f07e01c040f95ca7015 (patch)
tree6366ce00bb7ca9740a98347bbc6e38ff62a54593 /README.md
parent4a4a638d6d0336134cdb4cdab093054f3b3f09f9 (diff)
Run policy GUIs in a single JAR
Create gui-server module serving clamp and apex GUIs using Spring Add Spring filter to pass client SSL cert to clamp backend Remove nginx from docker image Add logback.xml to docker image Add helper scripts for running gui-server jar and docker Issue-ID: POLICY-3638 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ie857f5755015c522b8cf781de255f7a1d567e263
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/README.md b/README.md
index 575ad31..26487e9 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
# Summary
Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
-Copyright (C) 2021 Nordix Foundation.
+Copyright (C) 2021-2022 Nordix Foundation.
This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
@@ -14,8 +14,8 @@ To build it using Maven 3, run: mvn clean install -P docker
Maven produces a single docker image containing the policy GUIs.
These are exposed on the same port (2443) using different URLs:
-- Apex Policy Editor: https://localhost:2443/apex-editor
-- CLAMP Designer UI: https://localhost:2443/clamp
+- Apex Policy Editor: https://localhost:2443/apex-editor/
+- CLAMP Designer UI: https://localhost:2443/clamp/
## Building
You can use the following command to build the policy-gui docker image:
@@ -23,18 +23,16 @@ You can use the following command to build the policy-gui docker image:
mvn clean install -P docker
```
-## Deployment
-Currently, the policy-gui docker image can be deployed without configuration.
-For the GUI container to start correctly, the CLAMP backend
-`policy-clamp-backend` should be started first.
+## Running
+The gui-server module contains a server that hosts the GUIs.
+There are helper scripts for running the gui-server JAR and Docker image.
+They may be found under gui/gui-server/extra/bin-for-dev/
-For local testing, if the CLAMP backend is running on localhost port 8443,
-the policy-gui docker container can be started with:
-```
-docker run -p 2443:2443 --add-host policy-clamp-backend:host-gateway onap/policy-gui
-```
+These scripts assume the clamp backend is running at https://localhost:8443
## Client Credentials
+For integration with AAF, gui-server requests client SSL cert.
+
A certificate must be added in the browser and is required to log in properly:
[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")