diff options
| -rw-r--r-- | docs/apex/APEX-Policy-Examples.rst | 7 | ||||
| -rw-r--r-- | docs/api/api.rst | 3 | ||||
| -rw-r--r-- | docs/architecture/architecture.rst | 7 | ||||
| -rw-r--r-- | docs/development/development.rst | 2 | ||||
| -rw-r--r-- | docs/development/devtools/apex-s3p.rst | 2 | ||||
| -rw-r--r-- | docs/development/devtools/devtools.rst | 2 | ||||
| -rw-r--r-- | docs/drools/droolsFeaturesIndex.rst | 2 | ||||
| -rw-r--r-- | docs/drools/droolsTutorialsIndex.rst | 2 | ||||
| -rw-r--r-- | docs/drools/feature_clamsterdam.rst | 32 | ||||
| -rw-r--r-- | docs/drools/feature_clfrankfurt.rst | 37 | ||||
| -rw-r--r-- | docs/drools/feature_clusecases.rst | 12 | ||||
| -rw-r--r-- | docs/pap/InternalPapPdp.rst (renamed from docs/design/InternalPapPdp.rst) | 0 | ||||
| -rw-r--r-- | docs/pap/pap.rst | 3 |
13 files changed, 68 insertions, 43 deletions
diff --git a/docs/apex/APEX-Policy-Examples.rst b/docs/apex/APEX-Policy-Examples.rst index cb8fa8d3..982f3e0f 100644 --- a/docs/apex/APEX-Policy-Examples.rst +++ b/docs/apex/APEX-Policy-Examples.rst @@ -4,6 +4,13 @@ Policy Examples *************** +.. toctree:: + :maxdepth: 1 + + APEX-MyFirstPolicyExample.rst + APEX-PCVS-Example.rst + APEX-DecisionMakerExample.rst + .. contents:: :depth: 3 diff --git a/docs/api/api.rst b/docs/api/api.rst index 58f7e9e0..c65e35e8 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -2,9 +2,6 @@ .. Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. DO NOT REMOVE THIS LABEL - EVEN IF IT GENERATES A WARNING -.. _offeredapis: - .. THIS IS USED INTERNALLY IN POLICY ONLY .. _api-label: diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index d061b1b7..4c8b3f7b 100644 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -20,6 +20,13 @@ mapping out the components, software structure, and execution ecosystem of the f .. contents:: :depth: 6 +.. toctree:: + :caption: References + :maxdepth: 1 + + tosca-policy-primer + + 1. Overview =========== diff --git a/docs/development/development.rst b/docs/development/development.rst index 66c095d3..87f49bc4 100644 --- a/docs/development/development.rst +++ b/docs/development/development.rst @@ -6,7 +6,7 @@ Policy Platform Development --------------------------- .. toctree:: - :maxdepth: 2 + :maxdepth: 3 devtools/devtools.rst actors/actors.rst diff --git a/docs/development/devtools/apex-s3p.rst b/docs/development/devtools/apex-s3p.rst index 1220621a..d3a8d410 100644 --- a/docs/development/devtools/apex-s3p.rst +++ b/docs/development/devtools/apex-s3p.rst @@ -313,7 +313,7 @@ The results are similar to those below: :download:`Example APEX performance metrics <json/example-apex-perf.json>` Performance Test Result Frankfurt ------------------------ +--------------------------------- **Summary** diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index a3016d48..1e2fd49f 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -281,3 +281,5 @@ familiar with the Policy Framework components and test any local changes. apex-s3p.rst drools-s3p.rst xacml-s3p.rst + distribution-s3p.rst + diff --git a/docs/drools/droolsFeaturesIndex.rst b/docs/drools/droolsFeaturesIndex.rst index e1e05fd8..869bc7af 100644 --- a/docs/drools/droolsFeaturesIndex.rst +++ b/docs/drools/droolsFeaturesIndex.rst @@ -11,7 +11,7 @@ PDP-D Features feature_activestdbymgmt.rst feature_controllerlogging.rst feature_clmgt.rst - feature_clamsterdam.rst + feature_clfrankfurt.rst feature_clusecases.rst feature_eelf.rst feature_healthcheck.rst diff --git a/docs/drools/droolsTutorialsIndex.rst b/docs/drools/droolsTutorialsIndex.rst index a1ccf844..ae6a2610 100644 --- a/docs/drools/droolsTutorialsIndex.rst +++ b/docs/drools/droolsTutorialsIndex.rst @@ -9,9 +9,11 @@ PDP-D Tutorials :maxdepth: 1 runningPDPD.rst + runningEclipse.rst clsimulation.rst guardpdp.rst modAAIdata.rst + modTemplate.rst tutorial_cl.rst tutorial_vCPE.rst tutorial_vDNS.rst diff --git a/docs/drools/feature_clamsterdam.rst b/docs/drools/feature_clamsterdam.rst deleted file mode 100644 index 74e2668a..00000000 --- a/docs/drools/feature_clamsterdam.rst +++ /dev/null @@ -1,32 +0,0 @@ - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -******************************* -Feature: Control Loop Amsterdam -******************************* - -.. contents:: - :depth: 3 - -Summary -^^^^^^^ - -The "controlloop-amsterdam" feature enables the legacy "amsterdam" controller in a PDP-D. - -Usage -^^^^^ - -The feature is enabled by default. -The lifecycle "enabled" property can be toggled with the "features" command line tool. - - .. code-block:: bash - :caption: PDPD Features Command - - policy stop - - features disable controlloop-amsterdam # enable/disable toggles the activation of the feature. - - policy start - -End of Document diff --git a/docs/drools/feature_clfrankfurt.rst b/docs/drools/feature_clfrankfurt.rst new file mode 100644 index 00000000..629b3afd --- /dev/null +++ b/docs/drools/feature_clfrankfurt.rst @@ -0,0 +1,37 @@ + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +******************************* +Feature: Control Loop Frankfurt +******************************* + +.. contents:: + :depth: 3 + +Summary +^^^^^^^ + +The "controlloop-frankfurt" feature enables the "frankfurt" controller in a PDP-D. +The "frankfurt" controller supports the official ONAP use cases for Frankfurt. + +.. note:: + This feature is enabled by default vs the usecases controller which will be deprecated. In the Guilin release we will + be renaming this feature back to usecases. + +Usage +^^^^^ + +The feature is enabled by default. The lifecycle "enabled" property can be toggled with +the "features" command line tool. + + .. code-block:: bash + :caption: PDPD Features Command + + policy stop + + features disable controlloop-frankfurt # enable/disable toggles the activation of the feature. + + policy start + +End of Document diff --git a/docs/drools/feature_clusecases.rst b/docs/drools/feature_clusecases.rst index eab383f6..ae6fae5c 100644 --- a/docs/drools/feature_clusecases.rst +++ b/docs/drools/feature_clusecases.rst @@ -13,15 +13,17 @@ Summary ^^^^^^^ The "controlloop-usecases" feature enables the "usecases" controller in a PDP-D. -The "usecases" controller supports the official ONAP use cases in a more efficient manner than -the legacy "amsterdam" controller. -The main difference is that control loop provisioning does not need a new version upgrade -each time a control loop is added or removed. +The "usecases" controller is carried forward from the El Alto release and will be deprecated in favor of the +"frankfurt" controller. + +.. note:: + This feature is disabled by default. Please use the 'frankfurt' feature in lieu of this. We will be renaming the 'frankfurt' + controller feature back to use cases in the Guilin release. Usage ^^^^^ -The feature is enabled by default. The lifecycle "enabled" property can be toggled with +The feature is disabled by default. The lifecycle "enabled" property can be toggled with the "features" command line tool. .. code-block:: bash diff --git a/docs/design/InternalPapPdp.rst b/docs/pap/InternalPapPdp.rst index 998514af..998514af 100644 --- a/docs/design/InternalPapPdp.rst +++ b/docs/pap/InternalPapPdp.rst diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst index ff6aac51..21b5b42b 100644 --- a/docs/pap/pap.rst +++ b/docs/pap/pap.rst @@ -9,6 +9,9 @@ Policy Administration Point (PAP) Architecture .. contents:: :depth: 3 +.. toctree:: + InternalPapPdp.rst + The Policy Administration Point (PAP) keeps track of PDPs, supporting the deployment of PDP groups and the deployment of policies across those PDP groups. Policies are created using the Policy API, but are deployed via the PAP. |