From cc570490689c7f132c9c1271b833bf095f886ba7 Mon Sep 17 00:00:00 2001 From: jhh Date: Mon, 3 Jun 2019 15:31:00 -0500 Subject: Added new Dublin features to documentation Issue-ID: POLICY-1678 Signed-off-by: jhh Change-Id: Ie5b2fe967d114e462544ac3ce59113d9b28d760e Signed-off-by: jhh (cherry picked from commit 20e78d75bc091b1ca11e446659ab3322d47cc98d) --- docs/drools/droolsFeaturesIndex.rst | 4 ++ docs/drools/feature_clamsterdam.rst | 32 ++++++++++++++ docs/drools/feature_clmgt.rst | 86 +++++++++++++++++++++++++++++++++++++ docs/drools/feature_clusecases.rst | 36 ++++++++++++++++ docs/drools/feature_lifecycle.rst | 39 +++++++++++++++++ 5 files changed, 197 insertions(+) create mode 100644 docs/drools/feature_clamsterdam.rst create mode 100644 docs/drools/feature_clmgt.rst create mode 100644 docs/drools/feature_clusecases.rst create mode 100644 docs/drools/feature_lifecycle.rst (limited to 'docs') diff --git a/docs/drools/droolsFeaturesIndex.rst b/docs/drools/droolsFeaturesIndex.rst index 6bff285b..e1e05fd8 100644 --- a/docs/drools/droolsFeaturesIndex.rst +++ b/docs/drools/droolsFeaturesIndex.rst @@ -10,8 +10,12 @@ PDP-D Features feature_activestdbymgmt.rst feature_controllerlogging.rst + feature_clmgt.rst + feature_clamsterdam.rst + feature_clusecases.rst feature_eelf.rst feature_healthcheck.rst + feature_lifecycle.rst feature_locking.rst feature_mdcfilters.rst feature_pooling.rst diff --git a/docs/drools/feature_clamsterdam.rst b/docs/drools/feature_clamsterdam.rst new file mode 100644 index 00000000..74e2668a --- /dev/null +++ b/docs/drools/feature_clamsterdam.rst @@ -0,0 +1,32 @@ + +.. 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_clmgt.rst b/docs/drools/feature_clmgt.rst new file mode 100644 index 00000000..63cdb015 --- /dev/null +++ b/docs/drools/feature_clmgt.rst @@ -0,0 +1,86 @@ + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +******************************** +Feature: Control Loop Management +******************************** + +.. contents:: + :depth: 3 + +Summary +^^^^^^^ + +The Control Loop Management feature augments the telemetry tooling to allow +introspection of runtime operational policies. + +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-management # enable/disable toggles the activation of the feature. + + policy start + +The "telemetry" tool can be used to list the control loops and associated Operational Polices at runtime. + + .. code-block:: bash + :caption: PDPD Features Command + + bash-4.4$ telemetry + Version: 1.0.0 + https://localhost:9696/policy/pdp/engine> cd controllers/usecases/drools/facts/usecases/controlloops + https://localhost:9696/policy/pdp/engine/controllers/usecases/drools/facts/usecases/controlloops> get + HTTP/1.1 200 OK + Content-Length: 132 + Content-Type: application/json + Date: Mon, 03 Jun 2019 20:23:38 GMT + Server: Jetty(9.4.14.v20181114) + + [ + "LOOP_vLoadBalancerMS_v3_0_vLoadBalancerMS0_k8s-tca-clamp-policy-05162019", + "ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e" + ] + + https://localhost:9696/policy/pdp/engine/controllers/usecases/drools/facts/usecases/controlloops> get ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e/policy + HTTP/1.1 200 OK + Content-Length: 612 + Content-Type: text/plain + Date: Mon, 03 Jun 2019 20:23:58 GMT + Server: Jetty(9.4.14.v20181114) + + controlLoop: + version: 2.0.0 + controlLoopName: ControlLoop-vCPE-48f0c2c3-a172-4192-9ae3-052274181b6e + trigger_policy: unique-policy-id-1-restart + timeout: 3600 + abatement: true + + policies: + - id: unique-policy-id-1-restart + name: Restart the VM + description: + actor: APPC + recipe: Restart + target: + type: VM + retry: 3 + timeout: 1200 + success: final_success + failure: final_failure + failure_timeout: final_failure_timeout + failure_retries: final_failure_retries + failure_exception: final_failure_exception + failure_guard: final_failure_guard + + https://localhost:9696/policy/pdp/engine/controllers/usecases/drools/facts/usecases/controlloops> + +End of Document diff --git a/docs/drools/feature_clusecases.rst b/docs/drools/feature_clusecases.rst new file mode 100644 index 00000000..eab383f6 --- /dev/null +++ b/docs/drools/feature_clusecases.rst @@ -0,0 +1,36 @@ + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +******************************* +Feature: Control Loop Use Cases +******************************* + +.. contents:: + :depth: 3 + +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. + +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-usecases # enable/disable toggles the activation of the feature. + + policy start + +End of Document diff --git a/docs/drools/feature_lifecycle.rst b/docs/drools/feature_lifecycle.rst new file mode 100644 index 00000000..ca892131 --- /dev/null +++ b/docs/drools/feature_lifecycle.rst @@ -0,0 +1,39 @@ + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +****************** +Feature: Lifecycle +****************** + +.. contents:: + :depth: 3 + +Summary +^^^^^^^ + +The "lifecycle" feature enables a PDP-D to work with the Dublin Release Policy architectural framework. + +The lifecycle feature maintains three states: TERMINATED, PASSIVE, and ACTIVE. +The PAP (Dublin style) interacts with the lifecycle feature to put a PDP-D in PASSIVE or ACTIVE states. +The PASSIVE state allows for Tosca Operational policies to be deployed. +Policy execution is enabled when the PDP-D transitions to the ACTIVE state. + +This feature can coexist side by side with the legacy mode of operation that predates the Dublin release. + +Usage +^^^^^ + +The feature is enabled by default. +The lifecycle "enabled" property can be toggled with the "features" command line tool available in PDP-D containers. + + .. code-block:: bash + :caption: PDPD Features Command + + policy stop + + features disable lifecycle # enable/disable toggles the activation of the feature. + + policy start + +End of Document -- cgit 1.2.3-korg