summaryrefslogtreecommitdiffstats
path: root/docs/ONAP release 1 spec
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2017-10-24 15:11:28 +0000
committerEric Debeau <eric.debeau@orange.com>2017-10-24 15:14:17 +0000
commit2b3cafb8093f81a24ace3a41e067171f8248d538 (patch)
tree0cd5ae21b81f731ada9cd7fbd479152cc25e16ed /docs/ONAP release 1 spec
parent52ce4452109428de0b2c17c64f1895f96f91c45e (diff)
Correct to pass doc8 and minor changes
Change-Id: Icf15c8042b10358a1df8e54ef738bda1738602a7 Issue-ID: DOC-94 Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Diffstat (limited to 'docs/ONAP release 1 spec')
-rw-r--r--docs/ONAP release 1 spec/csar/csar.rst28
-rw-r--r--docs/ONAP release 1 spec/csar/index.rst2
-rw-r--r--docs/ONAP release 1 spec/im/index.rst2
-rw-r--r--docs/ONAP release 1 spec/im/ns-im.rst14
-rw-r--r--docs/ONAP release 1 spec/im/service-im.rst18
-rw-r--r--docs/ONAP release 1 spec/index.rst2
6 files changed, 37 insertions, 29 deletions
diff --git a/docs/ONAP release 1 spec/csar/csar.rst b/docs/ONAP release 1 spec/csar/csar.rst
index 74fcfd2..ee36aef 100644
--- a/docs/ONAP release 1 spec/csar/csar.rst
+++ b/docs/ONAP release 1 spec/csar/csar.rst
@@ -18,7 +18,7 @@ The files/directories under the root of CSAR include:
* **MainServiceTemplate.yaml** is a copy of the main service template located under Definitions directory.
* **TOSCA-Metadate** is a directory which contains **TOSCA.meta** file, the metadata regarding the CSAR structure.
* **Artifacts** is a directory which contains all the recoginzable artifacts (except those of type *Other*). It should be noted that images are not supported in ONAP Amsterdam as artifacts in CSAR. And all the artifacts are further classified as either *Informational* or *Deployment*, and are located in the sub-directories respectively. Artifacts located in the root directory or un-recognized folders will be classified as *Other*.
-* **Definitions** is a directory which contains all the TOSCA yaml files.
+* **Definitions** is a directory which contains all the TOSCA YAML files.
The files/directories under the *Artifacts* directory further include:
@@ -34,7 +34,7 @@ The files/directories under each **VFC TOSCA <name>** sub-directory further incl
CSAR for VNF Life Cycle Management
----------------------------------
-This section describes the CSAR generated by SDC for VNF and to be consumed by SO/VF-C/etc. for VNF life cycle management in run-time.
+This section describes the CSAR generated by SDC for VNF and to be consumed by SO/VF-C/etc. for VNF life cycle management in run-time.
|image1|
@@ -71,7 +71,7 @@ The files/directories under the root of CSAR include:
* **TOSCA-Metadate** is a directory which contains **TOSCA.meta** file, the metadata regarding the CSAR structure.
* **Artifacts** is a directory which contains all the recoginzable artifacts (except those of type *Other*). All the artifacts are further classified as either *Informational* or *Deployment*, and are located in the sub-directories respectively. Artifacts located in the root directory or un-recognized folders will be classified as *Other*.
* **Resources** is a directory which contains a sub-directory **node_template <name>** per each node_template that has specific artifacts (artifacts that were added to the instance/customized for the instance or generated for the instance. This folder should **NOT** include artifacts of the type of the instance. (e.g. HEAT should be in the folder of the VF and not in the folder of the VF instance, HEAT_ENV will be in the folder of the instance.)
-* **Definitions** is a directory which contains all the TOSCA yaml files.
+* **Definitions** is a directory which contains all the TOSCA YAML files.
The files/directories under the *Artifacts* directory further include:
@@ -89,16 +89,16 @@ Artifacts supported by SDC
This section enumerates the artifacts types supported by SDC.
Artifacts at the root directory or unrecognized folder(s) will be classified as type Other.
-+------------------------+-------------+---------------------------------+------------------+
-| Type | Category | Description |Component Types |
-+========================+=============+=================================+==================+
-| HEAT | Deployment | HEAT Base Template (yaml) | VF |
+------------------------+-------------+---------------------------------+------------------+
-| HEAT_VOL | Deployment | HEAT Template for volumes (yaml)| VF |
+| Type | Category | Description |Component Types |
++========================+=============+=================================+==================+
+| HEAT | Deployment | HEAT Base Template (YAML) | VF |
++------------------------+-------------+---------------------------------+------------------+
+| HEAT_VOL | Deployment | HEAT Template for volumes (YAML)| VF |
+------------------------+-------------+---------------------------------+------------------+
-| HEAT_NET | Deployment | HEAT Template for network (yaml)| VF |
+| HEAT_NET | Deployment | HEAT Template for network (YAML)| VF |
+------------------------+-------------+---------------------------------+------------------+
-| HEAT_ENV | Deployment |HEAT Environment artifacts (yaml)| VF |
+| HEAT_ENV | Deployment |HEAT Environment artifacts (YAML)| VF |
+------------------------+-------------+---------------------------------+------------------+
| HEAT_ARTIFACT | Deployment | Supplementary artifacts in HEAT | VF |
+------------------------+-------------+---------------------------------+------------------+
@@ -116,17 +116,17 @@ Artifacts at the root directory or unrecognized folder(s) will be classified as
+------------------------+-------------+---------------------------------+------------------+
| VENDOR_LICENSE |Informational| Vendor License artifact | VF |
+------------------------+-------------+---------------------------------+------------------+
-| APPC_CONFIG |Informational| Configuration artifact for APP-C| VF |
-+------------------------+-------------+---------------------------------+------------------+
+| APPC_CONFIG |Informational| Configuration artifact for APPC | VF |
++------------------------+-------------+---------------------------------+------------------+
| VF_MODULES_METADATA |Informational| JSON artifact for VF Modules |Component instance|
+------------------------+-------------+---------------------------------+------------------+
-| DCAE_TOSCA |Deployment | DCAE TOSCA Template (yaml) | VF/VFCMT |
+| DCAE_TOSCA |Deployment | DCAE TOSCA Template (YAML) | VF/VFCMT |
+------------------------+-------------+---------------------------------+------------------+
| DCAE_JSON |Deployment | JSON for DCAE component/template| VF/VFCMT |
+------------------------+-------------+---------------------------------+------------------+
| Other | | Artifacts at the Root or other | Service/VF/VFC |
| | | unrecognized folders. | |
-+------------------------+-------------+---------------------------------+------------------+
++------------------------+-------------+---------------------------------+------------------+
.. |image0| image:: csar-sdc-input.JPG
diff --git a/docs/ONAP release 1 spec/csar/index.rst b/docs/ONAP release 1 spec/csar/index.rst
index 2900baa..bed1519 100644
--- a/docs/ONAP release 1 spec/csar/index.rst
+++ b/docs/ONAP release 1 spec/csar/index.rst
@@ -6,5 +6,5 @@ ONAP CSAR Specification
.. toctree::
:titlesonly:
-
+
csar
diff --git a/docs/ONAP release 1 spec/im/index.rst b/docs/ONAP release 1 spec/im/index.rst
index 8fd239c..929e073 100644
--- a/docs/ONAP release 1 spec/im/index.rst
+++ b/docs/ONAP release 1 spec/im/index.rst
@@ -8,6 +8,6 @@ ONAP Information Model Specifications
.. toctree::
:titlesonly:
-
+
service-im
ns-im
diff --git a/docs/ONAP release 1 spec/im/ns-im.rst b/docs/ONAP release 1 spec/im/ns-im.rst
index 370edcd..5daad0d 100644
--- a/docs/ONAP release 1 spec/im/ns-im.rst
+++ b/docs/ONAP release 1 spec/im/ns-im.rst
@@ -28,14 +28,20 @@ For the purposes of the present document, the following abbreviations apply:
+------------+--------------------------------------------+
| NCT | Network Connectivity Topology |
+------------+--------------------------------------------+
+| NF | Network Function |
++------------+--------------------------------------------+
+| NFVO | NFV Orchestrator |
++------------+--------------------------------------------+
| NSD | Network Service Descriptor |
+------------+--------------------------------------------+
| UML | Unified Modeling Language |
+------------+--------------------------------------------+
| VL | Virtual Link |
+------------+--------------------------------------------+
+| VNF | Virtual Network Function |
++------------+--------------------------------------------+
-NSD Infomration Model Overview
+NSD Information Model Overview
------------------------------
Network Service (NS) is a set of functions with unspecified connectivity between them or according to one or more forwarding graphs.
@@ -56,7 +62,7 @@ Functional Requirements
The following table specifies requirements to the templates for NSD instances in R1.
+-----------------+-----------------------------------------------------------------+
-| Numbereing | Requirement Description |
+| Numbering | Requirement Description |
+-----------------+-----------------------------------------------------------------+
| NST_NSD001 | The NSD shall reference the VNF Node description of constituent |
| | VNFs. |
@@ -73,7 +79,7 @@ The following table specifies requirements to the templates for NSD instances in
| NST_NSD005 | The NSD shall support the capability to include or reference NS |
| | life cycle management scripts describing how to react upon spec-|
| | ific life cycle events, fault detection, performance threshold |
-| | crossing detection and other events. |
+| | crossing detection and other events. |
+-----------------+-----------------------------------------------------------------+
| NST_NSD006 | The NSD shall support the capability to provide monitoring para-|
| | meters to be tracked during the lifetime of a NS instance. |
@@ -83,7 +89,7 @@ The following table specifies requirements to the templates for NSD instances in
The following table specifies requirements to the templates for VLD instances.
+-----------------+-----------------------------------------------------------------+
-| Numbereing | Requirement Description |
+| Numbering | Requirement Description |
+-----------------+-----------------------------------------------------------------+
| NST_VLD001 | A VLD shall enable specifying the type of connectivity provided |
| | by the link between VNFs. |
diff --git a/docs/ONAP release 1 spec/im/service-im.rst b/docs/ONAP release 1 spec/im/service-im.rst
index 7e93e41..9f2ce21 100644
--- a/docs/ONAP release 1 spec/im/service-im.rst
+++ b/docs/ONAP release 1 spec/im/service-im.rst
@@ -5,7 +5,7 @@ ONAP Service Descriptor Information Model Specification (Amsterdam)
Scope
-----
-The scope of the present document is to describe the SD Information Model Specification.
+The scope of the present document is to describe the Service Descriptor (SD) Information Model Specification.
Terms, Definitions and Abbreviations
------------------------------------
@@ -15,16 +15,18 @@ For the purposes of the present document, the following abbreviations apply:
+-----------------+---------------------------------------------------------------------+
| Abbreviation | Definition |
+-----------------+---------------------------------------------------------------------+
-| SO | Service Orchestrator |
+| RD | Resource Descriptor |
+-----------------+---------------------------------------------------------------------+
| SD | Service Descriptor |
+-----------------+---------------------------------------------------------------------+
-| RD | Resource Descriptor |
+| SO | Service Orchestrator |
+-----------------+---------------------------------------------------------------------+
| VF | Virtual Function |
+-----------------+---------------------------------------------------------------------+
+| VL | Virtual Link |
++-----------------+---------------------------------------------------------------------+
-SD Infomration Model Overview
+SD Information Model Overview
-----------------------------
The Service Descriptor (SD) is a deployment template which consists of information used by the Service Orchestrator (SO) for life cycle management of a service.
@@ -41,7 +43,7 @@ The following table specifies requirements to the templates for SD instances.
+------------------+-------------------------------------------------------+
| NST_SD001 | The SD shall reference the resource applicable to its |
| | constituent services. |
-+------------------+-------------------------------------------------------+
++------------------+-------------------------------------------------------+
SD Information Model Definitions
--------------------------------
@@ -63,14 +65,14 @@ The SD information element is a template whose instances are used by the SO for
|description| M | 1 | String | The description of the SD. |
+-----------+-----------+-------------+----------+-------------------------------------------+
| vendor | M | 1 | String | The vendor of the SD. (TBD) |
-+-----------+-----------+-------------+----------+-------------------------------------------+
++-----------+-----------+-------------+----------+-------------------------------------------+
| type | M | 1 | String | Value set to "Service". |
+-----------+-----------+-------------+----------+-------------------------------------------+
| category | M | 1 | String | Value set to either "E2E" or "NS". |
+-----------+-----------+-------------+----------+-------------------------------------------+
-|serviceType| M | 1 | String | The ServiceType of the SD. |
+|serviceType| M | 1 | String | The service type of the SD. |
+-----------+-----------+-------------+----------+-------------------------------------------+
-|ServiceRole| M | 1 | String | The ServiceRole of the SD. |
+|ServiceRole| M | 1 | String | The service role of the SD. |
+-----------+-----------+-------------+----------+-------------------------------------------+
| resource | M | 1..N | RD | The consituent RDs of the SD. |
| | | | | It could be VF/WAN Descriptor etc. |
diff --git a/docs/ONAP release 1 spec/index.rst b/docs/ONAP release 1 spec/index.rst
index f38f959..f9c4e14 100644
--- a/docs/ONAP release 1 spec/index.rst
+++ b/docs/ONAP release 1 spec/index.rst
@@ -8,7 +8,7 @@ ONAP R1 Modeling Specifications
.. toctree::
:titlesonly:
-
+
csar/index
im/index