SOL003VNFPackageManagement_def.yaml 26.1 KB
Newer Older
1
2
3
4
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
5
  VnfPkgInfo:
6
    description: >
7
      This type represents the information of an VNF package.
8
9
10
    type: object
    required:
      - id
11
      - packageSecurityOption
12
13
      - operationalState
      - usageState
14
      - vnfmInfo
15
      - _links
16
    properties:
17
18
19
20
21
22
23
24
25
26
      id:
        description: >
          Identifier of the on-boarded VNF package. This identifier is
          allocated by the NFVO.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfdId:
        description: >
          This identifier, which is managed by the VNF provider, identifies
          the VNF package and the VNFD in a globally unique way.
          It's copied from the VNFD of the on-boarded VNF package.
27
28
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
29
30
31
32
33
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfProvider:
        description: >
          Provider of the VNF package and the VNFD. This information is copied
          from the VNFD.
34
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
35
36
37
38
      vnfProductName:
        description: >
          Name to identify the VNF product. Invariant for the VNF product
          lifetime. This information is copied from the VNFD.
39
40
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
41
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
42
43
44
45
46
      vnfSoftwareVersion:
        description: >
          Software version of the VNF. This is changed when there is any
          change to the software included in the VNF package.
          This information is copied from the VNFD.
47
48
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
Giacomo Bernini's avatar
Giacomo Bernini committed
49
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
50
51
52
      vnfdVersion:
        description: >
          The version of the VNFD. This information is copied from the VNFD.
53
54
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
Giacomo Bernini's avatar
Giacomo Bernini committed
55
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
56
57
58
59
60
61
62
63
      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.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
64
65
66
      checksum:
        description: >
          Checksum of the on-boarded VNF package.
67
68
          It shall be present after the VNF package content has been
          on-boarded and absent otherwise.
69
          Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.
70
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
71
72
73
74
75
76
77
78
79
80
81
82
      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
        type: string
        enum:
          - OPTION_1
          - OPTION_2
      signingCertificate:
        description: >
          The singleton signing certificate if it is included as a file in the VNF package.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
83
84
85
      softwareImages:
        description: >
          Information about VNF package artifacts that are software images.
86
87
88
          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.
89
90
91
92
93
94
95
        type: array
        items:
          $ref: "#/definitions/VnfPackageSoftwareImageInfo"
      additionalArtifacts:
        description: >
          Information about VNF package artifacts contained in the VNF package
          that are not software images.
96
97
98
99
100
101
          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.
102
103
104
          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.
105
106
107
        type: array
        items:
          $ref: "#/definitions/VnfPackageArtifactInfo"
108
109
110
      onboardingState:
        description: >
          On-boarding state of the VNF package.
111
        $ref: "#/definitions/PackageOnboardingStateType"
112
113
      operationalState:
        description: >
114
115
116
117
          Operational state of the VNF package.
          If the value of the onboardingState attribute is not equal to
          "ONBOARDED", the value of the operationalState attribute shall be
          equal to "DISABLED".
118
119
120
        $ref: "#/definitions/PackageOperationalStateType"
      usageState:
        description: >
121
122
123
124
          Usage state of the VNF package.
          If the value of the onboardingState attribute is not equal to
          "ONBOARDED", the value of the usageState attribute shall be
          equal to "NOT_IN_USE".
125
        $ref: "#/definitions/PackageUsageStateType"
126
127
128
129
130
      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.
131
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
132
133
134
135
      userDefinedData:
        description: >
          User defined data for the VNF package.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
136
137
138
139
140
141
142
143
      onboardingFailureDetails:
        description: >
          Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013
          for the details of "ProblemDetails" structure.
          If "onboardingState" is "ERROR", this attribute shall be present and contain error
          information (such as failed onboarding or processing operation, affected artifact etc.),
          unless it has been requested to be excluded via an attribute selector.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
144
145
146
147
      _links:
        description: >
          Links to resources related to this resource.
        type: object
148
        required:
149
150
          - self
          - packageContent
151
        properties:
152
153
154
155
156
157
          self:
            description: >
              URI of this resource.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          vnfd:
            description: >
158
              Link to the "VNFD in an individual VNf package" resource.
159
160
161
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"
          packageContent:
            description: >
162
              Link to the "VNF package content" resource.
163
164
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

165
  PkgmSubscriptionRequest:
166
    description: >
167
168
      This type represents a subscription request related to VNF package
      management notifications about VNF package on-boarding or changes.
169
    type: object
170
171
    required:
      - callbackUri
172
    properties:
173
      filter:
174
        description: >
175
176
177
178
179
180
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to.
          A particular notification is sent to the subscriber if the filter
          matches, or if there is no filter.
        $ref: "#/definitions/PkgmNotificationsFilter"
      callbackUri:
181
        description: >
182
183
184
          The URI of the endpoint to send the notification to.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
      authentication:
185
        description: >
186
187
188
189
190
191
          Authentication parameters to configure the use of Authorization when
          sending notifications corresponding to this subscription, as defined
          in clause 8.3.4 of ETSI GS NFV-SOL 013.
          This attribute shall only be present if the subscriber requires
          authorization of notifications.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"
192

193
194
195
196
197
  PkgmSubscription:
    description: >
      This type represents a subscription related to notifications about
      VNF package management.
    type: object
198
    required:
199
200
201
      - id
      - callbackUri
      - _links
202
    properties:
203
204
      id:
        description: >
205
          Identifier of this "Individual subscription" resource.
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/PkgmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
      _links:
        description: >
          Links to resources related to this resource.
        type: object
222
223
        required:
          - self
224
225
226
227
228
229
230
231
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Link"

  VnfPackageSoftwareImageInfo:
    description: >
232
      This type represents an artifact contained in or external to a VNF package which
233
234
235
236
237
238
239
240
      represents a software image.
    type: object
    required:
      - id
      - name
      - provider
      - version
      - checksum
241
      - isEncrypted
242
243
244
245
246
247
      - containerFormat
      - diskFormat
      - createdAt
      - minDisk
      - minRam
      - size
248
    properties:
249
250
251
252
253
254
255
      id:
        description: >
          Identifier of the software image.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnfd"
      name:
        description: >
          Name of the software image.
256
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
257
258
259
      provider:
        description: >
          Provider of the software image.
260
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
261
262
263
      version:
        description: >
          Version of the software image.
Giacomo Bernini's avatar
Giacomo Bernini committed
264
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
265
266
267
      checksum:
        description: >
          Checksum of the software image file.
268
          Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.
269
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
270
271
272
273
      isEncrypted:
        description: >
          Reflects whether the image is encrypted (true) or not (false).
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
274
275
276
277
278
279
280
281
282
283
284
285
      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
286
          The list of permitted values was taken from "Container formats" in
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
          http://docs.openstack.org/image-guide/image-formats.html
        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
          - QCOW2: a common disk image format, which can expand dynamically
            and supports copy on write
          - 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
314
          The list of permitted values was adapted from "Disk formats" in
315
316
          http://docs.openstack.org/image-guide/image-formats.html
        type: string
317
        enum:
318
          - AKI
319
          - AMI
320
321
322
323
324
325
326
          - ISO
          - QCOW2
          - RAW
          - VDI
          - VHD
          - VHDX
          - VMDK
327
      createdAt:
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
        description: >
          Time when this software image was created.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/DateTime"
      minDisk:
        description: >
          The minimal disk for this software image in bytes.
        type: integer
      minRam:
        description: >
          The minimal RAM for this software image in bytes.
        type: integer
      size:
        description: >
          Size of this software image in bytes.
        type: integer
      userMetadata:
        description: >
          User-defined data.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
      imagePath:
        description: >
349
          Path which identifies the image artifact and also
350
          allows to access a copy of the image artifact.
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
          For a software image contained as a file in the VNF
          package, this attribute shall be present, and the value of
          this attribute shall start with the name of the first segment
          in the path in the package, i.e., it shall not be prefixed by
          path separator characters such as "." and "/".
          EXAMPLE: foo/bar/m%40ster.vhd
          For an external software image represented as a URI in
          the VNF descriptor, this attribute shall be present if the 
          image artifact has been downloaded by the NFVO and
          shall be absent otherwise. If present, it shall contain the
          artifactPath under which the image artifact can be
          obtained using the "Individual artifact in a VNF package"
          resource defined in clause 9.4.7. It is the responsibility of
          the NFVO to synthesize this path in a manner that avoids
          any collision of the synthesized artifact path with the
          paths and names of image artifacts included in the
          package.
        type: string
      imageUri:
        description: >
          URI of the image artifact as defined in the VNF package
          manifest. Shall be present if the image artifact is external
          to the VNF package and shall be absent otherwise.
          EXAMPLE: https://example.com/m%40ster.vhd
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
376

377
378
379
  VnfPackageArtifactInfo:
    description: >
      This type represents an artifact other than a software image which is
380
      contained in or external to a VNF package.
381
382
383
384
    type: object
    required:
      - artifactPath
      - checksum
385
      - isEncrypted
386
387
388
    properties:
      artifactPath:
        description: >
389
390
          Path in the VNF package, which identifies the artifact and
          also allows to access a copy of the artifact. The
391

392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
          For an artifact contained as a file in the VNF package,
          this attribute shall be present, and the value of this
          attribute shall start with the name of the first segment
          in the path in the package, i.e. it shall not be prefixed
          by path separator characters such as "." and "/".

          EXAMPLE:	foo/bar/runm@ster.sh

          For an external artifact represented as a URI in the
          VNF descriptor, this attribute shall be present if the
          artifact has been downloaded by the NFVO and shall be
          absent otherwise. If present, it shall contain the
          artifactPath under which the artifact can be obtained
          using the "Individual artifact in a VNF package" resource
          defined in clause 10.4.6. It is the responsibility of the
          NFVO to synthesize this path in a manner that avoids any
          collision of the synthesized artifact path with the paths
          and names of artifacts included in the package.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      artifactURI:
        description: >
          URI of the artifact as defined in the VNF package manifest.
          Shall be present if the artifact is external to the package
          and shall be absent otherwise.

          EXAMPLE: https://example.com/m%40ster.sh
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Uri"
421
422
423
424
425
426
427
428
429
      checksum:
        description: >
          Checksum of the artifact file.
          Permitted hash algorithms are defined in ETSI GS NFV-SOL 004.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Checksum"
      isEncrypted:
        description: >
          Reflects whether the artifact is encrypted (true) or not (false).
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Boolean"
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
      nonManoArtifactSetId:
        description: >
          Non-MANO artifact set identifier of the non-MANO artifact set to
          which the artifact belongs, as defined in clause 4.3.7 of ETSI GS NFV-SOL 004.
          Shall be provided if the artifact is a non-MANO artifact, and shall be omitted otherwise.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/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.

          Valid values:
          -	HISTORY: a history artifact as per clause 4.3.3 in ETSI GS NFV-SOL 004
          -	TESTING: a testing artifact as per clause 4.3.4 in ETSI GS NFV-SOL 004
          -	LICENSE: a license artifact as per clause 4.3.5 in ETSI GS NFV-SOL 004
        type: string
        enum:
          - HISTORY
          - TESTING
          - LICENSE
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
      metadata:
        description: >
          The metadata of the artifact that are available in the VNF package,
          such as Content type, size, creation date, etc.
        $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"

  PkgmNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications
      related to VNF package management.
      At a particular nesting level in the filter structure, the following
      applies: All attributes shall match in order for the filter to match
      (logical "and" between different filter attributes). If an attribute
      is an array, the attribute shall match if at least one of the values
      in the array matches (logical "or" between the values of one filter
      attribute).
    type: object
467
468
469
470
471
472
473
474
    anyOf:
      - oneOf:
        - required:
            - vnfProductsFromProviders
        - required:
            - vnfdId
        - required:
            - vnfPkgId
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
    properties:
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - VnfPackageOnboardingNotification
          - VnfPackageChangeNotification
          The permitted values of the "notificationTypes" attribute are
          spelled exactly as the names of the notification types to
          facilitate automated code generation systems.
        type: array
        items:
          type: string
          enum:
            - VnfPackageOnboardingNotification
            - VnfPackageChangeNotification
      vnfProductsFromProviders:
        description: >
          If present, match VNF packages that contain VNF products from
          certain providers.
          The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
          are alternatives to reference to particular VNF packages in a
          filter. They should not be used both in the same filter instance,
          but one alternative should be chosen.
        type: array
        items:
          type: object
          required:
            - vnfProvider
          properties:
            vnfProvider:
              description: >
                Name of the VNF provider to match.
508
              $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
509
510
511
512
513
514
515
516
517
518
519
520
521
            vnfProducts:
              description: >
                If present, match VNF packages that contain VNF products with
                certain product names, from one particular provider.
              type: array
              items:
                type: object
                required:
                  - vnfProductName
                properties:
                  vnfProductName:
                    description: >
                      Name of the VNF product to match.
522
                    $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
523
524
525
526
527
528
529
530
531
532
533
534
535
536
                  versions:
                    description: >
                      If present, match VNF packages that contain VNF products
                      with certain versions and a certain product name, from
                      one particular provider.
                    type: array
                    items:
                      type: object
                      required:
                        - vnfSoftwareVersion
                      properties:
                        vnfSoftwareVersion:
                          description: >
                            VNF software version to match.
Giacomo Bernini's avatar
Giacomo Bernini committed
537
                          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
538
539
540
541
542
543
544
545
                        vnfdVersions:
                          description: >
                            If present, match VNF packages that contain VNF
                            products with certain VNFD versions, a certain
                            software version and a certain product name, from
                            one particular provider.
                          type: array
                          items:
Giacomo Bernini's avatar
Giacomo Bernini committed
546
                            $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Version"
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
      vnfdId:
        description: >
          Match VNF packages with a VNFD identifier listed in the attribute.
          The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
          are alternatives to reference to particular VNF packages in a
          filter. They should not be used both in the same filter instance,
          but one alternative should be chosen.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      vnfPkgId:
        description: >
          Match VNF packages with a package identifier listed in the
          attribute.
          May be present if the "notificationTypes" attribute contains the
562
          value "VnfPackageChangeNotification" and shall be absent
563
564
565
566
567
568
569
570
571
572
          otherwise.
          The attributes "vnfProductsFromProviders", "vnfdId" and "vnfPkgId"
          are alternatives to reference to particular VNF packages in a
          filter. They should not be used both in the same filter instance,
          but one alternative should be chosen.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
      operationalState:
        description: >
573
          Match particular operational states of the VNF package.
574
          May be present if the "notificationTypes" attribute contains the
575
          value "VnfPackageChangeNotification" and shall be absent
576
577
578
579
          otherwise.
        $ref: "#/definitions/PackageOperationalStateType"
      usageState:
        description: >
580
          Match particular usage states of the VNF package.
581
          May be present if the "notificationTypes" attribute contains the
582
          value "VnfPackageChangeNotification" and shall be absent
583
584
          otherwise.
        $ref: "#/definitions/PackageUsageStateType"
585
586
587
588
589
590
      vnfmInfo:
        description: >
          Match strings that specify VNFMs compatible with the VNF. See table 10.5.2.2-1.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
591
592
593
594

  PackageOperationalStateType:
    description: >
      - ENABLED: The VNF package is enabled, i.e. it can be used for
595
596
597
598
        the creation of new "Individual VNF instance" resources.
      - DISABLED: The VNF package is disabled, i.e. it shall not be used for
        the creation of further "Individual VNF instance" resources
        (unless and until the VNF package is re-enabled).
599
600
601
602
603
604
605
    type: string
    enum:
      - ENABLED
      - DISABLED

  PackageUsageStateType:
    description: >
606
607
      - 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.
608
609
610
611
612
613
614
615
616
617
    type: string
    enum:
      - IN_USE
      - NOT_IN_USE

  PackageOnboardingStateType:
    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.,
618
619
620
621
                  validation.
      ONBOARDED: 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.
622
623
624
625
626
    type: string
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
627
628
      - ONBOARDED
      - ERROR