Newer
Older
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
"description": "This type represents the information of an VNF package.\n",
"type": "object",
"required": ["id", "packageSecurityOption", "operationalState", "usageState", "vnfmInfo", "_links"],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"vnfProductName": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A version.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A version.\n",
"type": "string"
},
"compatibleSpecificationVersions": {
"description": "Indicates which versions of the ETSI GS NFV-SOL 004 specification the package complies to, as defined in the manifest of the package. Each entry shall be formatted as defined in clause 4.3.2 of ETSI GS NFV-SOL 004.\n",
"type": "array",
"items": {
"description": "A version.\n",
"type": "string"
}
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"type": "object",
"required": ["algorithm", "hash"],
"properties": {
"algorithm": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"hash": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
}
}
},
"packageSecurityOption": {
"description": "Signals the security option used by the package as defined in clause 5.1 of ETSI GS NFV-SOL 004. Valid values: OPTION_1, OPTION_2\n",
"type": "string",
"enum": ["OPTION_1", "OPTION_2"]
},
"signingCertificate": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"softwareImages": {
"description": "Information about VNF package artifacts that are software images. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present unless it has been requested to be excluded per attribute selector.\n",
"type": "array",
"items": {
"description": "This type represents an artifact contained in or external to a VNF package which represents a software image. It shall comply with provisions defined in table 10.5.3.2-1\n",
"type": "object",
"required": ["id", "name", "provider", "version", "checksum", "isEncrypted", "containerFormat", "diskFormat", "createdAt", "minDisk", "minRam", "size", "imagePath"],
"properties": {
"id": {
"description": "An identifier that is unique within a VNF descriptor.\n",
"type": "string"
},
"name": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"provider": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"version": {
"description": "A version.\n",
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"type": "object",
"required": ["algorithm", "hash"],
"properties": {
"algorithm": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"hash": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"containerFormat": {
"description": "Container format indicates whether the software image is in a file format that also contains metadata about the actual software. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - BARE: the image does not have a container or metadata envelope - DOCKER: docker container format - OVA: OVF package in a tarfile - OVF: OVF container format The list of permitted values was taken from \"Container formats\" in http://docs.openstack.org/image-guide/image-formats.html\n",
"type": "string",
"enum": ["AKI", "AMI", "ARI", "BARE", "DOCKER", "OVA", "OVF"]
},
"diskFormat": {
"description": "Disk format of a software image is the format of the underlying disk image. Permitted values: - AKI: a kernel image format - AMI: a machine image format - ARI: a ramdisk image format - ISO: an archive format for the data contents of an optical disc, such as CD-ROM\n- QCOW2: a common disk image format, which can expand dynamically and supports copy on write\n- RAW: an unstructured disk image format - VDI: a common disk image format - VHD: a common disk image format - VHDX: enhanced version of VHD format - VMDK: a common disk image format The list of permitted values was adapted from \"Disk formats\" in http://docs.openstack.org/image-guide/image-formats.html\n",
"type": "string",
"enum": ["AKI", "AMI", "ISO", "QCOW2", "RAW", "VDI", "VHD", "VHDX", "VMDK"]
},
"createdAt": {
"description": "Date-time stamp. Representation: String formatted according to IETF RFC 3339.\n",
"type": "string",
"format": "date-time"
},
"minDisk": {
"description": "The minimal disk for this software image in bytes.\n",
"type": "integer"
},
"minRam": {
"description": "The minimal RAM for this software image in bytes.\n",
"type": "integer"
},
"size": {
"description": "Size of this software image in bytes.\n",
"type": "integer"
},
"userMetadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"imagePath": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"imageUri": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
},
"additionalArtifacts": {
"description": "Information about VNF package artifacts contained in the VNF package that are not software images. Every local and external artifact declared in the manifest shall be included, except the software images and the files that make up the parts of the VNFD (see clause 10.4.4.3.2). Signature files and certificate files are not considered as artifacts, however, the content of the \"Licenses\" and \"Testing\" directories in the VNF package is. This attribute shall not be present before the VNF package content is on-boarded. Otherwise, this attribute shall be present if the VNF package contains additional artifacts.\n",
"type": "array",
"items": {
"description": "This type represents an artifact other than a software image which is contained in or external to a VNF package. It shall comply with the provisions defined in table 10.5.3.3-1.\n",
"type": "object",
"required": ["artifactPath", "checksum", "isEncrypted"],
"properties": {
"artifactPath": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"artifactURI": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
},
"checksum": {
"description": "This type represents the checksum of a VNF package or an artifact file.\n",
"type": "object",
"required": ["algorithm", "hash"],
"properties": {
"algorithm": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"hash": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
}
}
},
"isEncrypted": {
"description": "The Boolean is a data type having two values (true and false).\n",
"type": "boolean"
},
"nonManoArtifactSetId": {
"description": "A string defined in IETF RFC 8259.\n",
"type": "string"
},
"artifactClassification": {
"description": "Marks specific types of artifacts as defined in the VNF package. If none of the specific classes listed below applies, the attribute shall not be present.\nValid values: -\tHISTORY: a history artifact as per clause 4.3.3 in ETSI GS NFV-SOL 004 -\tTESTING: a testing artifact as per clause 4.3.4 in ETSI GS NFV-SOL 004 -\tLICENSE: a license artifact as per clause 4.3.5 in ETSI GS NFV-SOL 004\n",
"type": "string",
"enum": ["HISTORY", "TESTING", "LICENSE"]
},
"metadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
}
}
}
},
"onboardingState": {
"description": "CREATED: The \"Individual VNF package\" resource has been created. UPLOADING: The associated VNF package content is being uploaded. PROCESSING: The associated VNF package content is being processed, e.g., validation.\nONBOARDED: The associated VNF package content has been on-boarded successfully. ERROR: There was an error during upload of the VNF package content or external artifacts, or during VNF package processing.\n",
"type": "string",
"enum": ["CREATED", "UPLOADING", "PROCESSING", "ONBOARDED", "ERROR"]
},
"operationalState": {
"description": "- ENABLED: The VNF package is enabled, i.e. it can be used for the creation of new \"Individual VNF instance\" resources.\n- DISABLED: The VNF package is disabled, i.e. it shall not be used for the creation of further \"Individual VNF instance\" resources\n (unless and until the VNF package is re-enabled).\n",
"type": "string",
"enum": ["ENABLED", "DISABLED"]
},
"usageState": {
"description": "- IN_USE: \"Individual VNF instance\" resources created from this VNF package exist. - NOT_IN_USE: No \"Individual VNF instance\" resource created from this VNF package exists.\n",
"type": "string",
"enum": ["IN_USE", "NOT_IN_USE"]
},
"vnfmInfo": {
"description": "Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.\n"
},
"userDefinedData": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of keyvalue pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259. In the following example, a list of key-value pairs with four keys (\"aString\", \"aNumber\", \"anArray\" and \"anObject\") is provided to illustrate that the values associated with different keys can be of different type.\n",
"type": "object"
},
"onboardingFailureDetails": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": ["status", "detail"],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
},
"_links": {
"description": "Links to resources related to this resource.\n",
"type": "object",
"required": ["self", "packageContent"],
"properties": {
"self": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"vnfd": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
},
"packageContent": {
"description": "This type represents a link to a resource using an absolute URI.\n",
"type": "object",
"required": ["href"],
"properties": {
"href": {
"description": "String formatted according to IETF RFC 3986.\n",
"type": "string"
}
}
}
}
}
}