summaryrefslogtreecommitdiffstats
path: root/docs/ONAP release 1 spec/csar/csar.rst
blob: 0440234f7fe4747ee918727a649db9ecf99e66b2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
===================================
ONAP CSAR Specification (Amsterdam)
===================================

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

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

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

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          |
+------------------------+-------------+---------------------------------+------------------+
|  HEAT_NET              | Deployment  | HEAT Template for network (yaml)|      VF          |
+------------------------+-------------+---------------------------------+------------------+
|  HEAT_ENV              | Deployment  |HEAT Environment artifacts (yaml)|      VF          |
+------------------------+-------------+---------------------------------+------------------+
|  HEAT_ARTIFACT         | Deployment  | Supplementary artifacts in HEAT |      VF          |
+------------------------+-------------+---------------------------------+------------------+
|  HEAT_NESTED           | Deployment  | HEAT refered by another HEAT    |      VF          |
+------------------------+-------------+---------------------------------+------------------+
|  YANG_XML              |Informational| YANG asset based XML            |Service/VF/VFC    |
+------------------------+-------------+---------------------------------+------------------+
|  VNF_CATALOG           |Informational| YANG asset based XML            |Service/VF/VFC    |
+------------------------+-------------+---------------------------------+------------------+
|MODEL_INVENTORY_PROFILE |Informational| Inventory asset (XML)           |Service/VF/VFC    |
+------------------------+-------------+---------------------------------+------------------+
|MODEL_INVENTORY_PROFILE |Informational| Inventory asset named query spec|Service/VF/VFC    |
+------------------------+-------------+---------------------------------+------------------+
|  VF_LICENSE            |Informational| VF License artifact             |      VF          |
+------------------------+-------------+---------------------------------+------------------+
|  VENDOR_LICENSE        |Informational| Vendor License artifact         |      VF          |
+------------------------+-------------+---------------------------------+------------------+
|  APPC_CONFIG           |Informational| Configuration artifact for APP-C|      VF          |
+------------------------+-------------+---------------------------------+------------------+ 
|  VF_MODULES_METADATA   |Informational| JSON artifact for VF Modules    |Component instance|
+------------------------+-------------+---------------------------------+------------------+
|  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.           |                  |
+------------------------+-------------+---------------------------------+------------------+