docs/Chapter8/TOSCA-model.rst

   1 .. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
   2
   3 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   4    (the "License"); you may not use this documentation except in compliance
   5    with the License. You may obtain a copy of the License at
   6
   7 .. https://creativecommons.org/licenses/by/4.0/
   8
   9 .. Unless required by applicable law or agreed to in writing, software
  10    distributed under the License is distributed on an "AS IS" BASIS,
  11    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    See the License for the specific language governing permissions and
  13    limitations under the License.
  14
  15
  16 TOSCA model
  17 -----------
  18
  19 Table D1. ONAP Resource DM TOSCA/YAML constructs
  20 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  21
  22 Standard TOSCA/YAML definitions agreed by VNF SDK Modeling team to be used by
  23 VNF vendors to create a standard VNF descriptor.
  24
  25 All definitions are summarized in the table below based on the agreed ONAP
  26 Resource DM TOSCA/YAML constructs for Beijing. Their syntax is specified in
  27 ETSI GS NFV-SOL001 stable draft for VNF-D.
  28
  29 +------------+------------------------------+---------------------------------+
  30 | Requirement| Resource IM Info Elements    | TOSCA Constructs as per SOL001  |
  31 | Number     |                              |                                 |
  32 +============+==============================+=================================+
  33 | R-02454    | VNFD.vnfSoftwareVersion      | For VDU.Compute -               |
  34 |            |                              | tosca.artifacts.nfv.SwImage     |
  35 |            |                              |                                 |
  36 |            | SwImageDesc.Version          | For Virtual Storage -           |
  37 |            |                              | tosca.artifacts.Deployment.Image|
  38 +------------+------------------------------+---------------------------------+
  39 | R-03070    | vnfExtCpd's with virtual     | tosca.nodes.nfv.VnfExtCp with a |
  40 |            | NetworkInterfaceRequirements | property tosca.datatypes.nfv.\  |
  41 |            | (vNIC)                       | VirtualNetworkInterface\        |
  42 |            |                              | Requirements                    |
  43 +------------+------------------------------+---------------------------------+
  44 | R-09467    | VDU.Compute descriptor       | tosca.nodes.nfv.Vdu.Compute     |
  45 +------------+------------------------------+---------------------------------+
  46 | R-16065    | VDU.Compute. Configurable    | tosca.datatypes.nfv.Vnfc        |
  47 |            | Properties                   | ConfigurableProperties          |
  48 +------------+------------------------------+---------------------------------+
  49 | R-30654    | VNFD.lifeCycleManagement     | Interface construct tosca.\     |
  50 |            | Script - IFA011 LifeCycle\   | interfaces.nfv.vnf.lifecycle.Nfv|
  51 |            | ManagementScript             | with a list of standard LCM     |
  52 |            |                              | operations                      |
  53 +------------+------------------------------+---------------------------------+
  54 | R-35851    | CPD: VduCp, VnfExtCp,        | tosca.nodes.nfv.VduCp, tosca.\  |
  55 |            | VnfVirtualLinkDesc, QoS      | nodes.nfv.VnfVirtualLink,       |
  56 |            | Monitoring info element  -   | tosca.nodes.nfv.VnfExtCp        |
  57 |            | TBD                          |                                 |
  58 +------------+------------------------------+---------------------------------+
  59 | R-41215    | VNFD/VDU Profile and scaling | tosca.datatypes.nfv.VduProfile  |
  60 |            | aspect                       | and tosca.datatypes.nfv.\       |
  61 |            |                              | ScalingAspect                   |
  62 +------------+------------------------------+---------------------------------+
  63 | R-66070    |  VNFD meta data              | tosca.datatypes.nfv.            |
  64 |            |                              | VnfInfoModifiableAttributes -   |
  65 |            |                              | metadata?                       |
  66 +------------+------------------------------+---------------------------------+
  67 | R-96634    | VNFD.configurableProperties  | tosca.datatypes.nfv.Vnf\        |
  68 |            | describing scaling           | ConfigurableProperties,         |
  69 |            | characteristics.  VNFD.\     | tosca.datatypes.nfv.ScaleInfo   |
  70 |            | autoscale defines the rules  |                                 |
  71 |            | for scaling based on specific|                                 |
  72 |            | VNF  indications             |                                 |
  73 +------------+------------------------------+---------------------------------+
  74 | ?          |  VDU Virtual Storage         | tosca.nodes.nfv.Vdu.\           |
  75 |            |                              | VirtualStorage                  |
  76 +------------+------------------------------+---------------------------------+
  77 | R-01478    | Monitoring Info Element (TBD)| tosca.capabilities.nfv.Metric - |
  78 |            | - SOL001 per VNF/VDU/VLink   | type for monitoring             |
  79 | R-01556    | memory-consumption,          |                                 |
  80 |            | CPU-utilization,             | monitoring_parameter  of above  |
  81 |            | bandwidth-consumption, VNFC  | type per VNF/VDU/VLink          |
  82 |            | downtime, etc.               |                                 |
  83 +------------+------------------------------+---------------------------------+
  84
  85
  86 Table D2. TOSCA CSAR structure
  87 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  88
  89 This section defines the requirements around the CSAR structure.
  90
  91 The table below describes the numbered requirements for CSAR structure as
  92 agreed with SDC. The format of the CSAR is specified in SOL004.
  93
  94 +------------+-------------------------------------+--------------------------+
  95 | Requirement| Description                         | CSAR artifact directory  |
  96 | Number     |                                     |                          |
  97 +============+=====================================+==========================+
  98 | R-26881    | The VNF provider MUST provide the   | ROOT\\Artifacts\         |
  99 |            | binaries and images needed to       | \\VNF_Image.bin          |
 100 |            | instantiate the VNF (VNF and VNFC   |                          |
 101 |            | images).                            |                          |
 102 +------------+-------------------------------------+--------------------------+
 103 | R-30654    | VNFD.lifeCycleManagementScript that | ROOT\\Artifacts\         |
 104 |            | includes a list of events and       | \\Informational\         |
 105 |            | corresponding management scripts    | \\Install.csh            |
 106 |            | performed for the VNF - SOL001      |                          |
 107 +------------+-------------------------------------+--------------------------+
 108 | R-35851    | All VNF topology related definitions| ROOT\\Definitions\       |
 109 |            | in yaml files VNFD/Main Service     | \\VNFC.yaml              |
 110 |            | template at the ROOT                |                          |
 111 |            |                                     | ROOT\                    |
 112 |            |                                     | \\MainService\           |
 113 |            |                                     | \\Template.yaml          |
 114 +------------+-------------------------------------+--------------------------+
 115 | R-40827    | CSAR License directory - SOL004     | ROOT\\Licenses\          |
 116 |            |                                     | \\License_term.txt       |
 117 +------------+-------------------------------------+--------------------------+
 118 | R-77707    | CSAR Manifest file - SOL004         | ROOT\                    |
 119 |            |                                     | \\MainServiceTemplate.mf |
 120 +------------+-------------------------------------+--------------------------+
 121
 122