summaryrefslogtreecommitdiffstats
path: root/tutorials/tutorial-enforcement/README.md
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2022-10-17 16:55:51 +0100
committerliamfallon <liam.fallon@est.tech>2022-10-18 14:15:56 +0100
commitc3e8a4a2ed66e73c6b39d68924ae8e310e7541db (patch)
tree83076413d38f24564020ca157bf6a2dd330f3747 /tutorials/tutorial-enforcement/README.md
parent9831c28c678f70640f6f84e73c9c3d15d3f5a4a6 (diff)
Fix hard coded versions in XACML-PDP tutorials
This commit adds variables to the docker-compse file for the xacml-applicaiton tutorial and adds a startup script that downloads files fromt he docker/csit repo to run the tutorial This commit also removes the separate docker-compose file that was used for xacml-enforcement tutorial and replaces it with instructions on how to use the csit docker-compose to run the enforcement. Issue-ID: POLICY-4186 Change-Id: Id1476e6c0949d3d57bdea9a696b985b60220ec78 Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'tutorials/tutorial-enforcement/README.md')
-rw-r--r--tutorials/tutorial-enforcement/README.md60
1 files changed, 54 insertions, 6 deletions
diff --git a/tutorials/tutorial-enforcement/README.md b/tutorials/tutorial-enforcement/README.md
index 23321fd2..07b55984 100644
--- a/tutorials/tutorial-enforcement/README.md
+++ b/tutorials/tutorial-enforcement/README.md
@@ -1,20 +1,68 @@
Copyright 2020 AT&T Intellectual Property. All rights reserved.
+
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
+# Build the Tutorial
+
The Policy Enforcement Tutorial can be built:
-mvn clean install
+ mvn clean install
+
+# Start the Policy Framework components
+
+Be sure to start the Policy Framework application components in *docker* if you are not testing this in a lab.
+- Ensure you have docker and docker-compose installed
+- Check out the *policy/docker* repo from the ONAP gerrit or from github: https://github.com/onap/policy-docker
+- In a console, change directory into the *csit* directory of the *policy/docker* repo
+- Start *xacml-pdp* by running the *start-containter.sh* script
+
+ start-container.sh xacml-pdp
+
+- Ensure that DMaaP is up
+
+ > curl -X POST http://0.0.0.0:30227/events/POLICY-PDP-PAP
+ Should return JSON similar to this:
+ {"serverTimeMs":0,"count":0}
+
+- Run the xacml-pdp health check
+
+ curl -u 'policyadmin:zb!XztG34' 'http://0.0.0.0:30441/policy/pdpx/v1/healthcheck'
+ Should return JSON similar to this:
+ {"name":"Policy Xacml PDP","url":"self","healthy":true,"code":200,"message":"alive"}
+
+- Run the api health check
+
+ curl -u 'policyadmin:zb!XztG34' 'http://0.0.0.0:30440/policy/api/v1/healthcheck'
+ Should return JSON similar to this:
+ {
+ "name": "Policy API",
+ "url": "policy-api",
+ "healthy": true,
+ "code": 200,
+ "message": "alive"
+ }
+
+- Run the pap health check
+
+ curl -u 'policyadmin:zb!XztG34' 'http://0.0.0.0:30442/policy/pap/v1/healthcheck'
+ Should return JSON similar to this:
+ {
+ "name": "Policy PAP",
+ "url": "policy-pap",
+ "healthy": true,
+ "code": 200,
+ "message": "alive"
+ }
-Be sure to start the Policy Framework application components if you are not testing this in a lab. See
-src/main/docker/README.txt for details to run local instances of the components.
+# Run the Tutorial
-You can run the application via code by running the App.main method with command line argument with IP then Port
+You can run the application via code by running the *App.main* method with command line argument with IP then Port
of the XACML PDP, followed by the IP then Port of Dmaap.
-App.main(new String[] {"0.0.0.0", "6969", "0.0.0.0", "3904"});
+ App.main(new String[] {"0.0.0.0", "6969", "0.0.0.0", "3904"});
-or from Eclipse by right-clicking App.java and selecting "Run As" and select "Java Application". Edit the
+or from Eclipse by right-clicking App.java and selecting *Run As* and select *Java Application*. Edit the
configuration by adding these command line arguments: "0.0.0.0" "6969" "0.0.0.0" "3904"
Quit the application by typing 'q' into stdin.