From e306939ce7bf085d21faa0038da00c2127a368c8 Mon Sep 17 00:00:00 2001 From: Idan Amit Date: Thu, 9 Nov 2017 10:57:15 +0200 Subject: [PATCH] Add Release Notes to Read the Docs Added Release Notes section to SDC Read the Docs Change-Id: Ib4485e02f1edb45ecde16308c45cc96a4e6189d5 Issue-Id: SDC-604 Signed-off-by: Idan Amit --- docs/release-notes.rst | 463 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 443 insertions(+), 20 deletions(-) diff --git a/docs/release-notes.rst b/docs/release-notes.rst index b568bee821..800d53b19a 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,41 +1,463 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +============= 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: 1.1.0 +============== + +:Release Date: 2017-11-15 + + + +SDC SDKs Versions +----------------- + +- sdc-distribution-client + + :Version: 1.1.32 + +| + +- sdc-tosca + + :Version: 1.1.32 + +New Features +------------ +**Epics** -Version: x.y.z --------------- +- [`SDC-52 `__\ ] - SDC Opensource + tech gaps +- [`SDC-53 `__\ ] - F28350/302244 + [MVP] SDC 1710 - Increment Conformance Level +- [`SDC-54 `__\ ] - F36419/299760 + [EPIC] - [MVP] SDC 1710 – Introduce a new Asset Type: PNF +- [`SDC-55 `__\ ] - F34117/305092 + [EPIC] - [MVP] SDC 1710 – Enhance the CP +- [`SDC-56 `__\ ] - F36795/298830 + [EPIC] – Provide a new Capability to Onboard non-HEAT VNFs based on a + Questionnaire. +- [`SDC-57 `__\ ] - F36795/150093 + [EPIC] – Enhance the VNF Model to include VNFC (VFC) +- [`SDC-58 `__\ ] - F36795/291353 + EPIC] - [MVP] ASDC 1710 -TOSCA Parser - Stand alone +- [`SDC-59 `__\ ] - F36795/296771 + [EPIC] - [MVP] SDC 1710 - TOSCA Parser – Support Complex Inputs +- [`SDC-60 `__\ ] - F36795/309319 + EPIC] – Provide Additional Artifact type relevant for VNF Onboarding. +- [`SDC-61 `__\ ] - F36797/291413 + [EPIC] - Enhance the VFC Model with additional Properties for VFC + characterization +- [`SDC-62 `__\ ] - F36801/152151 + [EPIC] - [MVP] ASDC 1707 - Tosca Schema files +- [`SDC-63 `__\ ] - F36257/292814 + EPIC] - [MVP] SDC 1710 NFR – Enhance the System Health Check API +- [`SDC-64 `__\ ] - 306915 EPIC: + [DevOps] - SSL Certificates separation of certificates for the + deployment code +- [`SDC-66 `__\ ] - Workflow + Designer +- [`SDC-71 `__\ ] - Workflow + Management +- [`SDC-99 `__\ ] - Onbording + Tosca VNF +- [`SDC-111 `__\ ] - swagger + restful interface support +- [`SDC-116 `__\ ] - bpmn + workflow modeler +- [`SDC-218 `__\ ] - support + integration with VFC +- [`SDC-219 `__\ ] - Support for + uCPE usecase +- [`SDC-220 `__\ ] - integrate + VNF onboarding using VNF-SDK +- [`SDC-287 `__\ ] - catalog + support TOSCA CSAR import and distribution +- [`SDC-326 `__\ ] - Support work + flows in SDC +**Stories** -:Release Date: yyyy-mm-dd +- [`SDC-28 `__\ ] - TDP 291354 - + JTOSCA repo initial commit +- [`SDC-67 `__\ ] - Workflow + designer support json object type +- [`SDC-68 `__\ ] - Workflow + designer support Swagger definition +- [`SDC-69 `__\ ] - WorkFlow Input + Parameter Designer +- [`SDC-70 `__\ ] - WorkFlow + Diagram Editor +- [`SDC-72 `__\ ] - Export + WorkFlow +- [`SDC-74 `__\ ] - Delete + WorkFlow +- [`SDC-75 `__\ ] - Modify + WorkFlow +- [`SDC-76 `__\ ] - Add WorkFlow +- [`SDC-81 `__\ ] - Support VNF + Package Specification +- [`SDC-92 `__\ ] - Topology + Diagram Editor +- [`SDC-94 `__\ ] - Support + Package draft +- [`SDC-95 `__\ ] - Support + Package draft +- [`SDC-96 `__\ ] - Package + multiple-versions support +- [`SDC-97 `__\ ] - CLI Package + Validation and Packaging tool +- [`SDC-98 `__\ ] - Template + management +- [`SDC-112 `__\ ] - support + swagger specification interface definition +- [`SDC-113 `__\ ] - support set + swagger info by swagger string +- [`SDC-114 `__\ ] - support set + swagger info by url +- [`SDC-115 `__\ ] - support + invoke restful interfaces defined by swagger specification +- [`SDC-117 `__\ ] - support bpmn + workflow nodes(start, end, exclusive gateway, parallel gateway) +- [`SDC-119 `__\ ] - support set + conditoin for gateway +- [`SDC-120 `__\ ] - support set + input and output params for start event and end event +- [`SDC-121 `__\ ] - support + quote output of previous workflow node for params +- [`SDC-122 `__\ ] - support + quote input of start event for params +- [`SDC-161 `__\ ] - Remove + MojoHaus Maven plug-in from pom file +- [`SDC-222 `__\ ] - Retrive and + Desplay VNF provided by VNF-SDK +- [`SDC-223 `__\ ] - Attachment + display changes - UI +- [`SDC-224 `__\ ] - Tosca based + onbaording enrichment - BE +- [`SDC-225 `__\ ] - Tosca + validation in the attachment - BE +- [`SDC-226 `__\ ] - Support + TOSCA CSAR attachments and validation in overview display - BE +- [`SDC-227 `__\ ] - Create new + VSP, onboard from TOSCA file - BE +- [`SDC-228 `__\ ] - Tosca based + onbaording enrichment - UI +- [`SDC-229 `__\ ] - Support + TOSCA attachments in overview display - UI +- [`SDC-230 `__\ ] - Create new + VSP, onboard from TOSCA file - UI +- [`SDC-231 `__\ ] - VNF package + manifest file parsing - BE +- [`SDC-232 `__\ ] - Import TOSCA + YAML CSAR - BE +- [`SDC-240 `__\ ] - WorkFlow + Deisigner seed code +- [`SDC-248 `__\ ] - add verify + job for workflow-designer in ci-manager +- [`SDC-255 `__\ ] - support add + workflow node +- [`SDC-257 `__\ ] - save and + query workflow definition data from catalog +- [`SDC-269 `__\ ] - support set + microservice info +- [`SDC-276 `__\ ] - add dynamic + dox scheme creation +- [`SDC-282 `__\ ] - support rest + task node +- [`SDC-288 `__\ ] - Independent + Versioning and Release Process +- [`SDC-294 `__\ ] - support bpmn + timer element +- [`SDC-295 `__\ ] - delete node + or connection by keyboard +- [`SDC-299 `__\ ] - Port + mirorring +- [`SDC-306 `__\ ] - Replace + Dockefiles with new baselines +- [`SDC-318 `__\ ] - Provide + preset definitions for the enitity types standardized by the + tosca-nfv specification. +- [`SDC-325 `__\ ] - Add “Network + Service” and “E2E Service” to the predefined list of SDC categories. +- [`SDC-327 `__\ ] - add new + artifact type to SDC +- [`SDC-329 `__\ ] - add + categories to define SDC service +- [`SDC-339 `__\ ] - project + package and create dockfile +- [`SDC-355 `__\ ] - support set + value for branch node +- [`SDC-360 `__\ ] - Import New + VF vCSCF +- [`SDC-370 `__\ ] - sdc + documentation +- [`SDC-379 `__\ ] - Write + functional test cases based on the functionality tested by sanity + docker +- [`SDC-476 `__\ ] - add sonar + branch to sdc project pom +- [`SDC-481 `__\ ] - update + swager +- [`SDC-498 `__\ ] - Support and + align CSAR's for VOLTE +- [`SDC-506 `__\ ] - Fill SDC + read the docs sections +- [`SDC-517 `__\ ] - ONAP support +- [`SDC-521 `__\ ] - CSIT and + sanity stabilization +- [`SDC-522 `__\ ] - sync 1710 + defacts into ONAP +- [`SDC-586 `__\ ] - Support and + align CSAR's for VOLTE +- [`SDC-594 `__\ ] - Fill SDC + read the docs sections +- [`SDC-608 `__\ ] - CSIT and + sanity stabilization +- [`SDC-615 `__\ ] - add new + artifact type to SDC +- [`SDC-619 `__\ ] - ONAP support +- [`SDC-623 `__\ ] - Independent + Versioning and Release Process +**Tasks** +- [`SDC-185 `__\ ] - [Doc] + Document SDC generated CSAR structure +- [`SDC-246 `__\ ] - Set up + static analysis for on-boarding +- [`SDC-258 `__\ ] - get param + from url +- [`SDC-260 `__\ ] - add node + property edit panel +- [`SDC-261 `__\ ] - Resolve the + String nullpoint problem in validateString() function +- [`SDC-266 `__\ ] - change + component structure +- [`SDC-271 `__\ ] - support get + dynamic swagger definition +- [`SDC-281 `__\ ] - support + swagger definition for microservice +- [`SDC-284 `__\ ] - get + parameters from definition +- [`SDC-285 `__\ ] - support set + path and query parameters for rest task +- [`SDC-316 `__\ ] - support + multi element drag +- [`SDC-336 `__\ ] - support + workflow variable to be parameter +- [`SDC-362 `__\ ] - adjust css + style for tree node +- [`SDC-382 `__\ ] - Add Python + to Cassandra base docker +- [`SDC-439 `__\ ] - add consumer +- [`SDC-462 `__\ ] - Deploy + workflow designer in VM +- [`SDC-475 `__\ ] - Update + gitignore +- [`SDC-478 `__\ ] - Sanity + docker build & vLB + vCSCF\_aligned VNF addition +- [`SDC-487 `__\ ] - remove neo4j + classes +- [`SDC-496 `__\ ] - debug csit + sanity failure +- [`SDC-524 `__\ ] - move docker + pull credentials from settings.xml to pom +- [`SDC-527 `__\ ] - Update + SDC-Simulator base image to the latest +- [`SDC-553 `__\ ] - improve + build time +- [`SDC-569 `__\ ] - revert + changes to sdc tosca and jtosca +- [`SDC-577 `__\ ] - Change of + SDC artifact generator version from v10 to v11 for Amsterdam +- [`SDC-585 `__\ ] - pom.xml + alignment - sdc-docker-base +- [`SDC-635 `__\ ] - Updating + schema from V11 to V10 +- [`SDC-636 `__\ ] - add docs for + workflow designer +- [`SDC-644 `__\ ] - Fix doc8 + errors -**New Features** +**Sub-task** -One or two sentences explaining the purpose of this Release. +- [`SDC-372 `__\ ] - document + jenkins triggers +- [`SDC-377 `__\ ] - create tast + case, docker init logic and push to integration project +- [`SDC-378 `__\ ] - create + Jenkins jobs to trigger csit test cases +- [`SDC-419 `__\ ] - Setup Read + The Docs for SDC +- [`SDC-530 `__\ ] - remove all + use of snapshoots from the code +- [`SDC-542 `__\ ] - sanity + stabilization +- [`SDC-551 `__\ ] - Fix typos + and error/warning messages from sphinx-build +- [`SDC-563 `__\ ] - add tosca + parser verification step in onboarding test +- [`SDC-579 `__\ ] - fill SDC + SDKs +- [`SDC-611 `__\ ] - sanity + stabilization + + +**One or two sentences explaining the purpose of this Release.** + +Bug Fixes +--------- + +**Bugs** + +- [`SDC-160 `__\ ] - substitution + mapping problem +- [`SDC-256 `__\ ] - modify + workflow version in package.json +- [`SDC-263 `__\ ] - Exception is + not showing the correct error +- [`SDC-270 `__\ ] - The node + template name in the capability/requirement mapping map is not + synchronized while modify a node template' name. +- [`SDC-273 `__\ ] - Error: + Internal Server Error. Please try again later +- [`SDC-280 `__\ ] - SDC + healthcheck 500 on Rackspace deployment +- [`SDC-283 `__\ ] - jjb daily + build fail +- [`SDC-289 `__\ ] - UI shows + {length} and {maxLength} instead of actual limit values +- [`SDC-290 `__\ ] - discrepancy + between the BE and FE on the “Create New License Agreement” Wizard +- [`SDC-296 `__\ ] - The default + value of the VF input parameter is incorrect. +- [`SDC-297 `__\ ] - adjust + textarea component style +- [`SDC-298 `__\ ] - The exported + CSAR package of VFC lacks the definition of capability types + standardized in the tosca-nfv specification. +- [`SDC-300 `__\ ] - GET query to + metadata fails requested service not found +- [`SDC-307 `__\ ] - add sequence + flow after refresh +- [`SDC-308 `__\ ] - save new + position after node dragged +- [`SDC-309 `__\ ] - The exported + CSAR package of VF lacks the definition of relationship types + standardized in the tosca-nfv specification. +- [`SDC-310 `__\ ] - The exported + CSAR package of VFC lacks the definition of data types standardized + in the tosca-nfv specification. +- [`SDC-313 `__\ ] - requirement + id is not correct +- [`SDC-323 `__\ ] - The scalar + unit type value is in correctly created +- [`SDC-335 `__\ ] - swagger + convert error +- [`SDC-337 `__\ ] - add missing + global type +- [`SDC-338 `__\ ] - submit fails + when uploading CSAR file +- [`SDC-344 `__\ ] - move jtosca + version to main pom +- [`SDC-349 `__\ ] - add global + type for import tosca +- [`SDC-351 `__\ ] - enable port + mirroring +- [`SDC-353 `__\ ] - ONAP 1.1.0 + SDC distributions failing in ORD - Add Software Product - Status 500 +- [`SDC-363 `__\ ] - data convert + error for tree node +- [`SDC-369 `__\ ] - invalide tag + defined for docker +- [`SDC-375 `__\ ] - Onboarding + build time +- [`SDC-381 `__\ ] - VLM update + with EP/LKG - null error +- [`SDC-389 `__\ ] - Default + value of properties do not match +- [`SDC-390 `__\ ] - fix docker + file script error +- [`SDC-407 `__\ ] - VLM Refresh + issue in orphans list on added agreement +- [`SDC-410 `__\ ] - Import + normatives not running + Upgrade normatives not imports the onap + types +- [`SDC-431 `__\ ] - Artifacts + not generated for PNF Resource and hence not enabling model + distribution to A&AI +- [`SDC-435 `__\ ] - sdc staging + job is failing +- [`SDC-436 `__\ ] - sdc release + stagging is failing on release 1.1.0 +- [`SDC-441 `__\ ] - module-0 + with version 1.0 not found in MSO Catalog DB +- [`SDC-443 `__\ ] - Fix SDC + inter-DC overlay configuration model to support multiple networks +- [`SDC-444 `__\ ] - + sdc-sdc-workflow-designer-master-stage-site-java Jenkins job failed +- [`SDC-448 `__\ ] - Onboarding + of VNF Base\_VLB failed +- [`SDC-452 `__\ ] - Workflow + designer UI doesn't show up +- [`SDC-454 `__\ ] - vMME CSAR + from vendor failed SDC onboarding +- [`SDC-457 `__\ ] - artifacts + are not copied to CSAR +- [`SDC-460 `__\ ] - + vCSCF\_aligned.csar Tosca.meta Entry definition file is missing +- [`SDC-461 `__\ ] - sidebar + element background color changed +- [`SDC-471 `__\ ] - Predefined + Network Service is missing in Generic Service Category +- [`SDC-474 `__\ ] - Issue in + Onboarding converting occurrences in node\_types section +- [`SDC-477 `__\ ] - + SDC-base-docker jetty base failed to run apt-get +- [`SDC-483 `__\ ] - Zip file + stored under vendor CSAR Artifacts directory is not included in CSAR + created by SDC after VSP import +- [`SDC-491 `__\ ] - Artifact are + incorectly passed +- [`SDC-495 `__\ ] - artifacts + are not packed correctly when uploading csar +- [`SDC-525 `__\ ] - Docker RUN + chmod fails +- [`SDC-528 `__\ ] - SDC + Backend/frontend not starting +- [`SDC-533 `__\ ] - Fail to get + correct labels of requirements of nodes in service template +- [`SDC-537 `__\ ] - Backend + doesn't respond on port 8181 after heat deployment +- [`SDC-544 `__\ ] - Should not + be validating message router certificate +- [`SDC-546 `__\ ] - Fix SCH to + properly set "useHttpsWithDmaap" +- [`SDC-547 `__\ ] - SDC server + error when registering for distribution +- [`SDC-548 `__\ ] - Distribution + failing to SO in SDC client tosca parser null pointer +- [`SDC-561 `__\ ] - SDC version + 1.1.32 is not available in nexus, blocking SO docker build + + +Issues +------ -**Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. **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. + + N/A **Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ + N/A + +Notes +----- **Upgrade Notes** @@ -46,3 +468,4 @@ One or two sentences explaining the purpose of this Release. =========== End of Release Notes + -- 2.16.6