docs/ONAP release 2 spec/im/SwImageDesc.rst


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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

.. Copyright 2018 (China Mobile)
.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
.. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode

.. contents::
   :depth: 3
..

Class: SwImageDesc
==================

+-------------------+-------------+------------------+-----------------+--------------------------+
| **Attribute Name**| **Type**    | **Multiplicity** | **Description** | **Applied Stereotypes**  |
+===================+=============+==================+=================+==========================+
| id                | Identifier  | 1                | The             | support:                 |
|                   |             |                  | identifier      | MANDATORY                |
|                   |             |                  | of this         |                          |
|                   |             |                  | software        |                          |
|                   |             |                  | image.          |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| name              | String      | 1                | The name of     | support:                 |
|                   |             |                  | this            | MANDATORY                |
|                   |             |                  | software        |                          |
|                   |             |                  | image.          |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| version           | String      | 1                | The version     | support:                 |
|                   |             |                  | of this         | MANDATORY                |
|                   |             |                  | software        |                          |
|                   |             |                  | image.          |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| checksum          | String      | 1                | The             | support:                 |
|                   |             |                  | checksum of     | MANDATORY                |
|                   |             |                  | the             |                          |
|                   |             |                  | software        |                          |
|                   |             |                  | image file.     |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| containerFo       | String      | 1                | The             | support:                 |
| rmat              |             |                  | container       | MANDATORY                |
|                   |             |                  | format          |                          |
|                   |             |                  | describes       |                          |
|                   |             |                  | the             |                          |
|                   |             |                  | container       |                          |
|                   |             |                  | file format     |                          |
|                   |             |                  | in which        |                          |
|                   |             |                  | software        |                          |
|                   |             |                  | image is        |                          |
|                   |             |                  | provided.       |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| diskFormat        | String      | 1                | The disk        | support:                 |
|                   |             |                  | format of a     | MANDATORY                |
|                   |             |                  | software        |                          |
|                   |             |                  | image is        |                          |
|                   |             |                  | the format      |                          |
|                   |             |                  | of the          |                          |
|                   |             |                  | underlying      |                          |
|                   |             |                  | disk image.     |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| minDisk           | Number      | 1                | The minimal     | support:                 |
|                   | (recommende |                  | disk size       | MANDATORY                |
|                   | d           |                  | requirement     |                          |
|                   | DM type:    |                  | for this        |                          |
|                   | Scalar-Unit |                  | software        |                          |
|                   | -Size)      |                  | image. The      |                          |
|                   |             |                  | value of        |                          |
|                   |             |                  | the "size       |                          |
|                   |             |                  | of storage"     |                          |
|                   |             |                  | attribute       |                          |
|                   |             |                  | of the          |                          |
|                   |             |                  | VirtualStor     |                          |
|                   |             |                  | ageDesc         |                          |
|                   |             |                  | referencing     |                          |
|                   |             |                  | this            |                          |
|                   |             |                  | SwImageDesc     |                          |
|                   |             |                  | shall not       |                          |
|                   |             |                  | be smaller      |                          |
|                   |             |                  | than the        |                          |
|                   |             |                  | value of        |                          |
|                   |             |                  | minDisk.        |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| minRam            | Number      | 0..1             | The minimal     | support:                 |
|                   | (recommende |                  | RAM             | MANDATORY                |
|                   | d           |                  | requirement     |                          |
|                   | DM type:    |                  | for this        |                          |
|                   | Scalar-Unit |                  | software        |                          |
|                   | -Size)      |                  | image. The      |                          |
|                   |             |                  | value of        |                          |
|                   |             |                  | the "size"      |                          |
|                   |             |                  | attribute       |                          |
|                   |             |                  | of              |                          |
|                   |             |                  | VirtualMemo     |                          |
|                   |             |                  | ryData          |                          |
|                   |             |                  | of the Vdu      |                          |
|                   |             |                  | referencing     |                          |
|                   |             |                  | this            |                          |
|                   |             |                  | SwImageDesc     |                          |
|                   |             |                  | shall not       |                          |
|                   |             |                  | be smaller      |                          |
|                   |             |                  | than the        |                          |
|                   |             |                  | value of        |                          |
|                   |             |                  | minRam.         |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| size              | Number      | 1                | The size of     | support:                 |
|                   | (recommende |                  | this            | MANDATORY                |
|                   | d           |                  | software        |                          |
|                   | DM type:    |                  | image.          |                          |
|                   | Scalar-Unit |                  |                 |                          |
|                   | -Size)      |                  |                 |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| swImage           | Identifier  | 1                | This is a       | support:                 |
|                   | (Reference  |                  | reference       | MANDATORY                |
|                   | to a        |                  | to the          |                          |
|                   | SwImage)    |                  | actual          |                          |
|                   |             |                  | software        |                          |
|                   |             |                  | image. The      |                          |
|                   |             |                  | reference       |                          |
|                   |             |                  | can be          |                          |
|                   |             |                  | relative to     |                          |
|                   |             |                  | the root of     |                          |
|                   |             |                  | the VNF         |                          |
|                   |             |                  | Package or      |                          |
|                   |             |                  | can be a        |                          |
|                   |             |                  | URL.            |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| operatingSy       | String      | 0..1             | Identifies      | support:                 |
| stem              |             |                  | the             | MANDATORY                |
|                   |             |                  | operating       |                          |
|                   |             |                  | system used     |                          |
|                   |             |                  | in the          |                          |
|                   |             |                  | software        |                          |
|                   |             |                  | image. This     |                          |
|                   |             |                  | attribute       |                          |
|                   |             |                  | may also        |                          |
|                   |             |                  | identify if     |                          |
|                   |             |                  | a 32 bit or     |                          |
|                   |             |                  | 64 bit          |                          |
|                   |             |                  | software        |                          |
|                   |             |                  | image is        |                          |
|                   |             |                  | used.           |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+
| supportedVi       | String      | 0..N             | Identifies      | support:                 |
| rtualisatio       |             |                  | the             | MANDATORY                |
| nEnvironmen       |             |                  | virtualisat     |                          |
| t                 |             |                  | ion             |                          |
|                   |             |                  | environment     |                          |
|                   |             |                  | s               |                          |
|                   |             |                  | (e.g.           |                          |
|                   |             |                  | hypervisor)     |                          |
|                   |             |                  | compatible      |                          |
|                   |             |                  | with this       |                          |
|                   |             |                  | software        |                          |
|                   |             |                  | image.          |                          |
+-------------------+-------------+------------------+-----------------+--------------------------+