From 048f610c3bd896496fe488336ba689ed429b4324 Mon Sep 17 00:00:00 2001 From: huangsam Date: Thu, 16 Nov 2017 17:18:02 +0800 Subject: modify format for rst file Change-Id: I535b8521a9fe757af0110ecd2c3993a669e52e19 Issue-ID: MODELING-36 Signed-off-by: huangsam --- docs/refspec/open-o/e2e-service/e2e-service-im.rst | 28 +++++++-------- docs/refspec/open-o/index.rst | 4 +-- docs/refspec/open-o/nfv-nsd/nfv-nsd-template.rst | 40 ---------------------- .../NS&VNF Package Specification-v0.4.rst | 20 +++++------ docs/refspec/open-o/vnfd/vnfd-template.rst | 39 --------------------- 5 files changed, 25 insertions(+), 106 deletions(-) delete mode 100644 docs/refspec/open-o/nfv-nsd/nfv-nsd-template.rst delete mode 100644 docs/refspec/open-o/vnfd/vnfd-template.rst (limited to 'docs') diff --git a/docs/refspec/open-o/e2e-service/e2e-service-im.rst b/docs/refspec/open-o/e2e-service/e2e-service-im.rst index 9dfdabd..96ef74a 100644 --- a/docs/refspec/open-o/e2e-service/e2e-service-im.rst +++ b/docs/refspec/open-o/e2e-service/e2e-service-im.rst @@ -27,13 +27,13 @@ limitations under the License. ========================================================================= -1. TOSCA template for e2e-service +TOSCA template for e2e-service =================================== -1.1 Data Types +Data Types ------------------ -1.1.1 gso.datatypes.service.basicInfo +gso.datatypes.service.basicInfo ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Describe the basic information for the service @@ -100,10 +100,10 @@ Definition | description: Location of the single domain | +-----------------------------------------------------------------------+ -1.2 Interface Types +Interface Types -------------------- -1.2.1 gso.interfaces.lifecycle.Standard +gso.interfaces.lifecycle.Standard ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There is the lifecycle standard interface of the service. @@ -168,10 +168,10 @@ Definition | description: Standard lifecycle query operation. | +-----------------------------------------------------------------------------+ -1.3 Capability Types +Capability Types --------------------- -1.3.1 gso.capability.SingleDomainNs +gso.capability.SingleDomainNs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There is the depended capability of single domain network service. @@ -194,10 +194,10 @@ Definition | derived_from: tosca.capabilities.Root | +-------------------------------------------+ -1.4 Relationship Types +Relationship Types -------------------------- -1.4.1 gso.relationship.DependOn +gso.relationship.DependOn ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ There is the relationship of single domain network service and global @@ -235,10 +235,10 @@ Definition | valid_target_types: [gso.capability.SingleDomainNs] | +-----------------------------------------------------------------------+ -1.5 Node Types +Node Types ---------------- -1.5.1 gso.node.Root +gso.node.Root ~~~~~~~~~~~~~~~~~~~ Root is the super class of all the gs-o network service. @@ -299,7 +299,7 @@ Definition | required: false | +-----------------------------------------------------------------------+ -1.5.2 gso.node.NetworkService +gso.node.NetworkService ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Describe the information for the network service @@ -361,7 +361,7 @@ Definition | type: gso.interfaces.lifecycle.Standard | +-----------------------------------------------+ -1.5.3 gso.node.SingleDomainNetworkService +gso.node.SingleDomainNetworkService ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Describe the information for the single domain network service @@ -384,7 +384,7 @@ Definition | description: single domain network service | +----------------------------------------------+ -1.5.4 gso.node.CrossDomainNetworkService +gso.node.CrossDomainNetworkService ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Describe the basic information for cross domain network service diff --git a/docs/refspec/open-o/index.rst b/docs/refspec/open-o/index.rst index b126d8e..5797289 100644 --- a/docs/refspec/open-o/index.rst +++ b/docs/refspec/open-o/index.rst @@ -7,7 +7,5 @@ Open-o Seed References .. toctree:: :maxdepth: 2 - e2e-service/e2e-service-im.rst - nfv-nsd/nfv-nsd-template.rst - vnfd/vnfd-template.rst + e2e-service/e2e-service-im.rst vnf-package/NS&VNF Package Specification-v0.4.rst diff --git a/docs/refspec/open-o/nfv-nsd/nfv-nsd-template.rst b/docs/refspec/open-o/nfv-nsd/nfv-nsd-template.rst deleted file mode 100644 index bc5db03..0000000 --- a/docs/refspec/open-o/nfv-nsd/nfv-nsd-template.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. contents:: - :depth: 3 -.. - -======================================================================== - -Copyright 2017 ZTE Corporation. - -Licensed under the Apache License, Version 2.0 (the "License"); - -you may not use this file except in compliance with the License. - -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software - -distributed under the License is distributed on an "AS IS" BASIS, - -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - -See the License for the specific language governing permissions and - -limitations under the License. - -======================================================================== - -1.nfv-nsd type definiton include three layer profile definitions. - - A.simple tosca profle : tosca_definition_1.0.yaml - refer: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/os/TOSCA-Simple-Profile-YAML-v1.0-os.docx - - B.tosca nfv profile : TOSCA_definition_nfv_ns_1_0.yaml - refer: http://docs.oasis-open.org/tosca/tosca-nfv/v1.0/csd03/tosca-nfv-v1.0-csd03.doc - - C.openo extension profile: TOSCA_definition_ns_ext_1_0.yaml - refer: Open-O definition - -2.nfv-nsd service template should import the profiles above. diff --git a/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.rst b/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.rst index 9f9f7d1..87cf662 100644 --- a/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.rst +++ b/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.rst @@ -2,16 +2,16 @@ :depth: 3 .. -1. NS&VNF Package Specification V0.4 +NS&VNF Package Specification V0.4 ======================================= -1.1 Scope +Scope ------------- The scope of the present document is to describe the NS&VNF CSAR model specification for OPENO. -1.2 Terms, Definitions and Abbreviations +Terms, Definitions and Abbreviations ---------------------------------------------- For the purposes of the present document, the following abbreviations @@ -38,7 +38,7 @@ apply: | | Descriptor | +-----------------------------------+-----------------------------------+ -1.3 NS&VNF CSAR Model Definitio +NS&VNF CSAR Model Definitio ---------------------------------------- In OPENO, TOSCA language is adopted to describe the NS/VNF Package. This @@ -47,7 +47,7 @@ document refers to “TOSCA Simple Profile YAML v1.0” and specifications, these clauses below focus on extension and satisfy the open NS/VNF package requirements. -1.3.1 CSAR Introduction +CSAR Introduction ~~~~~~~~~~~~~~~~~~~~~~~~ A CSAR is a zip file containing at least two directories, the @@ -72,7 +72,7 @@ the Definitions documents in the Definitions directory MUST contain a Service Template definition that defines the structure and behavior of the cloud application. -1.3.2 NS CSAR Model Structure +NS CSAR Model Structure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------+----------------------+----------------------+ @@ -119,7 +119,7 @@ the cloud application. | | | etc. | +----------------------+----------------------+----------------------+ -1.3.3 VNF CSAR Model Structure +VNF CSAR Model Structure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------+----------------------+----------------------+ @@ -186,7 +186,7 @@ the cloud application. | | | Test, etc. | +----------------------+----------------------+----------------------+ -1.3.4 TOSCA Meta File Definition +TOSCA Meta File Definition ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The TOSCA meta file includes metadata that allows interpreting the @@ -262,7 +262,7 @@ csar_vfw.zip | Entry-Definitions: Definitions/tosca_vfw.yaml | +-----------------------------------------------+ -1.3.5 CSAR Meta File Definition +CSAR Meta File Definition ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Describing the content of the CSAR, including type(GSAR/SSAR/NSAR/NFAR), @@ -288,7 +288,7 @@ For an example: | Version: v1.0 | +---------------+ -1.3.6 Checksum File Definition +Checksum File Definition ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ File Name: checksum.lst diff --git a/docs/refspec/open-o/vnfd/vnfd-template.rst b/docs/refspec/open-o/vnfd/vnfd-template.rst deleted file mode 100644 index a5f5a1e..0000000 --- a/docs/refspec/open-o/vnfd/vnfd-template.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. contents:: - :depth: 3 -.. - -======================================================================== - -Copyright 2017 ZTE Corporation. - -Licensed under the Apache License, Version 2.0 (the "License"); - -you may not use this file except in compliance with the License. - -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software - -distributed under the License is distributed on an "AS IS" BASIS, - -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - -See the License for the specific language governing permissions and - -limitations under the License. - -======================================================================== - -1.nfv vnfd type definiton include three layer profile definitions. - - A.simple tosca profle : tosca_definition_1.0.yaml - refer: http://docs.oasis-open.org/tosca/TOSCA-Simple-Profile-YAML/v1.0/os/TOSCA-Simple-Profile-YAML-v1.0-os.docx - - B.tosca nfv profile : tosca-simple-nfv-1.1.yaml - refer: draft-tosca-nfv-v1.0-wd04-rev06.doc - - C.openo extension profile: In the future - -2.nfv vnfd service template should import the profiles above. -- cgit 1.2.3-korg