diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/clamp/controlloop/defining-controlloops.rst | 37 | ||||
-rw-r--r-- | docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png | bin | 44398 -> 214201 bytes | |||
-rw-r--r-- | docs/clamp/controlloop/images/defining-controlloops/standard-cle.png | bin | 44478 -> 200137 bytes | |||
-rw-r--r-- | docs/conf.py | 94 | ||||
-rw-r--r-- | docs/release-notes.rst | 70 | ||||
-rw-r--r-- | docs/requirements-docs.txt | 18 | ||||
-rw-r--r-- | docs/tox.ini | 5 |
7 files changed, 83 insertions, 141 deletions
diff --git a/docs/clamp/controlloop/defining-controlloops.rst b/docs/clamp/controlloop/defining-controlloops.rst index 71a646dd..92564c6f 100644 --- a/docs/clamp/controlloop/defining-controlloops.rst +++ b/docs/clamp/controlloop/defining-controlloops.rst @@ -57,6 +57,7 @@ and is the canonical definition of the Control Loop concepts. TOSCA Standard Control Loop Elements .. image:: images/defining-controlloops/standard-cle.png + :width: 600 1.2.1 Policy Control Loop Element ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -95,27 +96,6 @@ and is the canonical definition of the Kubernetes Control Loop Element type. For of the Kubernetes Control Loop Element and Kubernetes Participant,please see `The CLAMP Kubernetes Participant <#>`_ page. -1.2.4 CDS Control Loop Element -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The CDS Participant runs CDS Control Loop Elements. Each CDS Control Loop Element manages the -deployment of the CDS blueprint specified in the CDS Control Loop Element definition. The Yaml -file that holds the `CDS Control Loop Element Type definition is available in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/CdsControlLoopElementType.yaml>`_ -and is the canonical definition of the CDS Control Loop Element type. For a description of the -CDS Control Loop Element and CDS Participant, please see `The CLAMP CDS Participant page <#>`_. - -1.2.5 DCAE Participant -~~~~~~~~~~~~~~~~~~~~~~ - -The DCAE Participant runs DCAE Control Loop Elements. Each DCAE Control Loop Element manages -a DCAE microservice on DCAE. The user defines the DCAE blueprint for the DCAE microservice as -well as other properties that the microservice requires in order to execute. The Yaml file that -holds the `DCAE Control Loop Type definition is available in Github -<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/DcaeControlLoopElementType.yaml>`_ -and is the canonical definition of the DCAE Control Loop Element type. For a description of -the DCAE Control Loop Element and DCAE Participant, please see `The CLAMP DCAE Participant <#>`_ page. - 2 Common and Instance Specific Properties ========================================= @@ -204,7 +184,7 @@ Loop Element, so it can be defined as shown below in the :ref:`Kubernetes Contro typeVersion: 1.0.0 description: The helm chart for the microservice required: true - + # Definition that specifies the common flag metadata chart: type: org.onap.datatypes.policy.clamp.controlloop.kubernetesControlLoopElement.Chart @@ -227,6 +207,7 @@ itself, which contains TOSCA Node Templates for each Control Loop Element that m Control Loop. .. image:: images/defining-controlloops/controlloop-node-template.png + :width: 600 To create a control loop, a user creates a TOSCA Topology Template. In the Topology Template, the user creates a TOSCA Node Template for each Control Loop Element that will be in the @@ -241,13 +222,11 @@ The best way to explain how to create a Control Loop Definition is by example. .. image:: images/defining-controlloops/gentle-guidance-controlloop.png -The example Gentle Guidance control loop is illustrated in the diagram above. The domain logic -for the control loop is implemented in a microservice running in Kubernetes, a policy, a CDS -blueprint, and some configuration that is passed to the microservice over a REST endpoint. -We want to manage the life cycle of the domain logic for our Gentle Guidance control loop using -our TOSCA based Control Loop Life Cycle Management approach. To do this we create four Control -Loop Element definitions, one for the Kubernetes microservice, one for the policy, one for the -CDS blueprint and one or the REST configuration. +The example Gentle Guidance control loop is illustrated in the diagram above. The domain logic for the control loop is +implemented in a microservice running in Kubernetes, a policy, and some configuration that is passed to the microservice +over a REST endpoint. We want to manage the life cycle of the domain logic for our Gentle Guidance control loop using +our TOSCA based Control Loop Life Cycle Management approach. To do this we create four Control Loop Element definitions, +one for the Kubernetes microservice, one for the policy and one or the REST configuration. 3.2 The TOSCA Control Loop Definition ------------------------------------- diff --git a/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png b/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png Binary files differindex f8721299..e3e12538 100644 --- a/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png +++ b/docs/clamp/controlloop/images/defining-controlloops/controlloop-node-template.png diff --git a/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png b/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png Binary files differindex 038549e0..d23f89ab 100644 --- a/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png +++ b/docs/clamp/controlloop/images/defining-controlloops/standard-cle.png diff --git a/docs/conf.py b/docs/conf.py index ba98978d..d5ee3bd0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,103 +1,9 @@ from docs_conf.conf import * -branch = 'latest' -doc_url = 'https://docs.onap.org/projects' master_doc = 'index' intersphinx_mapping = {} -# Latest (change to branch) -intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ( - '{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-holmes-engine-management'] = ( - '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-holmes-rule-management'] = ( - '{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-oom-platform-cert-service'] = ( - '{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-policy-clamp'] = ('{}/onap-policy-clamp/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) - -# Guilin -branch = 'guilin' -intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None) - -# Frankfurt -branch = 'frankfurt' -intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None) - -# Latest -branch = 'latest' -intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-platform-plugins'] = ( - '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-logging-analytics'] = ('{}/onap-logging-analytics/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-logging-analytics-pomba-pomba-audit-common'] = ( - '{}/onap-logging-analytics-pomba-pomba-audit-common/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-modeling-toscaparsers'] = ( - '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-music-distributed-kv-store'] = ( - '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-osa'] = ('{}/onap-osa/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdc-sdc-distribution-client'] = ( - '{}/onap-sdc-sdc-distribution-client/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdc-sdc-workflow-designer'] = ( - '{}/onap-sdc-sdc-workflow-designer/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdc-sdc-tosca'] = ('{}/onap-sdc-sdc-tosca/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-sdc-sdc-docker-base'] = ('{}/onap-sdc-sdc-docker-base/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-so-libs'] = ('{}/onap-so-libs/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ( - '{}/onap-vfc-nfvo-driver-vnfm-svnfm/en/%s'.format(doc_url) % branch, None) - linkcheck_ignore = [ 'http://localhost', 'https://example.com', diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 3764d557..e145fe9c 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -18,6 +18,74 @@ Policy Release Notes .. * * * ISTANBUL * * * .. ========================== +Version: 9.0.1 +-------------- + +:Release Date: 2022-02-17 (Istanbul Maintenance Release #1) + +**Artifacts** + +Artifacts released: + +.. list-table:: + :widths: 15 10 10 + :header-rows: 1 + + * - Repository + - Java Artifact + - Docker Image (if applicable) + * - policy/parent + - 3.4.4 + - N/A + * - policy/docker + - 2.3.2 + - | onap/policy-jdk-alpine:2.3.2 + | onap/policy-jre-alpine:2.3.2 + | onap/policy-db-migrator:2.3.2 + * - policy/common + - 1.9.2 + - N/A + * - policy/models + - 2.5.2 + - N/A + * - policy/api + - 2.5.2 + - onap/policy-api:2.5.2 + * - policy/pap + - 2.5.2 + - onap/policy-pap:2.5.2 + * - policy/drools-pdp + - 1.9.2 + - onap/policy-drools:1.9.2 + * - policy/apex-pdp + - 2.6.2 + - onap/policy-apex-pdp:2.6.2 + * - policy/xacml-pdp + - 2.5.2 + - onap/policy-xacml-pdp:2.5.2 + * - policy/drools-applications + - 1.9.2 + - onap/policy-pdpd-cl:1.9.2 + * - policy/clamp + - 6.1.4 + - | onap/policy-clamp-backend:6.1.4 + | onap/policy-clamp-frontend:6.1.4 + | onap/policy-clamp-cl-pf-ppnt:6.1.4 + | onap/policy-clamp-cl-k8s-ppnt:6.1.4 + | onap/policy-clamp-cl-http-ppnt:6.1.4 + | onap/policy-clamp-cl-runtime:6.1.4 + * - policy/gui + - 2.1.2 + - onap/policy-gui:2.1.2 + * - policy/distribution + - 2.6.2 + - onap/policy-distribution:2.6.2 + +**Bug Fixes and Necessary Enhancements** + + * `[POLICY-3862] <https://jira.onap.org/browse/POLICY-3862>`_ + - Check all code for Log4J before version 2.15.0 and upgrade if necessary + Version: 9.0.0 -------------- @@ -28,8 +96,6 @@ New features Artifacts released: - - .. list-table:: :widths: 15 10 10 :header-rows: 1 diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 12c4de1a..3b3441a8 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,15 +1,3 @@ -tox -Sphinx==4.2.0 -doc8 -docutils -setuptools -six -lfdocs-conf~=0.7.5 -funcparserlib~=1.0.0a0 -sphinxcontrib.blockdiag~=2.0.0 -sphinxcontrib-needs<0.6.0 -sphinxcontrib.plantuml~=0.21 -sphinxcontrib.nwdiag~=2.0.0 -sphinxcontrib-seqdiag~=2.0.0 -sphinxcontrib-swaggerdoc~=0.1.7 -sphinx-rtd-theme~=1.0.0 +lfdocs-conf +sphinx>=4.2.0 # BSD +sphinx-rtd-theme>=1.0.0 # MIT diff --git a/docs/tox.ini b/docs/tox.ini index edac8c35..bf9bc51f 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -5,7 +5,10 @@ skipsdist = true [testenv:docs] basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=istanbul + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=istanbul commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" |