From 259bf4d16dd04ce6ad4537ed1616be6397215523 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Thu, 14 Jun 2018 00:15:29 -0400 Subject: Correct references and add release notes Correct gerrit URL, architecture, and API refrences Position Use Case Diagrams in Developer Section Change-Id: I149aad66844e343697771a7a3e4db14ff3a3daea Issue-ID: DOC-278 Signed-off-by: Rich Bennett --- docs/guides/onap-developer/apiref/index.rst | 2 +- .../onap-developer/architecture/references.rst | 2 +- docs/guides/onap-developer/developing/index.rst | 3 +- docs/guides/onap-developer/index.rst | 5 +- .../onap-developer/settingup/onap_individual.rst | 9 ++- docs/guides/onap-developer/use-cases/index.rst | 15 +++++ docs/guides/onap-developer/use-cases/vfw.rst | 74 ++++++++++++++++++++++ docs/guides/onap-user/index.rst | 4 +- docs/guides/onap-user/vnfcertifier.rst | 2 +- docs/index.rst | 7 +- docs/release-notes.rst | 16 ++++- docs/use-cases/index.rst | 14 ---- docs/use-cases/vfw.rst | 74 ---------------------- 13 files changed, 122 insertions(+), 105 deletions(-) create mode 100644 docs/guides/onap-developer/use-cases/index.rst create 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 diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 53b075b8f..f1a1171fd 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -47,7 +47,7 @@ Common Services :titlesonly: AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst> - AAI ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst> + AAI ESR <../../../submodules/aai/esr-server.git/docs/offeredapis.rst> DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst> ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst> Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst> diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index beaed5cde..520f8f988 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -31,7 +31,7 @@ User Interfaces APPC CDT - Application Controller Design Tool <../../../submodules/appc.git/docs/APPC CDT Guide/APPC CDT Guide.rst> CLAMP - Closed Loop Automation Platform <../../../submodules/clamp.git/docs/architecture.rst> CLI - Command Line Interface <../../../submodules/cli.git/docs/architecture.rst> - PORTAL + PORTAL <../../../submodules/portal.git/docs/platform/architecture.rst> SDC - Service Design and Creation <../../../submodules/sdc.git/docs/architecture.rst> UUI- Usecase UI <../../../submodules/usecase-ui.git/docs/platform/architecture.rst> VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/architecture.rst> diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index a7877d449..a34afa908 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -139,8 +139,9 @@ Integration * ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest`. + * To install the whole ONAP (from a complete demo solution perspective) - refer to :ref:`Setting Up ONAP `. + refer to :ref:`Setting Up ONAP `. Logging Analytics ----------------- diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst index 8ef2c0a10..8ed4eaee6 100644 --- a/docs/guides/onap-developer/index.rst +++ b/docs/guides/onap-developer/index.rst @@ -4,8 +4,8 @@ .. _onap_developer_guides: -ONAP Developer Guides -===================== +Developer Guides +================ The following guides are provided for developers who want to understanding or contribute to the ONAP open source. @@ -18,4 +18,5 @@ understanding or contribute to the ONAP open source. developing/index how-to-use-docs/index apiref/index + use-cases/index diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst index faac85ad7..8bd92d8a9 100644 --- a/docs/guides/onap-developer/settingup/onap_individual.rst +++ b/docs/guides/onap-developer/settingup/onap_individual.rst @@ -23,8 +23,13 @@ developers who desire to focus their attention on a few components and who have a deep understanding of dependencies between components. This type of installation is not recommended to fully install ONAP. -* The list of ports used by default within ONAP is documented in `ONAP Service List `_. -* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/. +* The list of ports used by default within ONAP is documented + in `ONAP Service List `_. + +* The ONAP Source Code is available through Gerrit + at https://gerrit.onap.org/r/#/admin/projects or Git at https://git.onap.org/. + * ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap. + * ONAP Docker releases are specified by a list of project artifact versions in a :ref:`manifest`. diff --git a/docs/guides/onap-developer/use-cases/index.rst b/docs/guides/onap-developer/use-cases/index.rst new file mode 100644 index 000000000..d9dc0d202 --- /dev/null +++ b/docs/guides/onap-developer/use-cases/index.rst @@ -0,0 +1,15 @@ +.. 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 new file mode 100644 index 000000000..2f83102a9 --- /dev/null +++ b/docs/guides/onap-developer/use-cases/vfw.rst @@ -0,0 +1,74 @@ +.. 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/guides/onap-user/index.rst b/docs/guides/onap-user/index.rst index 189d34fd3..24cfcf134 100644 --- a/docs/guides/onap-user/index.rst +++ b/docs/guides/onap-user/index.rst @@ -4,8 +4,8 @@ -ONAP User Guides -================ +User Guides +=========== The following guides are provided to describe tasks that a user of ONAP may need to perform when integrating, deploying, and operating an instance of ONAP. diff --git a/docs/guides/onap-user/vnfcertifier.rst b/docs/guides/onap-user/vnfcertifier.rst index 76a96be4f..4387d0c0c 100644 --- a/docs/guides/onap-user/vnfcertifier.rst +++ b/docs/guides/onap-user/vnfcertifier.rst @@ -4,6 +4,6 @@ VNF Certifier ============== .. toctree:: - :maxdepth:2 + :maxdepth: 2 ../../../submodules/vvp/documentation.git/docs/index.rst diff --git a/docs/index.rst b/docs/index.rst index fbcb897a9..a882caf4c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,6 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. 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. .. _master_index: @@ -11,9 +13,6 @@ ONAP Documentation release/index guides/onap-developer/index guides/onap-user/index - use-cases/index - - Index and Search ================ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index fbc9e7f3f..8b9cc2c9a 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,4 +1,3 @@ - .. 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. @@ -11,14 +10,25 @@ Release Notes Version: 2.0.0 -------------- -:Release Date: 2018-07-06 +:Release Date: 2018-06-07 **New Features** +* Created a beijing branch referencing all repos providing documentation + for the beijing release. -**Other** +* Added tox environments and documentation for linkcheck and spellcheck buiders. + +* Verify jobs now include the html build in the archived log to make it + easier to review changes prior to merge. +* Provided guidelines for document "code reviews" and + end of release work with multiple branches. + +* Added a template for a Virtual Netework Function + +**Other** Version: 1.0.0 -------------- 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 7c230ca0d..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 -========= - -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