summaryrefslogtreecommitdiffstats
path: root/docs/all_vnfrqts_seed_docs
diff options
context:
space:
mode:
authorrr929y <rr929y@att.com>2017-08-24 13:52:20 -0500
committerrr929y <rr929y@att.com>2017-08-24 13:52:20 -0500
commitcb73bf7bbed1df4c992b67285345fd4ced7a693e (patch)
treedc99c918cdf7e31e4c67883fb6b51ee6ced1098d /docs/all_vnfrqts_seed_docs
parent73be7afbed93a74e02ab46b80baaf823ea55942f (diff)
VNFRQTS Guidelines - Linkcheck/Tox Errors
VNFRQTS Guidelines - Fixed broken links and stubs for linck check, as well as rst formatting for tox Change-Id: I18ff54159a2dc2dd542f86ad6c7b17fc775452dd Issue-ID:VNFRQTS-75 Signed-off-by: rr929y <rr929y@att.com>
Diffstat (limited to 'docs/all_vnfrqts_seed_docs')
-rw-r--r--docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_Mgmt_Requirements_for_OpenO/VNF_Management_Requirements_for_OpenO_4_27_2017_clean.rst77
-rw-r--r--docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_TOSCA_Templates_for_OpenO/VNF_TOSCA_Template_Requirements_for_OpenO_4_27_2017_clean.rst9
-rw-r--r--docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Guidelines_for_Network_Cloud_and_ONAP/VNF_Guidelines_for_Network_Cloud_and_ONAP_7_3_17.rst2
-rw-r--r--docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Managment_Requirements_for_OpenECOMP/VNF_Management_Requirements_for_OpenECOMP_7_3_2017.rst6
4 files changed, 37 insertions, 57 deletions
diff --git a/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_Mgmt_Requirements_for_OpenO/VNF_Management_Requirements_for_OpenO_4_27_2017_clean.rst b/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_Mgmt_Requirements_for_OpenO/VNF_Management_Requirements_for_OpenO_4_27_2017_clean.rst
index 7aa5dd2..f32d9b6 100644
--- a/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_Mgmt_Requirements_for_OpenO/VNF_Management_Requirements_for_OpenO_4_27_2017_clean.rst
+++ b/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_Mgmt_Requirements_for_OpenO/VNF_Management_Requirements_for_OpenO_4_27_2017_clean.rst
@@ -2,13 +2,7 @@
:depth: 3
..
-\ **VNF Management Requirements for OpenO**
-
-**
-**
-
-**
-**
+**VNF Management Requirements for OpenO**
Introduction
============
@@ -41,7 +35,7 @@ and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization
1. .. rubric:: GVNFM Scenario
:name: gvnfm-scenario
- 1. \ **VNF Develop Steps**
+ 1. **VNF Develop Steps**
Aid to help the VNF vendor to fasten the integration with the GVNFM, the
OpenO provides the VNF SDK tools, and the documents. In this charter,
@@ -65,12 +59,12 @@ Note:
2. The monitoring and scale policy also be provide the next release.
- 1. \ **VNF Rest api**
+ 1. **VNF Rest api**
The VNF must provide a rest api to support initial configuration over
HTTP(s).
-1. \ **Set Initial Configuration**
+1. **Set Initial Configuration**
+-----------------+---------------------------------------------+
| If Definition | Description |
@@ -106,7 +100,7 @@ HTTP(s).
| | | | | VNF configurable properties. |
+-------------------+-------------+---------------+-----------------------------+---------------------------------------------+
-\ **CpConfiguration:**
+**CpConfiguration:**
+-------------+-------------+---------------+--------------+-----------------------------------------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
@@ -122,8 +116,6 @@ HTTP(s).
| cpAddress | M | 1..N | CpAddress | Address and Port assigned to the CP. |
+-------------+-------------+---------------+--------------+-----------------------------------------------------------------------------+
-**
-**
**CpAddress:**
@@ -151,9 +143,6 @@ HTTP(s).
| | | | | Reserved |
+---------------------+-------------+---------------+------------------+-----------------------------------------------------------------------------------------------------+
-**
-**
-
**VnfConfigurableProperties:**
+----------------+-------------+---------------+-----------+-----------------------------------------------------------------------------------------------+
@@ -447,7 +436,7 @@ HTTP(s).
}
-1. \ **Response Code**
+1. **Response Code**
+-----------+-----------------------+-------------------------------------------------------+
| Code | Meaning | Description |
@@ -460,7 +449,7 @@ HTTP(s).
1. .. rubric:: SVNFM Scenario
:name: svnfm-scenario
- 1. \ **VNFM Driver Develop Steps**
+ 1. **VNFM Driver Develop Steps**
Aid to help the VNF vendor to fasten the integration with the NFVO via
Special VNFM, the OpenO provides the documents. In this charter, the
@@ -476,7 +465,7 @@ SVNFM. The interface of NFVO is aligned to the ETSI IFA interfaces and
can be gotten in the charter 5.5. The interface of SVNFM is provided by
the VNF vendor self.
-1. \ **Create SVNFM Adaptor Mircoservice**
+1. **Create SVNFM Adaptor Mircoservice**
Some vnfs are managed by special vnfm, before add svnfm to openo, a
svnfm adaptor must be added to openo to adapter the interface of nfvo
@@ -518,7 +507,7 @@ POST /openoapi/microservices/v1/services
A svnfm
-1. \ **Interfaces provided by SVNFM Driver**\
+1. **Interfaces provided by SVNFM Driver**
Interfaces use RESTful API and the format is as follows:
@@ -532,7 +521,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
**juju**
-1. \ **Instantiate VNF**
+1. **Instantiate VNF**
+-----------------+--------------------------------------------------------------------+
| If Definition | Description |
@@ -544,7 +533,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
| Direction | NSLCM->VNFMDriver |
+-----------------+--------------------------------------------------------------------+
-1. \ **Request**
+1. **Request**
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
@@ -580,9 +569,6 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
| cpdId | M | 0..1 | String | Identifier of the external CPD in VNFD |
+----------------+-------------+---------------+-----------+------------------------------------------------------------------------------------------------------------------+
-**
-**
-
**VimInfo:**
+---------------------+---------------------+-----------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -673,7 +659,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
}
- “interfaceEndpoint”:”http://10.43.21.105:80/”
+ “interfaceEndpoint”:”<interface endpoint url>”
}
@@ -689,7 +675,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
}
-1. \ **Response**
+1. **Response**
+-----------------+-------------+---------------+--------------+---------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
@@ -709,7 +695,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
}
-1. \ **Terminate VNF**
+1. **Terminate VNF**
+-----------------+----------------------------------------------------------------------------------------------+
| IF Definition | Description |
@@ -721,7 +707,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
| Direction | NSLCM->VNFMDriver |
+-----------------+----------------------------------------------------------------------------------------------+
-1. \ **Request**
+1. **Request**
+------------------------------+-------------+---------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
@@ -751,7 +737,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
}
-1. \ **Response**
+1. **Response**
+-------------+-------------+---------------+--------------+---------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
@@ -767,7 +753,7 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
}
-1. \ **Query VNF**
+1. **Query VNF**
+-----------------+------------------------------------------------------------------------------------+
| IF Definition | Description |
@@ -779,11 +765,11 @@ http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
| Direction | NSLCM->VNFMDriver |
+-----------------+------------------------------------------------------------------------------------+
-1. \ **Request**
+1. **Request**
VNF filter: vnfInstanceId via url [R1]
-1. \ **Response**
+1. **Response**
+-------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
@@ -855,7 +841,7 @@ VNF filter: vnfInstanceId via url [R1]
}
-1. \ **Get operation status**
+1. **Get operation status**
+-----------------+-------------------------------------------------------------------------------------------------------+
| IF Definition | Description |
@@ -867,11 +853,11 @@ VNF filter: vnfInstanceId via url [R1]
| Direction | NSLCM->VNFMDriver |
+-----------------+-------------------------------------------------------------------------------------------------------+
-1. \ **Request**
+1. **Request**
None
-1. \ **Response**
+1. **Response**
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
@@ -963,7 +949,7 @@ None
}
-1. \ **Scale VNF**
+1. **Scale VNF**
+-----------------+------------------------------------------------------------------------------------------+
| If Definition | Description |
@@ -975,9 +961,6 @@ None
| Direction | NSLCM->VNFMDriver |
+-----------------+------------------------------------------------------------------------------------------+
-**
-**
-
1. **Request**
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -999,13 +982,13 @@ None
| | | | | |
| | | | | **Reserved** |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| NOTE 1: ETSI GS NFV-IFA 010 `[2] <#_bookmark7>`__ specifies that the lifecycle management operations that expand or contract a VNF instance include scale in, scale out, scale up and scale down. Vertical scaling (scale up, scale down) is not supported in the present document. |
-| |
-| SCALE\_IN designates scaling in. |
-| |
-| SCALE\_OUT 1 designates scaling out. |
-| |
-| NOTE 2: A scaling step is the smallest unit by which a VNF can be scaled w.r.t a particular scaling aspect. |
+| NOTE 1: ETSI GS NFV-IFA 010 `[2] <#_bookmark7>`__ specifies that the lifecycle management operations that expand or contract a VNF instance include scale in, scale out, scale up and scale down. Vertical scaling (scale up, scale down) is not supported in the present document. |
+| |
+| SCALE\_IN designates scaling in. |
+| |
+| SCALE\_OUT 1 designates scaling out. |
+| |
+| NOTE 2: A scaling step is the smallest unit by which a VNF can be scaled w.r.t a particular scaling aspect. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
{
diff --git a/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_TOSCA_Templates_for_OpenO/VNF_TOSCA_Template_Requirements_for_OpenO_4_27_2017_clean.rst b/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_TOSCA_Templates_for_OpenO/VNF_TOSCA_Template_Requirements_for_OpenO_4_27_2017_clean.rst
index 2bc2d9c..a5008dd 100644
--- a/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_TOSCA_Templates_for_OpenO/VNF_TOSCA_Template_Requirements_for_OpenO_4_27_2017_clean.rst
+++ b/docs/all_vnfrqts_seed_docs/openO/inital_seed_openO/VNF_TOSCA_Templates_for_OpenO/VNF_TOSCA_Template_Requirements_for_OpenO_4_27_2017_clean.rst
@@ -5,8 +5,8 @@
Introduction
============
-This reference document is the ***VNF TOSCA Template Requirements for
-OpenO***, which provides recommendations and standards for building VNF
+This reference document is the *VNF TOSCA Template Requirements for
+OpenO**, which provides recommendations and standards for building VNF
TOSCA templates compatible with OpenO– initial implementations of
Network Cloud. It has the following features:
@@ -1525,9 +1525,6 @@ presentation. Slide 8. With specific rules of “valid\_target\_type”
tosca.artifacts.nfv.SwImage
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-**
-**
-
+---------------------------+------------------------------------+
| **Shorthand Name** | SwImage |
+===========================+====================================+
@@ -1539,7 +1536,7 @@ tosca.artifacts.nfv.SwImage
+---------------------------+------------------------------------+
Properties
-^^^^^^^^^^
+~~~~~~~~~~
+------------------------------------------+------------+--------------------+---------------+----------------------------------------------------------------------------------------------------+
| Name | Required | Type | Constraints | Description |
diff --git a/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Guidelines_for_Network_Cloud_and_ONAP/VNF_Guidelines_for_Network_Cloud_and_ONAP_7_3_17.rst b/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Guidelines_for_Network_Cloud_and_ONAP/VNF_Guidelines_for_Network_Cloud_and_ONAP_7_3_17.rst
index 3eb3268..b8456e9 100644
--- a/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Guidelines_for_Network_Cloud_and_ONAP/VNF_Guidelines_for_Network_Cloud_and_ONAP_7_3_17.rst
+++ b/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Guidelines_for_Network_Cloud_and_ONAP/VNF_Guidelines_for_Network_Cloud_and_ONAP_7_3_17.rst
@@ -843,7 +843,7 @@ number of service providers interested in acquiring VNFs.
We invite feedback on these VNF Guidelines via
`VNFGuidelines@list.att.com <mailto:VNFGuidelines@list.att.com?subject=VNF%20Guidelines%20and%20Requirements%20Feedback>`__.
The ONAP Community has an active project, `VNF
-Requirements <https://wiki.onap.org/display/DW/VNF+Requirements>`__, to
+Requirements <https://wiki.onap.org/display/DW/VNF+Requirements+Project>`__, to
deliver a unified set of VNF Guidelines and Requirements. Interested
parties are encouraged to participate.
diff --git a/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Managment_Requirements_for_OpenECOMP/VNF_Management_Requirements_for_OpenECOMP_7_3_2017.rst b/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Managment_Requirements_for_OpenECOMP/VNF_Management_Requirements_for_OpenECOMP_7_3_2017.rst
index 81c2eee..844a6ba 100644
--- a/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Managment_Requirements_for_OpenECOMP/VNF_Management_Requirements_for_OpenECOMP_7_3_2017.rst
+++ b/docs/all_vnfrqts_seed_docs/open_ecomp/q2_ecomp/VNF_Managment_Requirements_for_OpenECOMP/VNF_Management_Requirements_for_OpenECOMP_7_3_2017.rst
@@ -683,7 +683,7 @@ action request against a Chef managed VNF.
“RequestId”:”8279-abcd-aksdj-19231”,
- “CallbackUrl”:”https://callback.onap:9333”
+ “CallbackUrl”:”<callback url>”
},
@@ -1737,11 +1737,11 @@ Table D1. Ansible Server Requirements
| | | | |
| | - It is recommended that the load Playbook API be a REST API. | | |
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | Request API: The Ansible Server must expose a REST endpoint that accepts a POST message to request execution of the playbook (e.g., https://ansible.test.att.com:8080). The POST request must be a JSON block as outlined in Table D2. | Must | D1060 |
+| | Request API: The Ansible Server must expose a REST endpoint that accepts a POST message to request execution of the playbook. The POST request must be a JSON block as outlined in Table D2. | Must | D1060 |
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
| | When the Ansible server accepts an authenticated request to execute a playbook, it is required to send back an initial response indicating whether the request is accepted or rejected. The response must be a JSON Object with the key value pairs as described in Table D3. | Must | D1070 |
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
-| | Result API: If the Ansible Server accepts a request to execute a playbook, it must make available status of the execution of the playbook at a Results REST endpoint indexed by the Id in the request in the form <url>?Id=<RequestId>&Type=GetResult where <url> is the URL used for submitting requests. For example, https://ansible.test.att.com?Id=10&Type=GetResult. | Must | D1080 |
+| | Result API: If the Ansible Server accepts a request to execute a playbook, it must make available status of the execution of the playbook at a Results REST endpoint indexed by the Id in the request in the form <url>?Id=<RequestId>&Type=GetResult where <url> is the URL used for submitting requests. | Must | D1080 |
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------+------------+
| | When a GET is invoked against the Results REST endpoint, the Ansible Server must reply with an appropriate response: | Must | D1090 |
| | | | |