summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rwxr-xr-xdocs/refspec/open-o/e2e-service/e2e-service-im.docxbin32238 -> 0 bytes
-rwxr-xr-xdocs/refspec/open-o/e2e-service/e2e-service-im.pdfbin563693 -> 0 bytes
-rw-r--r--docs/refspec/open-o/e2e-service/e2e-service-im.rst421
-rw-r--r--docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.pdfbin646545 -> 0 bytes
-rw-r--r--docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.rst304
5 files changed, 725 insertions, 0 deletions
diff --git a/docs/refspec/open-o/e2e-service/e2e-service-im.docx b/docs/refspec/open-o/e2e-service/e2e-service-im.docx
deleted file mode 100755
index fca61dd..0000000
--- a/docs/refspec/open-o/e2e-service/e2e-service-im.docx
+++ /dev/null
Binary files differ
diff --git a/docs/refspec/open-o/e2e-service/e2e-service-im.pdf b/docs/refspec/open-o/e2e-service/e2e-service-im.pdf
deleted file mode 100755
index 4e28204..0000000
--- a/docs/refspec/open-o/e2e-service/e2e-service-im.pdf
+++ /dev/null
Binary files differ
diff --git a/docs/refspec/open-o/e2e-service/e2e-service-im.rst b/docs/refspec/open-o/e2e-service/e2e-service-im.rst
new file mode 100644
index 0000000..9dfdabd
--- /dev/null
+++ b/docs/refspec/open-o/e2e-service/e2e-service-im.rst
@@ -0,0 +1,421 @@
+.. contents::
+ :depth: 3
+..
+
+========================================================================
+
+Copyright 2017 OPEN-O 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. TOSCA template for e2e-service
+===================================
+
+1.1 Data Types
+------------------
+
+1.1.1 gso.datatypes.service.basicInfo
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Describe the basic information for the service
+
+Properties
+^^^^^^^^^^
+
++------------+----------+--------+-------------+-----------------------------------+
+| Name | Required | Type | Constraints | Description |
++============+==========+========+=============+===================================+
+| createTime | No | string | | The creation time of the service |
++------------+----------+--------+-------------+-----------------------------------+
+| updateTime | No | string | | The update time of the service |
++------------+----------+--------+-------------+-----------------------------------+
+| creatorId | No | string | | The identification of the creator |
++------------+----------+--------+-------------+-----------------------------------+
+| location | No | string | | Location of the single domain |
++------------+----------+--------+-------------+-----------------------------------+
+
+Definition
+^^^^^^^^^^
+
++-----------------------------------------------------------------------+
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| # data types |
+| |
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| data_types: |
+| |
+| gso.datatypes.service.basicInfo: |
+| |
+| derived_from: tosca.datatypes.Root |
+| |
+| properties: |
+| |
+| createTime: |
+| |
+| type: string |
+| |
+| description: create time |
+| |
+| updateTime: |
+| |
+| type: string |
+| |
+| description: update time |
+| |
+| creatorId: |
+| |
+| type: string |
+| |
+| description: ID of the creator |
+| |
+| location: |
+| |
+| type: string |
+| |
+| description: Location of the single domain |
++-----------------------------------------------------------------------+
+
+1.2 Interface Types
+--------------------
+
+1.2.1 gso.interfaces.lifecycle.Standard
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There is the lifecycle standard interface of the service.
+
+.. properties-1:
+
+Properties
+^^^^^^^^^^
+
+.. definition-1:
+
+Definition
+^^^^^^^^^^
+
++-----------------------------------------------------------------------------+
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| # interface_types |
+| |
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| interface_types: |
+| |
+| gso.interfaces.lifecycle.Standard: |
+| |
+| derived_from: tosca.interfaces.Root |
+| |
+| create: |
+| |
+| description: Standard lifecycle create operation. |
+| |
+| update: |
+| |
+| description: Standard lifecycle configure and update operation. |
+| |
+| instantiate: |
+| |
+| description: Standard lifecycle instantiate operation. |
+| |
+| terminate: |
+| |
+| description: Standard lifecycle terminate operation. |
+| |
+| delete: |
+| |
+| description: Standard lifecycle delete operation. |
+| |
+| query: |
+| |
+| description: Standard lifecycle query operation. |
+| |
+| scalingIn: |
+| |
+| description: Standard lifecycle scalingIn operation. |
+| |
+| scalingOut: |
+| |
+| description: Standard lifecycle query operation. |
++-----------------------------------------------------------------------------+
+
+1.3 Capability Types
+---------------------
+
+1.3.1 gso.capability.SingleDomainNs
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There is the depended capability of single domain network service.
+
+.. properties-2:
+
+Properties
+^^^^^^^^^^
+
+.. definition-2:
+
+Definition
+^^^^^^^^^^
+
++-------------------------------------------+
+| capability_types: |
+| |
+| gso.capability.SingleDomainNs: |
+| |
+| derived_from: tosca.capabilities.Root |
++-------------------------------------------+
+
+1.4 Relationship Types
+--------------------------
+
+1.4.1 gso.relationship.DependOn
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There is the relationship of single domain network service and global
+network service.
+
+.. properties-3:
+
+Properties
+^^^^^^^^^^
+
+.. definition-3:
+
+Definition
+^^^^^^^^^^
+
++-----------------------------------------------------------------------+
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| # relationship types |
+| |
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| relationship_types: |
+| |
+| gso.relationship.DependOn: |
+| |
+| derived_from: tosca.relationships.Root |
+| |
+| description: |
+| |
+| valid_target_types: [gso.capability.SingleDomainNs] |
++-----------------------------------------------------------------------+
+
+1.5 Node Types
+----------------
+
+1.5.1 gso.node.Root
+~~~~~~~~~~~~~~~~~~~
+
+Root is the super class of all the gs-o network service.
+
+.. properties-4:
+
+Properties
+^^^^^^^^^^
+
++-------------+----------+--------+-------------+-----------------------------------+
+| Name | Required | Type | Constraints | Description |
++=============+==========+========+=============+===================================+
+| Id | Yes | string | | The identification of the service |
++-------------+----------+--------+-------------+-----------------------------------+
+| name | Yes | string | | The name of the service |
++-------------+----------+--------+-------------+-----------------------------------+
+| description | No | string | | The description of the service |
++-------------+----------+--------+-------------+-----------------------------------+
+
+.. definition-4:
+
+Definition
+^^^^^^^^^^
+
++-----------------------------------------------------------------------+
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| # node types |
+| |
+| # |
+| \******************************************************************** |
+| ********\* |
+| |
+| node_types: |
+| |
+| gso.node.Root: |
+| |
+| derived_from: tosca.nodes.Root |
+| |
+| description: gso root type |
+| |
+| properties: |
+| |
+| id: |
+| |
+| type: string |
+| |
+| name: |
+| |
+| type: string |
+| |
+| description: |
+| |
+| type: string |
+| |
+| required: false |
++-----------------------------------------------------------------------+
+
+1.5.2 gso.node.NetworkService
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Describe the information for the network service
+
+.. properties-5:
+
+Properties
+^^^^^^^^^^
+
++-------------+-------------+-------------+-------------+-------------+
+| Name | Required | Type | Constraints | Description |
++=============+=============+=============+=============+=============+
+| baseService | Yes | gso.datatyp | | The basic |
+| Info | | es.service. | | information |
+| | | basicInfo | | of the |
+| | | | | service |
++-------------+-------------+-------------+-------------+-------------+
+| templateId | Yes | string | | The |
+| | | | | template id |
+| | | | | of the |
+| | | | | service |
++-------------+-------------+-------------+-------------+-------------+
+| serviceDefI | Yes | string | | The csar |
+| d | | | | package id |
+| | | | | of the |
+| | | | | service |
++-------------+-------------+-------------+-------------+-------------+
+
+.. definition-5:
+
+Definition
+^^^^^^^^^^
+
++-----------------------------------------------+
+| gso.node.NetworkService: |
+| |
+| derived_from: gso.node.Root |
+| |
+| description: basic network service |
+| |
+| properties: |
+| |
+| baseServiceInfo: |
+| |
+| type: gso.datatypes.service.basicInfo |
+| |
+| templateId: |
+| |
+| type: string |
+| |
+| serviceDefId: |
+| |
+| type: string |
+| |
+| interfaces: |
+| |
+| standard: |
+| |
+| type: gso.interfaces.lifecycle.Standard |
++-----------------------------------------------+
+
+1.5.3 gso.node.SingleDomainNetworkService
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Describe the information for the single domain network service
+
+.. properties-6:
+
+Properties
+^^^^^^^^^^
+
+.. definition-6:
+
+Definition
+^^^^^^^^^^
+
++----------------------------------------------+
+| gso.node.SingleDomainNetworkService: |
+| |
+| derived_from: gso.node.NetworkService |
+| |
+| description: single domain network service |
++----------------------------------------------+
+
+1.5.4 gso.node.CrossDomainNetworkService
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Describe the basic information for cross domain network service
+
+.. properties-7:
+
+Properties
+^^^^^^^^^^^
+
+.. definition-7:
+
+Definition
+^^^^^^^^^^
+
++-------------------------------------------------+
+| gso.node.CrossDomainNetworkService: |
+| |
+| derived_from: gso.node.NetworkService |
+| |
+| description: cross domain network service |
+| |
+| requirements: |
+| |
+| -realizes: |
+| |
+| node: gso.node.SingleDomainNetworkService |
+| |
+| capability: gso.capability.SingleDomainNs |
+| |
+| relationship: gso.relationship.DependOn |
+| |
+| occurrences: [2, UNBOUNDED] |
++-------------------------------------------------+
+ \ No newline at end of file
diff --git a/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.pdf b/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.pdf
deleted file mode 100644
index 97dad9a..0000000
--- a/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.pdf
+++ /dev/null
Binary files differ
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
new file mode 100644
index 0000000..9f9f7d1
--- /dev/null
+++ b/docs/refspec/open-o/vnf-package/NS&VNF Package Specification-v0.4.rst
@@ -0,0 +1,304 @@
+.. contents::
+ :depth: 3
+..
+
+1. NS&VNF Package Specification V0.4
+=======================================
+
+1.1 Scope
+-------------
+
+The scope of the present document is to describe the NS&VNF CSAR model
+specification for OPENO.
+
+1.2 Terms, Definitions and Abbreviations
+----------------------------------------------
+
+For the purposes of the present document, the following abbreviations
+apply:
+
++-----------------------------------+-----------------------------------+
+| Abbreviation | Definition |
++===================================+===================================+
+| CSAR | TOSCA Cloud Service Archive |
++-----------------------------------+-----------------------------------+
+| CSAR Model | …… |
++-----------------------------------+-----------------------------------+
+| NS | Network Service |
++-----------------------------------+-----------------------------------+
+| NSD | Network Service Descriptor |
++-----------------------------------+-----------------------------------+
+| TOSCA | Topology and Orchestration |
+| | Specification for Cloud |
+| | Applications |
++-----------------------------------+-----------------------------------+
+| VNF | Virtual Network Function |
++-----------------------------------+-----------------------------------+
+| VNFD | Virtual Network Function |
+| | Descriptor |
++-----------------------------------+-----------------------------------+
+
+1.3 NS&VNF CSAR Model Definitio
+----------------------------------------
+
+In OPENO, TOSCA language is adopted to describe the NS/VNF Package. This
+document refers to “TOSCA Simple Profile YAML v1.0” and
+“tosca-nfv-profile-wd04-Rev06” specification. Base on those
+specifications, these clauses below focus on extension and satisfy the
+open NS/VNF package requirements.
+
+1.3.1 CSAR Introduction
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+A CSAR is a zip file containing at least two directories, the
+TOSCA-Metadata directory and the Definitions directory. Beyond that,
+other directories MAY be contained in a CSAR, i.e. the creator of a CSAR
+has all freedom to define the content of a CSAR and the structuring of
+this content as appropriate for the cloud application.
+
+The TOSCA-Metadata directory contains metadata describing the other
+content of the CSAR. This metadata is referred to as TOSCA meta file.
+This file is named TOSCA and has the file extension .meta.
+
+The Definitions directory contains one or more TOSCA Definitions
+documents (file extension .tosca). These Definitions files typically
+contain definitions related to the cloud application of the CSAR. In
+addition, CSARs can contain just the definition of elements for re-use
+in other contexts. For example, a CSAR might be used to package a set of
+Node Types and Relationship Types with their respective implementations
+that can then be used by Service Templates provided in other CSARs. In
+cases where a complete cloud application is packaged in a CSAR, one of
+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
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
++----------------------+----------------------+----------------------+
+| Dirctory/Files | Qualifier | Description |
++======================+======================+======================+
+| /TOSCA-Metadata/TOSC | M | Describing the other |
+| A.meta | | content of the CSAR. |
+| | | |
+| | | The detail of |
+| | | “TOSCA.meta” format |
+| | | refers to clause |
+| | | 3.4. |
++----------------------+----------------------+----------------------+
+| /Definitions | M | Including simple |
+| | | TOSCA Type |
+| | | Definition and |
+| | | NSD/VNFD definition |
+| | | files |
+| | | |
+| | | The detail of NSD |
+| | | format refers to < |
+| | | NSD Specification>. |
++----------------------+----------------------+----------------------+
+| /checksum.lst | O | It is a txt file for |
+| | | record the important |
+| | | file checksum. |
+| | | |
+| | | Such as |
+| | | SoftwareImages files |
+| | | or AppSoftware |
+| | | files. |
+| | | |
+| | | The detail of |
+| | | “checksum.lst” |
+| | | format refers to |
+| | | clause 3.6. |
++----------------------+----------------------+----------------------+
+| /Policies | O | Policies Definition |
+| | | files. |
++----------------------+----------------------+----------------------+
+| /Plans | O | LCM Workflow Plans |
+| | | |
+| | | Deploy, Termination, |
+| | | etc. |
++----------------------+----------------------+----------------------+
+
+1.3.3 VNF CSAR Model Structure
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
++----------------------+----------------------+----------------------+
+| Dirctory/Files | Qualifier | Description |
++======================+======================+======================+
+| /TOSCA-Metadata/TOSC | M | Describing the other |
+| A.meta | | content of the CSAR. |
+| | | |
+| | | The detail of |
+| | | “TOSCA.meta” format |
+| | | refers to clause |
+| | | 3.3. |
++----------------------+----------------------+----------------------+
+| /Definitions | M | Including simple |
+| | | TOSCA Type |
+| | | Definition and |
+| | | NSD/VNFD definition |
+| | | files |
+| | | |
+| | | The detail of VNFD |
+| | | format refers to < |
+| | | VNFD pecification>. |
++----------------------+----------------------+----------------------+
+| /checksum.lst | O | It is a txt file for |
+| | | record the important |
+| | | file checksum. |
+| | | |
+| | | Such as |
+| | | SoftwareImages files |
+| | | or AppSoftware |
+| | | files. |
+| | | |
+| | | The detail of |
+| | | “checksum.lst” |
+| | | format refers to |
+| | | clause 3.4. |
++----------------------+----------------------+----------------------+
+| /SoftwareImages | O | VNF Image directory. |
+| | | |
+| | | The Images can be in |
+| | | a fixed URL, such as |
+| | | in the catalog |
+| | | public directory on |
+| | | order to be imported |
+| | | by VNFD file. |
++----------------------+----------------------+----------------------+
+| /AppSoftwares | O | VNF Software |
+| | | directory |
+| | | |
+| | | The VNF Software can |
+| | | be in a fixed URL, |
+| | | such as in the |
+| | | catalog public |
+| | | directory on order |
+| | | to be imported by |
+| | | VNFD file. |
++----------------------+----------------------+----------------------+
+| /Policies | O | Policies Definition |
+| | | files. |
++----------------------+----------------------+----------------------+
+| /Scripts | O | LCM Scripts |
+| | | |
+| | | Deploy, Termination, |
+| | | Test, etc. |
++----------------------+----------------------+----------------------+
+
+1.3.4 TOSCA Meta File Definition
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The TOSCA meta file includes metadata that allows interpreting the
+various artifacts within the CSAR properly. The TOSCA.meta file is
+contained in the TOSCA-Metadata directory of the CSAR.
+
+A TOSCA meta file consists of name/value pairs. The name-part of a
+name/value pair is followed by a colon, followed by a blank, followed by
+the value-part of the name/value pair. The name MUST NOT contain a
+colon. Values that represent binary data MUST be base64 encoded. Values
+that extend beyond one line can be spread over multiple lines if each
+subsequent line starts with at least one space. Such spaces are then
+collapsed when the value string is read.
+
++-----------------+
+| <name>: <value> |
++-----------------+
+
+Each name/value pair is in a separate line. A list of related name/value
+pairs, i.e. a list of consecutive name/value pairs describing a
+particular file in a CSAR, is called a block. Blocks are separated by an
+empty line. The first block, called block_0, is metadata about the CSAR
+itself. All other blocks represent metadata of files in the CSAR.
+
+The structure of block_0 in the TOSCA meta file is as follows:
+
++--------------------------------------+
+| TOSCA-Meta-File-Version: digit.digit |
+| |
+| CSAR-Version: digit.digit |
+| |
+| Created-By: string |
+| |
+| Entry-Definitions: string ? |
++--------------------------------------+
+
+The name/value pairs are as follows:
+
+- TOSCA-Meta-File-Version: This is the version number of the TOSCA meta
+ file format. The value MUST be “1.0” in the current version of the
+ TOSCA specification.
+
+- CSAR-Version: This is the version number of the CSAR specification.
+ The value MUST be “1.0” in the current version of the TOSCA
+ specification.
+
+- Created-By: The person or vendor, respectively, who created the CSAR.
+
+- Entry-Definitions: This OPTIONAL name/value pair references a TOSCA
+ Definitions file from the Definitions directory of the CSAR that
+ SHOULD be used as entry point for processing the contents of the
+ CSAR.
+
+ Note, that a CSAR may contain multiple Definitions files. One reason
+ for this is completeness, e.g. a Service Template defined in one of
+ the Definitions files could refer to Node Types defined in another
+ Definitions file that might be included in the Definitions directory
+ to avoid importing it from external locations. The Entry-Definitions
+ name/value pair is a hint to allow optimized processing of the set
+ of files in the Definitions directory.
+
+For an example:
+
+csar_vfw.zip
+
++-----------------------------------------------+
+| TOSCA-Meta-File-Version: 1.0 |
+| |
+| CSAR-Version: 1.0 |
+| |
+| Created-By: zte |
+| |
+| Entry-Definitions: Definitions/tosca_vfw.yaml |
++-----------------------------------------------+
+
+1.3.5 CSAR Meta File Definition
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Describing the content of the CSAR, including type(GSAR/SSAR/NSAR/NFAR),
+provider, version.
+
++----------------+-----------+---------------------+
+| Dirctory/Files | Qualifier | Description |
++================+===========+=====================+
+| type | M | GSAR/SSAR/NSAR/NFAR |
++----------------+-----------+---------------------+
+| provider | M | |
++----------------+-----------+---------------------+
+| version | M | |
++----------------+-----------+---------------------+
+
+For an example:
+
++---------------+
+| Type: NSAR |
+| |
+| Provider: ZTE |
+| |
+| Version: v1.0 |
++---------------+
+
+1.3.6 Checksum File Definition
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+File Name: checksum.lst
+
+Content:
+
+[File related file path]:[checksum(MD5)]
+
+For an example:
+
+/SoftwareImages/zte_vmb_qcow2.img:8a683566bcc7801226b3d8b0cf35fd97
+
+/AppSoftwares/zte_nf_version.zip:7b8955fbb77654635b5c8a9be3aa854