diff options
| author |   mrichomme <morgan.richomme@orange.com> | 2020-11-30 18:31:29 +0100 |
|---|---|---|
| committer | mrichomme <morgan.richomme@orange.com> | 2020-12-01 10:43:23 +0100 |
| commit | e4643890441531c9009faa5759cedfa13ba7a6f7 (patch) | |
| tree | 7f0776fc7cc10090a1258569ec1d901de1027f6b /docs | |
| parent | 0fcaa851a655c4650af84ee73987139672395184 (diff) | |
Remove doc warning
- delete old csv
- delete unused orphan page
- adapt rst
Issue-ID: INT-1776
Signed-off-by: mrichomme <morgan.richomme@orange.com>
Change-Id: I7856e4f10637000e2085825a8cf8703e98a454d3
Diffstat (limited to 'docs')
41 files changed, 206 insertions, 372 deletions
diff --git a/docs/docs_5G_Bulk_PM.rst b/docs/docs_5G_Bulk_PM.rst index eebb4ecd3..7bdc06324 100644 --- a/docs/docs_5G_Bulk_PM.rst +++ b/docs/docs_5G_Bulk_PM.rst @@ -3,6 +3,8 @@ .. _docs_5g_bulk_pm: +:orphan: + 5G Bulk PM ---------- diff --git a/docs/docs_5G_Configuration_over_NETCONF.rst b/docs/docs_5G_Configuration_over_NETCONF.rst index 10bf740e4..4b737d04f 100644 --- a/docs/docs_5G_Configuration_over_NETCONF.rst +++ b/docs/docs_5G_Configuration_over_NETCONF.rst @@ -3,6 +3,8 @@ .. _docs_5G_Configuration_over_NETCONF: +:orphan: + 5G - Configuration over NETCONF ------------------------------- diff --git a/docs/docs_5G_NRM_Configuration.rst b/docs/docs_5G_NRM_Configuration.rst index ee76d1c3e..a57664832 100644 --- a/docs/docs_5G_NRM_Configuration.rst +++ b/docs/docs_5G_NRM_Configuration.rst @@ -3,6 +3,8 @@ .. _docs_5G_NRM_Configuration: +:orphan: + 5G NRM (Network Resource Model) Configuration --------------------------------------------- @@ -38,4 +40,3 @@ Test Status and Plans To see information on the status of the test cases, please follow the link below: `5G NRM Configuration Test Status <https://wiki.onap.org/display/DW/5G+Network+Resource+Model+%28NRM%29+Configuration+in+R6+Frankfurt#id-5GNetworkResourceModel(NRM)ConfigurationinR6Frankfurt-TestStatus>`_ - diff --git a/docs/docs_5G_PNF_Software_Upgrade.rst b/docs/docs_5G_PNF_Software_Upgrade.rst index cec02f9fd..a4d435b69 100644 --- a/docs/docs_5G_PNF_Software_Upgrade.rst +++ b/docs/docs_5G_PNF_Software_Upgrade.rst @@ -3,6 +3,7 @@ .. _docs_5g_pnf_software_upgrade: +:orphan: 5G PNF Software Upgrade ----------------------- diff --git a/docs/docs_5G_PNF_Software_Upgrade_With_Schema_Update.rst b/docs/docs_5G_PNF_Software_Upgrade_With_Schema_Update.rst index 840ff1a4f..a95dec772 100644 --- a/docs/docs_5G_PNF_Software_Upgrade_With_Schema_Update.rst +++ b/docs/docs_5G_PNF_Software_Upgrade_With_Schema_Update.rst @@ -3,6 +3,7 @@ .. _docs_5g_pnf_software_upgrade_with_schema_update: +:orphan: Support xNF Software Upgrade in association to schema updates ------------------------------------------------------------- @@ -50,7 +51,9 @@ Function limitations in Release G * When operator updating a service template, the updated service template must be upgradable from any previous versions: - Within the service template, the resource instance name and network topology are unchanged. - The new resource template of a given resource instance (within the service template) must be upgradeable from any previous resource template versions. -Note: This is to avoid adding possible upgrade paths info and upgrade sequence info into SDC model + +.. note:: + This is to avoid adding possible upgrade paths info and upgrade sequence info into SDC model Update a xNF resource template from a new onboarding package ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/docs_5G_PNF_Software_Upgrade_ansible_with_EM.rst b/docs/docs_5G_PNF_Software_Upgrade_ansible_with_EM.rst index 1482cb5d6..6426446eb 100644 --- a/docs/docs_5G_PNF_Software_Upgrade_ansible_with_EM.rst +++ b/docs/docs_5G_PNF_Software_Upgrade_ansible_with_EM.rst @@ -3,6 +3,8 @@ .. _docs_5g_pnf_software_upgrade_ansible_with_EM: +:orphan: + PNF Software Upgrade Scenario: Using Ansible protocol with EM ------------------------------------------------------------- diff --git a/docs/docs_5G_PNF_Software_Upgrade_direct_netconf_yang.rst b/docs/docs_5G_PNF_Software_Upgrade_direct_netconf_yang.rst index f2d4db1a4..24098cdc4 100644 --- a/docs/docs_5G_PNF_Software_Upgrade_direct_netconf_yang.rst +++ b/docs/docs_5G_PNF_Software_Upgrade_direct_netconf_yang.rst @@ -3,11 +3,13 @@ .. _docs_5g_pnf_software_upgrade_direct_netconf_yang: -=========================================================================== +:orphan: + PNF Software Upgrade Scenario: Using Direct Netconf/Yang interface with PNF =========================================================================== + Software Upgrade Procedure ------------------------------------- +--------------------------- With this scenario, the pre-conditions are: @@ -28,9 +30,8 @@ c. Repeat above two steps for each SO building blocks. Test Status and Plans ------------------------------------- +--------------------- To see information on the status of the test cases please follow the link below: `PNF Software Upgrade Test Status <https://wiki.onap.org/display/DW/PNF+software+upgrade+in+R6+Frankfurt#PNFsoftwareupgradeinR6Frankfurt-TestStatus>`_ - diff --git a/docs/docs_5G_PNF_Software_Upgrade_netconf_with_EM.rst b/docs/docs_5G_PNF_Software_Upgrade_netconf_with_EM.rst index a42113c70..75eb244e1 100644 --- a/docs/docs_5G_PNF_Software_Upgrade_netconf_with_EM.rst +++ b/docs/docs_5G_PNF_Software_Upgrade_netconf_with_EM.rst @@ -3,6 +3,8 @@ .. _docs_5g_pnf_software_upgrade_netconf_with_EM: +:orphan: + PNF Software Upgrade Scenario: Using Netconf/Yang interface with EM ------------------------------------------------------------------- diff --git a/docs/docs_5G_oof_pci.rst b/docs/docs_5G_oof_pci.rst index c89d20e1c..bd71d7f41 100644 --- a/docs/docs_5G_oof_pci.rst +++ b/docs/docs_5G_oof_pci.rst @@ -3,6 +3,8 @@ .. _docs_5G_oof_pci: +:orphan: + OOF-PCI -------- diff --git a/docs/docs_5g_a1_adaptor.rst b/docs/docs_5g_a1_adaptor.rst index 18e165e65..44bbc330b 100644 --- a/docs/docs_5g_a1_adaptor.rst +++ b/docs/docs_5g_a1_adaptor.rst @@ -3,6 +3,8 @@ .. _docs_5g_a1_adaptor: +:orphan: + 5G - A1 Adaptor --------------- diff --git a/docs/docs_5g_pnf_pnp.rst b/docs/docs_5g_pnf_pnp.rst index c2fcc8548..ba1e33ac3 100644 --- a/docs/docs_5g_pnf_pnp.rst +++ b/docs/docs_5g_pnf_pnp.rst @@ -3,6 +3,8 @@ .. _docs_5g_pnf_pnp: +:orphan: + 5G - PNF Plug and Play ---------------------- diff --git a/docs/docs_5g_rtpm.rst b/docs/docs_5g_rtpm.rst index 5ecab4b19..45f1103f2 100644 --- a/docs/docs_5g_rtpm.rst +++ b/docs/docs_5g_rtpm.rst @@ -3,6 +3,8 @@ .. _docs_realtime_pm: +:orphan: + 5G - Real Time PM and High Stream Data Collection ------------------------------------------------- diff --git a/docs/docs_BBS.rst b/docs/docs_BBS.rst index 38c43084a..1047ae3d7 100644 --- a/docs/docs_BBS.rst +++ b/docs/docs_BBS.rst @@ -1,5 +1,7 @@ .. _docs_bbs: +:orphan: + BBS (Broadband Service) ----------------------- @@ -166,7 +168,7 @@ Create the required topics in DMaaP DCAE: BBS Event Processor (BBS-ep) ================================== -Description: :doc:`BBS-ep <https://docs.onap.org/projects/onap-dcaegen2/en/frankfurt/sections/services/bbs-event-processor/index.html?highlight=BBS>` +Description: `BBS-ep <https://docs.onap.org/projects/onap-dcaegen2/en/frankfurt/sections/services/bbs-event-processor/index.html?highlight=BBS>`_ The following BBS event processor blueprint will be used: @@ -191,7 +193,7 @@ IMPORTANT: Make sure that the configuration of BBS-ep in Consul contains the fol DCAE: RESTCONF Collector ======================== -Description: :doc:`RESTCONF Collector <https://docs.onap.org/projects/onap-dcaegen2/en/frankfurt/sections/services/restconf/index.html>` +Description: `RESTCONF Collector <https://docs.onap.org/projects/onap-dcaegen2/en/frankfurt/sections/services/restconf/index.html>`_ The following RESTCONF collector blueprint will be used: @@ -209,7 +211,7 @@ RESTCONF Collector deployment procedure: DCAE: VES mapper ================ -Description: :doc:`VES Mapper <https://docs.onap.org/projects/onap-dcaegen2/en/frankfurt/sections/services/mapper/index.html>` +Description: `VES Mapper <https://docs.onap.org/projects/onap-dcaegen2/en/frankfurt/sections/services/mapper/index.html>`_ The following VES mapper blueprint will be used: diff --git a/docs/docs_CCVPN.rst b/docs/docs_CCVPN.rst index e304808ce..c1bb8e07d 100644 --- a/docs/docs_CCVPN.rst +++ b/docs/docs_CCVPN.rst @@ -3,6 +3,8 @@ .. _docs_ccvpn: +:orphan: + CCVPN (Cross Domain and Cross Layer VPN) ---------------------------------------- @@ -24,7 +26,8 @@ MDONS Extension implementation for the Frankfurt release will incorporate the fo - Support Asynchronous OpenRoadM OTN service activation notification handling - Add OOF support for inter domain link/path selection - Support Closed Loop sub-use case -Impacted ONAP modules include: OOF, SDN-C, SO and Holmes + +Impacted ONAP modules include: OOF, SDN-C, SO and Holmes. `Wiki link reference <https://wiki.onap.org/display/DW/MDONS+Extension+in+R7>`_ @@ -112,9 +115,6 @@ Functional Test Cases Usecase specific developments have been realized in SO, OOF, AAI, SDNC and UUI ONAP components.. -See the `wiki <https://wiki.onap.org/display/DW/E-LINE+over+OTN+Inter+Domain+Test+Cases>`_ -for details. - Testing Procedure ~~~~~~~~~~~~~~~~~ Design time @@ -124,7 +124,7 @@ Run Time: All operation will be triggered by UUI, including service creation and termination, link management and topology network display: -- `E-LINE over OTN Inter Doamin Test Cases <https://wiki.onap.org/display/DW/E-LINE+over+OTN+Inter+Domain+Test+Cases>`_ +- `E-LINE over OTN Inter Domain Test Cases <https://wiki.onap.org/display/DW/E-LINE+over+OTN+Inter+Domain+Test+Cases>`_ - `Testing status <https://wiki.onap.org/display/DW/2%3A+Frankfurt+Release+Integration+Testing+Status>`_ MDONS (Multi-Domain Optical Network Services) @@ -179,11 +179,14 @@ Update for Dublin release 1. Service model optimization In Dublin release,the design of CCVPN was optimized by having support of List type of Input in SDC. -During onboarding and design phase, one end to end service is created using SDC. This service is -composed of these two kinds of resources: - • VPN resource - • Site resource - See the `wiki <https://wiki.onap.org/display/DW/Details+of+Targeted+Service+Template>`_ for details. +During onboarding and design phase, one end to end service is created using SDC. +This service is composed of these two kinds of resources: + +- VPN resource +- Site resource + +See the `Details of Targeted Service Template wiki page <https://wiki.onap.org/display/DW/Details+of+Targeted+Service+Template>`_ +for details. 2. Closed Loop in bandwidth adjustment Simulate alarm at the edge site branch and ONAP will execute close-loop automatically and trigger bandwidth to change higher. @@ -195,7 +198,7 @@ More information about: - `CCVPN in Dublin release <https://wiki.onap.org/pages/viewpage.action?pageId=45296665>`_ - `Dublin test cases <https://wiki.onap.org/display/DW/CCVPN+Test+Cases+for+Dublin+Release>`_ -- `test status <https://wiki.onap.org/display/DW/CCVPN+Test+Status>`_ +- `CCVPN Test Status wiki page <https://wiki.onap.org/display/DW/CCVPN+Test+Status>`_ .. note:: CCVPN integration testing coversed service design, service creation and @@ -242,7 +245,8 @@ Run Time: link management and topology network display. -See the `wiki <https://wiki.onap.org/display/DW/CCVPN+Test+Guide>`_ for details. +See the `CCVPN Test Guide wiki page <https://wiki.onap.org/display/DW/CCVPN+Test+Guide>`_ +for details. Test Status and Plans ~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/docs_CM_flexible_designer_orchestrator.rst b/docs/docs_CM_flexible_designer_orchestrator.rst index 0cfd703b7..c919ec6f8 100644 --- a/docs/docs_CM_flexible_designer_orchestrator.rst +++ b/docs/docs_CM_flexible_designer_orchestrator.rst @@ -3,8 +3,10 @@ .. _docs_CM_flexible_designer_orchestrator: +:orphan: + Dublin Workflow Designer Release Notes -------------------------------------------------------------- +-------------------------------------- The Workflow Editor was developed in the Beijing release by Amdocs and is available in SDC for users to create workflows. diff --git a/docs/docs_CM_schedule_optimizer.rst b/docs/docs_CM_schedule_optimizer.rst index 28946b54d..2ff8cfca1 100644 --- a/docs/docs_CM_schedule_optimizer.rst +++ b/docs/docs_CM_schedule_optimizer.rst @@ -3,13 +3,20 @@ .. _docs_CM_schedule_optimizer: +:orphan: + Change Management Schedule Optimization -------------------------------------------------------------- +--------------------------------------- Description ~~~~~~~~~~~~~~ -The change management schedule optimizer automatically identifies a conflict-free schedule for executing changes across multiple network function instances. It takes into account constraints such as concurrency limits (how many instances can be executed simultaneously), time preferences (e.g., night time maintenance windows with low traffic volumes) and applies optimization techniques to generate schedules. +The change management schedule optimizer automatically identifies a conflict-free +schedule for executing changes across multiple network function instances. +It takes into account constraints such as concurrency limits (how many instances +can be executed simultaneously), time preferences (e.g., night time maintenance +windows with low traffic volumes) and applies optimization techniques to +generate schedules. More details can be found here: https://docs.onap.org/projects/onap-optf-cmso/en/latest/index.html#master-index diff --git a/docs/docs_E2E_network_slicing.rst b/docs/docs_E2E_network_slicing.rst index 2e2c8162b..648dfd2e3 100644 --- a/docs/docs_E2E_network_slicing.rst +++ b/docs/docs_E2E_network_slicing.rst @@ -3,6 +3,7 @@ .. _docs_E2E_network_slicing: +:orphan: E2E Network Slicing Use Case ============================ @@ -50,7 +51,7 @@ updates to the relevant standards which are also currently evolving. This use case shall also collaborate with other open initiatives such as O-RAN to enable wider adoption and use. -See the `wiki <https://wiki.onap.org/display/DW/Use+Case+Description+and+Blueprint>`_ +See the `Use Case Description and Blueprint wiki page <https://wiki.onap.org/display/DW/Use+Case+Description+and+Blueprint>`_ for details. Abbreviations @@ -100,7 +101,7 @@ From the NSI Life Cycle perspective, the scope includes NSI design and pre-provi To support the above functions, code impacts in U-UI, SO, OOF and ExtAPI components, and schema change in A&AI are implemented. -See the `wiki <https://wiki.onap.org/display/DW/Proposed+Functions+for+R6+and+Impacted+Modules>`_ +See the `Proposed Functions for R6 and Impacted Modules wiki page <https://wiki.onap.org/display/DW/Proposed+Functions+for+R6+and+Impacted+Modules>`_ for details. Impacted Modules @@ -131,7 +132,7 @@ recalibration of NSI&NSSI selection with manual intervention from the portal. A new SO adapter is created to be the adapter of NSSMF which will interact with external NSSMF for NSSI management. -See the `wiki <https://wiki.onap.org/display/DW/SO%3A+Impacts+and+Interfaces>`_ +See the `SO Impacts and Interfaces wiki page <https://wiki.onap.org/display/DW/SO%3A+Impacts+and+Interfaces>`_ for details. U-UI @@ -160,7 +161,8 @@ statistics of network slices. In this page, the statistics of slice usage (traffic), online users and total bandwidth can be monitored and displayed in the form of pi-charts and lines. -See the `wiki <https://wiki.onap.org/display/DW/UUI%3A+Impacts>`_ for details. +See the `UUI Impacts wiki page <https://wiki.onap.org/display/DW/UUI%3A+Impacts>` +_ for details. OOF ~~~ @@ -185,7 +187,7 @@ adapted for constraints and optimal selection of slice template and slice instance. In case of new NSSI creation, HAS returns appropriate slice profile for the sub-net for which a new NSSI has to be created. -See the `wiki <https://wiki.onap.org/display/DW/OOF%3A+Impacts+and+Interfaces>`_ +See the `OOF Impacts and Interfaces wiki page <https://wiki.onap.org/display/DW/OOF%3A+Impacts+and+Interfaces>`_ for details EXT-API @@ -211,7 +213,7 @@ for creating the service. As can be seen from above explanation, the existing constructs of ExtAPI has been reused with minor enhancements. -See the `wiki <https://wiki.onap.org/display/DW/ExtAPI%3A+Impacts+and+Interfaces>`_ +See the `ExtAPI Impacts and Interfaces wiki page <https://wiki.onap.org/display/DW/ExtAPI%3A+Impacts+and+Interfaces>`_ for details. A&AI @@ -250,7 +252,7 @@ A&AI also supply creation APIs to SO, such as: and - Create relationship between service-instances. -See the `wiki <https://wiki.onap.org/pages/viewpage.action?pageId=76875989>`_ +See the `AAI Impacts wiki page <https://wiki.onap.org/pages/viewpage.action?pageId=76875989>`_ for details. Functional Test Cases @@ -279,8 +281,8 @@ aspects: - Checking inventory updates in AAI for NSIs, service and slice profiles and NSSIs. -See the `wiki <https://wiki.onap.org/display/DW/Functional+Test+Cases>`_ for -details. +See the `Functional Test Cases wiki page <https://wiki.onap.org/display/DW/Functional+Test+Cases>`_ +for details. Operation Guidance ------------------ @@ -298,7 +300,7 @@ optimize the resources required for setting up the use case. This approach will help to install a minimum-scope version ONAP for 5G E2E Slicing use case. -See the `wiki <https://wiki.onap.org/display/DW/Install+Minimum+Scope+ONAP+for+5G+Network+Slicing>`_ +See the `Install Minimum Scope ONAP for 5G Network Slicing wiki page <https://wiki.onap.org/display/DW/Install+Minimum+Scope+ONAP+for+5G+Network+Slicing>`_ for details. Configuration aspects diff --git a/docs/docs_pnf_onboarding_preonboarding.rst b/docs/docs_pnf_onboarding_preonboarding.rst index bf38ca569..fb33ec370 100644 --- a/docs/docs_pnf_onboarding_preonboarding.rst +++ b/docs/docs_pnf_onboarding_preonboarding.rst @@ -3,6 +3,8 @@ .. _docs_pnf_onboarding_preonboarding: +:orphan: + 5G - PNF Pre-Onboarding & Onboarding ------------------------------------ diff --git a/docs/docs_robot.rst b/docs/docs_robot.rst index 96b4b7c65..f572f2799 100644 --- a/docs/docs_robot.rst +++ b/docs/docs_robot.rst @@ -3,6 +3,8 @@ .. _docs_robot: +:orphan: + Robot ----- diff --git a/docs/docs_scaleout.rst b/docs/docs_scaleout.rst index 6b88168da..77ab6f725 100644 --- a/docs/docs_scaleout.rst +++ b/docs/docs_scaleout.rst @@ -1,5 +1,7 @@ .. _docs_scaleout: +:orphan: + VF Module Scale Out Use Case ---------------------------- diff --git a/docs/docs_usecases.rst b/docs/docs_usecases.rst index 8648f69ab..f86fc6b11 100644 --- a/docs/docs_usecases.rst +++ b/docs/docs_usecases.rst @@ -3,6 +3,8 @@ .. _docs_usecases: +:orphan: + Deprecated Use Cases and Functional Requirements ================================================ diff --git a/docs/docs_usecases_release.rst b/docs/docs_usecases_release.rst index f5bf715f6..9e662a5a4 100644 --- a/docs/docs_usecases_release.rst +++ b/docs/docs_usecases_release.rst @@ -3,6 +3,8 @@ .. _docs_usecases_release: +:orphan: + Guilin Use Cases and Functional Requirements ============================================= diff --git a/docs/docs_vCPE.rst b/docs/docs_vCPE.rst index a0550cc22..6a8e2c536 100644 --- a/docs/docs_vCPE.rst +++ b/docs/docs_vCPE.rst @@ -4,8 +4,10 @@ .. _docs_vcpe: +:orphan: + vCPE Use Case ----------------------------- +------------- Description ~~~~~~~~~~~ diff --git a/docs/docs_vCPE_tosca_local.rst b/docs/docs_vCPE_tosca_local.rst index 3224b9ec9..8b903adb7 100644 --- a/docs/docs_vCPE_tosca_local.rst +++ b/docs/docs_vCPE_tosca_local.rst @@ -4,6 +4,8 @@ .. _docs_vcpe_tosca_local: +:orphan: + vCPE Tosca Local Mode Use Case ------------------------------ @@ -82,6 +84,7 @@ The use case has been automated by vcpe_tosca_test scripts. The followings are t Secondly, update the values according to your environment. :: + "open_cli_product": set to CLI product you installed, onap-dublin is OK for this test. "open_cli_home": set to the oclip home path, "aai_url": set to msb ip and port you used, @@ -107,7 +110,6 @@ The use case has been automated by vcpe_tosca_test scripts. The followings are t "system-status": "active" } } - "cloud-owner": set to any cloud name you want to use, , the name must be unique "service_name": set to any service name you want to use, the name must be unique "customer_name": set to any customer name you want to use, the name must be unique diff --git a/docs/docs_vCPE_with_Tosca_VNF.rst b/docs/docs_vCPE_with_Tosca_VNF.rst index 6f9bf8ba0..3343bdf9f 100644 --- a/docs/docs_vCPE_with_Tosca_VNF.rst +++ b/docs/docs_vCPE_with_Tosca_VNF.rst @@ -1,7 +1,9 @@ .. _docs_vcpe_tosca: +:orphan: + vCPE with Tosca VNF ----------------------------- +------------------- VNF Packages and NS Packages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -19,8 +21,8 @@ How to Use ~~~~~~~~~~ -Configuration: -~~~~~~~~~~~~~~ +Configuration +~~~~~~~~~~~~~ 1) VIM Configuration Prepare openstack test environment. @@ -51,15 +53,15 @@ Configuration: .. image:: files/vcpe_tosca/vnfm.png -Design Time: -~~~~~~~~~~~~ +Design Time +~~~~~~~~~~~ 1) We put the real ETSI aligned package as package artifact. 2) When design Network service in SDC, should assign "gvnfmdriver" as the value of nf_type in Properties Assignment. so that VF-C can know will use gvnfm to manage VNF life cycle. .. image:: files/vcpe_tosca/sdc.png -Run Time: -~~~~~~~~~ +Run Time +~~~~~~~~ 1) First onboard VNF/NS package from SDC to modeling etsicatalog in sequence. 2) Trigger the NS operation via UUI guide diff --git a/docs/docs_vFWDT.rst b/docs/docs_vFWDT.rst index ebf9e8985..0c13886d2 100644 --- a/docs/docs_vFWDT.rst +++ b/docs/docs_vFWDT.rst @@ -3,12 +3,11 @@ .. _docs_vfw_traffic: -.. contents:: - :depth: 3 -.. +:orphan: vFW In-Place Software Upgrade with Traffic Distribution Use Case ---------------------------------------------------------------- + Description ~~~~~~~~~~~ @@ -488,7 +487,7 @@ Configuration of VNF in the APPC CDT tool .. note:: Automated procedure can be found at the end of the section -Following steps aim to configure DistributeTraffic LCM action for our vPKG and vFW-SINK VNFs in APPC CDT tool. +Following steps aim to configure DistributeTraffic LCM action for our vPKG and vFW-SINK VNFs in APPC CDT tool. 1. Enter the Controller Design Tool portal @@ -799,7 +798,7 @@ the execution of APPC LCM actions with configuration resolved before by Optimiza Workflow Execution ~~~~~~~~~~~~~~~~~~ -In order to run workflows execute following commands from the vFWDT tutorial directory `Preparation of Workflow Script Environment`_ on Rancher server. +In order to run workflows execute following commands from the vFWDT tutorial directory `Preparation of Workflow Script Environment`_ on Rancher server. For Traffic Distribution workflow run @@ -839,8 +838,8 @@ The order of executed LCM actions for In-Place Software Upgrade with Traffic Dis 5. DistributeTraffic on vPKG VM - ansible playbook reconfigures vPKG in order to send traffic to destination specified before by OOF. 6. DistributeTrafficCheck on vFW-1 VM - ansible playbook checks if traffic is not present on vFW from which traffic should be migrated out. If traffic is still present after 30 seconds playbook fails 7. DistributeTrafficCheck on vFW-2 VM - ansible playbook checks if traffic is present on vFW from which traffic should be migrated out. If traffic is still not present after 30 seconds playbook fails -8. UpgradeSoftware on vFW-1 VM - ansible playbook modifies the software on the vFW instance and sets the version of the software to the specified one in the request -9. UpgradePostCheck on vFW-1 VM - ansible playbook checks if the software of vFW is the same like the one specified in the workflows input. +8. UpgradeSoftware on vFW-1 VM - ansible playbook modifies the software on the vFW instance and sets the version of the software to the specified one in the request +9. UpgradePostCheck on vFW-1 VM - ansible playbook checks if the software of vFW is the same like the one specified in the workflows input. 10. DistributeTraffic on vPKG VM - ansible playbook reconfigures vPKG in order to send traffic to destination specified before by OOF (reverse configuration). 11. DistributeTrafficCheck on vFW-2 VM - ansible playbook checks if traffic is not present on vFW from which traffic should be migrated out. If traffic is still present after 30 seconds playbook fails 12. DistributeTrafficCheck on vFW-1 VM - ansible playbook checks if traffic is present on vFW from which traffic should be migrated out. If traffic is still not present after 30 seconds playbook fails diff --git a/docs/docs_vFW_CNF_CDS.rst b/docs/docs_vFW_CNF_CDS.rst index 690bc5f92..c3150f529 100644 --- a/docs/docs_vFW_CNF_CDS.rst +++ b/docs/docs_vFW_CNF_CDS.rst @@ -4,11 +4,8 @@ .. _docs_vFW_CNF_CDS: -.. contents:: - :depth: 4 -.. +:orphan: ----------------------- vFirewall CNF Use Case ---------------------- @@ -1567,7 +1564,7 @@ where my_cba.zip is the CBA model with uat.yml (generated in spy step) inside Te This verify call failed for us with above uat.yaml file generated in spy. Issue was not investigated further in the scope of this use case. Instantiation Overview -...................... +---------------------- The figure below shows all the interactions that take place during vFW CNF instantiation. It's not describing flow of actions (ordered steps) but rather component dependencies. @@ -1576,11 +1573,11 @@ The figure below shows all the interactions that take place during vFW CNF insta vFW CNF CDS Use Case Runtime interactions. --------------------------- PART 1 - ONAP Installation --------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~ + 1-1 Deployment components -~~~~~~~~~~~~~~~~~~~~~~~~~ +......................... In order to run the vFW_CNF_CDS use case, we need ONAP Frankfurt Release (or later) and at least following components: @@ -1605,7 +1602,7 @@ Shared Maria DB Used as a shared stora ======================================================= =========== 1-2 Deployment -~~~~~~~~~~~~~~ +.............. In order to deploy such an instance, follow the `ONAP Deployment Guide`_ @@ -1692,14 +1689,14 @@ And check status of pods, deployments, jobs etc. 1-3 Post Deployment -~~~~~~~~~~~~~~~~~~~ +................... After completing the first part above, we should have a functional ONAP deployment for the Frankfurt Release. We will need to apply a few modifications to the deployed ONAP Frankfurt instance in order to run the use case. Retrieving logins and passwords of ONAP components -.................................................. +++++++++++++++++++++++++++++++++++++++++++++++++++ Since Frankfurt release hardcoded passwords were mostly removed and it is possible to configure passwords of ONAP components in time of their installation. In order to retrieve these passwords with associated logins it is required to get them with kubectl. Below is the procedure on mariadb-galera DB component example. @@ -1711,7 +1708,7 @@ Since Frankfurt release hardcoded passwords were mostly removed and it is possib In this case login is empty as the secret is dedicated to root user. Postman collection setup -........................ +++++++++++++++++++++++++ In this demo we have on purpose created all manual ONAP preparation steps (which in real life are automated) by using Postman so it will be clear what exactly is needed. Some of the steps like AAI population is automated by Robot scripts in other ONAP demos (**./demo-k8s.sh onap init**) and Robot script could be used for many parts also in this demo. Later when this demo is fully automated we probably update also Robot scripts to support this demo. @@ -1788,7 +1785,7 @@ Create all these entries into AAI in this order. Postman collection provided in Corresponding GET operations in "Check" folder in Postman can be used to verify entries created. Postman collection also includes some code that tests/verifies some basic issues e.g. gives error if entry already exists. SO BPMN endpoint fix for VNF adapter requests (v1 -> v2) -........................................................ +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ SO Openstack adapter needs to be updated to use newer version. Here is also possible improvement area in SO. OpenStack adapter is confusing in context of this use case as VIM is not Openstack but Kubernetes cloud region. In this use case we did not used Openstack at all. @@ -1800,7 +1797,7 @@ SO Openstack adapter needs to be updated to use newer version. Here is also poss kubectl -n onap delete pod -l app=so-bpmn-infra Naming Policy -............. ++++++++++++++ Naming policy is needed to generate unique names for all instance time resources that are wanted to be modeled in the way naming policy is used. Those are normally VNF, VNFC and VF-module names, network names etc. Naming is general ONAP feature and not limited to this use case. @@ -1813,8 +1810,7 @@ To check that the naming policy is created and pushed OK, we can run the command .. note:: Please change credentials respectively to your installation. The required credentials can be retrieved with instruction `Retrieving logins and passwords of ONAP components`_ -Network Naming mS -+++++++++++++++++ +**Network Naming mS** FIXME - Verify if on RC2 this still needs to be performed @@ -1831,14 +1827,13 @@ There's a strange feature or bug in naming service still at ONAP Frankfurt and f delete from EXTERNAL_INTERFACE; select * from EXTERNAL_INTERFACE; ---------------------------------------------------- PART 2 - Installation of managed Kubernetes cluster ---------------------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In this demo the target cloud region is a Kubernetes cluster of your choice basically just like with Openstack. ONAP platform is a bit too much hard wired to Openstack and it's visible in many demos. 2-1 Installation of Managed Kubernetes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +...................................... In this demo we use Kubernetes deployment used by ONAP multicloud/k8s team to test their plugin features see `KUD readthedocs`_. There's also some outdated instructions in ONAP wiki `KUD in Wiki`_. @@ -1853,7 +1848,7 @@ See `KUD subproject in github`_ for a list of additional plugins this Kubernetes Follow instructions in `KUD readthedocs`_ and install target Kubernetes cluster in your favorite machine(s), simplest being just one machine. Your cluster nodes(s) needs to be accessible from ONAP Kuberenetes nodes. 2-2 Cloud Registration -~~~~~~~~~~~~~~~~~~~~~~ +...................... Managed Kubernetes cluster is registered here into ONAP as one cloud region. This obviously is done just one time for this particular cloud. Cloud registration information is kept in AAI. @@ -1889,9 +1884,8 @@ It's possible improvement place in SO to rather get this information directly fr select * from cloud_sites; exit ----------------------------------- PART 3 - Execution of the Use Case ----------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This part contains all the steps to run the use case by using ONAP GUIs and Postman. @@ -1903,10 +1897,10 @@ Following picture describes the overall sequential flow of the use case. vFW CNF CDS Use Case sequence flow. 3-1 Onboarding -~~~~~~~~~~~~~~ +.............. Creating Onboarding Package -........................... ++++++++++++++++++++++++++++ Whole content of this use case is stored into single git repository and ONAP user content package of onboarding package can be created with provided Makefile. @@ -2004,7 +1998,7 @@ and package **vfw_k8s_demo.zip** file is created containing all sub-models. Import this package into SDC and follow onboarding steps. Service Creation with SDC -......................... ++++++++++++++++++++++++++ Service Creation in SDC is composed of the same steps that are performed by most other use-cases. For reference, you can relate to `vLB use-case`_ @@ -2021,7 +2015,7 @@ Service -> Properties Assignment -> Choose VF (at right box): - sdnc_model_version - 1.0.45 Distribution Of Service -....................... ++++++++++++++++++++++++ Distribute service. @@ -2240,7 +2234,7 @@ Verify in SDC UI if distribution was successful. In case of any errors (sometime ] 3-2 CNF Instantiation -~~~~~~~~~~~~~~~~~~~~~ +..................... This is the whole beef of the use case and furthermore the core of it is that we can instantiate any amount of instances of the same CNF each running and working completely of their own. Very basic functionality in VM (VNF) side but for Kubernetes and ONAP integration this is the first milestone towards other normal use cases familiar for VNFs. @@ -2304,8 +2298,8 @@ You can finally terminate this instance (now or later) with another call: **Postman -> LCM -> 5. [SO] Service Delete** -Second instance Instantion -.......................... +Second instance Instantiation ++++++++++++++++++++++++++++++ To finally verify that all the work done within this demo, it should be possible to instantiate second vFW instance successfully. @@ -2314,7 +2308,7 @@ Trigger new instance createion. You can use previous call or a separate one that **Postman -> LCM -> 6. [SO] Self-Serve Service Assign & Activate - Second** 3-3 Results and Logs -~~~~~~~~~~~~~~~~~~~~ +.................... Now multiple instances of Kubernetes variant of vFW are running in target VIM (KUD deployment). @@ -2392,7 +2386,7 @@ FIXME - needs updated output with newest naming policy Component Logs From The Execution -................................. ++++++++++++++++++++++++++++++++++ All logs from the use case execution are here: @@ -2410,8 +2404,7 @@ All logs from the use case execution are here: - `multicloud-k8s_multicloud-k8s_POD_LOG.log` - network naming -Debug log -+++++++++ +**Debug log** In case more detailed logging is needed, here's instructions how to setup DEBUG logging for few components. @@ -2437,9 +2430,8 @@ In case more detailed logging is needed, here's instructions how to setup DEBUG # Delete the Pods to make changes effective kubectl -n onap delete pods -l app=cds-blueprints-processor ------------------------------------------------ PART 4 - Summary and Future improvements needed ------------------------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This use case made CNFs onboarding and instantiation a little bit easier and closer to "normal" VNF way. Also CDS resource resolution capabilities were taken into use (compared to earlier demos) together with SO's MACRO workflow. diff --git a/docs/docs_vfw.rst b/docs/docs_vfw.rst index f91818125..1fdb2aaa7 100644 --- a/docs/docs_vfw.rst +++ b/docs/docs_vfw.rst @@ -1,5 +1,7 @@ .. _docs_vfw: +:orphan: + vFirewall Use Case ------------------ @@ -109,9 +111,8 @@ At the end of the test , robot sets the streams back to Medium so that it is setup for the next test. For documentation about running the use case manually for previous releases, -please look at the videos and the material available at this `wiki page`_. - -__ https://wiki.onap.org/display/DW/Running+the+ONAP+Demos +please look at the videos and the material available in +`Running the ONAP Demos wiki page <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_ Although videos are still valid, users are encouraged to use the Heat templates linked at the top of this page rather than the old Heat templates in that wiki page. diff --git a/docs/docs_vfwHPA.rst b/docs/docs_vfwHPA.rst index ed64e5e2a..c37754d55 100644 --- a/docs/docs_vfwHPA.rst +++ b/docs/docs_vfwHPA.rst @@ -4,6 +4,8 @@ .. _docs_vfw_hpa: +:orphan: + vFW/vDNS with HPA Tutorial: Setting Up and Configuration -------------------------------------------------------- diff --git a/docs/docs_vfw_edgex_k8s.rst b/docs/docs_vfw_edgex_k8s.rst index 02ff713d7..2a8c42372 100644 --- a/docs/docs_vfw_edgex_k8s.rst +++ b/docs/docs_vfw_edgex_k8s.rst @@ -4,6 +4,8 @@ .. _docs_vfw_edgex_multicloud_k8s: +:orphan: + vFW/Edgex with Multicloud Kubernetes Plugin: Setting Up and Configuration ------------------------------------------------------------------------- @@ -201,8 +203,8 @@ It is an example of the minimal HEAT template. Onboard the CSAR ---------------- -For onboarding instructions please refer to steps 4-9 from the document -`here <https://wiki.onap.org/display/DW/vFWCL+instantiation%2C+testing%2C+and+debuging>`_. +For onboarding instructions please refer to steps 4-9 from +`vFWCL instantiation, testing and debuging wiki page <https://wiki.onap.org/display/DW/vFWCL+instantiation%2C+testing%2C+and+debuging>`_. Steps for installing KUD Cloud ------------------------------ @@ -210,9 +212,8 @@ Steps for installing KUD Cloud Follow the link to install KUD Kubernetes Deployment. KUD contains all the packages required for running vfw use case. -Kubernetes Baremetal deployment instructions can be found here_ - -.. _here: https://wiki.onap.org/display/DW/Kubernetes+Baremetal+deployment+setup+instructions/ +Kubernetes Baremetal deployment instructions can be found in +`Kubernetes Baremetal deployment setup instructions wiki page <https://wiki.onap.org/display/DW/Kubernetes+Baremetal+deployment+setup+instructions>`_ REGISTER KUD CLOUD REGION with K8s-Plugin ----------------------------------------- @@ -272,15 +273,15 @@ registration) pointing to a real OpenStack tenant (e.g. the OOF tenant in the lab where we tested). This will cause multicloud to add the tenant to the k8s cloud region and -then, similarly to #10 in the documentation -`here <https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/docs_vfwHPA.html#docs-vfw-hpa>`_, +then, similarly to #10 in the +`vFW HPA casablanca official documentation <https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/docs_vfwHPA.html#docs-vfw-hpa>`_, the service-subscription can be added to that object. **NOTE:** use same name cloud-region and cloud-owner name An example is shown below for K8s cloud but following the steps 1,2,3 from -`here <https://docs.onap.org/projects/onap-multicloud-framework/en/latest/multicloud-plugin-windriver/UserGuide-MultiCloud-WindRiver-TitaniumCloud.html?highlight=multicloud>`_. +`Multicloud Windriver Plugin documentation <https://docs.onap.org/projects/onap-multicloud-framework/en/latest/multicloud-plugin-windriver/UserGuide-MultiCloud-WindRiver-TitaniumCloud.html?highlight=multicloud>`_. The sample input below is for k8s cloud type. **Step 1**: Cloud Registration/ Create a cloud region to represent the instance diff --git a/docs/docs_vipsec.rst b/docs/docs_vipsec.rst index 4ec8c6f7f..f50326f60 100644 --- a/docs/docs_vipsec.rst +++ b/docs/docs_vipsec.rst @@ -4,6 +4,8 @@ .. _docs_vipsec_hpa: +:orphan: + vIPsec with HPA Tutorial: Setting Up and Configuration -------------------------------------------------------- diff --git a/docs/docs_vlb.rst b/docs/docs_vlb.rst index 5044d2adc..5a9f6a2fb 100644 --- a/docs/docs_vlb.rst +++ b/docs/docs_vlb.rst @@ -1,5 +1,7 @@ .. _docs_vlb: +:orphan: + vLoadBalancer Use Case ---------------------- @@ -69,7 +71,6 @@ To change the volume of queries generated by the packet generator, run the follo :: - curl -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"pg-streams":{"pg-stream": [{"id":"dns1", "is-enabled":"true"}]}}' "http://PacketGen_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams" - {"id":"dns1", "is-enabled":"true"} shows the stream "dns1" is enabled. The packet generator sends requests in the rate of 100 packets per 10 seconds; @@ -83,18 +84,20 @@ For example, if you want to enable 3 streams, the curl command will be: When the VNF starts, the packet generator is automatically configured to run 5 streams. - Running the Use Case ~~~~~~~~~~~~~~~~~~~~ -Automated closed loop via Robot Framework is not supported at this time. For documentation about running the use case manually for previous releases, please look at the videos and the material available at this `wiki page`_. - -__ https://wiki.onap.org/display/DW/Running+the+ONAP+Demos +Automated closed loop via Robot Framework is not supported at this time. +For documentation about running the use case manually for previous releases, +please look at the videos and the material available at +`Running the ONAP Demos wiki page <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_ -Although videos are still valid, users are encouraged to use the Heat templates linked at the top of this page rather than the old Heat templates in that wiki page. +Although videos are still valid, users are encouraged to use the Heat templates +linked at the top of this page rather than the old Heat templates in that wiki page. Known issues and resolution ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1) The packet generator may become unresponsive and stop generating traffic. To solve the problem, reboot the packet generator. +1) The packet generator may become unresponsive and stop generating traffic. + To solve the problem, reboot the packet generator. 2) The base and scaling VF module names need to follow a specific naming convention: diff --git a/docs/files/csv/usecases-deprecated.csv b/docs/files/csv/usecases-deprecated.csv index afae825dd..123f30f47 100644 --- a/docs/files/csv/usecases-deprecated.csv +++ b/docs/files/csv/usecases-deprecated.csv @@ -10,3 +10,21 @@ EdgeXFoundry CNF with multicloud k8s plugin;:ref:`official doc <docs_vfw_edgex_m vCPE with Tosca;:ref:`official doc <docs_vcpe_tosca_local>`;Frankfurt;No resources to test on Guilin E2E Automation vLB with CDS;`wiki page <https://wiki.onap.org/pages/viewpage.action?pageId=71838891>`__; Frankfurt;No resources to test on Guilin vFirewall In-Place Software Upgrade with Traffic Distribution;:ref:`official doc <docs_vfw_traffic>`;Frankfurt;APPC in maintenance mode +5G Bulk PM; :ref:`official doc <docs_5g_bulk_pm>`;Frankfurt;No tested in Guilin +5G OOF and PCI;:ref:`official doc <docs_5G_oof_pci>`;Frankfurt;No tested in Guilin +5G NRM Network Resource Model (Configuration management);:ref:`official doc <docs_5G_NRM_Configuration>`;Frankfurt;No tested in Guilin +5G NETCONF configuration;:ref:`official doc <docs_5G_Configuration_over_NETCONF>`;Frankfurt;No tested in Guilin +5G OOF SON;:ref:`official doc <docs_5G_oof_pci>`;Frankfurt;No tested in Guilin +5G E2E Network Slicing ;:ref:`official doc<docs_E2E_network_slicing>`;Frankfurt;No tested in Guilin +5G ORAN A1 Adapter (SDNR);:ref:`official doc <docs_5g_a1_adaptor>`;Frankfurt;No tested in Guilin +PNF Software Upgrade using direct Netconf Yang interface with PNF;:ref:`official doc <docs_5g_pnf_software_upgrade>`;Frankfurt;No tested in Guilin +PNF Software Upgrade with EM with Ansible;:ref:`official doc <docs_5G_PNF_Software_Upgrade_ansible_with_EM>`;Frankfurt;No tested in Guilin +PNF Software Upgrade with EM with Netconf; :ref:`official doc <docs_5g_pnf_software_upgrade_netconf_with_EM>`;Frankfurt;No tested in Guilin +PNF Software Upgrade in association to schema updates; :ref:`official doc <docs_5G_PNF_Software_Upgrade_With_Schema_Update>`;Frankfurt;No tested in Guilin +VSP Compliance and Validation Check within SDC;`wiki page <https://wiki.onap.org/display/DW/VSP+Compliance+and+Validation+Check+within+SDC+%28Frankfurt%29+-+Phase+2#VSPComplianceandValidationCheckwithinSDC(Frankfurt)Phase2-VSPComplianceCheckwithinSDC-IntegrationTestPlan>`_;Frankfurt;No tested in Guilin +Enable PNF software version at onboarding;`wiki page <https://jira.onap.org/browse/REQ-88?src=confmacro>`__;Frankfurt;No tested in Guilin +xNF communication security enhancements; `wiki page <https://wiki.onap.org/display/DW/xNF+communication+security+enhancements+-+Tests+Description+and+Status>`__;Frankfurt;No tested in Guilin +ETSI Alignment SO plugin to support SOL003 to connect to an external VNFM;`wiki page <https://wiki.onap.org/display/DW/ETSI+Alignment+Support>`__;Frankfurt;No tested in Guilin +Integration of CDS as an Actor; `official doc <https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/ui/designer.html>`_;Frankfurt;No tested in Guilin +3rd Party Operational Domain Manager; `wiki page <https://wiki.onap.org/display/DW/Third-party+Operational+Domain+Manager>`__;Frankfurt;No tested in Guilin +Configuration & persistency; `wiki page <https://wiki.onap.org/pages/viewpage.action?pageId=64003184>`__;Frankfurt;No tested in Guilin diff --git a/docs/files/csv/usecases-functional-requirements-5g.csv.old b/docs/files/csv/usecases-functional-requirements-5g.csv.old deleted file mode 100644 index 286fd3aba..000000000 --- a/docs/files/csv/usecases-functional-requirements-5g.csv.old +++ /dev/null @@ -1,11 +0,0 @@ -5G functional requirement,Link,Contacts -5G Realtime PM and High Volume Stream Data Collection, :ref:`official doc <docs_realtime_pm>`,M.Przybysz -5G PNF Plug and Play, :ref:`official doc <docs_5g_pnf_pnp>`, M.Przybysz K.Kuzmicki -5G Bulk PM, :ref:`official doc <docs_5g_bulk_pm>`, J.Cuddy -5G OOF and PCI,:ref:`official doc <docs_5G_oof_pci>`, Reshmasree c -5G NRM Network Resource Model (Configuration management),:ref:`official doc <docs_5G_NRM_Configuration>`,Y.Wang C.Huang -5G NETCONF configuration,:ref:`official doc <docs_5G_Configuration_over_NETCONF>`, A.D.Singh -5G PNF Pre-Onboarding & Onboarding,:ref:`official doc <docs_pnf_onboarding_preonboarding>`,M.Przybysz K.Kuzmicki D.Melia A.Walshe -5G OOF SON,:ref:`official doc <docs_5G_oof_pci>`,Reshmasree c -5G E2E Network Slicing ,:ref:`official doc<docs_E2E_network_slicing>`,C.Chen Z.Min Swaminathan S -5G ORAN A1 Adapter (SDNR),:ref:`official doc <docs_5g_a1_adaptor>`,SandeepShah diff --git a/docs/files/csv/usecases-functional-requirements.csv.old b/docs/files/csv/usecases-functional-requirements.csv.old deleted file mode 100644 index cf5117e8e..000000000 --- a/docs/files/csv/usecases-functional-requirements.csv.old +++ /dev/null @@ -1,12 +0,0 @@ -Functional requirement,Link,Contacts -PNF Software Upgrade using direct Netconf Yang interface with PNF,:ref:`official doc <docs_5g_pnf_software_upgrade>`,R.Gumma R.Tyagi -PNF Software Upgrade with EM with Ansible,:ref:`official doc <docs_5G_PNF_Software_Upgrade_ansible_with_EM>`, Y.Wang E.Wang -PNF Software Upgrade with EM with Netconf, :ref:`official doc <docs_5g_pnf_software_upgrade_netconf_with_EM>`, Y.Wang E.Wang -PNF Software Upgrade in association to schema updates, :ref:`official doc <docs_5G_PNF_Software_Upgrade_With_Schema_Update>`, Zu Qiang -VSP Compliance and Validation Check within SDC,`wiki page <https://wiki.onap.org/display/DW/VSP+Compliance+and+Validation+Check+within+SDC+%28Frankfurt%29+-+Phase+2#VSPComplianceandValidationCheckwithinSDC(Frankfurt)Phase2-VSPComplianceCheckwithinSDC-IntegrationTestPlan>`__,P.Balan -Enable PNF software version at onboarding,`wiki page <https://jira.onap.org/browse/REQ-88?src=confmacro>`__,A.Schmid -xNF communication security enhancements, `wiki page <https://wiki.onap.org/display/DW/xNF+communication+security+enhancements+-+Tests+Description+and+Status>`__,M.Przybysz -ETSI Alignment SO plugin to support SOL003 to connect to an external VNFM,`wiki page <https://wiki.onap.org/display/DW/ETSI+Alignment+Support>`__,F.Oliveira Byung-Woo Jun -Integration of CDS as an Actor, `official doc <https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/ui/designer.html>`__, B.Sakoto R.K.Verma Y.Malakov -3rd Party Operational Domain Manager, `wiki page <https://wiki.onap.org/display/DW/Third-party+Operational+Domain+Manager>`__, D.Patel -Configuration & persistency, `wiki page <https://wiki.onap.org/pages/viewpage.action?pageId=64003184>`__,Reshmasree c Swaminathan S diff --git a/docs/files/csv/usecases-old-valid.csv b/docs/files/csv/usecases-old-valid.csv index a53c572e9..aa9ecbcef 100644 --- a/docs/files/csv/usecases-old-valid.csv +++ b/docs/files/csv/usecases-old-valid.csv @@ -2,3 +2,6 @@ Summary;Link;Contacts vFirewall CNF With CDS;:ref:`official doc <docs_vFW_CNF_CDS>`;L.Rajewski, K.Banka vFirewall with closed loop;:ref:`official doc <docs_vfw>`;B.Freeman, C.Closet, S.Déterme Scale Out;:ref:`official doc <docs_scaleout>`;B.Freeman, C.Closet, S.Déterme +5G Realtime PM and High Volume Stream Data Collection; :ref:`official doc <docs_realtime_pm>`;M.Przybysz +5G PNF Plug and Play; :ref:`official doc <docs_5g_pnf_pnp>`; M.Przybysz K.Kuzmicki +5G PNF Pre-Onboarding & Onboarding;:ref:`official doc <docs_pnf_onboarding_preonboarding>`;M.Przybysz K.Kuzmicki D.Melia A.Walshe diff --git a/docs/heat.rst b/docs/heat.rst deleted file mode 100644 index cb34c87cc..000000000 --- a/docs/heat.rst +++ /dev/null @@ -1,237 +0,0 @@ -ONAP HEAT Template ------------------- - -Source files -~~~~~~~~~~~~ - -- Template file: https://git.onap.org/integration/plain/deployment/heat/onap-rke/onap-oom.yaml -- Environment file: https://git.onap.org/integration/plain/deployment/heat/onap-rke/env/windriver/onap-oom.env - -The files are based on the windriver environement used by the integration team. - -Description -~~~~~~~~~~~ - -The ONAP HEAT template spins up the entire ONAP platform. The template, -onap_openstack.yaml, comes with an environment file, -onap_openstack.env, in which all the default values are defined. - -.. note:: - onap_openstack.yaml AND onap_openstack.env ARE THE HEAT TEMPLATE - AND ENVIRONMENT FILE CURRENTLY SUPPORTED. - onap_openstack_float.yaml/env AND onap_openstack_nofloat.yaml/env - AREN'T UPDATED AND THEIR USAGE IS NOT SUGGESTED. - -The HEAT template is composed of two sections: (i) parameters, and (ii) -resources. -The parameter section contains the declaration and -description of the parameters that will be used to spin up ONAP, such as -public network identifier, URLs of code and artifacts repositories, etc. -The default values of these parameters can be found in the environment -file. - -The resource section contains the definition of: - -- ONAP Private Management Network, which ONAP components use to communicate with each other and with VNFs -- ONAP Virtual Machines (VMs) -- Public/private key pair used to access ONAP VMs -- Virtual interfaces towards the ONAP Private Management Network -- Disk volumes. - -Each VM specification includes Operating System image name, VM size -(i.e. flavor), VM name, etc. Each VM has two virtual network interfaces: -one towards the public network and one towards the ONAP Private -Management network, as described above. Furthermore, each VM runs a -post-instantiation script that downloads and installs software -dependencies (e.g. Java JDK, gcc, make, Python, ...) and ONAP software -packages and docker containers from remote repositories. - -When the HEAT template is executed, the Openstack HEAT engine creates -the resources defined in the HEAT template, based on the parameters -values defined in the environment file. - -Environment file -~~~~~~~~~~~~~~~~ - -Before running HEAT, it is necessary to customize the environment file. -Indeed, some parameters, namely public_net_id, pub_key, -openstack_tenant_id, openstack_username, and openstack_api_key, -need to be set depending on the user's environment: - -**Global parameters** - -:: - - public_net_id: PUT YOUR NETWORK ID/NAME HERE - pub_key: PUT YOUR PUBLIC KEY HERE - openstack_tenant_id: PUT YOUR OPENSTACK PROJECT ID HERE - openstack_username: PUT YOUR OPENSTACK USERNAME HERE - openstack_api_key: PUT YOUR OPENSTACK PASSWORD HERE - horizon_url: PUT THE HORIZON URL HERE - keystone_url: PUT THE KEYSTONE URL HERE (do not include version number) - -openstack_region parameter is set to RegionOne (OpenStack default). If -your OpenStack is using another Region, please modify this parameter. - -public_net_id is the unique identifier (UUID) or name of the public -network of the cloud provider. To get the public_net_id, use the -following OpenStack CLI command (ext is the name of the external -network, change it with the name of the external network of your -installation) - -:: - - openstack network list | grep ext | awk '{print $2}' - -pub_key is string value of the public key that will be installed in -each ONAP VM. To create a public/private key pair in Linux, please -execute the following instruction: - -:: - - user@ubuntu:~$ ssh-keygen -t rsa - -The following operations to create the public/private key pair occur: - -:: - - Generating public/private rsa key pair. - Enter file in which to save the key (/home/user/.ssh/id_rsa): - Created directory '/home/user/.ssh'. - Enter passphrase (empty for no passphrase): - Enter same passphrase again: - Your identification has been saved in /home/user/.ssh/id_rsa. - Your public key has been saved in /home/user/.ssh/id_rsa.pub. - -openstack_username, openstack_tenant_id (password), and -openstack_api_key are user's credentials to access the -OpenStack-based cloud. - -**Images and flavors parameters** - -:: - - ubuntu_1404_image: PUT THE UBUNTU 14.04 IMAGE NAME HERE - ubuntu_1604_image: PUT THE UBUNTU 16.04 IMAGE NAME HERE - flavor_small: PUT THE SMALL FLAVOR NAME HERE - flavor_medium: PUT THE MEDIUM FLAVOR NAME HERE - flavor_large: PUT THE LARGE FLAVOR NAME HERE - flavor_xlarge: PUT THE XLARGE FLAVOR NAME HERE - flavor_xxlarge: PUT THE XXLARGE FLAVOR NAME HERE - -To get the images in your OpenStack environment, use the following -OpenStack CLI command: - -:: - - openstack image list | grep 'ubuntu' - -To get the flavor names used in your OpenStack environment, use the -following OpenStack CLI command: - -:: - - openstack flavor list - -**DNS parameters** - -:: - - dns_list: PUT THE ADDRESS OFTHE EXTERNAL DNS HERE (e.g. a comma-separated list of IP addresses in your /etc/resolv.conf in UNIX-based Operating Systems). THIS LIST MUST INCLUDE THE DNS SERVER THAT OFFERS DNS AS AS SERVICE (see DCAE section below for more details) - external_dns: PUT THE FIRST ADDRESS OF THE EXTERNAL DNS LIST HERE oam_network_cidr: 10.0.0.0/16 - -You can use the Google Public DNS 8.8.8.8 and 4.4.4.4 address or your internal DNS servers - -**DCAE Parameters** - -DCAE spins up ONAP's data collection and analytics system in two phases. -The first is the launching of a bootstrap VM that is specified in the -ONAP Heat template. This VM requires a number of deployment specific -conifiguration parameters being provided so that it can subsequently -bring up the DCAE system. There are two groups of parameters. - -The first group relates to the launching of DCAE VMs, including parameters such as -the keystone URL and additional VM image IDs/names. DCAE VMs are -connected to the same internal network as the rest of ONAP VMs, but -dynamically spun up by the DCAE core platform. Hence these parameters -need to be provided to DCAE. Note that although DCAE VMs will be -launched in the same tenant as the rest of ONAP, because DCAE may use -MultiCloud node as the agent for interfacing with the underying cloud, -it needs a separate keystone URL (which points to MultiCloud node -instead of the underlying cloud). - -The second group of configuration parameters relate to DNS As A Service support (DNSaaS). -DCAE requires DNSaaS for registering its VMs into organization-wide DNS service. For -OpenStack, DNSaaS is provided by Designate. Designate support can be -provided via an integrated service endpoint listed under the service -catalog of the OpenStack installation; or proxyed by the ONAP MultiCloud -service. For the latter case, a number of parameters are needed to -configure MultiCloud to use the correct Designate service. These -parameters are described below: - -:: - - dcae_keystone_url: PUT THE KEYSTONE URL OF THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED (Note: put the MultiCloud proxy URL if the DNSaaS is proxyed by MultiCloud) - dcae_centos_7_image: PUT THE CENTOS7 IMAGE ID/NAME AVAILABLE AT THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED - dcae_security_group: PUT THE SECURITY GROUP ID/NAME TO BE USED AT THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED - dcae_key_name: PUT THE ACCESS KEY-PAIR NAME REGISTER AT THE OPENSTACK INSTANCE WHERE DCAE IS DEPLOYED - dcae_public_key: PUT THE PUBLIC KEY OF A KEY-PAIR USED FOR DCAE BOOTSTRAP NODE TO COMMUNICATE WITH DCAE VMS - dcae_private_key: PUT THE PRIVATE KEY OF A KEY-PAIR USED FOR DCAE BOOTSTRAP NODE TO COMMUNICATE WITH DCAE VMS - - dnsaas_config_enabled: true or false FOR WHETHER DNSAAS IS PROXYED - dnsaas_region: PUT THE REGION OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED - dnsaas_tenant_id: PUT THE TENANT ID/NAME OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED - dnsaas_keystone_url: PUT THE KEYSTONE URL OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED - dnsaas_username: PUT THE USERNAME OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED - dnsaas_password: PUT THE PASSWORD OF THE OPENSTACK INSTANCE WHERE DNSAAS IS PROVIDED - -Instantiation -~~~~~~~~~~~~~ - -The ONAP platform can be instantiated via Horizon (OpenStack dashboard) -or Command Line. - -**Instantiation via Horizon:** - -- Login to Horizon URL with your personal credentials -- Click "Stacks" from the "Orchestration" menu -- Click "Launch Stack" -- Paste or manually upload the HEAT template file (onap_openstack.yaml) in the "Template Source" form -- Paste or manually upload the HEAT environment file (onap_openstack.env) in the "Environment Source" form -- Click "Next" - Specify a name in the "Stack Name" form -- Provide the password in the "Password" form -- Click "Launch" - -**Instantiation via Command Line:** - -- Install the HEAT client on your machine, e.g. in Ubuntu (ref. http://docs.openstack.org/user-guide/common/cli-install-openstack-command-line-clients.html): - -:: - - apt-get install python-dev python-pip - pip install python-heatclient # Install heat client - pip install python-openstackclient # Install the Openstack client to support multiple services - -- Create a file (named i.e. ~/openstack/openrc) that sets all the - environmental variables required to access Rackspace: - -:: - - export OS_AUTH_URL=INSERT THE AUTH URL HERE - export OS_USERNAME=INSERT YOUR USERNAME HERE - export OS_TENANT_ID=INSERT YOUR TENANT ID HERE - export OS_REGION_NAME=INSERT THE REGION HERE - export OS_PASSWORD=INSERT YOUR PASSWORD HERE - -- Run the script from command line: - -:: - - source ~/openstack/openrc - -- In order to install the ONAP platform, type: - -:: - - heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE # Old HEAT client, OR - openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME # New Openstack client diff --git a/docs/integration-s3p.rst b/docs/integration-s3p.rst index 3effe0550..e1220a002 100644 --- a/docs/integration-s3p.rst +++ b/docs/integration-s3p.rst @@ -1,5 +1,7 @@ .. _integration-s3p: +:orphan: + ONAP Maturity Testing Notes --------------------------- diff --git a/docs/onap-oom-heat.rst b/docs/onap-oom-heat.rst index 848af72ef..d3c82790b 100644 --- a/docs/onap-oom-heat.rst +++ b/docs/onap-oom-heat.rst @@ -1,5 +1,7 @@ .. _integration-installation: +:orphan: + Integration Environment Installation ------------------------------------- @@ -22,10 +24,10 @@ must be adapted according to your context. Source files ~~~~~~~~~~~~ -- HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke?h=frankfurt -- Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc?h=frankfurt -- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=frankfurt -- Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh?h=frankfurt +- HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke?h=guilin +- Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc?h=guilin +- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=guilin +- Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh?h=guilin Heat Template Description @@ -33,7 +35,7 @@ Heat Template Description The ONAP Integration Project provides a sample HEAT template that fully automates the deployment of ONAP using OOM as described in -OOM documentation (https://docs.onap.org/en/frankfurt/guides/onap-developer/settingup/index.html#installing-onap). +OOM documentation, see :ref:`OOM<onap-oom:oom_quickstart_guide>` for details. The ONAP OOM HEAT template deploys the entire ONAP platform. It spins up an HA-enabled Kubernetes cluster, and deploys ONAP using OOM onto diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 604837915..6b00bbb30 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -14,16 +14,28 @@ Integration Release Notes .. important:: - - New use cases (cmpv2, ves-collector) - - New smoke tests based on pythonsdk-tests (replace onap_tests) + + - Creation of a Guilin Daily CI/CD chain + - Setup of a staging lab on Azure + - Setup of a staging lab on Windriver/Intel lab (with performance audit of the Windriver/Intel labs) + - Creation of java and python baseline images + - Update of oparent (java dependencies) + - Update of Seccom waivers and version recommendations + - New security tests (versions, pod limits, nonssl, nodeport certificate verification) + - New automated smoke tests (basic_vm, basic_network, basic_cnf) + - New requirement automated tests (ves-collector, cmpv2) + - Development of a new test framework pythonsdk + - onap_tests framework is now deprecated + - Heavy refactory of CSIT initiated + - Documentation refactoring (official documentation and wiki) + - New repositories (see dedicated section) - Bug fixes - - New Daily Guilin CI chain Quick Links: - `Guilin Integration page <https://wiki.onap.org/display/DW/Integration+G+Release>`_ - `Guilin Integration JIRA follow-up <https://wiki.onap.org/display/DW/Guilin+Docker+version+follow-up>`_ - - `Guilin use case testing status page <https://wiki.onap.org/display/DW/Guilin+Integration+blocking+points>` + - `Guilin use case testing status page <https://wiki.onap.org/display/DW/Guilin+Integration+blocking+points>`_ - `Guilin Integration weather Board <https://wiki.onap.org/display/DW/0%3A+Integration+Weather+Board+for+Guilin+Release>`_ diff --git a/docs/repo-onap-integration-ci.rst b/docs/repo-onap-integration-ci.rst index 6f26c265a..150c82b40 100644 --- a/docs/repo-onap-integration-ci.rst +++ b/docs/repo-onap-integration-ci.rst @@ -1,5 +1,7 @@ .. _integration-ci: +:orphan: + Integration Continuous Integration Guide ---------------------------------------- |