From 9d87ad64427207114bf890db3325929f1ab619b8 Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Mon, 16 Nov 2020 16:37:52 +0100 Subject: Updated the conf.py Edited the conf.py to guilin Issue-ID: DOC-683 Signed-off-by: Sofia Wallin Change-Id: I48eff1949e2bb69722b0c75efe08db18677aa082 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 467836e8b..2d99a103a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ from docs_conf.conf import * -branch = 'latest' +branch = 'guilin' doc_url = 'https://docs.onap.org/projects' master_doc = 'index' -- cgit 1.2.3-korg From 36d0359e0db9d20bf2d2ef8c651f04fdc33e4dfe Mon Sep 17 00:00:00 2001 From: andreasgeissler Date: Wed, 18 Nov 2020 11:38:16 +0100 Subject: Update release notes list to Guilin release Update Multicloud link Issue-ID: DOC-687 Signed-off-by: andreasgeissler Change-Id: Iffc1d38d4326981c7ce1b56a8dfbdc621d33e346 (cherry picked from commit 8b53a72cf58680403bcf0d9f6d4c93df42a6d257) --- docs/release/releaserepos.rst | 59 ++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 29 deletions(-) (limited to 'docs') diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 5ff18d27e..dd7abc6c2 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -11,32 +11,33 @@ Project Specific Release Notes .. toctree:: :maxdepth: 1 -| :ref:`Active and Available Inventory` -| :ref:`Application Authorization Framework` -| :ref:`Application Controller` -| :ref:`Common Controller Software Development Kit` -| :ref:`Closed Loop Automation Platform` -| :ref:`Data Collection Analysis and Events` -| :ref:`DMAAP Message Router (MR)` -| :ref:`DMAAP Dmaap Data Router (DR)` -| :ref:`DMAAP Dmaap Bus Controller (BC)` -| :ref:`Documentation` -| :ref:`External API NorthBound Interface` -| :ref:`Integration` -| :ref:`Modeling etsicatalog` -| :ref:`Micro Services Bus` -| :ref:`Music` -| :ref:`MultiVIM Cloud ` -| :ref:`ONAP Operations Manager` -| :ref:`Optimization Framework` -| :ref:`Policy Framework` -| :ref:`Portal Platform` -| :ref:`Service Design & Creation` -| :ref:`Service Orchestration` -| :ref:`Software Defined Network Controller` -| :ref:`Use Case User Interface` -| :ref:`Virtual Function Controller` -| :ref:`Virtual Infrastructure Deployment` -| :ref:`VNF Requirements` -| :ref:`VNF Software Development Kit` -| :ref:`VNF Validation Project` +| :ref:`Project: Integration` +| :ref:`Project: Model Specification` +| :ref:`Project: VNF Requirements` +| :ref:`AAI - Active and Available Inventory` +| :ref:`CCSDK - Common Controller Software Development Kit` +| :ref:`CLAMP - Closed Loop Automation Platform` +| :ref:`CLI - Command Line Interface` +| :ref:`DCAE - Data Collection Analysis and Events` +| :ref:`DMAAP - Message Router (MR)` +| :ref:`DMAAP - Data Router (DR)` +| :ref:`DMAAP - Bus Controller (BC)` +| :ref:`DOC - Documentation` +| :ref:`EXTAPI - External API NorthBound Interface` +| :ref:`HOLMES - Rule Management` +| :ref:`MODELING - Modeling ETSI catalog` +| :ref:`MSB - Micro Services Bus` +| :ref:`MULTICLOUD - MultiCloud Framework` +| :ref:`OOF - Optimization Framework` +| :ref:`OOM - ONAP Operations Manager` +| :ref:`OOM - Certification Service` +| :ref:`POLICY- Policy Framework` +| :ref:`PORTAL - Portal Platform` +| :ref:`SDC - Service Design & Creation` +| :ref:`SDNC - Software Defined Network Controller` +| :ref:`SO - Service Orchestration` +| :ref:`UUI - Use Case User Interface` +| :ref:`VFC - Virtual Function Controller` +| :ref:`VID - Virtual Infrastructure Deployment` +| :ref:`VNFSDK - VNF Software Development Kit` +| :ref:`VVP - VNF Validation Project` -- cgit 1.2.3-korg From a065902c0a780890af13ad03b5cb732381c8d23e Mon Sep 17 00:00:00 2001 From: andreasgeissler Date: Thu, 19 Nov 2020 11:58:47 +0100 Subject: Added Guilin Release Note Issue-ID: DOC-679 Signed-off-by: andreasgeissler Change-Id: I59f8dd03ed58508ccf2bb3a3b0316af4a5f3f3e9 (cherry picked from commit fc3c7c4407d8c9ed1e9498098481c534f68840db) --- docs/release/index.rst | 94 +++++++++++++++++++++++--------------------------- 1 file changed, 43 insertions(+), 51 deletions(-) (limited to 'docs') diff --git a/docs/release/index.rst b/docs/release/index.rst index 8c2035b80..0a342d39c 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -4,10 +4,10 @@ .. _release-notes: -Frankfurt Release Notes -^^^^^^^^^^^^^^^^^^^^^^^ +Guilin Release Notes +^^^^^^^^^^^^^^^^^^^^ -This page provides the release notes for the ONAP Frankfurt release. This +This page provides the release notes for the ONAP Guilin release. This includes details of software versions, known limitations, and outstanding trouble reports. @@ -19,15 +19,14 @@ release notes and links to those release notes are provided below. Details on the specific items delivered in each release by each component is maintained in the component specific release notes. -Frankfurt Releases -================== +Guilin Releases +=============== -The following releases are available for Frankfurt: - - `Frankfurt Major Release 6.0.0`_ - - `Frankfurt Maintenance Release 6.0.1`_ +The following releases are available for Guilin: + - `Guilin Major Release 7.0.0`_ -Frankfurt Maintenance Release 6.0.1 -=================================== +Guilin Major Release 7.0.0 +========================== Release data ============ @@ -36,53 +35,40 @@ Release data | **Project** | Open Network Automation Platform | | | (ONAP) | +--------------------------------------+--------------------------------------+ -| **Release name** | Frankfurt | +| **Release name** | Guilin | | | | +--------------------------------------+--------------------------------------+ -| **Release version** | 6.0.1 | +| **Release version** | 7.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | August 17th 2020 | +| **Release date** | December 3rd 2020 | | | | +--------------------------------------+--------------------------------------+ -Frankfurt Maintenance Release 6.0.1 delivered a number of fixes and updates -across the following projects: +Guilin Features +=============== +ONAP Gulin focusses on: -- AAF -- OOM -- CCSDK -- CLAMP -- DCAEGEN2 -- Integration -- POLICY -- SDC -- SO -- TEST +* 5G network automation and services such as network slicing through RAN, core and transport +* deepening O-RAN Software Community integration along with other leading SDOs +* seamless orchestration of CNFs, VNFs and PNFs +* and bringing several new ONAP Blueprint and docs updates. -Details on the specific Jira tickets addressed by each project can be found in -the component specific Release Notes. Link can be found below in section -`Project Specific Release Notes`_. +5G Network Slicing +------------------ +In the industry evolution toward 5G networks, Guilin expands upon the end-to-end network slicing introduced with Frankfurt with the addition of RAN, core, and transport through Network Slice Subnet Management Function (NSSMF) which completes functionality with the Communication Service Management Function (CSMF) and Network Slice Management Function (NSMF) components. In addition to the NSSMF included in Guilin, ONAP supports an external RAN NSSMF. Next, the RAN domain also has initial support for a simple closed control loop and machine learning (ML) for intelligent slicing. -Frankfurt Major Release 6.0.0 -============================= +ONAP/O-RAN Alignment +-------------------- +The release also marks greater ONAP + O-RAN Software Community harmonization by adding support for the A1 interface (O-RAN A1-AP v1.1), adding to the existing O1 support. ONAP can now manage multiple A1 targets with different versions and includes a A1 Policy Management Service that interacts with the Near Real-Time RICs policy instances and provides a transient cache for these policies. -Release data -============ +CNF, VNF and PNF integration +---------------------------- +Guilin contains a large number of new features classified into design time, run time, and ONAP operations to optimize the self-serve control loop and dashboard, make it easier to reuse existing models, make xNF pre-onboarding and onboarding easier, speed up UI development, and more. For Documentation (Usability), ONAP documentation made improvements such as setting up ONAP, Platform Operations, Service Design and Deployment, and User Guides. Specific to cloud native, The Service Design & Creation (SDC) project, the unified design time tool, now supports Helm types to natively support Cloud Native Network Functions (CNF). -+--------------------------------------+--------------------------------------+ -| **Project** | Open Network Automation Platform | -| | (ONAP) | -+--------------------------------------+--------------------------------------+ -| **Release name** | Frankfurt | -| | | -+--------------------------------------+--------------------------------------+ -| **Release version** | 6.0.0 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | June 11th 2020 | -| | | -+--------------------------------------+--------------------------------------+ +Enhancements in ONAP Blueprints +------------------------------- +Other enhancements to the ONAP Blueprints includes a new Standard Defined VNF Event Stream (VES) event for Fault Management (FM) / Performance Management (PM) Data Collection, the first use of Machine Learning in Self-Organizing Networks (SON), and greater support for 5G RAN Wireless Network Resource Model (NRM) with Service Modeling and Definition and Intent Based Network supporting intent-drive 5G slice creation. Project Specific Release Notes ============================== @@ -96,8 +82,8 @@ are compatible with a major release are made available. Documentation ============= -ONAP Frankfurt Release provides a set selection of documents, -see `ONAP Documentation `_. +ONAP Guilin Release provides a set selection of documents, +see `ONAP Documentation `_. The `developer wiki `_ remains a good source of information on meeting plans and notes from committees, project teams and @@ -113,6 +99,8 @@ ONAP has adopted the `CII Best Practice Badge Program `_ - `Badging Status for all ONAP projects `_ +In the Guilin release, 24% projects pass the CII badge, 52% projects pass 75% of the CII silver badge tests (next badge up from the vanilla CII badge), 5% projects pass 84% of the CII silver badge tests, and 20% pass the entirety of the silver CII badge. + Project specific details are in the :ref:`release notes` for each project. @@ -120,12 +108,16 @@ each project. ONAP Maturity Testing Notes =========================== -For the Frankfurt release, ONAP continues to improve in multiple areas of +For the Guilin release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics. -The Integration team ran the 72 hours stability testing (100% passing rate) -and full resilience testing (99.4% passing rate) at ONAP OpenLabs. More details -in :ref:`ONAP Maturity Testing Notes ` +In Guilin the Integration team focussed in + +- Automating ONAP Testing to improve the overall quality +- Adding security and E2E tests +- Integrated new ONAP Python SDK in E2E testing + +More details in :ref:`ONAP Integration Project` Known Issues and Limitations ============================ -- cgit 1.2.3-korg From 0d861646799e0013edb06fea49dc7e5073df31e2 Mon Sep 17 00:00:00 2001 From: andreasgeissler Date: Mon, 23 Nov 2020 14:28:48 +0100 Subject: Added links to older release docs for maintained components Issue-ID: DOC-672 Signed-off-by: andreasgeissler Change-Id: If10a83665768cf3695b977448a3dd79f44f9b4dd (cherry picked from commit 8787afd724f24201b1e21ad0b8839c8189e51364) --- docs/guides/onap-developer/developing/index.rst | 40 +++++++++++++++++++++++++ 1 file changed, 40 insertions(+) (limited to 'docs') diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 14c9a85f8..2c250ec79 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -48,10 +48,17 @@ AAF - Application Authorization Framework * - Document - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) * - :ref:`AAF` +======= + * - (in Maintenance) `AAF (Frankfurt) `_ +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) - AAF Architecture, APIs and Guides +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) * - :ref:`Secret Management Service` - Secret Management Service Architecture and API +======= +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) AAI - Active and Available Inventory ------------------------------------ @@ -64,6 +71,7 @@ AAI - Active and Available Inventory - Description * - :ref:`AAI` - AAI Architecture, APIs and Guides +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) * - :ref:`ESR` - External System Registry GUI Documentation (to be removed ?) * - :ref:`ESR` @@ -72,6 +80,14 @@ AAI - Active and Available Inventory - Sparky - AAI Inventory UI Documentation (to be removed ?) * - :ref:`AAI Event Client` - AAI Event Client Documentation (to be removed ?) +======= + * - (in Maintenance) `ESR GUI (Latest) `_ + - External System Registry GUI Documentation + * - (in Maintenance) `ESR Server (Latest) `_ + - External System Registry Server Documentation + * - (in Maintenance) :ref:`Model` + - Sparky - AAI Inventory UI Documentation +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) APPC - Application Controller ----------------------------- @@ -82,9 +98,17 @@ APPC - Application Controller * - Document - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) * - :ref:`APPC` +======= + * - (in Maintenance) `APPC (Frankfurt) `_ +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) - APPC Architecture, APIs and Guides +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) * - :ref:`APPC Deployment` +======= + * - (in Maintenance) `APPC Deployment (Frankfurt) `_ +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) - APPC Deployment Documentation CCSDK - Common Controller Software Development Kit @@ -206,8 +230,13 @@ LOGGING - Centralized Logging * - Document - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) * - :ref:`Logging` - ONAP Centralized Logging Documentation (to be deleted ?) +======= + * - (in Maintenance) `LOGGING (Latest) `_ + - ONAP Centralized Logging Documentation +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) MSB - Microservices Bus ----------------------- @@ -242,10 +271,17 @@ MUSIC - ONAP Multi-Site Integration * - Document - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) * - :ref:`MUSIC` - MUSIC Architecture and Guides (To be deleted ?) * - :ref:`Distributed KV Store` - MUSIC Distribute KV Store Documents (To be deleted ?) +======= + * - (in Maintenance) `MUSIC (Frankfurt) `_ + - MUSIC Architecture and Guides + * - (in Maintenance) `MUSIC KV (Latest) `_ + - MUSIC Distribute KV Store Documents +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) OOF - Optimization Framework ---------------------------- @@ -361,7 +397,11 @@ SO - Service Orchestration * - :ref:`SO` - Service Orchestration Architecture, APIs and Guides * - :ref:`SO Libraries` +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - Service Orchestration Build (To be deleted ?) +======= + - ONAP SO/libs Documentation +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) UUI - Use Case User Interface ----------------------------- -- cgit 1.2.3-korg From c6dd3a993f66f61ad3cc0c7d380ad4526cd78644 Mon Sep 17 00:00:00 2001 From: mrichomme Date: Tue, 24 Nov 2020 17:08:59 +0100 Subject: Update use case section for Guilin section has been split in 2 - Guilin use cases - Deprecated use cases the user guide shall also include the use case of the release.. Issue-ID: INT-1736 Signed-off-by: mrichomme Change-Id: I4d42605858924911f5c5b1f40836043966c20ee7 (cherry picked from commit b83ccbaea962083b37b3e097e76df23731bd0835) --- docs/guides/onap-user/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 79698fcf3..d8432fb0a 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -26,4 +26,5 @@ Verified Use Cases In the following page you find all use cases and functional requirements which have been officially verified in the actual release by the ONAP community. -* :ref:`Verified Use Cases` +* :ref:`Guilin Use Cases` +* :ref:`Deprecated Use Cases` -- cgit 1.2.3-korg From da037a33862b9dd4b4c54f8c8585ceb156a46eb9 Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam Date: Wed, 25 Nov 2020 16:01:39 +0530 Subject: Remove Deprecate tag from CLI Issue-ID: DOC-688 Signed-off-by: Kanagaraj Manickam Change-Id: Ica9f5bf7ab98b9f4b3401754798a9b8213e3fa4e (cherry picked from commit e7070c0a214a14b41baa4b04c5754f2b976754d7) --- .../architecture/media/ONAP-architecture.png | Bin 131977 -> 131064 bytes 1 file changed, 0 insertions(+), 0 deletions(-) (limited to 'docs') diff --git a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png b/docs/guides/onap-developer/architecture/media/ONAP-architecture.png index 5f12d955a..0e7c69548 100644 Binary files a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png and b/docs/guides/onap-developer/architecture/media/ONAP-architecture.png differ -- cgit 1.2.3-korg From 01570f3299cde3eaaa2b33ef5bf777645de8e099 Mon Sep 17 00:00:00 2001 From: mrichomme Date: Wed, 25 Nov 2020 09:21:03 +0100 Subject: Cleanup use case part in doc repo The use cases are hosted in integration repositories There were 2 dirctories referencing use cases in doc repo - guides/onap-developer/use-cases - use-cases they both dealt with vfw and were not up to date the vfw call flows are also in integration repository no update since beijing Issue-ID: INT-1776 Signed-off-by: mrichomme Change-Id: I61b8eb80381d13f45bfdd4a7639ff5364d02186b (cherry picked from commit 0c78ada4020a743fcd5c8b299fd3b0cb05c8b8f1) --- docs/guides/onap-developer/use-cases/index.rst | 15 ------ docs/guides/onap-developer/use-cases/vfw.rst | 74 -------------------------- docs/use-cases/index.rst | 14 ----- docs/use-cases/vfw.rst | 74 -------------------------- 4 files changed, 177 deletions(-) delete mode 100644 docs/guides/onap-developer/use-cases/index.rst delete mode 100644 docs/guides/onap-developer/use-cases/vfw.rst delete mode 100644 docs/use-cases/index.rst delete mode 100644 docs/use-cases/vfw.rst (limited to 'docs') diff --git a/docs/guides/onap-developer/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst deleted file mode 100644 index d9dc0d202..000000000 --- a/docs/guides/onap-developer/use-cases/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. 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. - -Use Cases -========= - -Example uses case descriptions and sequence diagrams illustrating -interactions between platform components. - -.. toctree:: - :maxdepth: 1 - - vfw.rst - volte.rst diff --git a/docs/guides/onap-developer/use-cases/vfw.rst b/docs/guides/onap-developer/use-cases/vfw.rst deleted file mode 100644 index 2f83102a9..000000000 --- a/docs/guides/onap-developer/use-cases/vfw.rst +++ /dev/null @@ -1,74 +0,0 @@ -.. 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. - -vFirewall Use Case -================== - -Description ------------ - -Onboarding ----------- - - -.. uml:: - - @startuml - title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services - ONAP_User -> SDC : vFW_vDNS resource onboarding (HEAT) - note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\ - ONAP_User -> SDC : vFW_vDNS service onboarding - ONAP_User -> SDC : vFW_vDNS distribution - ||| - SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - @enduml - -Instantiation -------------- - -.. uml:: - - @startuml - title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services - participant ONAP_User - participant Robot - Participant SDC - Participant VID - Participant SO - ONAP_User -> AAI : populate cloud inventory - note left of AAI: manual via curl or POSTMAN - ||| - ONAP_User -> VID : vFW_vDNS deployment - VID -> SDC : Lookup VNF artifacts - VID -> AAI : Lookup cloud locations, subscriber - VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules) - SO -> AAI : inventory update - VID -> SO : vFW_vDNS VNF Instantiation\n(base modules) - note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice - SO -> AAI : inventory update - ONAP_User -> SDNC : VNF API Preload VNF/VF data - VID -> SO : vFW_vDNS VF Instantiation\n(base modules) - SO -> AAI : inventory update - SO -> SDNC : Generic VNF API\n(assign) - SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters - Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or - CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation - Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation - Hypervisor -> CloudAPI : complete - CloudAPI -> Multi_VIM : complete - Multi_VIM -> SO : complete - note right : SO may poll for completion - SO -> SDNC: Generic VNF API\n(activated) - note left : on failure from Openstack SO issues rollback to SDNC - SDNC -> AAI : L3 Network resource update - SO -> VID : complete - note right : VID will poll for completion - ONAP_User -> Robot : run Heat Bridge - Robot -> CloudAPI : retrieve cloud data - Robot -> AAI : Update with cloud data - ||| - @enduml - diff --git a/docs/use-cases/index.rst b/docs/use-cases/index.rst deleted file mode 100644 index cc076b1c5..000000000 --- a/docs/use-cases/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. 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. - -ONAP Use Cases -============== - -Example uses case descriptions and sequence diagrams illustrating -interactions between platform components. - -.. toctree:: - :maxdepth: 1 - - vfw.rst diff --git a/docs/use-cases/vfw.rst b/docs/use-cases/vfw.rst deleted file mode 100644 index beef17caa..000000000 --- a/docs/use-cases/vfw.rst +++ /dev/null @@ -1,74 +0,0 @@ -.. 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. - -.. _vfirewall_usecase: - -vFirewall -========= - -Description ------------ - -Onboarding ----------- - -.. uml:: - - @startuml - title vFW/vFWCL and vDNS VNF Onboarding (R1)\nVFW/vFWCL and vDNS use the same flows but they are separate VNFs/Services - ONAP_User -> SDC : vFW_vDNS resource onboarding (HEAT) - note right : vFWCL (vpg & vfw,vsn)\nvFW (vpg, vfw, vsn)\nvDNS (vpg, vlb,vdns) + DNSScaling (vdns)\ - ONAP_User -> SDC : vFW_vDNS service onboarding - ONAP_User -> SDC : vFW_vDNS distribution - ||| - SDC -> SO : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - SDC -> AAI : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - SDC -> SDNC : artifact distribution\nNOTIFY,DOWNLOAD,DEPLOY_OK - @enduml - -Instantiation -------------- - -.. uml:: - - @startuml - title vFW vDNS Instantiation (R1)\nvFW and vDNS use the same flows but they are separate VNFs/Services - participant ONAP_User - participant Robot - Participant SDC - Participant VID - Participant SO - ONAP_User -> AAI : populate cloud inventory - note left of AAI: manual via curl or POSTMAN - ||| - ONAP_User -> VID : vFW_vDNS deployment - VID -> SDC : Lookup VNF artifacts - VID -> AAI : Lookup cloud locations, subscriber - VID -> SO : vFW_vDNS Service \nInstantiation\n(base modules) - SO -> AAI : inventory update - VID -> SO : vFW_vDNS VNF Instantiation\n(base modules) - note left of AAI : VFWCL is two VNFs in one service\nso VNF instantiate occurs twice - SO -> AAI : inventory update - ONAP_User -> SDNC : VNF API Preload VNF/VF data - VID -> SO : vFW_vDNS VF Instantiation\n(base modules) - SO -> AAI : inventory update - SO -> SDNC : Generic VNF API\n(assign) - SO -> Multi_VIM : vFW_vDNS Heat template, \nENV file, preload parameters - Multi_VIM -> CloudAPI : vFW_vDNS Heat template,\nENV file, preload parameters or - CloudAPI -> Hypervisor : vFW_vDNS Infrastructure instantiation - Hypervisor -> vFW_vDNS : Nova/Neutron Instantiation - Hypervisor -> CloudAPI : complete - CloudAPI -> Multi_VIM : complete - Multi_VIM -> SO : complete - note right : SO may poll for completion - SO -> SDNC: Generic VNF API\n(activated) - note left : on failure from Openstack SO issues rollback to SDNC - SDNC -> AAI : L3 Network resource update - SO -> VID : complete - note right : VID will poll for completion - ONAP_User -> Robot : run Heat Bridge - Robot -> CloudAPI : retrieve cloud data - Robot -> AAI : Update with cloud data - ||| - @enduml -- cgit 1.2.3-korg From f4243bd9acd4bdf16c5d49a275abe238fedf3ce2 Mon Sep 17 00:00:00 2001 From: andreasgeissler Date: Wed, 25 Nov 2020 13:21:27 +0100 Subject: Update typos in Components List Issue-ID: DOC-672 Signed-off-by: andreasgeissler Change-Id: I3e5e9cdb0cb9cb586dd5a19ffccafd8f30cb8966 (cherry picked from commit 15f3917911bc6778758739301c4246e84de3ee5d) --- docs/guides/onap-developer/developing/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 2c250ec79..1e3c751da 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -85,7 +85,7 @@ AAI - Active and Available Inventory - External System Registry GUI Documentation * - (in Maintenance) `ESR Server (Latest) `_ - External System Registry Server Documentation - * - (in Maintenance) :ref:`Model` + * - (in Maintenance) :ref:`AAI UI` - Sparky - AAI Inventory UI Documentation >>>>>>> CHANGE (8787af Added links to older release docs for maintained components) @@ -370,7 +370,7 @@ SDNC - Software Defined Network Controller * - Document - Description - * - :ref:`SDCN` + * - :ref:`SDNC` - SDNC Architecture, APIs and Guides SDNR - Software Defined Network Controller for Radio @@ -382,7 +382,7 @@ SDNR - Software Defined Network Controller for Radio * - Document - Description - * - :ref:`SDNR` + * - :ref:`SDN-R` - SDN-R Documentation (part of CCSDK) SO - Service Orchestration -- cgit 1.2.3-korg From ba9b727fd04fbab8b321e885fcc5cec4187b99e3 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Wed, 25 Nov 2020 13:37:11 +0100 Subject: Correct intersphinx mapping for cert-service Add platform in the and the '-' between cert and service Issue-ID: OOM-2526 Signed-off-by: Eric Debeau Change-Id: Ic798e8a8a3486e469e1623602891e13a8440b1d6 (cherry picked from commit 9dde43681f0819be43aeab1f05c2360ea1282ebb) --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/conf.py b/docs/conf.py index 2d99a103a..c68057251 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,7 +45,7 @@ intersphinx_mapping['onap-vfc-nfvo-driver-vnfm-svnfm'] = ('{}/onap-vfc-nfvo-driv intersphinx_mapping['onap-holmes-rule-management'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-oom-certservice'] = ('{}/onap-oom-platform-cert-service/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-ccsdk-cds'] = ('{}/onap-ccsdk-cds/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-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None) -- cgit 1.2.3-korg From 0daaad0619c1a22dabce477461a918647f5c7462 Mon Sep 17 00:00:00 2001 From: andreasgeissler Date: Wed, 25 Nov 2020 13:58:11 +0100 Subject: Updated link to cert-service and corrected description for CLAMP in release Notes Issue-ID: DOC-672 Signed-off-by: andreasgeissler Change-Id: Iae1b2155a948a244930595c60539b1b6335575b4 (cherry picked from commit 79d76be5bc453e74ffa02b6a533efedae73a2ac9) --- docs/guides/onap-developer/developing/index.rst | 2 +- docs/release/releaserepos.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 2c250ec79..f34e2576a 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -310,7 +310,7 @@ OOM - ONAP Operations Manager - Description * - :ref:`OOM` - ONAP Operations Manager Documentation - * - :ref:`OOM Certification Service` + * - :ref:`OOM Certification Service` - ONAP CMPv2 certification support ORAN - Open-RAN Support in ONAP diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index dd7abc6c2..b573b1a7a 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -16,7 +16,7 @@ Project Specific Release Notes | :ref:`Project: VNF Requirements` | :ref:`AAI - Active and Available Inventory` | :ref:`CCSDK - Common Controller Software Development Kit` -| :ref:`CLAMP - Closed Loop Automation Platform` +| :ref:`CLAMP - Control Loop Automation Platform` | :ref:`CLI - Command Line Interface` | :ref:`DCAE - Data Collection Analysis and Events` | :ref:`DMAAP - Message Router (MR)` -- cgit 1.2.3-korg From 26fe0dff3c0375ada2102bd225e6c3b15a89868a Mon Sep 17 00:00:00 2001 From: ramagp Date: Mon, 31 Aug 2020 08:25:04 +0000 Subject: changes to be added in vfcreation Change-Id: I6471010c41d7481ef54a8cece0761831e49422c5 Issue-ID: DOC-662 Signed-off-by: ramagp (cherry picked from commit 14655f5557c2b72913a6d19de543b7f24b92ef77) --- docs/guides/onap-user/design/vfcreation/index.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst index 14928bbe7..0eacd40dd 100644 --- a/docs/guides/onap-user/design/vfcreation/index.rst +++ b/docs/guides/onap-user/design/vfcreation/index.rst @@ -35,7 +35,7 @@ Create a VF/PNF by VSP import **Steps** -#. From the SDC HOME page, click the *Import VSP* +#. From the SDC HOME page, hover over *Import*, then click on *IMPORT VSP* |image2| @@ -94,7 +94,7 @@ Create a VF/PNF manually **Steps** -#. From the SDC HOME page, click the *ADD VF* or *ADD PNF* +#. From the SDC HOME page, hover over *Add*, then click on *ADD VF* or *ADD PNF*. |image2| @@ -160,7 +160,7 @@ Update a VF/PNF [optional] **Steps** -#. From the SDC HOME page, click *CATALOG* and search for the VF/PNF. +#. From the SDC HOME page, click *CATALOG* and search for the VF/PNF, click on selected VF/PNF to update. #. In the General section, click *Check Out*. The *VSP* field is displays. @@ -173,7 +173,8 @@ Update a VF/PNF [optional] |image4| #. Click *Update VSP* - A progress bar displays.|image5| + A progress bar displays. + |image5| #. Click *Deployment Artifact* to edit, upload, or delete associated [Optional] deployment artifacts. @@ -206,7 +207,9 @@ Certify VF/PNF **Steps** #. When a VF/PNF is ready for certification, - click *CATALOG* and search for the checked-in VF/PNF. + On the SDC HOME page, click *CATALOG* and search for the checked-in VF/PNF. + Bottom half of the VN/PNF will say “In Design Check In”. + #. Click the VF/PNF and click *Certify*. |image7| -- cgit 1.2.3-korg From 72ba39bf0abe141822bf698828bd24fee490ebc1 Mon Sep 17 00:00:00 2001 From: ramagp Date: Tue, 27 Oct 2020 11:06:05 +0000 Subject: [DOC] Fix for example-packages path not found issue Change-Id: I40345147dd85324b728b7356e89ae70e28658673 Issue-ID: SDC-3278 Signed-off-by: ramagp (cherry picked from commit c95e6ed131e4505bb7f3671642a85d1fc9608286) --- docs/guides/onap-user/design/pre-onboarding/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index 063ba3c4e..b712958aa 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -114,4 +114,4 @@ No VF functionality testing is performed at this stage. .. _generate-manifest.py: https://git.onap.org/sdc/tree/openecomp-be/tools/scripts/generate-manifest.py -.. _example-packages: https://git.onap.org/sdc/tree/test-apis-ci/sdc-api-tests/chef-repo/cookbooks/sdc-api-tests/files/default/Files +.. _example-packages: https://git.onap.org/sdc/tree/integration-tests/src/test/resources/Files/VNFs -- cgit 1.2.3-korg From 76bd6c37f3d401a3cccba27b557e7d848511e346 Mon Sep 17 00:00:00 2001 From: ramagp Date: Sat, 29 Aug 2020 09:41:22 +0000 Subject: changes to be added in few steps Change-Id: I7398a9c58efef3052d022314db4a9b703a30385d Issue-ID: DOC-661 Signed-off-by: ramagp (cherry picked from commit 0e19d4ff1ac995a88a5a945c189e3c2169af225c) --- .../onap-user/design/resource-onboarding/index.rst | 45 ++++++++++++---------- 1 file changed, 24 insertions(+), 21 deletions(-) (limited to 'docs') diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 067d77a94..2c7020d7d 100644 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -39,14 +39,14 @@ Create a License Model [Optional] VSPs optionally require a license and entitlements to enable the service provider to track the usage. -Note: For interim saving while creating the license model and its components, -click |image2| +.. note:: + For interim saving while creating the license model and its components, click |image2| **Prerequisites:** To obtain license information, contact the service provider's Supply Chain Management (SCM) group. -#. From the SDC HOME page, click *ONBOARD*. +#. From the SDC HOME page, navigate to the ONBOARD Tab. |image11| @@ -56,7 +56,7 @@ provider's Supply Chain Management (SCM) group. #. Complete all fields. #. Click *Create*. -#. In the Overview Dialog. +#. After creation of the VLM, you should be presented with the “Overview” tab of the VLM. |image13| @@ -73,8 +73,7 @@ provider's Supply Chain Management (SCM) group. |image14| -#. Click *Submit* to add the license model to the catalog. -After filling a comment, press *Commit&Submit*. +#. Click *Submit* to add the license model to the catalog.After filling a comment, press *Commit&Submit*. |image15| @@ -91,7 +90,7 @@ otherwise the license key group is optional. **Prerequisites:** `Create a License Model`_ #. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + behind the *License Key Groups*. +#. In the Overview click the + inside the License Key Groups OR Navigate to License Key Groups and click on “+ ADD LICENSE KEY GROUP” |image4| @@ -106,7 +105,7 @@ license key groups (see `Create a License Key Group [Optional]`_). #. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + behind the *Entitlement Pools*. +#. In the Overview click the + sign inside the Entitlement Pools OR Navigate to Entitlement Pools and click on “+ ADD ENTITLEMENT POOL” |image5| @@ -123,17 +122,17 @@ Create a Feature Group * entitlement pools (see `Create an Entitlement Pool`_) #. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + behind the *Feature Groups*. +#. In the Overview click the + sign inside the Feature Groups OR Navigate to Feature Groups and click on “+ ADD FEATURE GROUP” |image6| #. On the General tab, complete all fields. -#. Click *Entitlement Pools*. -#. Click *Available Entitlement Pools*. -#. Select one or more entitlement pools and click the right arrow. -#. Click *License Key Groups*. -#. Click *Available License Key Groups*. -#. Select one or more license key groups and click the right arrow. +#. Navigate to the *Entitlement Pools*. Tab + * In the Available Entitlement Pools, select one or more entitlement pools and click on the “>” sign. + * Selected pools should now be seen under the Selected Entitlements Pools. +#. Navigate to the *License Key Groups*. Tab + * In the Available License Key Groups, select one or more license key groups and click on the “>” sign. + * Selected pools should now be seen under the Selected License Key Groups. #. Click *Save*. Create a License Agreement @@ -143,14 +142,15 @@ Create a License Agreement (see `Create a Feature Group`_). #. Select the License Model in the Onboard section of the SDC. -#. In the Overview click the + behind the *License Agreements*. +#. In the Overview click the + sign inside the License Agreements OR Navigate to License Agreements and click on “+ Add FEATURE GROUP” |image7| #. On the General tab, complete required fields. #. Click *Feature Groups*. -#. If not selected, click *Available Feature Groups*. -#. Select one or more groups and click the right arrow. +#. If not selected, click Available *Feature Groups*. + * Select one or more groups in the Available Feature Groups, select one or more feature groups and click on the “>” sign. + * Selected feature groups should now be seen under the Selected Feature Groups. #. Click *Save*. #. Return to step 6 of `Create a License Model`_ to complete the license model. @@ -174,6 +174,9 @@ for VFs/PNFs. of the onboarding package types. * If the package is a secure package then :ref:`pre-install the corresponding Root Certificate in SDC `. +.. note:: + Example packages can be found in the SDC project: `example-packages`_ + #. From the SDC HOME page, click *ONBOARD*. |image11| @@ -212,7 +215,7 @@ for VFs/PNFs. |image24| -#. Press the Button *Procees to Validation*. After successful validation, SDC +#. Press the Button *Proceed to Validation*. After successful validation, SDC displays the files and a success message. If validation fails, SDC displays the errors in the files. @@ -318,7 +321,7 @@ Upload a new onboarding package to a VSP. Afterward, update the VF/PNF and servi |image24| -#. Press the Button *Procees to Validation*. After successful validation, SDC +#. Press the Button *Proceed to Validation*. After successful validation, SDC displays the files and a success message. If validation fails, SDC displays the errors in the files. @@ -404,4 +407,4 @@ the *cert* block in the following values file:: .. |image25| image:: media/sdro-vsp-version.png -.. |image26| image:: media/sdro-vsp-version-dialog.png \ No newline at end of file +.. |image26| image:: media/sdro-vsp-version-dialog.png -- cgit 1.2.3-korg From 0a3327e669d853c2f1972bcf3f8a9db7606b4d99 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Thu, 26 Nov 2020 08:31:07 +0100 Subject: Added links to older release docs for maintained components Issue-ID: DOC-672 Signed-off-by: Eric Debeau Change-Id: Ibb1a62d57b5ff57c0b273a5baad31e7d294559a2 --- docs/guides/onap-developer/developing/index.rst | 50 ------------------------- 1 file changed, 50 deletions(-) (limited to 'docs') diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 93e8daed1..9500ec227 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -48,17 +48,8 @@ AAF - Application Authorization Framework * - Document - Description -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - * - :ref:`AAF` -======= * - (in Maintenance) `AAF (Frankfurt) `_ ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) - AAF Architecture, APIs and Guides -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - * - :ref:`Secret Management Service` - - Secret Management Service Architecture and API -======= ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) AAI - Active and Available Inventory ------------------------------------ @@ -71,23 +62,12 @@ AAI - Active and Available Inventory - Description * - :ref:`AAI` - AAI Architecture, APIs and Guides -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - * - :ref:`ESR` - - External System Registry GUI Documentation (to be removed ?) - * - :ref:`ESR` - - External System Registry Server Documentation (to be removed ?) - * - :ref:`AAI Inventory UI` - - Sparky - AAI Inventory UI Documentation (to be removed ?) - * - :ref:`AAI Event Client` - - AAI Event Client Documentation (to be removed ?) -======= * - (in Maintenance) `ESR GUI (Latest) `_ - External System Registry GUI Documentation * - (in Maintenance) `ESR Server (Latest) `_ - External System Registry Server Documentation * - (in Maintenance) :ref:`AAI UI` - Sparky - AAI Inventory UI Documentation ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) APPC - Application Controller ----------------------------- @@ -98,17 +78,9 @@ APPC - Application Controller * - Document - Description -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - * - :ref:`APPC` -======= * - (in Maintenance) `APPC (Frankfurt) `_ ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) - APPC Architecture, APIs and Guides -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - * - :ref:`APPC Deployment` -======= * - (in Maintenance) `APPC Deployment (Frankfurt) `_ ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) - APPC Deployment Documentation CCSDK - Common Controller Software Development Kit @@ -122,12 +94,6 @@ CCSDK - Common Controller Software Development Kit - Description * - :ref:`Distribution` - TOSCA Orchestration Plugin, Directed Graph Support - * - :ref:`Dashboard` - - Common Controller Dashboard (To be removed ?) - * - :ref:`Platform Plugins` - - Platform Plugins (To be removed ?) - * - :ref:`APPS` - - Apps optside ODL (To be removed ?) CDS - Controller Design Studio ------------------------------ @@ -230,13 +196,8 @@ LOGGING - Centralized Logging * - Document - Description -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - * - :ref:`Logging` - - ONAP Centralized Logging Documentation (to be deleted ?) -======= * - (in Maintenance) `LOGGING (Latest) `_ - ONAP Centralized Logging Documentation ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) MSB - Microservices Bus ----------------------- @@ -271,17 +232,10 @@ MUSIC - ONAP Multi-Site Integration * - Document - Description -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - * - :ref:`MUSIC` - - MUSIC Architecture and Guides (To be deleted ?) - * - :ref:`Distributed KV Store` - - MUSIC Distribute KV Store Documents (To be deleted ?) -======= * - (in Maintenance) `MUSIC (Frankfurt) `_ - MUSIC Architecture and Guides * - (in Maintenance) `MUSIC KV (Latest) `_ - MUSIC Distribute KV Store Documents ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) OOF - Optimization Framework ---------------------------- @@ -397,11 +351,7 @@ SO - Service Orchestration * - :ref:`SO` - Service Orchestration Architecture, APIs and Guides * - :ref:`SO Libraries` -<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) - - Service Orchestration Build (To be deleted ?) -======= - ONAP SO/libs Documentation ->>>>>>> CHANGE (8787af Added links to older release docs for maintained components) UUI - Use Case User Interface ----------------------------- -- cgit 1.2.3-korg