aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/platform/clc.rst8
-rw-r--r--docs/platform/cookbook.rst139
-rw-r--r--docs/platform/index.rst18
-rw-r--r--docs/platform/installation.rst48
-rw-r--r--docs/platform/swarch_srm.rst10
5 files changed, 171 insertions, 52 deletions
diff --git a/docs/platform/clc.rst b/docs/platform/clc.rst
new file mode 100644
index 000000000..2b7ff7630
--- /dev/null
+++ b/docs/platform/clc.rst
@@ -0,0 +1,8 @@
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+**************************************
+Policy Control Loop Coordination - POC
+**************************************
+
diff --git a/docs/platform/cookbook.rst b/docs/platform/cookbook.rst
index fee191358..c4a2c7cf3 100644
--- a/docs/platform/cookbook.rst
+++ b/docs/platform/cookbook.rst
@@ -6,11 +6,11 @@
Policy Cookbook
***************
-Policy VM/Docker Recipes
-^^^^^^^^^^^^^^^^^^^^^^^^
+Openstack Heat Installation - Policy VM/Docker Recipes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
- :caption: Get latest images in an already setup policy VM
+ :caption: Get the latest images in an already setup policy VM
:linenos:
/opt/policy_vm_init.sh
@@ -31,60 +31,106 @@ Policy VM/Docker Recipes
# This is the current default mode of instantiation.
# These operations are unnecessary unless PRELOAD_POLICIES
# was previously set to true
-
+
echo "PRELOAD_POLICIES=true" > /opt/policy/.env
/opt/policy_vm_init.sh
.. code-block:: bash
- :caption: Access the PDP-D container as a policy user
+ :caption: Access the PDP-D container as the policy user
:linenos:
docker exec -it drools bash
.. code-block:: bash
- :caption: Access the PDP-X container as a policy user
+ :caption: Access the PDP-X container as the policy user
:linenos:
docker exec -it -u 0 pdp su - policy
.. code-block:: bash
- :caption: Access the BRMSGW container as a policy user
+ :caption: Access the BRMSGW container as the policy user
:linenos:
docker exec -it -u 0 brmsgw su - policy
.. code-block:: bash
- :caption: Access PAP container as a policy user
+ :caption: Access PAP container as the policy user
:linenos:
docker exec -it -u 0 pap su - policy
.. code-block:: bash
- :caption: Access the CONSOLE container as a policy user
+ :caption: Access the CONSOLE container the a policy user
:linenos:
docker exec -it -u 0 console su - policy
.. code-block:: bash
- :caption: Manual Healthcheck invokation
+ :caption: Command line Healthcheck invokation
:linenos:
- # Assuming the healthcheck service credentials have not been changed
- # post-installation within the drools container
-
source /opt/app/policy/config/feature-healthcheck.conf.environment
- curl --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}"
- -X GET http://localhost:6969/healthcheck | python -m json.tool
+ curl --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}"
+ -X GET https://localhost:6969/healthcheck | python -m json.tool
+
+
+OOM Installation - Policy Kubernetes Recipes
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ .. code-block:: bash
+ :caption: List the policy pods
+ :linenos:
+
+ kubectl get pods -n onap -o wide | grep policy
+
+
+ .. code-block:: bash
+ :caption: Access the PAP container
+ :linenos:
+
+ kubectl exec -it <pap-pod> -c pap -n onap bash
+
+
+ .. code-block:: bash
+ :caption: Access a PDPD-D container
+ :linenos:
+
+ # <policy-deployment-prefix> depends on the deployment configuration
+
+ kubectl exec -it <policy-deployment-prefix>-drools-0 -c drools -n onap bash
+
+
+ .. code-block:: bash
+ :caption: Access the PDP container
+ :linenos:
+
+ # <policy-deployment-prefix> depends on the deployment configuration
+
+ kubectl exec -it <policy-deployment-prefix>-pdp-0 -c drools -n onap bash
+
+
+ .. code-block:: bash
+ :caption: Push Default Policies
+ :linenos:
+
+ kubectl exec -it <pap-pod> -c pap -n onap -- bash -c "export PRELOAD_POLICIES=true; /tmp/policy-install/config/push-policies.sh"
+
+
+ .. code-block:: bash
+ :caption: Standalone Policy Web UI URL access
+ :linenos:
+ http://<pap-vm>:30219/onap/login.htm
-PDP-D Recipes ("drools" container)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+PDP-D Recipes (inside the "drools" container)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
:caption: Stop the PDP-D
@@ -104,12 +150,61 @@ PDP-D Recipes ("drools" container)
:caption: Manual Healthcheck Invokation
:linenos:
- # Assuming the healthcheck service credentials have not been changed
- # post-installation within the drools container
-
source ${POLICY_HOME}/config/feature-healthcheck.conf
- curl --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}"
- -X GET http://localhost:6969/healthcheck | python -m json.tool
+ curl --silent --user "${HEALTHCHECK_USER}:${HEALTHCHECK_PASSWORD}"
+ -X GET https://localhost:6969/healthcheck | python -m json.tool
+
+
+ .. code-block:: bash
+ :caption: Start a telemetry shell
+ :linenos:
+
+ telemetry
+
+
+ .. code-block:: bash
+ :caption: See all the configured loggers
+ :linenos:
+
+ curl -k --silent --user "${ENGINE_MANAGEMENT_USER}:${ENGINE_MANAGEMENT_PASSWORD}"
+ https://localhost:9696/policy/pdp/engine/tools/loggers
+
+
+ .. code-block:: bash
+ :caption: See the logging level for a given logger (for example the network logger):
+ :linenos:
+
+ curl -k --silent --user"${ENGINE_MANAGEMENT_USER}:${ENGINE_MANAGEMENT_PASSWORD}"
+ https://localhost:9696/policy/pdp/engine/tools/loggers/network
+
+
+ .. code-block:: bash
+ :caption: Modify the logging level for a given logger (for example the network logger):
+ :linenos:
+
+ curl -k --silent --user"${ENGINE_MANAGEMENT_USER}:${ENGINE_MANAGEMENT_PASSWORD}"
+ -X PUT https://localhost:9696/policy/pdp/engine/tools/loggers/network/WARN
+
+
+PAP Recipes (inside the "pap" container)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ .. code-block:: bash
+ :caption: Bypass Portal Authentication with the Policy Web UI
+ :linenos:
+
+ edit: /opt/app/policy/servers/console/webapps/onap/WEB-INF/classes/portal.properties
+ comment out: #role_access_centralized = remote
+ restart pap: policy.sh stop; policy.sh start;
+
+
+ .. code-block:: bash
+ :caption: Access the Policy Web UI without going through the Portal UI
+ :linenos:
+
+ https://<pap-vm>:8443/onap/login.htm (Heat)
+ https://<pap-vm>:30219/onap/login.htm (Kubernetes)
+
End of Document
diff --git a/docs/platform/index.rst b/docs/platform/index.rst
index 91336e4fe..0bac8a09d 100644
--- a/docs/platform/index.rst
+++ b/docs/platform/index.rst
@@ -29,6 +29,16 @@ Policy Software Architecture
:maxdepth: 1
swarch_pdp.rst
+ swarch_pdpx.rst
+ swarch_pap.rst
+ swarch_brmsgw.rst
+
+PDP-D Features
+----------------------------
+
+.. toctree::
+ :maxdepth: 1
+
feature_eelf.rst
feature_testtransaction.rst
feature_healthcheck.rst
@@ -37,9 +47,7 @@ Policy Software Architecture
feature_activestdbymgmt.rst
feature_locking.rst
feature_pooling.rst
- swarch_pdpx.rst
- swarch_pap.rst
- swarch_brmsgw.rst
+
Policy Platform Tutorials
-------------------------
@@ -62,6 +70,4 @@ Policy Platform Tutorials
modAAIdata.rst
oofhpa.rst
oofSpec.rst
-
-
-
+ clc.rst
diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst
index 0f068ea8f..987c69511 100644
--- a/docs/platform/installation.rst
+++ b/docs/platform/installation.rst
@@ -42,15 +42,14 @@ ONAP Policy requires all the *policy* modules from the ONAP repository. It also
## the ONAP repos to clone
onap_repos="\
- policy/api \
+ policy/parent \
policy/common \
policy/docker \
policy/drools-applications \
policy/drools-pdp \
policy/engine \
- policy/gui \
- policy/pap \
- policy/pdp"
+ policy/apex-pdp \
+ policy/distribution"
##
## Help screen and exit condition (i.e. too few arguments)
@@ -135,15 +134,14 @@ Execution of the script above results in the following directory hierarchy in yo
* ~/git/onap
* ~/git/onap/policy
- * ~/git/onap/policy/api
+ * ~/git/onap/policy/parent
* ~/git/onap/policy/common
* ~/git/onap/policy/docker
* ~/git/onap/policy/drools-applications
* ~/git/onap/policy/drools-pdp
* ~/git/onap/policy/engine
- * ~/git/onap/policy/gui
- * ~/git/onap/policy/pap
- * ~/git/onap/policy/pdp
+ * ~/git/onap/policy/apex-pdp
+ * ~/git/onap/policy/distribution
Building ONAP
@@ -177,15 +175,13 @@ Building ONAP
</organization>
<modules>
+ <module>parent</module>
<module>common</module>
- <module>engine</module>
- <module>pdp</module>
- <module>pap</module>
<module>drools-pdp</module>
<module>drools-applications</module>
- <module>api</module>
- <module>gui</module>
- <module>docker</module>
+ <module>engine</module>
+ <module>apex-pdp</module>
+ <module>distribution</module>
</modules>
</project>
@@ -219,10 +215,25 @@ The instructions here are based on the instructions in the file *~/git/onap/poli
docker build -t onap/policy-drools policy-drools
+**Step 3:** Build the Policy SDC Distribution docker image:
+
+ .. code-block:: bash
+
+ cd ~/git/onap/policy/distribution/packages
+ mvn clean install -Pdocker
+
+**Step 4:** Build the Apex PDP docker image:
+
+ .. code-block:: bash
+
+ cd ~/git/onap/policy/apex-pdp/packages/apex-pdp-docker/target
+ docker build -t onap/policy-apex-pdp policy-apex-pdp
+
+
Starting the ONAP Policy Framework Docker Images
------------------------------------------------
-In order to run the containers, you can use *docker-compose*. This uses the *docker-compose.yml* yaml file to bring up the ONAP Policy Framework.
+In order to run the containers, you can use *docker-compose*. This uses the *docker-compose.yml* yaml file to bring up the ONAP Policy Framework. This file is located in the policy/docker repository.
**Step 1:** Make the file config/drools/drools-tweaks.sh executable.
@@ -258,13 +269,12 @@ In order to run the containers, you can use *docker-compose*. This uses the *doc
**You now have a full standalone ONAP Policy framework up and running!**
-Installation of Controllers and Policies
-----------------------------------------
+Installation of Drools Controllers and Policies
+-----------------------------------------------
-You may now install a controller and policies on the ONAP Policy Framework. Follow either of the HowTos below to install either the Amsterdam or Beijing controller and policies.
+You may now install a controller and policies on the ONAP Policy Framework. Follow the HowTos below to install the Amsterdam controller and policies.
* `Installation of Amsterdam Controller and vCPE Policy <installAmsterController.html>`_
- * `Installation of Beijing Controller and Policies <installBeijingController.html>`_
diff --git a/docs/platform/swarch_srm.rst b/docs/platform/swarch_srm.rst
index 1483eb24e..af9eca33b 100644
--- a/docs/platform/swarch_srm.rst
+++ b/docs/platform/swarch_srm.rst
@@ -79,7 +79,7 @@ A policy healthcheck (with more detailed output) can be done directly by invokin
# please modify configuration pre-installation at:
# oom/kubernetes/policy/charts/drools/resources/config/opt/policy/config/drools/keys/feature-healthcheck.conf
- curl --silent --user 'healthcheck:zb!XztG34' -X GET http://localhost:30217/healthcheck | python -m json.tool
+ curl --silent --user 'demo@people.osaaf.org:demo123456!' -X GET http://localhost:30217/healthcheck | python -m json.tool
{
"details": [
{
@@ -135,7 +135,7 @@ The following command can be issued on each of the PDP-D replicas IPs:
# oom/kubernetes/policy/charts/drools/resources/config/opt/policy/config/drools/base.conf
- curl --silent --user '@1b3rt:31nst31n' -X GET http://<drools-replica-ip>:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
+ curl --silent --user 'demo@people.osaaf.org:demo123456!' -X GET http://<drools-replica-ip>:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
{
"alive": false,
"artifactId": "NO-ARTIFACT-ID",
@@ -260,7 +260,7 @@ The following command can be used for verifying each replica:
# please modify configuration pre-installation at:
# oom/kubernetes/policy/charts/drools/resources/config/opt/policy/config/drools/base.conf
- curl --silent --user '@1b3rt:31nst31n' -X GET http://<replica-ip>:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
+ curl --silent --user 'demo@people.osaaf.org:demo123456!' -X GET http://<replica-ip>:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
{
"alive": true,
@@ -521,7 +521,7 @@ Verification that the restarted PDP-D 0 comes up with the appropriate policy loa
.. code-block:: bash
:caption: Verifying restarted PDP-D points to policies pre-failure.
- ubuntu@k8sx:~$ curl --silent --user '@1b3rt:31nst31n' -X GET http://10.42.10.21:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
+ ubuntu@k8sx:~$ curl --silent --user 'demo@people.osaaf.org:demo123456!' -X GET http://10.42.10.21:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
{
"alive": true,
"artifactId": "policy-amsterdam-rules",
@@ -911,7 +911,7 @@ Verify that the new PDP-D comes up with the latest policy coordinates:
.. code-block:: bash
:caption: Verify new PDP-D 2 comes up with policies loaded
- ubuntu@k8sx:~$ curl --silent --user '@1b3rt:31nst31n' -X GET http://10.42.172.88:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
+ ubuntu@k8sx:~$ curl --silent --user 'demo@people.osaaf.org:demo123456!' -X GET http://10.42.172.88:9696/policy/pdp/engine/controllers/amsterdam/drools | python -m json.tool
{
"alive": true,
"artifactId": "policy-amsterdam-rules",