diff options
Diffstat (limited to 'docs')
35 files changed, 0 insertions, 1037 deletions
diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index 43ca5b671..000000000 --- a/docs/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -/.tox -/_build/* -/__pycache__/* diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css deleted file mode 100644 index 6008cb1a0..000000000 --- a/docs/_static/css/ribbon.css +++ /dev/null @@ -1,63 +0,0 @@ -.ribbon { - z-index: 1000; - background-color: #a00; - overflow: hidden; - white-space: nowrap; - position: fixed; - top: 25px; - right: -50px; - -webkit-transform: rotate(45deg); - -moz-transform: rotate(45deg); - -ms-transform: rotate(45deg); - -o-transform: rotate(45deg); - transform: rotate(45deg); - -webkit-box-shadow: 0 0 10px #888; - -moz-box-shadow: 0 0 10px #888; - box-shadow: 0 0 10px #888; - -} - -.ribbon a { - border: 1px solid #faa; - color: #fff; - display: block; - font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; - margin: 1px 0; - padding: 10px 50px; - text-align: center; - text-decoration: none; - text-shadow: 0 0 5px #444; - transition: 0.5s; -} - -.ribbon a:hover { - background: #c11; - color: #fff; -} - - -/* override table width restrictions */ -@media screen and (min-width: 767px) { - - .wy-table-responsive table td, .wy-table-responsive table th { - /* !important prevents the common CSS stylesheets from overriding - this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; - } - - .wy-table-responsive { - overflow: visible !important; - } -} - -@media screen and (max-width: 767px) { - .wy-table-responsive table td { - white-space: nowrap; - } -} - -/* fix width of the screen */ - -.wy-nav-content { - max-width: none; -} diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico Binary files differdeleted file mode 100644 index cb712ebd2..000000000 --- a/docs/_static/favicon.ico +++ /dev/null diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png Binary files differdeleted file mode 100644 index 5d064f431..000000000 --- a/docs/_static/logo_onap_2017.png +++ /dev/null diff --git a/docs/architecture.rst b/docs/architecture.rst deleted file mode 100644 index b65eb1c1d..000000000 --- a/docs/architecture.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved. -.. _architecture: - -Policy/Clamp in ONAP Architecture ---------------------------------- - -CLAMP platform has been integrated into the Policy framework project, starting as a POC during -Honolulu release and as a official feature with Istanbul release. So CLAMP must be seen now -as a function provided by the Policy Framework project. - -CLAMP is a function for designing and managing control loops and a UI to manage Policies. - It is used to visualize a control loop, configure it with specific parameters for a particular network -service, then deploying and undeploying it. Once deployed, the user can also -update the loop with new parameters during runtime, as well as suspending and -restarting it. - -Starting with Istanbul release, CLAMP GUI can also be used to create/read/update/delete/list policies -outside of a control loop, and therefore CLAMP is also the front-end for Policies management in ONAP. - -CLAMP interacts with other systems to deploy and execute the control loop. For -example, it extracts the control loop blueprint from CSAR distributed by SDC. -CLAMP also calls the internal Policy framework API to get the Policy Models(Model Driven Control Loop) -It requests from DCAE the instantiation of microservices. -to manage the control loop flow. Furthermore, it creates and updates multiple -policies (for DCAE mS configuration and actual Control Operations) in the Policy Engine -that define the closed loop flow. - -|clamp-flow| - -The ONAP CLAMP function abstracts the details of these systems under the concept -of a control loop model. The design of a control loop and its management is -represented by a workflow in which all relevant system interactions take -place. This is essential for a self-service model of creating and managing -control loops, where no low-level user interaction with other components is -required. - -At a higher level, CLAMP is about supporting and managing the broad operational -life cycle of VNFs/VMs and ultimately ONAP components itself. It will offer the -ability to design, test, deploy and update control loop automation - both closed -and open. Automating these functions would represent a significant saving on -operational costs compared to traditional methods. - -|closed-loop| - -.. |clamp-flow| image:: images/architecture/distdepl.png -.. |closed-loop| image:: images/architecture/ONAP-closedloop.png diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 5371015c6..000000000 --- a/docs/conf.py +++ /dev/null @@ -1,15 +0,0 @@ -from docs_conf.conf import * - -branch = 'latest' -master_doc = 'index' - -linkcheck_ignore = [ - 'http://localhost', -] - -intersphinx_mapping = {} - -html_last_updated_fmt = '%d-%b-%y %H:%M' - -def setup(app): - app.add_stylesheet("css/ribbon.css") diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index ab5928131..000000000 --- a/docs/conf.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -project_cfg: onap -project: onap - -# Change this to ReleaseBranchName to modify the header -default-version: latest -# diff --git a/docs/images/architecture/ONAP-closedloop.png b/docs/images/architecture/ONAP-closedloop.png Binary files differdeleted file mode 100644 index 7d3a2cac8..000000000 --- a/docs/images/architecture/ONAP-closedloop.png +++ /dev/null diff --git a/docs/images/architecture/distdepl.png b/docs/images/architecture/distdepl.png Binary files differdeleted file mode 100644 index 27a39302e..000000000 --- a/docs/images/architecture/distdepl.png +++ /dev/null diff --git a/docs/images/clamp-policy_archi.png b/docs/images/clamp-policy_archi.png Binary files differdeleted file mode 100644 index f384dddcd..000000000 --- a/docs/images/clamp-policy_archi.png +++ /dev/null diff --git a/docs/images/html.png b/docs/images/html.png Binary files differdeleted file mode 100644 index f1bda8835..000000000 --- a/docs/images/html.png +++ /dev/null diff --git a/docs/images/pdf.png b/docs/images/pdf.png Binary files differdeleted file mode 100644 index fed52f963..000000000 --- a/docs/images/pdf.png +++ /dev/null diff --git a/docs/images/swagger.png b/docs/images/swagger.png Binary files differdeleted file mode 100644 index f5a9e0c0c..000000000 --- a/docs/images/swagger.png +++ /dev/null diff --git a/docs/images/user-guide/add-operational-policies.png b/docs/images/user-guide/add-operational-policies.png Binary files differdeleted file mode 100644 index 3d5224aec..000000000 --- a/docs/images/user-guide/add-operational-policies.png +++ /dev/null diff --git a/docs/images/user-guide/blueprint_node_type.png b/docs/images/user-guide/blueprint_node_type.png Binary files differdeleted file mode 100644 index 1e5ef6a4a..000000000 --- a/docs/images/user-guide/blueprint_node_type.png +++ /dev/null diff --git a/docs/images/user-guide/clamp-cds-operation.png b/docs/images/user-guide/clamp-cds-operation.png Binary files differdeleted file mode 100644 index edc4c63aa..000000000 --- a/docs/images/user-guide/clamp-cds-operation.png +++ /dev/null diff --git a/docs/images/user-guide/config-policy-tca.png b/docs/images/user-guide/config-policy-tca.png Binary files differdeleted file mode 100644 index ce5f79bc8..000000000 --- a/docs/images/user-guide/config-policy-tca.png +++ /dev/null diff --git a/docs/images/user-guide/create-loop.png b/docs/images/user-guide/create-loop.png Binary files differdeleted file mode 100644 index 40cdb4c39..000000000 --- a/docs/images/user-guide/create-loop.png +++ /dev/null diff --git a/docs/images/user-guide/deploy-params.png b/docs/images/user-guide/deploy-params.png Binary files differdeleted file mode 100644 index 9d003258f..000000000 --- a/docs/images/user-guide/deploy-params.png +++ /dev/null diff --git a/docs/images/user-guide/loop-menu.png b/docs/images/user-guide/loop-menu.png Binary files differdeleted file mode 100644 index b6056349d..000000000 --- a/docs/images/user-guide/loop-menu.png +++ /dev/null diff --git a/docs/images/user-guide/loop-operation-menu.png b/docs/images/user-guide/loop-operation-menu.png Binary files differdeleted file mode 100644 index 2a2dbf899..000000000 --- a/docs/images/user-guide/loop-operation-menu.png +++ /dev/null diff --git a/docs/images/user-guide/loop-properties.png b/docs/images/user-guide/loop-properties.png Binary files differdeleted file mode 100644 index 5c266155d..000000000 --- a/docs/images/user-guide/loop-properties.png +++ /dev/null diff --git a/docs/images/user-guide/op-policy-box-policy.png b/docs/images/user-guide/op-policy-box-policy.png Binary files differdeleted file mode 100644 index 89c6265ba..000000000 --- a/docs/images/user-guide/op-policy-box-policy.png +++ /dev/null diff --git a/docs/images/user-guide/open-loop.png b/docs/images/user-guide/open-loop.png Binary files differdeleted file mode 100644 index a763ad133..000000000 --- a/docs/images/user-guide/open-loop.png +++ /dev/null diff --git a/docs/images/user-guide/open-menu-prop.png b/docs/images/user-guide/open-menu-prop.png Binary files differdeleted file mode 100644 index 046e2a3d3..000000000 --- a/docs/images/user-guide/open-menu-prop.png +++ /dev/null diff --git a/docs/images/user-guide/opened-loop.png b/docs/images/user-guide/opened-loop.png Binary files differdeleted file mode 100644 index c955deee8..000000000 --- a/docs/images/user-guide/opened-loop.png +++ /dev/null diff --git a/docs/images/user-guide/policy-model-menu.png b/docs/images/user-guide/policy-model-menu.png Binary files differdeleted file mode 100644 index 838fcf8d9..000000000 --- a/docs/images/user-guide/policy-model-menu.png +++ /dev/null diff --git a/docs/images/user-guide/policy-submitted.png b/docs/images/user-guide/policy-submitted.png Binary files differdeleted file mode 100644 index 04a9df358..000000000 --- a/docs/images/user-guide/policy-submitted.png +++ /dev/null diff --git a/docs/images/user-guide/remove-operational-policies.png b/docs/images/user-guide/remove-operational-policies.png Binary files differdeleted file mode 100644 index fbc680d04..000000000 --- a/docs/images/user-guide/remove-operational-policies.png +++ /dev/null diff --git a/docs/images/user-guide/template-menu.png b/docs/images/user-guide/template-menu.png Binary files differdeleted file mode 100644 index cc2cdf78b..000000000 --- a/docs/images/user-guide/template-menu.png +++ /dev/null diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 4fd4def67..000000000 --- a/docs/index.rst +++ /dev/null @@ -1,203 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved. -.. _master_index: - -Policy/CLAMP - Control Loop Automation Management Platform -========================================================== -.. High level architecture, design, and packaging information for release planning and delivery. - -.. include:: architecture.rst - - -Offered APIs ------------- -The list of APIs that Policy/CLAMP has offered could be find in the following table: - -.. |pdf-icon| image:: images/pdf.png - :width: 40px - -.. |swagger-icon| image:: images/swagger.png - :width: 40px - -.. |html-icon| image:: images/html.png - :width: 40px - -.. csv-table:: - :header: "|Swagger-icon|", "|html-icon|", "|pdf-icon|" - :widths: 60,60,60 - - "swagger json file", "html doc", "pdf doc" - ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.pdf>`" - - -Consumed APIs -------------- -Policy/CLAMP uses the API's exposed by the following ONAP components: - -- SDC : REST based interface exposed by the SDC, Distribution of service to DCAE -- DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional)) -- Policy Core: REST based interface, Policy Core engine target both XACML and Drools PDP, Policy Engine trigger operations to App-C/VF-C/SDN-C -- CDS: REST based interface, to retrieve list of operations/actions with their corresponding payload at runtime for Operational Policies where the field 'actor' is 'CDS'. - -Delivery --------- -Policy/CLAMP component is composed of a UI layer and a backend layer, each layer having its own container. -Policy/CLAMP also requires a database instance with 1 DB, it uses MariaDB, which is the same DB as for the core Policy. - -.. |clamp-policy-archi| image:: images/clamp-policy_archi.png - -|clamp-policy-archi| - -Logging & Diagnostic Information --------------------------------- -CLAMP uses logback framework to generate logs. The logback.xml file can be found under the [src/main/resources/ folder](src/main/resources). - -With the default log settings, all logs will be generated into console and into root.log file under the CLAMP root folder. The root.log file is not allowed to be appended, thus restarting the CLAMP will result in cleaning of the old log files. - - -.. _index-clamp-installation: - -Installation ------------- -A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/). - -Once the image has been built and is available locally, you can use the `docker-compose up` command to deploy a pre-populated database and a CLAMP instance available on [https://localhost:3000](https://localhost:3000). - -Configuration -------------- -.. Where are they provided? -.. What are parameters and values? - - -Currently, the CLAMP docker images can be deployed with small configuration needs. Though, you might need to make small adjustments to the configuration. As CLAMP is spring based, you can use the SPRING_APPLICATION_JSON environment variable to update its parameters. - -.. TODO detail config parameters and the usage - - -There are one datasource for Clamp. By default, it will try to connect to the localhost server using the credentials available in the example SQL files. If you need to change the default database host and/or credentials, you can do it by using the following json as SPRING_APPLICATION_JSON environment variable : - -.. code-block:: json - - { - "spring.datasource.cldsdb.url": "jdbc:mariadb:sequential://clampdb.{{ include "common.namespace" . }}:3306/cldsdb4?autoReconnect=true&connectTimeout=10000&socketTimeout=10000&retriesAllDown=3", - "clamp.config.files.sdcController": "file:/opt/clamp/sdc-controllers-config.json", - "clamp.config.dcae.inventory.url": "https://inventory.{{ include "common.namespace" . }}:8080", - "clamp.config.dcae.dispatcher.url": "https://deployment-handler.{{ include "common.namespace" . }}:8443", - "clamp.config.dcae.deployment.url": "https://deployment-handler.{{ include "common.namespace" . }}:8443", - "clamp.config.dcae.deployment.userName": "none", - "clamp.config.dcae.deployment.password": "none", - "clamp.config.policy.api.url": "https://policy-api.{{ include "common.namespace" . }}:6969", - "clamp.config.policy.api.userName": "healthcheck", - "clamp.config.policy.api.password": "zb!XztG34", - "clamp.config.policy.pap.url": "https://policy-pap.{{ include "common.namespace" . }}:6969", - "clamp.config.policy.pap.userName": "healthcheck", - "clamp.config.policy.pap.password": "zb!XztG34", - "clamp.config.cadi.aafLocateUrl": "https://aaf-locate.{{ include "common.namespace" . }}:8095", - "com.att.eelf.logging.path": "/opt/clamp", - "com.att.eelf.logging.file": "logback.xml" - } - -SDC-Controllers config ----------------------- -This file is a JSON that must be specified to Spring config, here is an example: - -.. code-block:: json - - { - "sdc-connections":{ - "sdc-controller1":{ - "user": "clamp", - "consumerGroup": "consumerGroup1", - "consumerId": "consumerId1", - "environmentName": "AUTO", - "sdcAddress": "localhost:8443", - "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981", - "pollingInterval":30, - "pollingTimeout":30, - "activateServerTLSAuth":"false", - "keyStorePassword":"", - "keyStorePath":"", - "messageBusAddresses":["dmaaphost.com"] - }, - "sdc-controller2":{ - "user": "clamp", - "consumerGroup": "consumerGroup1", - "consumerId": "consumerId1", - "environmentName": "AUTO", - "sdcAddress": "localhost:8443", - "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981", - "pollingInterval":30, - "pollingTimeout":30, - "activateServerTLSAuth":"false", - "keyStorePassword":"", - "keyStorePath":"", - "messageBusAddresses":["dmaaphost.com"] - } - } - } - -Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers. -Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification. -The environmentName is normally the Dmaap Topic used by SDC. -If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers) - -Administration --------------- - -A user can access Policy/CLAMP UI at the following URL : https://localhost:3000. -(in this URL 'localhost' must be replaced by the actual host where Policy/CLAMP has been installed if it is not your current localhost) -For OOM, the URL is https://<host-ip>:30258 - -.. code-block:: html - - - Without AAF, the credentials are - Default username : admin - Default password : password - - - With AAF enabled, the certificate p12 must be added to the browser - ca path: src/main/resources/clds/aaf/org.onap.clamp.p12, password "China in the Spring" - Or get it from this page : https://wiki.onap.org/display/DW/Control+Loop+Flows+and+Models+for+Casablanca - -Human Interfaces ----------------- -.. Basic info on the interface type, ports/protocols provided over, etc. - -User Interface - serve to configure control loop -Policy/CLAMP UI is used to configure the Control Loop designed and distributed by SDC. From that UI it's possible to distribute the configuration policies and control the life-cycle of the DCAE Micro Services. -Policy/CLAMP UI is also used to manage Policies outside of a Control Loop. - -The following actions are done using the UI: - -* Design a control loop flow by selecting a predefined template from a list - (a template is an orchestration chain of Micro-services, so the template - defines how the micro-services of the control loop are chained together) - -* Give value to the configuration the parameters of each micro-service of - the control loop - -* Select the service and VNF(of that service) to which the control loop - will be attached - -* Configure the operational policy(the actual operation resulting from - the control loop) - -* Send the “TOSCA” blueprint parameters that will be used by DCAE to start the - control loop (The blueprint will be sent first to SDC and SDC will - publish it to DCAE) - -* Trigger the deployment of the Control loop in DCAE - -* Control (start/stop) the operation of the control loop in DCAE - -HealthCheck API - serve to verify CLAMP status (see offered API's section) -* https://<host-ip>:8443/restservices/clds/v1/healthcheck -This one does not require the certificate - -Walk-through can be found here: https://wiki.onap.org/display/DW/CLAMP+videos - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - CLAMP User Guide <user-guide.rst>
\ No newline at end of file diff --git a/docs/release-notes.rst b/docs/release-notes.rst deleted file mode 100644 index 18c1aa6b9..000000000 --- a/docs/release-notes.rst +++ /dev/null @@ -1,504 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2017-2020 AT&T Intellectual Property. All rights reserved. -.. _release_notes: - -Release Notes -============= - -Version: 5.1.0 (Guilin) --------------------------- - -:Release Date: 2020-11-19 - -**New Features** - -The Guilin release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the Guilin release was to: - - - Complete integration to CDS for Actor/Action selection. - - SECCOM Perform Software Composition Analysis - Vulnerability tables (TSC must have). - - SECCOM Password removal from OOM HELM charts (TSC must have) - implementation of certinInitializer to get AAF certificates at oom deployment time. - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `CLAMP R7 - M1 release planning <https://wiki.onap.org/display/DW/CLAMP+R7+-+M1+Release+Planning>`_ - - The full list of issues(bugs) solved, is available on `CLAMP R7 - Guilin list of solved issues(bugs) <https://wiki.onap.org/pages/viewpage.action?pageId=93000705>`_ - -**Known Issues** - -**Security Notes** - -*Fixed Security Issues* - -*Known Security Issues* - -*Known Vulnerabilities in Used Modules* - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - -**Upgrade Notes** - - - The Upgrade strategy for Guilin can be found here:`<https://wiki.onap.org/display/DW/Frankfurt+CLAMP+Container+upgrade+strategy>`_ - - New Docker Containers are available. the list of containers composing this release are below: - - clamp-backend: nexus3.onap.org:10001/onap/clamp-backend 5.1.5 - - clamp-frontend: nexus3.onap.org:10001/onap/clamp-frontend 5.1.5 - - clamp-dash-es: nexus3.onap.org:10001/onap/clamp-dashboard-elasticsearch 5.0.4 - - clamp-dash-kibana: nexus3.onap.org:10001/onap/clamp-dashboard-kibana 5.0.4 - - clamp-dash-logstash: nexus3.onap.org:10001/onap/clamp-dashboard-logstash 5.0.4 - - -Version: 5.0.7 (Frankfurt maintenance release tag 6.0.0) --------------------------------------------------------- - -:Release Date: 2020-08-17 - -**Bug Fixes** - - - `CLAMP-878 <https://jira.onap.org/browse/CLAMP-885>`_ Clamp backend pod fails with mariaDB server error - - `CLAMP-885 <https://jira.onap.org/browse/CLAMP-885>`_ CLAMP update documentation - -**Known Issues** - - `CLAMP-856 <https://jira.onap.org/browse/CLAMP-856>`_ CLAMP should not display all CDS workflow properties - - Other more minor issues are captured in the following page:`CLAMP known Frankfurt issues <https://wiki.onap.org/display/DW/CLAMP+R6+-+Frankfurt+known+issues%28bugs%29+-+to+be+solved+in+futur+Releases>`_ - -**Security Notes** - -N/A - -*Fixed Security Issues* - -*Known Security Issues* - -*Known Vulnerabilities in Used Modules* - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - -**Upgrade Notes** - - - The Upgrade strategy for Frankfurt can be found here:`<https://wiki.onap.org/display/DW/Frankfurt+CLAMP+Container+upgrade+strategy>`_ - - New Docker Containers are available. the list of containers composing this release are below: - - - clamp-backend-filebeat-onap: docker.elastic.co/beats/filebeat 5.5.0 - - clamp-backend: nexus3.onap.org:10001/onap/clamp-backend 5.0.7 - - clamp-frontend: nexus3.onap.org:10001/onap/clamp-frontend 5.0.7 - - clamp-dash-es: nexus3.onap.org:10001/onap/clamp-dashboard-elasticsearch 5.0.3 - - clamp-dash-kibana: nexus3.onap.org:10001/onap/clamp-dashboard-kibana 5.0.3 - - clamp-dash-logstash: nexus3.onap.org:10001/onap/clamp-dashboard-logstash 5.0.3 - -Version: 5.0.1 (Frankfurt) --------------------------- - -:Release Date: 2020-05-12 - -**New Features** - -The Frankfurt release is the seventh release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the Frankfurt release was to: - - - implementing a new Control Loop creation flow: Self Serve Control Loop(partially done will be continued in next release). - - Add Tosca policy-model support for Operational Policies definitions. - - Add integration to CDS for Actor/Action selection. - - Move from SearchGuard to OpenDistro. - - Document(high level) current upgrade component strategy (TSC must have). - - SECCOM Perform Software Composition Analysis - Vulnerability tables (TSC must have). - - SECCOM Password removal from OOM HELM charts (TSC must have). - - SECCOM HTTPS communication vs. HTTP (TSC must have) - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `Frankfurt CLAMP M1 release planning <https://wiki.onap.org/display/DW/CLAMP+R6+-+M1+Release+Planning>`_ - - The full list of issues(bugs) solved, is available on `CLAMP R6 - Frankfurt list of solved issues(bugs) <https://wiki.onap.org/pages/viewpage.action?pageId=84648915>`_ - -**Known Issues** - - `CLAMP-856 <https://jira.onap.org/browse/CLAMP-856>`_ CLAMP should not display all CDS workflow properties - -**Security Notes** - -*Fixed Security Issues* - -*Known Security Issues* - -*Known Vulnerabilities in Used Modules* - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - -**Upgrade Notes** - - - The Upgrade strategy for Frankfurt can be found here:`<https://wiki.onap.org/display/DW/Frankfurt+CLAMP+Container+upgrade+strategy>`_ - - New Docker Containers are available. the list of containers composing this release are below: - - clamp-backend-filebeat-onap: docker.elastic.co/beats/filebeat 5.5.0 - - clamp-backend: nexus3.onap.org:10001/onap/clamp-backend 5.0.6 - - clamp-frontend: nexus3.onap.org:10001/onap/clamp-frontend 5.0.6 - - clamp-dash-es: nexus3.onap.org:10001/onap/clamp-dashboard-elasticsearch 5.0.3 - - clamp-dash-kibana: nexus3.onap.org:10001/onap/clamp-dashboard-kibana 5.0.3 - - clamp-dash-logstash: nexus3.onap.org:10001/onap/clamp-dashboard-logstash 5.0.3 - - -Version: 4.1.3 (El-Alto) ------------------------- - -:Release Date: 2019-10-11 - -**New Features** - -The El Alto release is the sixth release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the El Alto release was to: - - - _.Fix a maximum a security issues, especially the angular related issues by moving to React. - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `El Alto CLAMP user stories done <https://wiki.onap.org/display/DW/El+Alto+CLAMP+user+stories+done>`_ - This includes the list of bugs that were fixed during the course of this release. - -**Known Issues** - - - `CLAMP-506 <https://jira.onap.org/browse/CLAMP-506>`_ Elastic Search Clamp image cannot be built anymore(SearchGuard DMCA issue) - - Due to the uncertainties with the DMCA SearchGuard issue, the ELK stack has been removed from El Alto release, meaning the CLAMP "Control Loop Dashboard" is not part of the El Alto release. - - `CLAMP-519 <https://jira.onap.org/browse/CLAMP-519>`_ Clamp cannot authenticate to AAF(Local authentication as workaround) - - -**Security Notes** - -*Fixed Security Issues* - -*Known Security Issues* - -*Known Vulnerabilities in Used Modules* - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release. -The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - - - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_ - -**Upgrade Notes** - - New Docker Containers are available. - - -Version: 4.1.0 (El-Alto Early Drop) ------------------------------------ - -:Release Date: 2019-08-19 - -**New Features** - -The El Alto-Early Drop release is the fifth release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the El Alto-Early Drop release was to: - - - _.Fix a maximum a security issues, especially the angular related issues by moving to React. - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `CLAMP R5 - Early Drop RELEASE <https://wiki.onap.org/display/DW/CLAMP+R5+-+Early+Drop>`_ - This includes the list of bugs that were fixed during the course of this release. - -**Known Issues** - - - `CLAMP-384 <https://jira.onap.org/browse/CLAMP-384>`_ Loop State in UI is not reflecting the current state - -**Security Notes** - -*Fixed Security Issues* - - - `OJSI-166 <https://jira.onap.org/browse/OJSI-166>`_ Port 30290 exposes unprotected service outside of cluster. - -*Known Security Issues* - -*Known Vulnerabilities in Used Modules* - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release. -The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - - - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=68540334>`_ - -**Upgrade Notes** - - New Docker Containers are available. - - - -Version: 4.0.5 (Dublin) ------------------------ - -:Release Date: 2019-06-06 - -**New Features** - -The Dublin release is the fourth release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the Dublin release was to: - - - Stabilize Platform maturity by stabilizing CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Dublin+Release+Platform+Maturity>`_. - - CLAMP supports of Policy-model based Configuration Policy - - CLAMP supports new Policy Engine direct Rest API (no longer based on jar provided by Policy Engine) - - CLAMP main Core/UI have been reworked, removal of security issues reported by Nexus IQ. - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `DUBLIN RELEASE <https://jira.onap.org/projects/CLAMP/versions/10427>`_ - This includes the list of bugs that were fixed during the course of this release. - -**Known Issues** - - - `CLAMP-384 <https://jira.onap.org/browse/CLAMP-384>`_ Loop State in UI is not reflecting the current state - -**Security Notes** - -*Fixed Security Issues* - - - `OJSI-128 <https://jira.onap.org/browse/OJSI-128>`_ In default deployment CLAMP (clamp) exposes HTTP port 30258 outside of cluster. - - `OJSI-147 <https://jira.onap.org/browse/OJSI-147>`_ In default deployment CLAMP (cdash-kibana) exposes HTTP port 30290 outside of cluster. - - `OJSI-152 <https://jira.onap.org/browse/OJSI-152>`_ In default deployment CLAMP (clamp) exposes HTTP port 30295 outside of cluster. - -*Known Security Issues* - -*Known Vulnerabilities in Used Modules* - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release. -The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64003444>`_. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - - - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=64003444>`_ - -**Upgrade Notes** - - New Docker Containers are available. - - -Version: 3.0.4 - maintenance release ------------------------------------- - -:Release Date: 2019-04-06 - -**New Features** -none - -**Bug Fixes** -none - -**Known Issues** -CLAMP certificates have been renewed to extend their expiry dates - - `CLAMP-335 <https://jira.onap.org/browse/CLAMP-335>`_ Update Certificates on Casablanca release. - - -Version: 3.0.3 - maintenance release ------------------------------------- - -:Release Date: 2019-02-06 - -**New Features** -none - -**Bug Fixes** -none - -**Known Issues** -one documentation issue was fixed, this issue does not require a new docker image: - - `CLAMP-257 <https://jira.onap.org/browse/CLAMP-257>`_ User Manual for CLAMP : nothing on readthedocs. - -Version: 3.0.3 (Casablanca) ---------------------------- - -:Release Date: 2018-11-30 - -**New Features** - -The Casablanca release is the third release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the Casablanca release was to: - - - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Casablanca+Release+Platform+Maturity>`_. - - CLAMP Dashboard improvements for the monitoring of active Closed Loops - - CLAMP logs alignment on the ONAP platform. - - CLAMP is now integrated with AAF for authentication and permissions retrieval (AAF server is pre-loaded by default with the required permissions) - - CLAMP improvement for configuring the policies (support of Scale Out use case) - - CLAMP main Core/UI have been reworked, removal of security issues reported by Nexus IQ on JAVA/JAVASCRIPT code (Libraries upgrade or removal/replacement when possible) - - As a POC, the javascript coverage can now be enabled in SONAR (Disabled for now) - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `CASABLANCA RELEASE <https://jira.onap.org/projects/CLAMP/versions/10408>`_ - This includes the list of bugs that were fixed during the course of this release. - -**Known Issues** - - - None - -**Security Notes** - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and actions to be taken in future release. -The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598587>`_. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - - - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=42598587>`_ - -**Upgrade Notes** - - New Docker Containers are available, an ELK stack is also now part of CLAMP deployments. - -**Deprecation Notes** - - The CLAMP Designer Menu (in CLAMP UI) is deprecated since Beijing, the design time is being onboarded into SDC - DCAE D. - -**Other** - - CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP. - -**How to - Videos** - - https://wiki.onap.org/display/DW/CLAMP+videos - -Version: 2.0.2 (Beijing) ------------------------- - -:Release Date: 2018-06-07 - -**New Features** - -The Beijing release is the second release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the Beijing release was to: - - - Enhance Platform maturity by improving CLAMP maturity matrix see `Wiki <https://wiki.onap.org/display/DW/Beijing+Release+Platform+Maturity>`_. - - Focus CLAMP on Closed loop runtime operations and control - this is reflected by the move of the design part to DCAE-D. - - Introduce CLAMP Dashboard for monitoring of active Closed Loops. - - CLAMP is integrated with MSB. - - CLAMP has integrated SWAGGER. - - CLAMP main Core has been reworked for improved flexibility. - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `BEIJING RELEASE <https://jira.onap.org/projects/CLAMP/versions/10314>`_ - This includes the list of bugs that were fixed during the course of this release. - -**Known Issues** - - - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work. - - The "Deploy" action does not work directly after submitting it. - - Workaround: - - You have to close the CL and reopen it again. In that case the Deploy action will do something. - -**Security Notes** - -CLAMP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The CLAMP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25440749>`_. - -Quick Links: - - `CLAMP project page <https://wiki.onap.org/display/DW/CLAMP+Project>`_ - - - `Passing Badge information for CLAMP <https://bestpractices.coreinfrastructure.org/en/projects/1197>`_ - - - `Project Vulnerability Review Table for CLAMP <https://wiki.onap.org/pages/viewpage.action?pageId=25440749>`_ - -**Upgrade Notes** - - New Docker Containers are avaialble, an ELK stack is also now part of CLAMP deployments. - -**Deprecation Notes** - - The CLAMP Designer UI is now deprecated and unavailable, the design time is being onboarded into SDC - DCAE D. - -**Other** - - CLAMP Dashboard is now implemented, allows to monitor Closed Loops that are running by retrieving CL events on DMAAP. - -Version: 1.1.0 (Amsterdam) --------------------------- - -:Release Date: 2017-11-16 - -**New Features** - -The Amsterdam release is the first release of the Control Loop Automation Management Platform (CLAMP). - -The main goal of the Amsterdam release was to: - - - Support the automation of provisionning for the Closed loops of the vFW, vDNW and vCPE through TCA. - - Support the automation of provisionning for the Closed loops of VVolte (Holmes) - - Demonstrate complete interaction with Policy, DCAE, SDC and Holmes. - -**Bug Fixes** - - - The full list of implemented user stories and epics is available on `AMSTERDAM RELEASE <https://jira.onap.org/projects/CLAMP/versions/10313>`_ - This is technically the first release of CLAMP, previous release was the seed code contribution. - As such, the defects fixed in this release were raised during the course of the release. - Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira link above. - -**Known Issues** - - `CLAMP-68 <https://jira.onap.org/browse/CLAMP-68>`_ ResourceVF not always provisioned. - - In Closed Loop -> Properties CL: When opening the popup window, the first service in the list does not show Resource-VF even though in SDC there is a resource instance in the service. - - Workaround: - - If you have multiple service available (if not create a dummy one on SDC), just click on another one and then click back on the first one in the list. The ResourceVF should be provisioned now. - - - `CLAMP-69 <https://jira.onap.org/browse/CLAMP-69>`_ Deploy action does not always work. - - The "Deploy" action does not work directly after submitting it. - - Workaround: - - You have to close the CL and reopen it again. In that case the Deploy action will do something - - -**Security Issues** - CLAMP is following the CII Best Practices Badge Program, results including security assesment can be found on the - `project page <https://bestpractices.coreinfrastructure.org/projects/1197>`_ - - -**Upgrade Notes** - - N/A - -**Deprecation Notes** - - N/A - -**Other** - - - -=========== - -End of Release Notes diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt deleted file mode 100644 index b3188ddd3..000000000 --- a/docs/requirements-docs.txt +++ /dev/null @@ -1,15 +0,0 @@ -tox -Sphinx -doc8 -docutils -setuptools -six -sphinx_rtd_theme>=0.4.3 -sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag -sphinxcontrib-swaggerdoc -sphinxcontrib-plantuml -sphinx_bootstrap_theme -lfdocs-conf diff --git a/docs/tox.ini b/docs/tox.ini deleted file mode 100644 index edac8c35f..000000000 --- a/docs/tox.ini +++ /dev/null @@ -1,22 +0,0 @@ -[tox] -minversion = 1.6 -envlist = docs, -skipsdist = true - -[testenv:docs] -basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt -commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html - echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = - echo - git - sh - -[testenv:docs-linkcheck] -basepython = python3 -#deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo diff --git a/docs/user-guide.rst b/docs/user-guide.rst deleted file mode 100644 index 5cfcf1abd..000000000 --- a/docs/user-guide.rst +++ /dev/null @@ -1,157 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved. - -Control loop in Policy/CLAMP ----------------------------- -There are 2 control loop levels in Policy/CLAMP: - -- Control loop template: This is created from the DCAE blueprint (designed in the DCAE designer), and distributed by SDC to CLAMP. -- Control loop instance: Based on the template, it represents a physical control loop in the platform related to a service and a VNF. - -There is no way to design the microservice components of the control loop from scratch in CLAMP, you can only configure it and manage its life-cycle. -For more info on how to design the service in SDC, check this: https://wiki.onap.org/display/DW/CLAMP+videos#CLAMPvideos-DesignpartinSDC - - -There is a specific menu to view the available Control loop templates. - -|clamp-template-menu| - - -Each microservice policies and operational policies is related to a Policy Model. -Clamp either communicates with Policy Engine periodically to download the available Policy Models automatically or user can upload the Policy Model manually. -Policy Models related operations could be found under Policy Models menu. - -|clamp-policy-model-menu| - - -Under the menu *Loop Instance*, there's a list of actions to perform regarding to the loops. - -|clamp-loop-menu| - - -Option *Create* creates the loop from the templates distributed by SDC. - -|clamp-create-loop| - - -Option *Open* opens the saved loops. Once the distributed control loop has been chosen, the control loop is shown to the user. - -|clamp-open-loop| - - -Option *Close* will close the current opened loop. - - -Option *Modify* opens the window to add/remove different Operational Policies to the loop. -Tab *Add Operational Policies* lists all the available operational policies. -Click *Add* button to add the selected operational policies to the loop. - -|clamp-add-operational-policies| - -Tab *Remove Operational Policies* lists all the operational policies added to the loop. -Click *Remove* button to remove the selected operational policies from the loop. - -|clamp-remove-operational-policies| - - -Once opened, the user can start configure empty control loop using **Closed loop modeller**. - -|clamp-opened-loop| - - -Loop modeler has 3 main parts: - -#. Loop configuration view - Visualizes event flow in Control Loop. This view is auto-generated by Clamp. To generate it Clamp parses DCAE_INVENTORY_BLUEPRINT from CSAR distributed by SDC. - It Always consists of **VES -> <nodes from blueprint> -> OperationalPolicy**. Not all nodes are visualized. Only those with type **dcae.nodes.\*** - |blueprint-node| - -#. Loop status - Visualizes status of opened loop. -#. Loop logs - Table with log data of opened loop - - -Control Loop properties ------------------------ -In Dublin release this view shows what are deployment parameters or control Loop. -To open it from *Loop Instance* menu select *Properties* - -|clamp-menu-prop| - -This opens a box with JSON object. It contains deployment parameters extracted from DCAE_INVENTORY_BLUEPRINT. -It's not recommended to edit this JSON. Each of this parameters should be available in view shown to deploy analytic application. - -|clamp-prop-box| - - -Operational policy properties ---------------------------------------- -Operational policies are added by the user using *Modify* window. The configuration view is generated using Policy Type assigned to selected operational policy. - -To configure operational policies, user has to click the corresponding operational policy boxes. Example popup dialog for operational policy looks like: - -|clamp-op-policy-box-policy| - -Operations and payload for CDS actor is fetched from CDS. -Clamp receives CDS blueprint name and version information from sdnc_model_name and sdnc_model_version properties in CSAR distributed by SDC and queries CDS to get list of operations and payload for the corresponding CDS blueprint. - -|clamp-cds-operation| - -Micro-service policy properties -------------------------------- -Boxes between `VES` and `Operational Policies` are generated from blueprint. They can be one of ONAP predefined analytic microservices or custom analytics. -Each of the boxes is clickable. Microservice configuration view is generated using Policy Type assigned to selected microservice. -Clamp by default assumes that microservices have policy type **onap.policies.monitoring.cdap.tca.hi.lo.app**. - -After clicking microservice box Clamp opens popup dialog. Example popup dialog for microservice with default type looks like: - -|clamp-config-policy-tca| - - - -In the *Loop Operations* menu, lists the operations to be perform to the loop. - -|clamp-loop-operation-menu| - - -Submitting the Control loop to core policy ------------------------------------------- -The SUBMIT operation can be used to send the configuration to policy engine. -If everything is successful, the status to the policy will become *SENT*. Clamp should also show proper logs in logs view. - -|clamp-policy-submitted| - -After Policies are submitted they should be visible in Policy PAP component. -Please check `Policy GUI <https://docs.onap.org/en/dublin/submodules/policy/engine.git/docs/platform/policygui.html>`_ - - -Deploy/undeploy the Control Loop to DCAE ------------------------------------------ -Once sent to policy engine, Clamp can ask to DCAE to DEPLOY the micro service - -This opens a window where the parameters of the DCAE micro service can be configured/tuned. -The policy_id is automatically generated by Clamp in the previous steps. - -|clamp-deploy-params| - -Once deployed on DCAE the status of DCAE goes to *MICROSERVICE_INSTALLED_SUCCESSFULLY*, it can then be Undeployed/Stopped/Restart. - -.. |clamp-template-menu| image:: images/user-guide/template-menu.png -.. |clamp-policy-model-menu| image:: images/user-guide/policy-model-menu.png -.. |clamp-loop-menu| image:: images/user-guide/loop-menu.png -.. |clamp-create-loop| image:: images/user-guide/create-loop.png -.. |clamp-open-loop| image:: images/user-guide/open-loop.png -.. |clamp-add-operational-policies| image:: images/user-guide/add-operational-policies.png -.. |clamp-remove-operational-policies| image:: images/user-guide/remove-operational-policies.png -.. |clamp-opened-loop| image:: images/user-guide/opened-loop.png -.. |clamp-menu-prop| image:: images/user-guide/open-menu-prop.png -.. |clamp-prop-box| image:: images/user-guide/loop-properties.png -.. |clamp-op-policy-box-policy| image:: images/user-guide/op-policy-box-policy.png -.. |clamp-config-policy-tca| image:: images/user-guide/config-policy-tca.png -.. |clamp-loop-operation-menu| image:: images/user-guide/loop-operation-menu.png -.. |clamp-policy-submitted| image:: images/user-guide/policy-submitted.png -.. |clamp-deploy-params| image:: images/user-guide/deploy-params.png -.. |blueprint-node| image:: images/user-guide/blueprint_node_type.png -.. |clamp-cds-operation| image:: images/user-guide/clamp-cds-operation.png |
