summaryrefslogtreecommitdiffstats
path: root/docs/development
diff options
context:
space:
mode:
Diffstat (limited to 'docs/development')
-rw-r--r--docs/development/actors/cds/cds.rst2
-rw-r--r--docs/development/actors/vfc/vfc.rst8
-rw-r--r--docs/development/devtools/devtools.rst61
-rw-r--r--docs/development/pdp/pdp-pap-interaction.rst10
4 files changed, 71 insertions, 10 deletions
diff --git a/docs/development/actors/cds/cds.rst b/docs/development/actors/cds/cds.rst
index d991f6c5..efc6c4cc 100644
--- a/docs/development/actors/cds/cds.rst
+++ b/docs/development/actors/cds/cds.rst
@@ -337,7 +337,7 @@ E.g. For vFW usecase the policy-type is "onap.policies.controlloop.operational.c
In the below rest endpoint, the hostname points to K8S service "policy-api" and internal port 6969.
-.. code-block:: bash
+.. code-block::
curl POST 'https://{$POLICY_API_URL}:{$POLICY_API_SERVICE_PORT}/policy/api/v1/policytypes/onap.policies.controlloop.operational.common.Drools/versions/1.0.0/policies/operational.modifyconfig/versions/1.0.0' \
-H 'Accept: application/json' \
diff --git a/docs/development/actors/vfc/vfc.rst b/docs/development/actors/vfc/vfc.rst
index e7d8d3e7..c4f3d077 100644
--- a/docs/development/actors/vfc/vfc.rst
+++ b/docs/development/actors/vfc/vfc.rst
@@ -16,10 +16,10 @@ Overview of VFC Actor
ONAP Policy Framework enables VFC as one of the supported actors.
.. note::
-There has not been any support given to the Policy Framework project for the VFC Actor
-in several releases. Thus, the code and information provided is to the best of the
-knowledge of the team. If there are any questions or problems, please consult the VFC
-Project to help provide guidance.
+ There has not been any support given to the Policy Framework project for the VFC Actor
+ in several releases. Thus, the code and information provided is to the best of the
+ knowledge of the team. If there are any questions or problems, please consult the VFC
+ Project to help provide guidance.
VFC uses a REST-based
interface. However, as requests may not complete right away, a REST-based polling
diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index fac06ac6..1a001b02 100644
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -267,6 +267,36 @@ An example of running the api using a docker compose script is located in the Po
`Policy CSIT API Docker Compose <https://gerrit.onap.org/r/gitweb?p=integration/csit.git;a=blob;f=scripts/policy/docker-compose-api.yml;h=e32190f1e6cb6d9b64ddf53a2db2c746723a0c6a;hb=refs/heads/master>`_
+Running the Smoke Tests
+***********************
+
+The following links contain instructions on how to run the smoke tests. These may be helpful to developers to become
+familiar with the Policy Framework components and test any local changes.
+
+.. toctree::
+ :maxdepth: 1
+
+..
+ api-smoke.rst
+
+..
+ pap-smoke.rst
+
+..
+ apex-smoke.rst
+
+..
+ drools-smoke.rst
+
+..
+ xacml-smoke.rst
+
+..
+ distribution-smoke.rst
+
+..
+ clamp-smoke.rst
+
Running the Stability/Performance Tests
***************************************
@@ -283,6 +313,37 @@ familiar with the Policy Framework components and test any local changes.
xacml-s3p.rst
distribution-s3p.rst
+Running the Pairwise Tests
+***********************
+
+The following links contain instructions on how to run the pairwise tests. These may be helpful to developers check that
+the Policy Framework works in a full ONAP deployment.
+
+.. toctree::
+ :maxdepth: 1
+
+..
+ api-pairwise.rst
+
+..
+ pap-pairwise.rst
+
+..
+ apex-pairwise.rst
+
+..
+ drools-pairwise.rst
+
+..
+ xacml-pairwise.rst
+
+..
+ distribution-pairwise.rst
+
+..
+ clamp-pairwise.rst
+
+
Generating Swagger Documentation
********************************
The `Policy Parent Integration POM <https://github.com/onap/policy-parent/blob/master/integration/pom.xml>`_ contains a *generateSwaggerDocs* profile. This
diff --git a/docs/development/pdp/pdp-pap-interaction.rst b/docs/development/pdp/pdp-pap-interaction.rst
index 45988192..14a92517 100644
--- a/docs/development/pdp/pdp-pap-interaction.rst
+++ b/docs/development/pdp/pdp-pap-interaction.rst
@@ -37,7 +37,7 @@ Some of the information included in the message are:
- *name* a name that is unique to the PDP instance.
-.. code-block:: json
+.. code-block::
:caption: Sample PDP_STATUS Registration message (from APEX-PDP)
:linenos:
@@ -86,7 +86,7 @@ If so, it updates itself with the information in PDP_UPDATE message from PAP suc
*pdpHeartbeatIntervalMs* and *policiesToBeDeployed* (if any). After handling the PDP_UPDATE message, the PDP sends
a response message back to PAP with the current status of the PDP along with the result of the PDP_UPDATE operation.
-.. code-block:: json
+.. code-block::
:caption: Sample PDP_STATUS response message (from APEX-PDP)
:linenos:
@@ -144,7 +144,7 @@ then it waits in ACTIVE state, ready to execute any policies as and when they ar
to them from PAP. After handling the PDP_STATE_CHANGE message, the PDP sends a response message
back to PAP with the current status of the PDP along with the result of the PDP_STATE_CHANGE operation.
-.. code-block:: json
+.. code-block::
:caption: Sample PDP_STATUS response message (from APEX-PDP)
:linenos:
@@ -178,7 +178,7 @@ with the data in the database, PAP sends out a PDP_UPDATE message to update the
PAP considers a PDP as expired if three consecutive heartbeats are missing from the PDP,
and removes the PDP instance details from the database.
-.. code-block:: json
+.. code-block::
:caption: Sample PDP_STATUS response message (from APEX-PDP)
:linenos:
@@ -212,7 +212,7 @@ PAP sends a PDP_UPDATE message with information about policies to be deployed an
undeployed. If there are some policies that are already deployed, then only the new ones
are sent under the *policiesToBeDeployed* field.
-.. code-block:: json
+.. code-block::
:caption: Sample PDP_STATUS response message (from APEX-PDP)
:linenos: