diff options
| -rw-r--r-- | docs/ONAP release 1 spec/csar/csar.rst | 33 |
1 files changed, 24 insertions, 9 deletions
diff --git a/docs/ONAP release 1 spec/csar/csar.rst b/docs/ONAP release 1 spec/csar/csar.rst index 3848e61..74fcfd2 100644 --- a/docs/ONAP release 1 spec/csar/csar.rst +++ b/docs/ONAP release 1 spec/csar/csar.rst @@ -6,14 +6,18 @@ CSAR for VNF Onboarding ----------------------- This is the currently expected structure supported by SDC, which is provided by VNF Vendor directly or via VNF Market (through VNF SDK) to SDC for VNF onboarding in design time. -.. |CSAR for VNF Onboarding| image:: csar-sdc-input.JPG + +|image0| + +\ **Figure 1. CSAR for VNF Onboarding** + The files/directories under the root of CSAR include: * **MainServiceTemplate.mf** is a map representing the different parts of the CSAR structure. * **MainServiceTemplate.yaml** is a copy of the main service template located under Definitions directory. -* **TOSCA-Metadata** 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*. See `Artifacts supported by SDC`_. +* **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. The files/directories under the *Artifacts* directory further include: @@ -32,12 +36,14 @@ 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. -.. |CSAR for VNF LCM| image:: csar-sdc-output-vf.JPG +|image1| + +\ **Figure 2. CSAR for VNF LCM** The files/directories under the root of CSAR include: -* **TOSCA-Metadata** 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*. See `Artifacts supported by SDC`_. +* **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. @@ -56,12 +62,14 @@ CSAR for Service Life Cyclem Management --------------------------------------- This section describes the CSAR generated by SDC for Network Service or End-to-End Service orchestration in run time. -.. |CSAR for Service LCM| image:: csar-sdc-output-service.JPG +|image2| + +\ **Figure 3. CSAR for Service LCM** The files/directories under the root of CSAR include: -* **TOSCA-Metadata** 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*. See `Artifacts supported by SDC`_. +* **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. @@ -119,3 +127,10 @@ Artifacts at the root directory or unrecognized folder(s) will be classified as | Other | | Artifacts at the Root or other | Service/VF/VFC | | | | unrecognized folders. | | +------------------------+-------------+---------------------------------+------------------+ + +.. |image0| image:: csar-sdc-input.JPG + +.. |image1| image:: csar-sdc-output-vf.JPG + +.. |image2| image:: csar-sdc-output-service.JPG + |