From ba72d20c02b25b981c68e269a663ef5c3d0d9ec1 Mon Sep 17 00:00:00 2001 From: ChrisC Date: Tue, 7 Nov 2017 06:44:18 -0800 Subject: [PATCH] Improve documentation Add Release Note for Amsterdam and link to ONAP wiki Change-Id: I87781f15cdea542741b43cec05536f8ce1b7d2db Issue-Id: CLAMP-67 Signed-off-by: ChrisC --- docs/index.rst | 4 ++-- docs/release-notes.rst | 61 +++++++++++++++++++++++++++++++++----------------- 2 files changed, 42 insertions(+), 23 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 8372137c..c654c81e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright © 2017 AT&T Intellectual Property. All rights reserved. +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. CLAMP - Closed Loop Automation Management Platform ================================================== @@ -164,6 +164,6 @@ The following actions are done using the UI: * Control (start/stop) the operation of the control loop in DCAE - +Please refer to the `Using ONAP ` for more details HealthCheck API - serve to verify CLAMP status (see offered API's section) diff --git a/docs/release-notes.rst b/docs/release-notes.rst index b568bee8..e372c846 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,48 +1,67 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. Release Notes ============= -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z +Version: 1.1.0 -------------- +:Release Date: 2017-11-16 -:Release Date: yyyy-mm-dd - +**New Features** +The Amsterdam release is the first release of the Control Loop Automation Management Platform (CLAMP). -**New Features** +The main goal of the Amsterdam release was to: -One or two sentences explaining the purpose of this Release. + - 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** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. + + - The full list of implemented user stories and epics is available on `JIRA `_ + 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** - - `CIMAN-65 `_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. + - `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 `_ 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** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ + CLAMP is following the CII Best Practices Badge Program, results including security assesment can be found on the + `project page `_ **Upgrade Notes** + N/A + **Deprecation Notes** + N/A + **Other** + + =========== End of Release Notes -- 2.16.6