diff options
| author |   Eric Debeau <eric.debeau@orange.com> | 2020-11-30 15:32:31 +0100 |
|---|---|---|
| committer | Eric Debeau <eric.debeau@orange.com> | 2020-11-30 15:32:31 +0100 |
| commit | ab0c78bb275b345eb5e995a40a90e633980d7bca (patch) | |
| tree | d27e73c14d4fcb22ccaac37341dfd494630f2c8a | |
| parent | f60c4279e12ba862fee20afdbff4a2d586a458cc (diff) | |
Remove all warnings during Documentation buildings
Remove files with not links:
- guides/onap-developer/architecture/blueprint-enr.rst old file based on Beijing
- smsummary.rst: no more relevant as no more submodules used
- templates/sections/vnf-reference.rst : not referenced
- guides/onap-user/onapportal.rst: redundant
- guides/onap-developer/tutorials/index.rst: no tutorial
Add new files to inlude templates
Move templates directory under how-to-use-docs
Modify global release not label with onap_release_notes to avoid confusion
Issue-ID: DOC-692
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I709765beb02403c4ad058863c2b5136f42968cff
27 files changed, 42 insertions, 238 deletions
diff --git a/docs/guides/onap-developer/architecture/blueprint-enr.rst b/docs/guides/onap-developer/architecture/blueprint-enr.rst deleted file mode 100644 index a3018a195..000000000 --- a/docs/guides/onap-developer/architecture/blueprint-enr.rst +++ /dev/null @@ -1,100 +0,0 @@ -ONAP Blueprint Enrichment -------------------------- - -The ONAP Beijing release includes four functional enhancements in the -areas of manually triggered scaling, change management, and hardware -platform awareness (HPA). These features required significant community -collaboration as they impact multiple ONAP projects. These features are -applicable to any use case; however, to showcase them in a concrete -manner, they have been incorporated into VoLTE and vCPE blueprints. - -Manually Triggered Scaling -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Scale-out and scale-in are two primary benefits of NFV. Scaling can be -triggered manually (e.g., by a user or OSS/BSS) or automatically via a -policy-driven closed loop. An automatic trigger allows real-time action -without human intervention, reducing costs and improving customer -experience. A manual trigger, on the other hand, is useful to schedule -capacity in anticipation of events such as holiday shopping. An ideal -scaling operation can scale granularly at a virtual function level (VF), -automate VF configuration tasks and manage the load-balancer that may be -in front of the VF instances. In addition to run-time, this capability -also affects service design, as VNF descriptors need to be granular up -to the VF level. - -The Beijing release provides the initial support for these capabilities. -The community has implemented manually triggered scale-out and scale-in -in combination with a specific VNF manager (sVNFM) and demonstrated this -with the VoLTE blueprint. An operator uses the Usecase UI (UUI) project -to trigger a scaleing operation. UUI communicates with the Service -Orchestrator (SO). SO uses the VF-C controller, which in turn instructs -a vendor-provided sVNFM to implement the scale-out action. - -We have also demonstrated a manual process to Scale Out VNFs that use -the Virtual Infrastructure Deployment (VID), the Service Orchestrator -(SO) and the Application Controller (APPC) as a generic VNF Manager. -Currently, the process is for the operator to trigger the Scale Out -action using VID, which will request SO to spin up a new component of -the VNF. Then SO is building the ConfigScaleOut request and sending to -APPC over DMaaP, where APPC picks it up and executes the configuration -scale out action on the requested VNF. - -Change Management -~~~~~~~~~~~~~~~~~ - -NFV will bring with it an era of continuous, incremental changes instead -of periodic step-function software upgrades, in addition to a constant -stream of both PNF and VNF updates and configuration changes. To -automatically deliver these to existing network services, the ONAP -community is creating framework to implement change management -functionality that is independent of any particular network service or -use case. Ideally, change management provides a consistent interface and -mechanisms to manage complex dependencies, different upgrade mechanisms -(in-place vs. scale-out and replace), A/B testing, conflict checking, -pre- and post-change testing, change scheduling, rollbacks, and traffic -draining, redirection and load-balancing. These capabilities impact both -design-time and run-time environments. - -Over the next several releases, the community will enhance change -management capabilities in ONAP, culminating with a full CI/CD flow. -These capabilities can be applied to any use case; however, specifically -for the Beijing release, the vCPE blueprint has been enriched to execute -a predefined workflow to upgrade the virtual gateway VNF by using -Ansible. An operator invokes an upgrade operation through the VID -interface. VID drives SO, which initiates a sequence of steps such as -VNF lock, pre-check, software upgrade, post-check and unlock. Since -virtual gateway is an L3 VNF, the specific operations are carried out by -the SDN-C controller in terms of running the pre-check, post-check and -upgrade through Ansible playbooks. - -Hardware Platform Awareness (HPA) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Many VNFs have specific hardware requirements to achieve their -performance and security goals. These hardware requirements may range -from basic requirements such as number of cores, memory size, and -ephemeral disk size to advanced requirements such as CPU policy (e.g. -dedicate, shared), NUMA, hugepages (size and number), accelerated -vSwitch (e.g DPDK), crypto/compression acceleration, SRIOV-NIC, TPM, SGX -and so on. The Beijing release provides three HPA-related capabilities: - -1. Specification of the VNF hardware platform requirements as a set of - policies. - -2. Discovery of hardware and other platform features supported by cloud - regions. - -3. Selection of the right cloud region and NFV infrastructure flavor by - matching VNF HPA requirements with the discovered platform - capabilities. - -While this functionality is independent of any particular use case, in -the Beijing release, the vCPE use case has been enriched with HPA. An -operator can specify engineering rules for performance sensitive VNFs -through a set of policies. During run-time, SO relies on the ONAP -Optimization Framework (OOF) to enforce these policies via a -placement/scheduling decision. OOF determines the right compute node -flavors for the VNF by querying the above-defined policies. Once a -homing decision is conveyed to SO, SO executes the appropriate workflow -via the appropriate controller. diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst index 799574dbb..2e7e47acf 100644 --- a/docs/guides/onap-developer/how-to-use-docs/index.rst +++ b/docs/guides/onap-developer/how-to-use-docs/index.rst @@ -12,6 +12,7 @@ Creating Documentation setting-up-environment style-guide api-swagger-guide + templates converting-to-rst addendum diff --git a/docs/guides/onap-developer/how-to-use-docs/templates.rst b/docs/guides/onap-developer/how-to-use-docs/templates.rst new file mode 100644 index 000000000..73b60666b --- /dev/null +++ b/docs/guides/onap-developer/how-to-use-docs/templates.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2020 ONAP community + +Templates +========= + +This section provides templates for the projects + +Sections +-------- + +.. toctree:: + :maxdepth: 1 + + templates/collections/platform-component.rst + templates/collections/sdk.rst + +Release notes +------------- +.. toctree:: + :maxdepth: 1 + + templates/sections/release-notes.rst diff --git a/docs/templates/collections/platform-component.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst index 98119aca5..3cde22948 100644 --- a/docs/templates/collections/platform-component.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst @@ -14,6 +14,7 @@ Platform Component ../sections/offeredapis.rst ../sections/consumedapis.rst ../sections/delivery.rst + ../sections/design.rst ../sections/logging.rst ../sections/installation.rst ../sections/configuration.rst diff --git a/docs/templates/collections/sdk.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst index 83fbbe2ee..83fbbe2ee 100644 --- a/docs/templates/collections/sdk.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst diff --git a/docs/templates/sections/administration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst index 94a740718..94a740718 100644 --- a/docs/templates/sections/administration.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst diff --git a/docs/templates/sections/architecture.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst index 8daa0d3bc..8daa0d3bc 100644 --- a/docs/templates/sections/architecture.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst diff --git a/docs/templates/sections/build.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst index 99a061c24..99a061c24 100644 --- a/docs/templates/sections/build.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst diff --git a/docs/templates/sections/configuration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst index 085f9c667..085f9c667 100644 --- a/docs/templates/sections/configuration.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst diff --git a/docs/templates/sections/consumedapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst index c2af4c20e..c2af4c20e 100644 --- a/docs/templates/sections/consumedapis.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst diff --git a/docs/templates/sections/delivery.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst index f3f083a73..f3f083a73 100644 --- a/docs/templates/sections/delivery.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst diff --git a/docs/templates/sections/design.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst index f173a2fb5..f173a2fb5 100644 --- a/docs/templates/sections/design.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst diff --git a/docs/templates/sections/humaninterfaces.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst index 429284608..429284608 100644 --- a/docs/templates/sections/humaninterfaces.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst diff --git a/docs/templates/sections/installation.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst index be64a63bb..be64a63bb 100644 --- a/docs/templates/sections/installation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst diff --git a/docs/templates/sections/logging.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst index 39eabfba7..39eabfba7 100644 --- a/docs/templates/sections/logging.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst diff --git a/docs/templates/sections/offeredapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst index 23504c1da..23504c1da 100644 --- a/docs/templates/sections/offeredapis.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst diff --git a/docs/templates/sections/release-notes.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst index 11f38fed9..11f38fed9 100644 --- a/docs/templates/sections/release-notes.rst +++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst deleted file mode 100644 index a181644bc..000000000 --- a/docs/guides/onap-developer/tutorials/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. - -Tutorials -========= - -.. note:: - This is an empty document as placeholder for future tutorials. - - diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst index aa38a79c8..2a629999e 100644 --- a/docs/guides/onap-user/design/index.rst +++ b/docs/guides/onap-user/design/index.rst @@ -91,35 +91,27 @@ Onboarding, Design and Distribution process. not yet integrated with the SDC Design Catalog to exchange models and artefacts. -The follwing sections will focus on the different Design steps: +The following sections focus on the different Design steps: .. toctree:: :maxdepth: 1 :titlesonly: Pre-Onboarding <./pre-onboarding/index.rst> - Resource-Onboarding <./resource-onboarding/index.rst> - VF Creation and Testing <./vfcreation/index.rst> - Service Design <./service-design/index.rst> - Service Distribution <./service-distribution/index.rst> - VNF parameter resolution Design <./parameter_resolution/index.rst> + Control Loop Design <./control-loop/index.rst> -:ref:`Policy Design<onap-policy-parent:design-label>` - -:ref:`VNF LifeCycle Command templating<onap-appc:master_index>` - -:ref:`Workflow Design<onap-sdc:workflow>` - -:ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>` - -:ref:`Control Loop Automation Management<onap-clamp:master_index>` - +The following section provide links to the projects: +- :ref:`Policy Design<onap-policy-parent:design-label>` +- :ref:`VNF LifeCycle Command templating<onap-appc:master_index>` +- :ref:`Workflow Design<onap-sdc:workflow>` +- :ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>` +- :ref:`Control Loop Automation Management<onap-clamp:master_index>` .. |image1| image:: media/Design-Overview.png diff --git a/docs/guides/onap-user/instantiate/index.rst b/docs/guides/onap-user/instantiate/index.rst index fb14e698e..d9bc3c7fb 100644 --- a/docs/guides/onap-user/instantiate/index.rst +++ b/docs/guides/onap-user/instantiate/index.rst @@ -16,3 +16,5 @@ Instantiation includes the following topics: Pre-instantiation operations <./pre_instantiation/index.rst> Instantiation operation(s) <./instantiation/index.rst> + + Instantiation via Use-Case UI portal <./instantiation/uui/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/index.rst b/docs/guides/onap-user/instantiate/instantiation/index.rst index 0d2981b4d..9bfb6b6b3 100644 --- a/docs/guides/onap-user/instantiate/instantiation/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/index.rst @@ -2,7 +2,6 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. - Declare PNF instances: .. toctree:: @@ -17,7 +16,6 @@ Instantiate a Service Instantiate a Service <./service_instance/index.rst> - Instantiate a VNF: .. toctree:: @@ -25,14 +23,6 @@ Instantiate a VNF: Instantiate a VNF <./vnf_instance/index.rst> -Configure a VNF: - -.. toctree:: - :maxdepth: 1 - - Configure a VNF <./vnf_configure/index.rst> - - Instantiate a Virtual Link: .. toctree:: diff --git a/docs/guides/onap-user/onapportal.rst b/docs/guides/onap-user/onapportal.rst deleted file mode 100644 index 205798ec3..000000000 --- a/docs/guides/onap-user/onapportal.rst +++ /dev/null @@ -1,58 +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 Portal -=========== -The ONAP Portal integrates different ONAP applications in one place. -The Portal platform provides common management services and -connectivity, while the applications run separately. - -From the Portal, users access applications. Administrators -onboard and manage applications and widgets, and manage user access. - -The Portal SDK for application developers includes bundled tools, -technologies, and built-in capabilities such as services, APIs, -and UI controls. Existing applications can migrate to the Portal -with the provided APIs and libraries. -See Portal SDK_. - -:ref:`docs tutorials portal-sdk <onap-portal:master_index>` - -Access the ONAP Portal ----------------------- - -Access the ONAP Portal using a browser such as Mozilla Firefox or -Google Chrome. The URL is dependent on a specific ONAP platform -deployment. - -From the Portal, users access applications directly or by -function using the Manage menu. - -.. figure:: onap-portal-home.png - :width: 900 px - :height: 600 px - - -Roles in the ONAP Portal ------------------------- -The Portal displays different menus for the following roles: - -* User - -* Portal Administrator - -* Application Administrator - -* Governor - -* Operator - -Each application also defines a distinct set of user roles. -See Users. - -See also --------- - -* `Applications in the Portal <https://wiki.onap.org/x/h4sP>`_ diff --git a/docs/guides/overview/overview.rst b/docs/guides/overview/overview.rst index 12f536953..2567ec4be 100644 --- a/docs/guides/overview/overview.rst +++ b/docs/guides/overview/overview.rst @@ -127,8 +127,7 @@ These service design activities are built up of the following subtasks: the example of onboarding and instantiating a virtual network function (VNF), the virtual Firewall (vFirewall). Following the guidelines and steps of this example, any other VNF can be similarly onboarded - and instantiated to ONAP. See :ref:`virtual Firewall Onboarding and - Instantiating <vfirewall_usecase>` examples. + and instantiated to ONAP. e. Controllers applying configuration on VNFs @@ -164,7 +163,9 @@ is named after a city. +----------------------+----------------+----------------------+-----------------------------------------------------------+ |Release Name |Release version |Release Date |Features delivered | +======================+================+======================+===========================================================+ -|Frankfurt |6.0.0 | 11 June 2020 | :ref:`Frankfurt Release Notes<release-notes>` | +|Guilin |7.0.0 | 3 Deember 2020 | | ++----------------------+----------------+----------------------+-----------------------------------------------------------+ +|Frankfurt |6.0.0 | 11 June 2020 | | +----------------------+----------------+----------------------+-----------------------------------------------------------+ |El Alto |5.0.1 | 24 October 2019 | | +----------------------+----------------+----------------------+-----------------------------------------------------------+ diff --git a/docs/index.rst b/docs/index.rst index 060522713..e1f7e24f8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,7 +24,7 @@ Please find some guidance here on the content of ONAP documentation: +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | Main documentation areas | Description | +=================================================================================+===============================================================================================+ - | :ref:`Release Notes <release-notes>` | The Release Notes besides providing the basic information on the main release, also | + | :ref:`Release Notes <onap-release-notes>` | The Release Notes besides providing the basic information on the main release, also | | | presents link to the release information of each, specific ONAP component. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main | diff --git a/docs/release/index.rst b/docs/release/index.rst index 124c28868..9f9a5dcb3 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -2,7 +2,7 @@ International License. http://creativecommons.org/licenses/by/4.0 -.. _release-notes: +.. _onap-release-notes: Guilin Release Notes ^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/smsummary.rst b/docs/smsummary.rst deleted file mode 100644 index 13e0e4563..000000000 --- a/docs/smsummary.rst +++ /dev/null @@ -1,10 +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. - -Contributing Submodule Summary -============================== - -.. code-block:: console - -.. literalinclude:: _static/smsummary.out diff --git a/docs/templates/sections/vnf-reference.rst b/docs/templates/sections/vnf-reference.rst deleted file mode 100644 index 165eee530..000000000 --- a/docs/templates/sections/vnf-reference.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -VNF -=== - -.. note:: - * This section is used to describe Virtual Network Function software - - * This section is typically provided: as additional detail on use cases, - to illustrate end to end platform architecture, and to describe - compliance with ONAP VNF requirements. - - * The VNF Heading above should be replaced with the VNF NAME - - * This note must be removed after content has been added. - -Version -------- - -User Documentation ------------------- - -Source ------- - -ONAP VNF Requirements Compliance --------------------------------- - |