summaryrefslogtreecommitdiffstats
path: root/docs/drools
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2022-11-01 13:16:21 +0000
committerLiam Fallon <liam.fallon@est.tech>2022-11-01 17:00:48 +0000
commit688a2dd3a681c28ac48ad737316c2dc1dff08526 (patch)
tree2cec8ad6af476f64fdf13f495788a277ee88644b /docs/drools
parentb0f136169fcf812b4f030a6d0ffe2817977b313c (diff)
Fix doc config files and dead links
Documentation config fixed as instructed. Configuration files have been copied from examples provided by the documentation project. Dead links are fixed as well, they cause build fails now. Issue-ID: POLICY-4426 Change-Id: Ied5ca5e5a24f7a625e5b2d94c46d0c2347c68ace Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'docs/drools')
-rw-r--r--docs/drools/feature_controllerlogging.rst5
-rw-r--r--docs/drools/feature_mdcfilters.rst7
-rw-r--r--docs/drools/pdpdApps.rst12
-rw-r--r--docs/drools/pdpdEngine.rst10
4 files changed, 19 insertions, 15 deletions
diff --git a/docs/drools/feature_controllerlogging.rst b/docs/drools/feature_controllerlogging.rst
index 561c2be7..fc8d6dab 100644
--- a/docs/drools/feature_controllerlogging.rst
+++ b/docs/drools/feature_controllerlogging.rst
@@ -2,6 +2,8 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. _feature_controllerlogging-label:
+
***************************
Feature: Controller Logging
***************************
@@ -37,7 +39,8 @@ Once a logger for the controller is configured, start the drools-pdp and navigat
.. image:: ctrlog_view.png
-The original network log remains and will append traffic information from all topics regardless of which controller it is for. To abbreviate and customize messages for the network log, refer to the `Feature MDC Filters <feature_mdcfilters.html>`_ documentation.
+The original network log remains and will append traffic information from all topics regardless of which controller it is for. To abbreviate and customize messages for the network log, refer to the
+:ref:`Feature MDC Filters <feature_mdcfilters-label>` documentation.
End of Document
diff --git a/docs/drools/feature_mdcfilters.rst b/docs/drools/feature_mdcfilters.rst
index df779401..b7077138 100644
--- a/docs/drools/feature_mdcfilters.rst
+++ b/docs/drools/feature_mdcfilters.rst
@@ -2,6 +2,8 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. _feature_mdcfilters-label:
+
********************
Feature: MDC Filters
********************
@@ -108,9 +110,8 @@ Once the feature and logback.xml is configured to the user's desired settings, s
[2019-03-22T16:38:23.884+00:00] [IN|DMAAP|DCAE-CL|664be3d2-6c12-4f4b-a3e7-c349acced200|ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e]
-The message has now been filtered to display the network infrastructure information and the extracted data from the JSON message based on the feature properties. In order to view the entire message received from a topic, a complementary feature was developed to display the entire message on a per controller basis while preserving the compact network log. Refer to the `Feature Controller Logging <feature_controllerlogging.html>`_ documentation for details.
-
-
+The message has now been filtered to display the network infrastructure information and the extracted data from the JSON message based on the feature properties. In order to view the entire message received from a topic, a complementary feature was developed to display the entire message on a per controller basis while preserving the compact network log. Refer to the
+:ref:`Feature Controller Logging <feature_controllerlogging-label>` documentation for details.
End of Document
diff --git a/docs/drools/pdpdApps.rst b/docs/drools/pdpdApps.rst
index 0fcc9f46..58bbb068 100644
--- a/docs/drools/pdpdApps.rst
+++ b/docs/drools/pdpdApps.rst
@@ -52,7 +52,7 @@ The *onap/policy-pdpd-cl* image extends the *onap/policy-drools* image with
the *usecases* controller that realizes the *control loop* application.
Usecases Controller
-====================
+===================
The `usecases <https://git.onap.org/policy/drools-applications/tree/controlloop/common/controller-usecases>`__
controller is the *control loop* application in ONAP.
@@ -140,14 +140,14 @@ telemetry API extensions. *Actor* configurations are packaged in this
feature.
Usecases Controller (controlloop-usecases)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is the *guilin* release implementation of the ONAP use cases.
It relies on the new *Actor* model framework to carry out a policy's
execution.
TDJAM Controller (controlloop-tdjam)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is an experimental, java-only controller that will be deprecated after the
guilin release.
@@ -734,7 +734,7 @@ Verify in *$POLICY_LOGS/network.log* that a *FINAL: SUCCESS* notification is sen
and an entry is added to the *$POLICY_LOGS/audit.log* indicating successful completion.
vFirewall use case testing
-===========================
+==========================
First step is to create the *operational.modifyconfig* policy.
@@ -803,7 +803,7 @@ Verify that the policy shows with the telemetry tools:
dcae.vfw.onset.json
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~
.. code-block:: bash
@@ -885,6 +885,6 @@ Additional information
======================
For additional information, please see the
-`Drools PDP Development and Testing (In Depth) <https://wiki.onap.org/display/DW/2020+Frankfurt+Tutorials>`__ page.
+`Drools PDP Development and Testing (In Depth) <https://wiki.onap.org/display/DW/2020-08+Frankfurt+Tutorials>`__ page.
diff --git a/docs/drools/pdpdEngine.rst b/docs/drools/pdpdEngine.rst
index 58120a5d..6992a8ed 100644
--- a/docs/drools/pdpdEngine.rst
+++ b/docs/drools/pdpdEngine.rst
@@ -473,7 +473,7 @@ commit to execute policies against these policy types if a supporting controller
</kmodule>
Software Architecture
-======================
+=====================
PDP-D is divided into 2 layers:
@@ -872,7 +872,7 @@ The drools libraries in the PDP-D uses maven to fetch rules artifacts and softwa
The default *settings.xml* file specifies the repositories to search. This configuration
can be overriden with a custom copy that would sit in a mounted configuration
directory. See an example of the OOM override
-`settings.xml <https://git.onap.org/oom/tree/kubernetes/policy/charts/drools/resources/configmaps/settings.xml>`__.
+`settings.xml <https://github.com/onap/oom/blob/master/kubernetes/policy/components/policy-drools-pdp/resources/configmaps/settings.xml>`_.
The default ONAP installation of the *control loop* child image *onap/policy-pdpd-cl:1.6.4* is *OFFLINE*.
In this configuration, the *rules* artifact and the *dependencies* retrieves all the artifacts from the local
@@ -883,7 +883,7 @@ An offline configuration requires two items:
- *OFFLINE* environment variable set to true.
- override *settings.xml* customization, see
- `settings.xml <https://git.onap.org/oom/tree/kubernetes/policy/charts/drools/resources/configmaps/settings.xml>`__.
+ `settings.xml <https://github.com/onap/oom/blob/master/kubernetes/policy/components/policy-drools-pdp/resources/configmaps/settings.xml>`_.
The default mode in the *onap/policy-drools:1.6.3* is ONLINE instead.
@@ -1357,7 +1357,7 @@ A post-start script *config/active.post.sh* can place PDP-D in *active* mode at
.. code-block:: bash
- bash -c "http --verify=no -a ${TELEMETRY_USER}:${TELEMETRY_PASSWORD} PUT https://localhost:9696/policy/pdp/engine/lifecycle/state/ACTIVE"
+ bash -c "http --verify=no -a ${TELEMETRY_USER}:${TELEMETRY_PASSWORD} PUT <http|https>://localhost:9696/policy/pdp/engine/lifecycle/state/ACTIVE"
Bring up the PDP-D, nexus, and mariadb
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1401,4 +1401,4 @@ Additional information
======================
For additional information, please see the
-`Drools PDP Development and Testing (In Depth) <https://wiki.onap.org/display/DW/2020+Frankfurt+Tutorials>`__ page.
+`Drools PDP Development and Testing (In Depth) <https://wiki.onap.org/display/DW/2020-08+Frankfurt+Tutorials>`__ page.