On-Board Modelspec to use RTD, convert wiki docs

Create top level docs folder
Move folders and files to docs folder
Create top level index structure
All exist rst files were connected
Convert 2 wiki documents to restructured text (listed in Jira Issue MODELING-22

Change-Id: I6f66524a27c7c19ffdee091f1e3da7f748bb6c1f
Issue-ID: MODELING-22
Signed-off-by: Rich Bennett <rb2745@att.com>

5 files changed, 472 insertions, 0 deletions

diff --git a/docs/refspec/open-o/nfv-nsd/README.md b/docs/refspec/open-o/nfv-nsd/README.md
new file mode 100755
index 0000000..1eda1fe
--- /dev/null
+++ b/docs/refspec/open-o/nfv-nsd/README.md
@@ -0,0 +1,28 @@
+#

+# 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.
\ No newline at end of file
diff --git a/docs/refspec/open-o/nfv-nsd/TOSCA_definition_nfv_ns_1_0.yaml b/docs/refspec/open-o/nfv-nsd/TOSCA_definition_nfv_ns_1_0.yaml
new file mode 100755
index 0000000..23f2f93
--- /dev/null
+++ b/docs/refspec/open-o/nfv-nsd/TOSCA_definition_nfv_ns_1_0.yaml
@@ -0,0 +1,176 @@
+#

+# 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.

+#

+

+tosca_definitions_version: tosca_simple_yaml_1_0

+

+description: Definitions file for all type of tosca-nfv specification.

+

+node_types:

+  tosca.nodes.nfv.VNF:

+    derived_from: tosca.nodes.Root

+    properties:

+      id:

+        type: string

+        description: ID of this VNF

+        required: true

+        constraints:

+          - min_length: 1

+      vendor:

+        type: string

+        description: name of the vendor who generate this VNF

+        required: true

+      version:

+         type: version

+         description: version of the software for this VNF

+         required: true

+    requirements:

+      - virtualLink:

+          capability: tosca.capabilities.nfv.VirtualLinkable

+          node: tosca.nodes.nfv.VL

+          relationship: tosca.relationships.nfv.VirtualLinksTo

+

+  tosca.nodes.nfv.CP:

+    derived_from: tosca.nodes.network.Port

+    properties:

+      type:

+        type: string

+        description: >

+          This may be, for example, a virtual port, a virtual NIC address, a physical port,

+          a physical NIC address or the endpoint of an IP VPN enabling network connectivity.

+        required: false

+      anti_spoof_protection:

+        type: boolean

+        description: >

+          Indicates of whether anti-spoofing rule need to be enabled for this vNIC. This is applicable only

+          when CP type is virtual NIC (vPort).

+        required: false

+    attributes:

+      address:

+        type: string

+        description: The actual virtual NIC address that is been assigned when instantiating the connection point.

+    requirements:

+      - virtualLink:

+          capability: tosca.capabilities.nfv.VirtualLinkable

+          node: tosca.nodes.nfv.VL

+          relationship: tosca.relationships.nfv.VirtualLinksTo

+      - virtualbinding:

+          capability: tosca.capabilities.nfv.VirtualBindable

+          node: tosca.nodes.nfv.VDU

+          relationship: tosca.relationships.nfv.VirtualBindsTo

+

+  tosca.nodes.nfv.VL:

+    derived_from: tosca.nodes.network.Network

+    properties:

+      vendor:

+        type: string

+        description: name of the vendor who generate this VL

+        required: false

+    capabilities:

+      virtual_linkable:

+        type: tosca.capabilities.nfv.VirtualLinkable

+

+  tosca.nodes.nfv.VL.ELine:

+    derived_from: tosca.nodes.nfv.VL

+    #capabilities:

+    #  virtual_linkable:

+    #    type: tosca.capabilities.nfv.VirtualLinkable

+    #    occurrences: [ 2, 2 ]

+

+  tosca.nodes.nfv.VL.ELAN:

+    derived_from: tosca.nodes.nfv.VL

+

+  tosca.nodes.nfv.VL.ETree:

+    derived_from: tosca.nodes.nfv.VL

+

+  tosca.nodes.nfv.FP:

+    derived_from: tosca.nodes.Root

+    properties:

+      policy:

+        type: string

+        required: false

+        description: A policy or rule to apply to the NFP

+    requirements:

+      - forwarder:

+          capability: tosca.capabilities.nfv.Forwarder

+          node: tosca.nodes.nfv.CP

+          relationship: tosca.relationships.nfv.ForwardsTo

+

+capability_types:

+

+  tosca.capabilities.nfv.VirtualLinkable:

+    derived_from: tosca.capabilities.Root

+

+  tosca.capabilities.nfv.VirtualBindable:

+    derived_from: tosca.capabilities.Root

+

+  tosca.capabilities.nfv.Metric:

+    derived_from: tosca.capabilities.Endpoint

+

+  tosca.capabilities.nfv.Forwarder:

+    derived_from: tosca.capabilities.Root

+

+relationship_types:

+  tosca.relationships.nfv.VirtualBindsTo:

+    derived_from: tosca.relationships.DependsOn

+    valid_target_types: [ tosca.capabilities.nfv.VirtualBindable ]

+

+  tosca.relationships.nfv.VirtualLinksTo:

+    derived_from: tosca.relationships.DependsOn

+    valid_target_types: [ tosca.capabilities.nfv.VirtualLinkable ]

+

+  tosca.relationships.nfv.Monitor:

+    derived_from: tosca.relationships.ConnectsTo

+    valid_target_types: [ tosca.capabilities.nfv.Metric ]

+

+  tosca.relationships.nfv.ForwardsTo:

+    derived_from: tosca.relationships.Root

+    valid_target_types: [ tosca.capabilities.nfv.Forwarder ]

+

+group_types:

+  tosca.groups.nfv.VNFFG:

+    derived_from: tosca.groups.Root

+    properties:

+      vendor:

+        type: string

+        required: true

+        description: name of the vendor who generate this VNFFG

+      version:

+        type: string

+        required: true

+        description: version of this VNFFG

+      number_of_endpoints:

+        type: integer

+        required: true

+        description: count of the external endpoints included in this VNFFG

+      dependent_virtual_link:

+        type: list

+        entry_schema:

+          type: string

+        required: true

+        description: Reference to a VLD used in this Forwarding Graph

+      connection_point:

+        type: list

+        entry_schema:

+          type: string

+        required: true

+        description: Reference to Connection Points forming the VNFFG

+      constituent_vnfs:

+        type: list

+        entry_schema:

+          type: string

+        required: true

+        description: Reference to a list of VNFD used in this VNF Forwarding Graph

+    members: [ tosca.nodes.nfv.FP ]

diff --git a/docs/refspec/open-o/nfv-nsd/TOSCA_definition_ns_ext_1_0.yaml b/docs/refspec/open-o/nfv-nsd/TOSCA_definition_ns_ext_1_0.yaml
new file mode 100644
index 0000000..4028b87
--- /dev/null
+++ b/docs/refspec/open-o/nfv-nsd/TOSCA_definition_ns_ext_1_0.yaml
@@ -0,0 +1,232 @@
+#
+# 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.
+#
+
+tosca_definitions_version: tosca_simple_yaml_1_0
+
+description: Extend types definitions file for tosca-nfv.
+  
+data_types:
+  tosca.datatypes.nfv.ext.FPPolicyCriteria:
+    derived_from: tosca.datatypes.Root
+    properties:
+      dest_port_range:
+        type: range
+        required: false
+        constraints:
+          - in_range: [ 1, 65535 ]
+      source_port_range:
+        type: range
+        required: false
+        constraints:
+          - in_range: [ 1, 65535 ]
+      ip_protocol:
+        type: string
+        required: false
+        default: tcp
+        constraints:
+          - valid_values: [ udp, tcp ]
+      dest_ip_range:
+        type: list
+        required: false
+        description: The format is startip1-endip1,startip2-endip2
+        entry_schema:
+          type: string
+      source_ip_range:
+        type: list
+        required: false
+        description: The format is startip1-endip1,startip2-endip2
+        entry_schema:
+          type: string
+      dscp:
+        type: integer
+        required: false
+
+  tosca.datatypes.nfv.ext.FPPolicy:
+    derived_from: tosca.datatypes.Root
+    properties:
+      type:
+        type: string
+        required: false
+        default: ACL
+        constraints:
+          - valid_values: [ ACL ]
+      criteria:
+        type: tosca.datatypes.nfv.ext.FPPolicyCriteria
+        required: true
+        
+
+node_types:
+  tosca.nodes.nfv.ext.VNF:
+    derived_from: tosca.nodes.nfv.VNF
+    properties:
+      vnf_type:
+        type: string
+        required: false
+        description: Type of this VNF. For example MME,USPP,xGW etc.
+      request_reclassification:
+        type: boolean
+        required: false
+        default: false
+        description: Determines whether VNF can request reclassification by the VNF forwarder
+      nsh_aware:
+        type: boolean
+        required: false
+        default: true
+        description: Whether this VNF can process NSH headers
+      vnfm_type:
+        type: string
+        required: true
+        description: Type of this VNFM, Such as ZTE,HW,JUJU,...
+    requirements:
+      - virtual_link:
+          capability: tosca.capabilities.nfv.VirtualLinkable
+          relationship: tosca.relationships.nfv.VirtualLinksTo
+          occurrences: [0, UNBOUNDED]
+
+  tosca.nodes.nfv.ext.CP:
+    derived_from: tosca.nodes.nfv.CP
+    properties:
+      sfc_encapsulation:
+        type: string
+        required: false
+        description: The encapsulateion used to carry NSH packages
+        constraints:
+          - valid_values: [ mac, vxlan-gpe, gre, mpls ]
+      direction:
+        type: string
+        required: false
+        constraints:
+          - valid_values: [ input, output, bidirectional ]
+      interface_name:
+        type: string
+        required: false
+        description: Physical interface name of CP for PNF.
+    requirements:
+      - link:
+          capability: tosca.capabilities.network.Linkable
+          relationship: tosca.relationships.network.LinksTo
+          occurrences: [ 0, 1 ]
+      - binding:
+          capability: tosca.capabilities.network.Bindable
+          relationship: tosca.relationships.network.BindsTo
+          occurrences: [ 0, 1 ]
+      - virtualLink:
+          capability: tosca.capabilities.nfv.VirtualLinkable
+          relationship: tosca.relationships.nfv.VirtualLinksTo
+          occurrences: [ 0, 1 ]
+      - virtualbinding:
+          capability: tosca.capabilities.nfv.VirtualBindable
+          relationship: tosca.relationships.nfv.VirtualBindsTo
+          occurrences: [ 0, 1 ]
+    capabilities:
+      forwarder: 
+        type: tosca.capabilities.nfv.Forwarder
+
+  tosca.nodes.nfv.ext.NS:
+    derived_from: tosca.nodes.Root
+    properties:
+      id:
+        type: string
+        description: ID of this NSD
+        required: true
+        constraints:
+          - min_length: 1
+      designer:
+        type: string
+        description: Designer of this NSD
+        required: true
+      version:
+        type: version
+        description: version of this NSD
+        required: true
+      name:
+        type: string
+        description: name of this NSD
+        required: true
+      type:
+        type: string
+        description: Type of this NSD,include:SSAR,NSAR,GSAR
+        required: true
+    requirements:
+      - virtualLink:
+          capability: tosca.capabilities.nfv.VirtualLinkable
+          node: tosca.nodes.nfv.VL
+          relationship: tosca.relationships.nfv.VirtualLinksTo
+
+  tosca.nodes.nfv.ext.PNF:
+    derived_from: tosca.nodes.Root
+    properties:
+      id:
+        type: string
+        description: ID of this PNF
+        required: true
+        constraints:
+          - min_length: 1
+      vendor:
+        type: string
+        description: name of the vendor who provide this PNF
+        required: true
+      version:
+        type: version
+        description: version of the software for this PNF
+        required: true
+      pnf_type:
+        type: string
+        description: type of PNF
+        required: false
+      request_reclassification:
+        type: boolean
+        required: false
+        default: false
+        description: Determines whether VNF can request reclassification by the VNF forwarder
+      nsh_aware:
+        type: boolean
+        required: false
+        default: true
+        description: Whether this VNF can process NSH headers
+      management_address:
+        type: string
+        description: Management port address of this PNF.
+        required: true
+    capabilities:
+      virtualBinding:
+        type: tosca.capabilities.nfv.VirtualBindable
+
+  tosca.nodes.nfv.ext.FP:
+    derived_from: tosca.nodes.Root
+    properties:
+      policy:
+        type: tosca.datatypes.nfv.ext.FPPolicy
+        required: false
+      symmetric:
+        type: boolean
+        required: false
+        description: If the chain is symmetric, SDN Controller will create two service paths, one ingress and another egress.
+    requirements:
+      - forwarder:
+          capability: tosca.capabilities.nfv.Forwarder
+          occurrences: [0, UNBOUNDED]
+
+group_types:
+  tosca.groups.nfv.ext.VNFFG:
+    derived_from: tosca.groups.nfv.VNFFG
+    properties:
+      constituent_pnfs:
+        type: list
+        entry_schema:
+          type: string
+        required: false
+        description: Reference to a list of PNF'ID used in this VNF Forwarding Graph
diff --git a/docs/refspec/open-o/nfv-nsd/nfv-nsd-dm-sample.rst b/docs/refspec/open-o/nfv-nsd/nfv-nsd-dm-sample.rst
new file mode 100755
index 0000000..9bd5f74
--- /dev/null
+++ b/docs/refspec/open-o/nfv-nsd/nfv-nsd-dm-sample.rst
@@ -0,0 +1,18 @@
+.. ========================================================================

+.. Copyright 2017 CMCC 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.

+.. =========================================================================

+

+nfv nsd dm sample

+=================

diff --git a/docs/refspec/open-o/nfv-nsd/nfv-nsd-im-sample.rst b/docs/refspec/open-o/nfv-nsd/nfv-nsd-im-sample.rst
new file mode 100755
index 0000000..2c448cf
--- /dev/null
+++ b/docs/refspec/open-o/nfv-nsd/nfv-nsd-im-sample.rst
@@ -0,0 +1,18 @@
+.. ========================================================================

+.. Copyright 2017 CMCC 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.

+.. =========================================================================

+

+nfv nsd im sample

+=================