aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authordanielhanrahan <daniel.hanrahan@est.tech>2021-09-08 17:55:13 +0100
committerdanielhanrahan <daniel.hanrahan@est.tech>2021-09-10 11:47:18 +0100
commit69d300a2132f103162a5e98f68ae4256750ce527 (patch)
treee5cca7b3f647987820a5f55a78490bdc36711238 /README.md
parent4ee6cfe3c0c507370118348d782b14a09e1b3c53 (diff)
Remove CLAMP_REST_URL variable from Docker image
Remove redundant CLAMP_REST_URL environment variable Update README to remove references to CLAMP_REST_URL Group Dockerfile COPY commands to reduce image layers Issue-ID: POLICY-3639 Signed-off-by: danielhanrahan <daniel.hanrahan@est.tech> Change-Id: Ia6947a6681875167dfc63b0ffd19f7dc6faad6d4
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 11 insertions, 20 deletions
diff --git a/README.md b/README.md
index 4bff635..feea0aa 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,11 @@ To build it using Maven 3, run: mvn clean install -P docker
# Docker image
-Maven produces a single docker image containing the policy GUIs. These are exposed on
-the same port (2443) using different URLs:
-- Apex Policy Editor: http://localhost:2443/apex-editor
-- PDP Monitoring UI: http://localhost:2443/pdp-monitoring
-- CLAMP Designer UI: http://localhost:2443/clamp
+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
+- PDP Monitoring UI: https://localhost:2443/pdp-monitoring
+- CLAMP Designer UI: https://localhost:2443/clamp
## Building
You can use the following command to build the policy-gui docker image:
@@ -25,23 +25,14 @@ mvn clean install -P docker
```
## Deployment
-Currently, the policy-gui docker image can be deployed with minimal configuration. As
-the clamp backend is required to use the clamp GUI, you can use the CLAMP_REST_URL
-environment variable to set its location.
+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.
-By default, CLAMP_REST_URL is set to an invalid address (0.0.0.0), meaning the CLAMP GUI
-will not work without specifying CLAMP_REST_URL.
-
-If running clamp as part of a docker network, where `policy-clamp-backend` is the CLAMP
-backend, then CLAMP_REST_URL should be set to `https://policy-clamp-backend:8443`.
-
-If running clamp backend on localhost port 8443, the policy-gui docker image would be
-started like this:
+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 host.docker.internal:host-gateway \
- --env CLAMP_REST_URL=https://host.docker.internal:8443 \
- onap/policy-gui
+docker run -p 2443:2443 --add-host policy-clamp-backend:host-gateway onap/policy-gui
```
## Client Credentials