diff options
Diffstat (limited to 'docs/apex')
-rw-r--r-- | docs/apex/APEX-Introduction.rst | 11 | ||||
-rw-r--r-- | docs/apex/APEX-MyFirstPolicyExample.rst | 3 | ||||
-rw-r--r-- | docs/apex/APEX-OnapPf-Guide.rst | 7 | ||||
-rw-r--r-- | docs/apex/APEX-PCVS-Example.rst | 16 | ||||
-rw-r--r-- | docs/apex/APEX-Policy-Guide.rst | 8 | ||||
-rw-r--r-- | docs/apex/APEX-User-Manual.rst | 1 |
6 files changed, 17 insertions, 29 deletions
diff --git a/docs/apex/APEX-Introduction.rst b/docs/apex/APEX-Introduction.rst index b13e335e..8c9b34b5 100644 --- a/docs/apex/APEX-Introduction.rst +++ b/docs/apex/APEX-Introduction.rst @@ -3,7 +3,7 @@ A short Introduction to APEX -***************************** +**************************** .. contents:: :depth: 3 @@ -65,7 +65,7 @@ Introduction to APEX being fed by the state before. The simplest policy can have just one state. We provide specific support for the four-state `MEDA (Match Establish Decide - Act) <https://www.researchgate.net/publication/303564082_Apex_An_Engine_for_Dynamic_Adaptive_Policy_Execution>`__ + Act) <https://ieeexplore.ieee.org/document/7502880>`__ policy state model and the three-state `ECA (Event Condition Action) <https://en.wikipedia.org/wiki/Event_condition_action>`__ policy state model. APEX is fully distributed. You can @@ -514,18 +514,15 @@ Resources .. container:: ulist - APEX Documentation hosted on Github: - https://ericsson.github.io/apex-docs + https://docs.onap.org/projects/onap-policy-parent/en/latest/apex/apex.html - APEX source code repository hosted by ONAP: - https://gerrit.onap.org/r/#/admin/projects/policy/apex-pdp + https://github.com/onap/policy-apex-pdp - Issue Management (source and documentation, ONAP JIRA, requires a Linux Foundation ID): https://jira.onap.org/projects/POLICY/issues - - List of APEX publications: - https://ericsson.github.io/apex-docs/apex-publications.html - .. container:: :name: footer diff --git a/docs/apex/APEX-MyFirstPolicyExample.rst b/docs/apex/APEX-MyFirstPolicyExample.rst index 44316f9d..089ead02 100644 --- a/docs/apex/APEX-MyFirstPolicyExample.rst +++ b/docs/apex/APEX-MyFirstPolicyExample.rst @@ -1198,8 +1198,7 @@ Extend Policy Model .. container:: paragraph The exported policy model is then available in the - directory you selected, as - `MyFirstPolicyModel_0.0.1.json <files/mfp-files/2/MyFirstPolicyModel_0.0.1.json>`__. + directory you selected, as **MyFirstPolicyModel_0.0.1.json**. The exported policy can now be loaded into the APEX Policy Engine, or can be re-loaded and edited by the APEX Policy Editor. diff --git a/docs/apex/APEX-OnapPf-Guide.rst b/docs/apex/APEX-OnapPf-Guide.rst index 0fe38025..f7f1f3a7 100644 --- a/docs/apex/APEX-OnapPf-Guide.rst +++ b/docs/apex/APEX-OnapPf-Guide.rst @@ -12,11 +12,12 @@ Installation ^^^^^^^^^^^^ Build and Install -------------------- +----------------- .. container:: paragraph - Refer `Apex User Manual <https://docs.onap.org/en/casablanca/submodules/policy/apex-pdp.git/docs/APEX-User-Manual.html>`_ to find details on the build and installation of the APEX component. Information on the requirements and system configuration can also be found here. + Refer to + :ref:`Apex User Manual <apex-user-manual-label>` to find details on the build and installation of the APEX component. Information on the requirements and system configuration can also be found here. Installation Layout ------------------- @@ -300,7 +301,7 @@ Build a Docker Image APEXOnapPf Configuration File Explained -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. container:: paragraph diff --git a/docs/apex/APEX-PCVS-Example.rst b/docs/apex/APEX-PCVS-Example.rst index 2d40e347..380a2585 100644 --- a/docs/apex/APEX-PCVS-Example.rst +++ b/docs/apex/APEX-PCVS-Example.rst @@ -218,7 +218,7 @@ Install Ubuntu Server and SW VPN SLA Demo -^^^^^^^^^^^^^ +^^^^^^^^^^^^ .. container:: sect1 @@ -525,14 +525,6 @@ VPN SLA Demo ``http://localhost:8080/ui/pages/index.html`` should work on the same host - - APEX please see the APEX documentation for - `Monitoring - Client <https://ericsson.github.io/apex-docs/user-manual/engine-apps/um-engapps-eng-monitoring.html>`__ - or `Full - Client <https://ericsson.github.io/apex-docs/user-manual/engine-apps/um-engapps-full-client.html>`__ - for details on how to monitor APEX. - - VPN SLA Policy ^^^^^^^^^^^^^^ @@ -609,7 +601,7 @@ Trigger Schemas Context Logic Nodes --------------------- +------------------- .. container:: sect1 @@ -622,7 +614,7 @@ Context Logic Nodes context topology (|cntxtNodes_link|). Context Logic Edges --------------------- +------------------- .. container:: sect1 @@ -722,7 +714,7 @@ Logic: Policy Decide State Logic: Policy Act State ------------------------- +----------------------- .. container:: sect1 diff --git a/docs/apex/APEX-Policy-Guide.rst b/docs/apex/APEX-Policy-Guide.rst index 1871fb2a..0f49d356 100644 --- a/docs/apex/APEX-Policy-Guide.rst +++ b/docs/apex/APEX-Policy-Guide.rst @@ -497,7 +497,7 @@ Concept: Policy .. container:: ulist - The *MEDA* flavor supports policies written to the - `MEDA policy pattern <https://www.researchgate.net/publication/282576518_Dynamically_Adaptive_Policies_for_Dynamically_Adaptive_Telecommunications_Networks>`__ + `MEDA policy pattern <https://ieeexplore.ieee.org/document/7367357>`__ and require a sequence of four states: namely *Match*, *Establish*, *Decide* and *Act*. - The *OODA* flavor supports policies written to the @@ -1450,8 +1450,7 @@ Create a instance of an Outfield using Schemas If an outfield is not an atomic type (string, integer, etc.) but uses a complex schema (with a Java or Avro backend), APEX can help to create new instances. The ``executor`` provides a field called ``subject``, - which provides a schem helper with an API for this. The complete API of the schema helper is documented here: - `API Doc: SchemaHelper <https://ericsson.github.io/apex-docs/javadocs/index.html>`__. + which provides a schem helper with an API for this. .. container:: paragraph @@ -1518,8 +1517,7 @@ Create a instance of an Context Album entry using Schemas .. container:: paragraph Context album instances can be created using very similar to the outfields. Here, the schema helper - comes from the context album directly. The API of the schema helper is the same as for outfields, see - `API Doc: SchemaHelper <https://ericsson.github.io/apex-docs/javadocs/index.html>`__. + comes from the context album directly. The API of the schema helper is the same as for outfields. .. container:: paragraph diff --git a/docs/apex/APEX-User-Manual.rst b/docs/apex/APEX-User-Manual.rst index 21e9dbcb..c0a7aaca 100644 --- a/docs/apex/APEX-User-Manual.rst +++ b/docs/apex/APEX-User-Manual.rst @@ -1,6 +1,7 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +.. _apex-user-manual-label: APEX User Manual **************** |