From a958b986af7b8f17ad23e5c31c7ff719c153021e Mon Sep 17 00:00:00 2001 From: mrichomme Date: Mon, 13 Apr 2020 18:46:35 +0200 Subject: Fix rst errors - Modify the linter to use sphinx linters (no coala bean) - Fix all broken links - fix minor rst issue - Add regex in ignore link (for ONAP URL and frankfurt doc) The rst target defined in tox will execute 3 steps: - local build of the documentation - check of the url Note 1: for the moment the Warning have not been turned into Error Note 2: frankfurt exeption shall be removed when frankfurt branch is available Issue-ID: INT-1523 Signed-off-by: mrichomme Change-Id: I6d7ad9d293a1b5c01f05a021d9a6f3767d04e62f Signed-off-by: mrichomme --- .coafile | 5 - docs/conf.py | 11 +- docs/docs_5G_Bulk_PM.rst | 6 +- ...ocs_5G_PNF_Software_Upgrade_netconf_with_EM.rst | 2 +- docs/docs_5g_pnf_pnp.rst | 15 +- docs/docs_5g_rtpm.rst | 6 +- docs/docs_BBS.rst | 8 +- docs/docs_CCVPN.rst | 2 +- docs/docs_E2E_network_slicing.rst | 2 +- docs/docs_scaleout.rst | 6 +- docs/docs_vCPE with Tosca VNF.rst | 159 --------------------- docs/docs_vCPE_with_Tosca_VNF.rst | 159 +++++++++++++++++++++ docs/docs_vFWDT.rst | 44 +++--- docs/docs_vFW_CNF_CDS.rst | 4 +- docs/docs_vfw.rst | 6 +- docs/docs_vfwHPA.rst | 2 +- docs/heat.rst | 7 +- docs/onap-oom-heat.rst | 8 +- tox.ini | 4 +- 19 files changed, 231 insertions(+), 225 deletions(-) delete mode 100644 docs/docs_vCPE with Tosca VNF.rst create mode 100644 docs/docs_vCPE_with_Tosca_VNF.rst diff --git a/.coafile b/.coafile index 79c27af9e..81bf44021 100644 --- a/.coafile +++ b/.coafile @@ -27,11 +27,6 @@ pylint_enable = ignore = .tox/** -[rst] -bears = reSTLintBear -ignore = - .tox/** - [md] bears = MarkdownBear ignore = diff --git a/docs/conf.py b/docs/conf.py index 8f40e8b81..99a44bc85 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,7 +4,16 @@ branch = 'latest' master_doc = 'index' linkcheck_ignore = [ - 'http://localhost', + r'http://localhost:\d+/', + 'http://CONSUL_SERVER_UI:30270/ui/#/dc1/services', + r'https://.*h=frankfurt', + r'http.*frankfurt.*', + r'http.*simpledemo.onap.org.*', + r'http://ANY_K8S_IP.*', + 'http://so-monitoring:30224', + r'http://SINK_IP_ADDRESS:667.*', + r'http.*K8S_HOST:30227.*', + r'http.*K8S_NODE_IP:30209.*' ] intersphinx_mapping = {} diff --git a/docs/docs_5G_Bulk_PM.rst b/docs/docs_5G_Bulk_PM.rst index da21b701c..eebb4ecd3 100644 --- a/docs/docs_5G_Bulk_PM.rst +++ b/docs/docs_5G_Bulk_PM.rst @@ -8,7 +8,7 @@ 5G Bulk PM Package ~~~~~~~~~~~~~~~~~~ -- 5G Bulk PM Package: https://wiki.onap.org/display/DW/5G+-+Bulk+PM+-+Integration+Test+Case +- 5G Bulk PM Package: https://wiki.onap.org/pages/viewpage.action?pageId=38121543 Description ~~~~~~~~~~~ @@ -18,8 +18,8 @@ https://wiki.onap.org/display/DW/5G+-+Bulk+PM How to Use ~~~~~~~~~~ -See the following instructions on how to manually test the feature. https://wiki.onap.org/display/DW/5G+Bulk+PM+Usecase+Testing+@+Ericsson+Lab+-+Casablanca -The tests can also be executed using the Robot framework, information can be found https://wiki.onap.org/display/DW/5G+-+Bulk+PM+-+Integration+Test+Cases +See the following instructions on how to manually test the feature. https://wiki.onap.org/display/DW/5G+Bulk+PM+Usecase+Testing+\@+Ericsson+Lab+-+Casablanca +The tests can also be executed using the Robot framework, information can be found https://wiki.onap.org/pages/viewpage.action?pageId=38121543 Test Status and Plans ~~~~~~~~~~~~~~~~~~~~~ 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 0d5b3b3a6..a42113c70 100644 --- a/docs/docs_5G_PNF_Software_Upgrade_netconf_with_EM.rst +++ b/docs/docs_5G_PNF_Software_Upgrade_netconf_with_EM.rst @@ -30,4 +30,4 @@ Test Status and Plans To see information on the status of the test cases, please follow the link below: -`PNF Software Upgrade with netconf/yang interface with EM Test Status `_ +`PNF Software Upgrade with netconf/yang interface with EM Test Status `_ diff --git a/docs/docs_5g_pnf_pnp.rst b/docs/docs_5g_pnf_pnp.rst index 2a8b55140..a81cca571 100644 --- a/docs/docs_5g_pnf_pnp.rst +++ b/docs/docs_5g_pnf_pnp.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 - + .. _docs_5g_pnf_pnp: 5G - PNF Plug and Play @@ -9,7 +9,7 @@ Source files ~~~~~~~~~~~~ -- Base PnP PNF Simulator heat template file: https://gerrit.onap.org/r/gitweb?p=integration.git;a=tree;f=test/mocks/pnfsimulator/deployment/src +- Base PnP PNF Simulator heat template file: https://gerrit.onap.org/r/gitweb?p=integration/simulators/pnf-simulator.git;a=blob_plain;f=deployment/src/simulators_heat_template.yaml Description ~~~~~~~~~~~ @@ -21,14 +21,13 @@ The PNF Plug and Play is a procedure that is executed between a PNF and ONAP. In - `5G - PNF Plug and Play use case documentation `_ - `5G - PNF Plug and Play - Integration Test Cases `_ - `Instruction how to setup PnP PNF Simulator `_ -- `Instruction how to use PnP PNF Simulator `_ +- `Instruction how to use PnP PNF Simulator `_ How to Use ~~~~~~~~~~ -1) `Create and distribute service model which contains PNF `_ -2) `Create service for PNF and wait for PNF Ready message in DmaaP topic `_ -3) `Send PNF Registartion request from PnP PNF Simualtor and finish registration `_ - - +1) `Create and distribute service model which contains PNF +2) `Create service for PNF and wait for PNF Ready message in DmaaP topic +3) `Send PNF Registartion request from PnP PNF Simualtor and finish registration +See `_ for details. diff --git a/docs/docs_5g_rtpm.rst b/docs/docs_5g_rtpm.rst index 2de85cdb6..eaed6786d 100644 --- a/docs/docs_5g_rtpm.rst +++ b/docs/docs_5g_rtpm.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 - + .. _docs_realtime_pm: 5G - Real Time PM and High Stream Data Collection @@ -26,8 +26,8 @@ How to verify Follow instructions in the links below to send data to HV-VES collector and verify messages published on Kafka topic: -- `HV-VES xNF simulator integration to ONAP `_ -- `HV-VES xNF message simulation from shell `_ +- `HV-VES xNF simulator integration to ONAP `_ (HVVESsimulator-HV-VESxNFmessagesimulationfromshell) +- `HV-VES xNF message simulation from shell `_ (HV-VESsimulator-HV-VESxNFsimulatorintegrationtoONAP) Useful links ~~~~~~~~~~~~ diff --git a/docs/docs_BBS.rst b/docs/docs_BBS.rst index 240c3099b..d2bca11c6 100644 --- a/docs/docs_BBS.rst +++ b/docs/docs_BBS.rst @@ -166,7 +166,7 @@ Create the required topics in DMaaP DCAE: BBS Event Processor (BBS-ep) ================================== -Description: :doc:`BBS-ep <../../dcaegen2.git/docs/sections/services/bbs-event-processor/index>` +Description: :doc:`BBS-ep ` The following BBS event processor blueprint will be used: @@ -191,7 +191,7 @@ IMPORTANT: Make sure that the configuration of BBS-ep in Consul contains the fol DCAE: RESTCONF Collector ======================== -Description: :doc:`RESTCONF Collector <../../dcaegen2.git/docs/sections/services/restconf/index>` +Description: :doc:`RESTCONF Collector ` The following RESTCONF collector blueprint will be used: @@ -209,7 +209,7 @@ RESTCONF Collector deployment procedure: DCAE: VES mapper ================ -Description: :doc:`VES Mapper <../../dcaegen2.git/docs/sections/services/mapper/index>` +Description: :doc:`VES Mapper ` The following VES mapper blueprint will be used: @@ -229,7 +229,7 @@ DCAE: VES collector Configure the mapping of the VES event domain to the correct DMaaP topic in Consul: ves-statechange --> unauthenticated.CPE_AUTHENTICATION -1. Access Consul UI http://CONSUL_SERVER_UI:30270/ui/#/dc1/services +1. Access Consul UI 2. Modify the dcae-ves-collector configuration by adding a new VES domain to DMaaP topic mapping diff --git a/docs/docs_CCVPN.rst b/docs/docs_CCVPN.rst index e6fde72b1..94bd4e09b 100644 --- a/docs/docs_CCVPN.rst +++ b/docs/docs_CCVPN.rst @@ -238,7 +238,7 @@ Following steps were undertaken for the closed loop testing. a. Give controller ip, username and password, trust store and key store file in restconf collector collector.properties b. Updated DMAAP ip in cambria.hosts in DmaapConfig.json in restconf collector and run restconf collector -c. Followed the steps provided in this link(https://wiki.onap.org/display/DW/Holmes+User+Guide+-+Casablanca#HolmesUserGuide-Casablanca-Configurations) to push CCVPN rules to holmes +c. Followed the steps provided in this link(https://wiki.onap.org/display/DW/Holmes+User+Guide+-+Casablanca) to push CCVPN rules to holmes d. Followed the steps provided in this link(https://wiki.onap.org/display/DW/ONAP+Policy+Framework%3A+Installation+of+Amsterdam+Controller+and+vCPE+Policy) as reference to push CCVPN policies to policy module and updated sdnc.url, username and password in environment(/opt/app/policy/config/controlloop.properties.environment) As per wiki (Policy on OOM), push-policied.sh script is used to install policies. but I observed that CCVPN policy is not added in this script. So merged CCVPN policy using POLICY-1356 JIRA ticket. but policy is pushed by using push-policy_casablanca.sh script during integration test. diff --git a/docs/docs_E2E_network_slicing.rst b/docs/docs_E2E_network_slicing.rst index 04878bd90..76f4a6a9b 100644 --- a/docs/docs_E2E_network_slicing.rst +++ b/docs/docs_E2E_network_slicing.rst @@ -316,4 +316,4 @@ approach will help to install a minimum-scope version ONAP for 5G E2E Slicing use case. Further details of the installation steps are available at: -https://wiki.onap.org/display/DW/How+to+install+5G+E2E+Slicing+Minimum+Scope +https://wiki.onap.org/display/DW/Install+Minimum+Scope+ONAP+for+5G+Network+Slicing diff --git a/docs/docs_scaleout.rst b/docs/docs_scaleout.rst index d3fe9fb41..4e296c95a 100644 --- a/docs/docs_scaleout.rst +++ b/docs/docs_scaleout.rst @@ -111,7 +111,7 @@ Once the configuration blueprint is uploaded to CDS, users can define and onboar zip ../vLB.zip * -For a complete description of service design and creation, please refer to the SDC wiki page: https://wiki.onap.org/display/DW/Design +For a complete description of service design and creation, please refer to the SDC documentation. During the creation of the service in SDC, there are a few extra steps that need to be executed to make the VNF ready for scale out. These require users to login to the SDC Portal as service designer user (username: cs0008, password: demo123456!). @@ -319,7 +319,7 @@ Here is an example of API for the vLB VNF used for this use case. We name the fi To create the VNF template in CDT, the following steps are required: -- Connect to the CDT GUI: http://ANY-K8S-IP:30289 +- Connect to the CDT GUI: http://ANY_K8S_IP:30289 - Click "My VNF" Tab. Create your user ID, if necessary - Click "Create new VNF" entering the VNF type as reported in VID or AAI, e.g. vLoadBalancerMS/vLoadBalancerMS 0 - Select "ConfigScaleOut" action @@ -2053,7 +2053,7 @@ PART 6 - Known Issues and Resolutions Resolution: Change TCA configuration for the old vLB/vDNS use case -- Connect to Consul: http://:30270 and click on "Key/Value" → "dcae-tca-analytics" +- Connect to Consul: http://ANY_K8S_IP:30270 and click on "Key/Value" → "dcae-tca-analytics" - Change "eventName" in the vLB default policy to something different, for example "vLB" instead of the default value "vLoadBalancer" - Change "subscriberConsumerGroup" in the TCA configuration to something different, for example "OpenDCAE-c13" instead of the default value "OpenDCAE-c12" - Click "UPDATE" to upload the new TCA configuration diff --git a/docs/docs_vCPE with Tosca VNF.rst b/docs/docs_vCPE with Tosca VNF.rst deleted file mode 100644 index 85b2cbe3b..000000000 --- a/docs/docs_vCPE with Tosca VNF.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. _docs_vcpe_tosca: - -vCPE with Tosca VNF ----------------------------- - -VNF Packages and NS Packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE - -5 VNFs are here for the ONAP vCPE use case. This VNFD is transformed manually from vCPE heat template. -Please run "./generate_csar.sh" to create the CSAR package files for these 5 VNFS. CSAR package file is just a zip formatted file. If you want to use SRIOV SRIOV-NIC", please run "./generate_csar.sh sriov" to create the CSAR package files for SRIOV. -All the generated VNF packges can be found in the following link: -- VNF packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide -- NS packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide - -Description -~~~~~~~~~~~ -The vCPE with Tosca VNF shows how to use ONAP to deploy tosca based vCPE. ONAP Casablanca release supports deployment,termination and manual heal Tosca based vCPE. User can trigger the above operation via UUI. and User can first chose Network serivce type and conrresponding service template in UUI and then UUI will directly invoke VF-C Northbound interfaces to do the life cycle management. In Casablanca release, we bypass SO, in the following release, we can add SO to the workflow. The main projects involved in this use case include: SDC, A&AI, UUI，VF-C, Multicloud，MSB, Policy，OOF. -The use case is composed of five virtual functions (VFs): Infrastructure including vDNS, vDHCP, vAAA(Authorization, Authentication, Accounting) and vWEB, vBNG(Virtual Broadband Network Gateway), vGMUX(Virtual Gateway Multiplexer), vBRGEMU(Bridged Residential Gateway) and vGW(Virtual Gateway). Infrastructure VF run in one VM. the other VFs run in separate four VMs. We will send much data from vBRGEMU to vGW. we need to accelarate it using SRIOV-NIC. -The original vCPE Use Case Wiki Page can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=3246168 - -How to Use -~~~~~~~~~~ - - -Configuration: -~~~~~~~~~~~~~~ -1) VIM Configuration -If you want to use SRIOV-NIC, you need first config SRIOV NIC to refer to [1]. -[1] https://docs.openstack.org/ocata/networking-guide/config-sriov.html - -ONAP managing 1 cloud-region which have three flavors. -Flavor 11: -2 vcpus, 1 Gbytes of memory, 20Gb disk -Numa page size: 2Mbytes and number pages 512 -:: - - openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2 - -Flavor 12: -2 vcpus, 2 Gbytes of memory, 20Gb disk -Numa page size: 2Mbytes and number pages 1024 -:: - - openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2 - -Flavor 13: -2 vcpus, 4 Gbytes of memory, 20Gb disk -Huge page size: 2Mbytes and number pages 2048 -1 SRIOV-NIC VF -:: - - openstack flavor create onap.hpa.flavor13 -id auto --ram 4096 --disk 20 -vcpus 2 - openstack flavor set onap.hpa.flavor11 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 - openstack aggregate create --property sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 hpa_aggr11 - -comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network. - -2)Policy Configuration -After the patch https://gerrit.onap.org/r/#/c/73502/ is merged. With the generated policy and do some manually update as follows, the service could be distributed successfully and the Policy/VFC/OOF could work as excepted. - -- Need manually modify policy item because the “vendor id” and “PCI device id” and “architecture” must be changed in different VIMs since we have different PCI devices in different VIMs -- The value of mandatory in CSAR is “true”, OOF is case intensive, it needs to use “True”. Have to update it. suggest OOF to use ignoreCase in R4. -- The attribute key in CSAR is pciNumDevices, but the responding one in OOF/Mutlicloud is pciCount. Suggest keeping alignment in R4. -- The policy scope has to add a value “us” into it which is a configuration issue in OOF side. Policy side also need do improvement to deal with policy scope automatically append instead of replacement so such policy could be used by several services at the same time. - -Design Time: -~~~~~~~~~~~~ -1) Because SDC doesn't export ETSI aigned VNF package and NS package, so in this release, 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. - -Run Time: -~~~~~~~~~ -1) First onboard VNF/NS package from SDC to VF-C catalog in sequence. -2) Trigger the NS operation via UUI - -More details can be fonud here: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide - -Test Status and Plans -~~~~~~~~~~~~~~~~~~~~~ -The test plan 3 in https://wiki.onap.org/pages/viewpage.action?pageId=41421112. -Test Plan 3: VF-C HPA testing -This test plan covers the tests related to testing -Support for the vCPE use case in VF-C -Use vCPE (Infra, vGW, vBNG, vBRGEMU and vGMUX) - -Infra part of policy asking for: -:: - - 2 vcpus - >= 2Gbytes of memory - > 40Gbytes of disk - -vGW part of policy asking for: -:: - - 2 vcpus - >=4Gbytes of memory - >= 40Gbytes of disk - Numa page size: 2Mbytes and pages 1024 - with one SRIOV-NIC - -vBNG part of policy asking for: -:: - - 2 vcpus - >= 2Gbytes of memory - > 40Gbytes of disk - Numa page size: 2Mbytes and pages 1024 - with one SRIOV-NIC - -vBGREMU part of policy asking for: -:: - - 2 vcpus - >= 2Gbytes of memory - >= 40Gbytes of disk - Numa page size: 2Mbytes and pages 1024 - with one SRIOV-NIC - -vGMUX part of policy asking for: -:: - - 2 vcpus - >= 2Gbytes of memory - > 40Gbytes of disk - Numa page size: 2Mbytes and pages 1024 - with one SRIOV-NIC - -Instantiate the VNF -Check for results: -It would have selected flavor13 for vGW, vBNG, vBRGEMU and vGMUX VMs. It would have selected flavor13 and flavor12 for Infrastructure. - -This case completed all tests as found here: https://wiki.onap.org/display/DW/vCPE+with+TOSCA+VNF+Integration+Test++-+Test+status - -Known Issues and Resolutions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Some SDC NS data model is not aligned to VFC NS data model, VFC NS also according to ETSI SOL0001. we also can refer to https://jira.onap.org/browse/SDC-1897. we have a workaround for this issue, we put the service as artifact file and distribute to VFC. -- NFV Tosca parser bug https://jira.opnfv.org/browse/PARSER-187. we also filed a bug in VFC https://jira.onap.org/browse/VFC-1196. -- 'artifacts' definition is missing in the exported csar's VDU node, we also can refer to https://jira.onap.org/browse/SDC-1900. It’s a very hacky workaround in VFC’s GVFNM. Because currently the only use case will use GVFNM is vCPE, which only uses the ubuntu16.04 image, so GVFNM just makes the ubuntu16.04 image as the default if the "sw_image" artifact is missing in the SDC’s exported CSAR. -- OOF patch https://gerrit.onap.org/r/#/c/73332/ is not accepted by 1.2.4 image. 1.2.5 is available in nexus3 repo. But not available in Casablanca release. If you want to use it, you can use 1.2.5-SNAPSHOT-latest. If you use 1.2.4 image, you also need to modify code according to the patch. -- vnflcm notification error patch https://gerrit.onap.org/r/#/c/73852/ -- grant error patch not merged into VF-C 1.2.2 image: https://gerrit.onap.org/r/#/c/73833/ and https://gerrit.onap.org/r/#/c/73770/ -- VF-C catalog config should be updated with the right SDC URL and user/pwd - Resolution: Disable VFC catalog livenessprobe and update configuration - -a) edit dev-vfc-catalog deployment -b) remove livenessprobe section -c) enter into catalog pod and update configuration - -:: - - kubectl -n onap exec -it dev-vfc-catalog-6978b76c86-87722 /bin/bash - config file location: service/vfc/nfvo/catalog/catalog/pub/config/config.py - Update the SDC configuration as follows: - SDC_BASE_URL = "http://msb-iag:80/api" - SDC_USER = "aai" - SDC_PASSWD = "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U" diff --git a/docs/docs_vCPE_with_Tosca_VNF.rst b/docs/docs_vCPE_with_Tosca_VNF.rst new file mode 100644 index 000000000..a62001fc7 --- /dev/null +++ b/docs/docs_vCPE_with_Tosca_VNF.rst @@ -0,0 +1,159 @@ +.. _docs_vcpe_tosca: + +vCPE with Tosca VNF +---------------------------- + +VNF Packages and NS Packages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +vCPE tosca file url: https://git.onap.org/demo/tree/tosca/vCPE + +5 VNFs are here for the ONAP vCPE use case. This VNFD is transformed manually from vCPE heat template. +Please run "./generate_csar.sh" to create the CSAR package files for these 5 VNFS. CSAR package file is just a zip formatted file. If you want to use SRIOV SRIOV-NIC", please run "./generate_csar.sh sriov" to create the CSAR package files for SRIOV. +All the generated VNF packges can be found in the following link: +- VNF packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide +- NS packages: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide + +Description +~~~~~~~~~~~ +The vCPE with Tosca VNF shows how to use ONAP to deploy tosca based vCPE. ONAP Casablanca release supports deployment,termination and manual heal Tosca based vCPE. User can trigger the above operation via UUI. and User can first chose Network serivce type and conrresponding service template in UUI and then UUI will directly invoke VF-C Northbound interfaces to do the life cycle management. In Casablanca release, we bypass SO, in the following release, we can add SO to the workflow. The main projects involved in this use case include: SDC, A&AI, UUI，VF-C, Multicloud，MSB, Policy，OOF. +The use case is composed of five virtual functions (VFs): Infrastructure including vDNS, vDHCP, vAAA(Authorization, Authentication, Accounting) and vWEB, vBNG(Virtual Broadband Network Gateway), vGMUX(Virtual Gateway Multiplexer), vBRGEMU(Bridged Residential Gateway) and vGW(Virtual Gateway). Infrastructure VF run in one VM. the other VFs run in separate four VMs. We will send much data from vBRGEMU to vGW. we need to accelarate it using SRIOV-NIC. +The original vCPE Use Case Wiki Page can be found here: https://wiki.onap.org/pages/viewpage.action?pageId=3246168 + +How to Use +~~~~~~~~~~ + + +Configuration: +~~~~~~~~~~~~~~ +1) VIM Configuration +If you want to use SRIOV-NIC, you need first config SRIOV NIC to refer to [1]. +[1] https://docs.openstack.org/ocata/networking-guide/config-sriov.html + +ONAP managing 1 cloud-region which have three flavors. +Flavor 11: +2 vcpus, 1 Gbytes of memory, 20Gb disk +Numa page size: 2Mbytes and number pages 512 +:: + + openstack flavor create onap.hpa.flavor11 -id auto --ram 1024 --disk 20 --vcpus 2 + +Flavor 12: +2 vcpus, 2 Gbytes of memory, 20Gb disk +Numa page size: 2Mbytes and number pages 1024 +:: + + openstack flavor create onap.hpa.flavor12 -id auto --ram 2048 --disk 20 --vcpus 2 + +Flavor 13: +2 vcpus, 4 Gbytes of memory, 20Gb disk +Huge page size: 2Mbytes and number pages 2048 +1 SRIOV-NIC VF +:: + + openstack flavor create onap.hpa.flavor13 -id auto --ram 4096 --disk 20 -vcpus 2 + openstack flavor set onap.hpa.flavor11 --property aggregate_instance_extra_specs:sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 + openstack aggregate create --property sriov_nic=sriov-nic-intel-1234-5678-physnet1:1 hpa_aggr11 + +comments: you must change 1234 and 5678 to real vendor id and product id. you also need change physnet1 to the provider network. + +2)Policy Configuration +After the patch https://gerrit.onap.org/r/73502/ is merged. With the generated policy and do some manually update as follows, the service could be distributed successfully and the Policy/VFC/OOF could work as excepted. + +- Need manually modify policy item because the “vendor id” and “PCI device id” and “architecture” must be changed in different VIMs since we have different PCI devices in different VIMs +- The value of mandatory in CSAR is “true”, OOF is case intensive, it needs to use “True”. Have to update it. suggest OOF to use ignoreCase in R4. +- The attribute key in CSAR is pciNumDevices, but the responding one in OOF/Mutlicloud is pciCount. Suggest keeping alignment in R4. +- The policy scope has to add a value “us” into it which is a configuration issue in OOF side. Policy side also need do improvement to deal with policy scope automatically append instead of replacement so such policy could be used by several services at the same time. + +Design Time: +~~~~~~~~~~~~ +1) Because SDC doesn't export ETSI aigned VNF package and NS package, so in this release, 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. + +Run Time: +~~~~~~~~~ +1) First onboard VNF/NS package from SDC to VF-C catalog in sequence. +2) Trigger the NS operation via UUI + +More details can be fonud here: https://wiki.onap.org/display/DW/vCPE+with+Tosca+VNF+Test+Guide + +Test Status and Plans +~~~~~~~~~~~~~~~~~~~~~ +The test plan 3 in https://wiki.onap.org/pages/viewpage.action?pageId=41421112. +Test Plan 3: VF-C HPA testing +This test plan covers the tests related to testing +Support for the vCPE use case in VF-C +Use vCPE (Infra, vGW, vBNG, vBRGEMU and vGMUX) + +Infra part of policy asking for: +:: + + 2 vcpus + >= 2Gbytes of memory + > 40Gbytes of disk + +vGW part of policy asking for: +:: + + 2 vcpus + >=4Gbytes of memory + >= 40Gbytes of disk + Numa page size: 2Mbytes and pages 1024 + with one SRIOV-NIC + +vBNG part of policy asking for: +:: + + 2 vcpus + >= 2Gbytes of memory + > 40Gbytes of disk + Numa page size: 2Mbytes and pages 1024 + with one SRIOV-NIC + +vBGREMU part of policy asking for: +:: + + 2 vcpus + >= 2Gbytes of memory + >= 40Gbytes of disk + Numa page size: 2Mbytes and pages 1024 + with one SRIOV-NIC + +vGMUX part of policy asking for: +:: + + 2 vcpus + >= 2Gbytes of memory + > 40Gbytes of disk + Numa page size: 2Mbytes and pages 1024 + with one SRIOV-NIC + +Instantiate the VNF +Check for results: +It would have selected flavor13 for vGW, vBNG, vBRGEMU and vGMUX VMs. It would have selected flavor13 and flavor12 for Infrastructure. + +This case completed all tests as found here: https://wiki.onap.org/display/DW/vCPE+with+TOSCA+VNF+Integration+Test++-+Test+status + +Known Issues and Resolutions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Some SDC NS data model is not aligned to VFC NS data model, VFC NS also according to ETSI SOL0001. we also can refer to https://jira.onap.org/browse/SDC-1897. we have a workaround for this issue, we put the service as artifact file and distribute to VFC. +- NFV Tosca parser bug https://jira.opnfv.org/browse/PARSER-187. we also filed a bug in VFC https://jira.onap.org/browse/VFC-1196. +- 'artifacts' definition is missing in the exported csar's VDU node, we also can refer to https://jira.onap.org/browse/SDC-1900. It’s a very hacky workaround in VFC’s GVFNM. Because currently the only use case will use GVFNM is vCPE, which only uses the ubuntu16.04 image, so GVFNM just makes the ubuntu16.04 image as the default if the "sw_image" artifact is missing in the SDC’s exported CSAR. +- OOF patch https://gerrit.onap.org/r/73332/ is not accepted by 1.2.4 image. 1.2.5 is available in nexus3 repo. But not available in Casablanca release. If you want to use it, you can use 1.2.5-SNAPSHOT-latest. If you use 1.2.4 image, you also need to modify code according to the patch. +- vnflcm notification error patch https://gerrit.onap.org/r/73852/ +- grant error patch not merged into VF-C 1.2.2 image: https://gerrit.onap.org/r/73833/ and https://gerrit.onap.org/r/73770/ +- VF-C catalog config should be updated with the right SDC URL and user/pwd + Resolution: Disable VFC catalog livenessprobe and update configuration + +a) edit dev-vfc-catalog deployment +b) remove livenessprobe section +c) enter into catalog pod and update configuration + +:: + + kubectl -n onap exec -it dev-vfc-catalog-6978b76c86-87722 /bin/bash + config file location: service/vfc/nfvo/catalog/catalog/pub/config/config.py + Update the SDC configuration as follows: + SDC_BASE_URL = "http://msb-iag:80/api" + SDC_USER = "aai" + SDC_PASSWD = "Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U" diff --git a/docs/docs_vFWDT.rst b/docs/docs_vFWDT.rst index 4eeba7b84..35fae7715 100755 --- a/docs/docs_vFWDT.rst +++ b/docs/docs_vFWDT.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 - + .. _docs_vfw_traffic: .. contents:: @@ -13,11 +13,11 @@ Description ~~~~~~~~~~~ The purpose of this work is to show Traffic Distribiution functionality implemented in Casablanca and Dublin releases for vFW Use Case. -The orchstration workflow triggers a change to traffic distribution (redistribution) done by a traffic balancing/distribution entity (aka anchor point). -The DistributeTraffic action targets the traffic balancing/distribution entity, in some cases DNS, other cases a load balancer external to the VNF instance, as examples. -Traffic distribution (weight) changes intended to take a VNF instance out of service are completed only when all in-flight traffic/transactions have been completed. -DistributeTrafficCheck command may be used to verify initial conditions of redistribution or can be used to verify the state of VNFs and redistribution itself. -To complete the traffic redistribution process, gracefully taking a VNF instance out-of-service/into-service, without dropping in-flight calls or sessions, +The orchstration workflow triggers a change to traffic distribution (redistribution) done by a traffic balancing/distribution entity (aka anchor point). +The DistributeTraffic action targets the traffic balancing/distribution entity, in some cases DNS, other cases a load balancer external to the VNF instance, as examples. +Traffic distribution (weight) changes intended to take a VNF instance out of service are completed only when all in-flight traffic/transactions have been completed. +DistributeTrafficCheck command may be used to verify initial conditions of redistribution or can be used to verify the state of VNFs and redistribution itself. +To complete the traffic redistribution process, gracefully taking a VNF instance out-of-service/into-service, without dropping in-flight calls or sessions, QuiesceTraffic/ResumeTraffic command may need to follow traffic distribution changes. The VNF application remains in an active state. @@ -55,8 +55,8 @@ The purpose of the work in the Dublin release was to built a Traffic Distributio The prepared Traffic Distribution Workflow has following steps: -- Workflow sends placement request to Optimization Framework (**1**) specific information about the vPKG and vFW-SINK models and VNF-ID of vFW that we want to migrate traffic out from. - Optimization Framework role is to find the vFW-SINK VNF/VF-module instance where traffic should be migrated to and vPKG which will be associated with this vFW. +- Workflow sends placement request to Optimization Framework (**1**) specific information about the vPKG and vFW-SINK models and VNF-ID of vFW that we want to migrate traffic out from. + Optimization Framework role is to find the vFW-SINK VNF/VF-module instance where traffic should be migrated to and vPKG which will be associated with this vFW. Although in our case the calculation is very simple, the mechanism is ready to work for instances of services with VNF having houndreds of VF-modules spread accross different cloud regions. - Optimization Framework takes from the Policy Framework policies (**2-3**) for VNFs and for relations between each other (in our case there is checked ACTIVE status of vFW-SINK and vPKG VF-modules and the Region to which they belong) @@ -88,7 +88,7 @@ In order to setup the scenario and to test the DistributeTraffic LCM API in acti #. Configure Ansible Server to work with vPKG and vFW VMs -#. Execute Traffic Distribution Workflow +#. Execute Traffic Distribution Workflow You will use the following ONAP K8s VMs or containers: @@ -168,7 +168,7 @@ Go to the Rancher node and locate *demo-k8s.sh* script in *oom/kubernetes/robot* ./ete-k8s.sh onap instantiateVFWDT -.. note:: You can verify the status of robot's service instantiation process by going to http://:30209/logs/ (login/password: test/test) +.. note:: You can verify the status of robot's service instantiation process by going to http://K8S_NODE_IP:30209/logs/ (login/password: test/test) After successful instantiation of vFWDT service go to the OpenStack dashboard and project which is configured for VNFs deployment and locate vFWDT VMs. Choose one and try to ssh into one them to proove that further ansible configuration action will be possible @@ -231,8 +231,8 @@ Gathering facts from VID Portal 1. Enter the VID portal -:: - +:: + https://:30200/vid/welcome.htm 2. In the left hand menu enter **Search for Existing Service Instances** @@ -388,7 +388,7 @@ The result can be verified in the Policy portal, in the *Editor* section, after Testing Gathered Facts on Workflow Script ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Having collected *vnf-id* and *vnf-type* parameters we can execute Traffic Distribution Workflow Python script. It works in two modes. First one executes ony initial phase where AAI and OOF +Having collected *vnf-id* and *vnf-type* parameters we can execute Traffic Distribution Workflow Python script. It works in two modes. First one executes ony initial phase where AAI and OOF is used to collect neccessary information for configuration of APPC and for further execution phase. The second mode performs also second phase which executes APPC LCM actions. At this stage we will execute script in the initial mode to generate some configuration helpful in CDT and Ansible configuration. @@ -409,7 +409,7 @@ For now and for further use workflow script has following input parameters: - if only configuration information will be collected (True for initial phase and False for full execution of workflow) - if APPC LCM action status should be verified and FAILURE should stop workflow (when False FAILED status of LCM action does not stop execution of further LCM actions) -2. The script at this stage should give simmilar output +2. The script at this stage should give simmilar output :: @@ -446,7 +446,7 @@ For now and for further use workflow script has following input parameters: vofwl01vfw4407 ansible_ssh_host=10.0.110.1 ansible_ssh_user=ubuntu vofwl02vfw4407 ansible_ssh_host=10.0.110.4 ansible_ssh_user=ubuntu -The result should have almoast the same information for *vnf-id's* of both vFW VNFs. *vnf-type* for vPKG and vFW VNFs should be the same like those collected in previous steps. +The result should have almoast the same information for *vnf-id's* of both vFW VNFs. *vnf-type* for vPKG and vFW VNFs should be the same like those collected in previous steps. Ansible Inventory section contains information about the content Ansible Inventor file that will be configured later on `Configuration of Ansible Server`_ Configuration of VNF in the APPC CDT tool @@ -506,9 +506,9 @@ Following steps aim to configure DistributeTraffic LCM action for our vPKG and v "PlaybookName": "${()=(book_name)}", "NodeList": [{ "vm-info": [{ - "ne_id": "${()=(ne_id)}", + "ne_id": "${()=(ne_id)}", "fixed_ip_address": "${()=(fixed_ip_address)}" - }], + }], "site": "site", "vnfc-type": "vpgn" }], @@ -579,7 +579,7 @@ After an instantiation of the vFWDT service the Ansible server must be configure chmod 400 onap.pem chown ansible:ansible onap.pem -4. Edit the :file:`/opt/ansible-server/Playbooks/Ansible\ \_\ inventory` file including all the hosts of vFWDT service instance used in this use case. +4. Edit the :file:`/opt/ansible-server/Playbooks/Ansible\ \_\ inventory` file including all the hosts of vFWDT service instance used in this use case. The content of the file is generated by workflow script `Testing Gathered Facts on Workflow Script`_ :: @@ -608,7 +608,7 @@ After an instantiation of the vFWDT service the Ansible server must be configure .. note:: This is the default privaye key file. In the `/opt/ansible-server/Playbooks/Ansible\ \_\ inventory` different key could be configured but APPC in time of execution of playbbok on Ansible server creates its own dedicated inventory file which does not have private key file specified. In consequence, this key file configured is mandatory for proper execution of playbooks by APPC -6. Test that the Ansible server can access over ssh vFWDT hosts configured in the ansible inventory +6. Test that the Ansible server can access over ssh vFWDT hosts configured in the ansible inventory :: @@ -704,8 +704,8 @@ Result should be simmilar to the following one: Testing Traffic Distribution Workflow ------------------------------------- -Since all the configuration of components of ONAP is already prepared it is possible to enter second phase of Traffic Distribution Workflow execution - -the execution of DistributeTraffic and DistributeTrafficCheck LCM actions with configuration resolved before by OptimizationFramework. +Since all the configuration of components of ONAP is already prepared it is possible to enter second phase of Traffic Distribution Workflow execution - +the execution of DistributeTraffic and DistributeTrafficCheck LCM actions with configuration resolved before by OptimizationFramework. Workflow Execution @@ -727,7 +727,7 @@ The order of executed LCM actions is following: change of the traffic should be observed on following dashboards (please turn on automatic reload of graphs) :: - + http://:667/ http://:667/ diff --git a/docs/docs_vFW_CNF_CDS.rst b/docs/docs_vFW_CNF_CDS.rst index 601224167..9b9543685 100644 --- a/docs/docs_vFW_CNF_CDS.rst +++ b/docs/docs_vFW_CNF_CDS.rst @@ -1293,7 +1293,7 @@ Multiple lower level bugs/issues were also found during use case development .. _vFW EDGEX K8S In ONAP Wiki: https://wiki.onap.org/display/DW/Deploying+vFw+and+EdgeXFoundry+Services+on+Kubernets+Cluster+with+ONAP .. _KUD readthedocs: https://docs.onap.org/en/frankfurt/submodules/multicloud/k8s.git/docs .. _KUD in Wiki: https://wiki.onap.org/display/DW/Kubernetes+Baremetal+deployment+setup+instructions -.. _Multicloud k8s gerrit: https://gerrit.onap.org/r/#/q/status:open+project:+multicloud/k8s +.. _Multicloud k8s gerrit: https://gerrit.onap.org/r/q/status:open+project:+multicloud/k8 .. _KUD subproject in github: https://github.com/onap/multicloud-k8s/tree/master/kud .. _KUD Jenkins ci/cd verification: https://jenkins.onap.org/job/multicloud-k8s-master-kud-deployment-verify-shell/ .. _SO Cloud Region Selection: https://git.onap.org/so/tree/adapters/mso-openstack-adapters/src/main/java/org/onap/so/adapters/vnf/MsoVnfPluginAdapterImpl.java?h=elalto#n1149 @@ -1301,7 +1301,7 @@ Multiple lower level bugs/issues were also found during use case development .. _Jira Epic: https://jira.onap.org/browse/INT-1184 .. _Data Dictionary: https://git.onap.org/demo/tree/heat/vFW_CNF_CDS/templates/cba-dd.json?h=frankfurt .. _Helm Healer: https://git.onap.org/oom/offline-installer/tree/tools/helm-healer.sh -.. _CDS UAT Testing: https://wiki.onap.org/display/DW/Modeling+Concepts#Concepts-2603186 +.. _CDS UAT Testing: https://wiki.onap.org/display/DW/Modeling+Concepts .. _postman.zip: files/vFW_CNF_CDS/postman.zip .. _logs.zip: files/vFW_CNF_CDS/logs.zip .. _SDC-2776: https://jira.onap.org/browse/SDC-2776 diff --git a/docs/docs_vfw.rst b/docs/docs_vfw.rst index b9ed9adb7..ec46e5c64 100644 --- a/docs/docs_vfw.rst +++ b/docs/docs_vfw.rst @@ -28,7 +28,7 @@ These VFs run in three separate VMs. The packet generator sends packets to the packet sink through the firewall. The firewall reports the volume of traffic passing though to the ONAP DCAE collector. To check the traffic volume that lands at the sink VM, you can access -the link http://sink_ip_address:667 through your browser and enable automatic page +the link through your browser and enable automatic page refresh by clicking the "Off" button. You can see the traffic volume in the charts. The packet generator includes a script that periodically generates different @@ -60,7 +60,7 @@ operation policies that are currently enabled for the vFirewall use case: operational policy to request APPC to adjust the traffic volume to 500 packets per 10 seconds. - APPC sends a request to the packet generator to adjust the traffic volume. -- Changes to the traffic volume can be observed through the link http://sink_ip_address:667. +- Changes to the traffic volume can be observed through the link . Adjust packet generator @@ -130,7 +130,7 @@ expire. Monitoring the DMaaP topic for DCAE_CL_OUTPUT can be used to confirm that no TCA events are coming in from the VNF through VES/TCA. :: - http://:30227/events/unauthenticated.DCAE_CL_OUTPUT/g1/c3?timeout=5000 + http://K8S_HOST:30227/events/unauthenticated.DCAE_CL_OUTPUT/g1/c3?timeout=5000 +-------------+------------+ | JIRA ID | Status | diff --git a/docs/docs_vfwHPA.rst b/docs/docs_vfwHPA.rst index 35cea9d6a..015b725e6 100644 --- a/docs/docs_vfwHPA.rst +++ b/docs/docs_vfwHPA.rst @@ -18,7 +18,7 @@ This tutorial covers enhancements 1 to 5 in Background of https://wiki.onap.org/ `HPA Enhancements Page `_ -`vFW with HPA Test Status Page `_ +`vFW with HPA Test Status Page `_ `Hardware Platform Enablement in ONAP `_ diff --git a/docs/heat.rst b/docs/heat.rst index 78796df95..cb34c87cc 100644 --- a/docs/heat.rst +++ b/docs/heat.rst @@ -4,8 +4,10 @@ ONAP HEAT Template Source files ~~~~~~~~~~~~ -- Template file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml -- Environment file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env +- 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 ~~~~~~~~~~~ @@ -233,4 +235,3 @@ or Command Line. 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/onap-oom-heat.rst b/docs/onap-oom-heat.rst index 8bccec796..288ef770b 100644 --- a/docs/onap-oom-heat.rst +++ b/docs/onap-oom-heat.rst @@ -1,4 +1,4 @@ -Integration Environement Installation +Integration Environment Installation ------------------------------------- ONAP is deployed on top of kubernetes through the OOM installer. @@ -14,7 +14,7 @@ are provided, they correspond to files used on windriver environment. This environment is used by the integration team to validate the installation, perform tests and troubleshoot. -If you intend to deploy your own environement, they can be used as reference but +If you intend to deploy your own environment, they can be used as reference but must be adapted according to your context. Source files @@ -22,7 +22,7 @@ Source files - HEAT template files: https://git.onap.org/integration/tree/deployment/heat/onap-rke?h=elalto - Sample OpenStack RC file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/Integration-SB-00-openrc?h=elalto -- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=elatlo +- Sample environment file: https://git.onap.org/integration/tree/deployment/heat/onap-rke/env/windriver/onap-oom.env?h=elalto - Deployment script: https://git.onap.org/integration/tree/deployment/heat/onap-rke/scripts/deploy.sh?h=elalto @@ -31,7 +31,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 -:ref:`ONAP Operations Manager (OOM) over Kubernetes`. +OOM documentation (https://docs.onap.org/en/elalto/guides/onap-developer/settingup/index.html#installing-onap). 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/tox.ini b/tox.ini index ee7cbe0e6..ee2b4c008 100644 --- a/tox.ini +++ b/tox.ini @@ -38,8 +38,10 @@ commands = [testenv:rst] commands_pre = /bin/sh -c "git --no-pager diff HEAD HEAD^ --name-only '*.rst' > /tmp/.coalist_rst" +deps = -r ./docs/requirements-docs.txt commands = - /bin/bash -c "coala --non-interactive --disable-caching --no-autoapply-warn rst --files $(