SOL005NSDescriptorManagement_def.yaml 24.3 KB
Newer Older
1
2
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
3

4
definitions:
5
6
7
8
9
10
11
12
  NsdInfoModifications:
    type: object
    description: >
      This type represents attribute modifications for an individual NS
      descriptor resource based on the NsdInfo data type. The attributes of
      NsdInfo that can be modified are included in the NsdInfoModifications
      data type.NOTE: At least one of the attributes - nsdOperationalState and
      userDefinedData - shall be present.
13
14
15
16
17
    oneOf:
      - required:
        - nsdOperationalState
      - required:
        - userDefinedData
18
19
20
21
22
23
24
25
26
27
28
29
30
    properties:
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      userDefinedData:
        description: >
          Modifications of the userDefinedData attribute in NsdInfo
          data type. See note. If present, these modifications shall be applied
          according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]).
          NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

31
  NsdInfo:
32
    type: object
33
    required:
34
35
36
37
      - id
      - nsdOnboardingState
      - nsdOperationalState
      - nsdUsageState
38
      - _links
39
40
41
42
43
    properties:
      id:
        description: >
          Identifier of the on boarded individual NS descriptor
          resource. This identifier is allocated by the NFVO.
44
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
45
46
47
48
49
50
      nsdId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies the NSD in a globally unique
          way. It is copied from the NSD content and shall be
          present after the NSD content is on-boarded.
51
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
52
      nsdName:
53
        type: string
54
        description: >
55
56
          Name of the on boarded NSD. This information is copied from the
          NSD content and shall be present after the NSD content is on-boarded.
57
58
59
60
61
      nsdVersion:
        description: >
          Version of the on-boarded NSD. This information is
          copied from the NSD content and shall be present
          after the NSD content is on-boarded.
62
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
63
      nsdDesigner:
64
        type: string
65
        description: >
66
67
          Designer of the on-boarded NSD. This information is copied
          from the NSD content and shall be present after the NSD content is on-boarded.
68
69
70
71
72
73
74
      nsdInvariantId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies an NSD in a version independent
          manner. This information is copied from the NSD
          content and shall be present after the NSD content is
          on-boarded.
75
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
76
77
78
79
80
81
      vnfPkgIds:
        description: >
          Identifies the VNF package for the VNFD referenced
          by the on-boarded NS descriptor resource.
        type: array
        items:
82
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
83
84
85
86
87
88
89
      pnfdInfoIds:
        description: >
          Identifies the PnfdInfo element for the PNFD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
90
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
91
92
93
94
95
96
97
      nestedNsdInfoIds:
        description: >
          Identifies the NsdInfo element for the nested NSD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
98
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
      archiveSecurityOption:
        description: >
          Signals the security option used by the NSD archive as defined
          in clause 5.1 of ETSI GS NFV SOL 007.
          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 NSD archive.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      artifacts:
        description: >
          Information about NSD archive artifacts contained in the NSD archive.
          This attribute shall not be present before the NSD archive content
          is on-boarded. Otherwise, this attribute shall be present if the NSD
          archive contains artifacts.
        type: array
        items:
          $ref: "#/definitions/NsdArchiveArtifactInfo"
121
122
123
124
125
126
127
      nsdOnboardingState:
        description: >
          On boarding state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on boarding procedure. See
128
          clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails"
129
130
          structure.
          It shall be present when the "nsdOnboardingState"
131
132
          attribute is "ERROR", i.e. the uploading or processing has failed in NFVO,
          unless it has been requested to be excluded via an attribute selector.
133
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
      nsdOperationalState:
        description: >
          Operational state of the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
        $ref: "#/definitions/NsdOperationalStateType"
      nsdUsageState:
        description: >
          Usage state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
149
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
150
      _links:
151
        type: object
152
        required:
153
154
          - self
          - nsd_content
155
        description: >
156
          Links to resources related to this resource.
157
158
159
        properties:
          self:
            description: >
160
              URI of this resource.
161
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
162
163
          nsd_content:
            description: >
164
              Link to the NSD content resource.
165
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
166
    description: >
167
      This type represents a response for the query NSD operation.
168
169

  CreateNsdInfoRequest:
170
    type: object
171
172
    properties:
      userDefinedData:
173
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
174
    description: >
175
176
      This type creates a completely new NS descriptor resource.

177
  PnfdInfoModifications:
178
    type: object
179
    required:
180
      - userDefinedData
181
182
    properties:
      userDefinedData:
183
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
184
    description: >
185
      This type represents attribute modifications for an individual PNF
186
187
      descriptor resource based on the "PnfdInfo" data type. The attributes of
      "PnfdInfo" that can be modified are included in the "PnfdInfoModifications"
188
      data type.
189

190
  PnfdInfo:
191
    type: object
192
    required:
193
194
195
196
      - id
      - pnfdOnboardingState
      - pnfdUsageState
      - _links
197
198
199
200
201
202
    properties:
      id:
        description: >
          Identifier of the on-boarded individual PNF
          descriptor resource. This identifier is allocated by
          the NFVO.
203
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
204
205
206
207
208
209
      pnfdId:
        description: >
          This identifier, which is managed by the PNFD
          designer, identifies the PNFD in a globally unique way.
          It is copied from the PNFD content and shall
          be present after the PNFD content is on-boarded.
210
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
211
212
213
214
215
      pnfdName:
        description: >
          Name of the on-boarded PNFD. This information
          is copied from the PNFD content and shall be
          present after the PNFD content is on-boarded.
216
        type: string
217
      pnfdersion:
218
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
219
220
      pnfdProvider:
        description: >
221
222
          Provider of the on-boarded PNFD. This information is copied from
          the PNFD content and shall be present after the PNFD content is on-boarded.
223
        type: string
224
225
226
227
228
      pnfdInvariantId:
        description: >
          Identifies a PNFD in a version independent
          manner. This attribute is invariant across versions
          of PNFD.
229
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
      archiveSecurityOption:
        description: >
          Signals the security option used by the PNFD archive 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 PNFD archive.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      artifacts:
        description: >
          Information about PNFD archive artifacts contained in the PNFD archive.
          This attribute shall not be present before the PNFD archive content is
          on-boarded. Otherwise, this attribute shall be present if the PNFD archive
          contains artifacts.
        type: array
        items:
          $ref: "#/definitions/PnfdArchiveArtifactInfo"
252
253
254
255
256
257
258
      pnfdOnboardingState:
        description: >
          On-boarding state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on-boarding procedure.
259
          See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
260
          It shall be present when the
261
262
          pnfdOnboardingState attribute is "ERROR", i.e. the uploading or processing has failed
          in the NFVO, unless it has been requested to be excluded via an attribute selector.
263
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
264
265
266
267
268
269
270
271
      pnfdUsageState:
        description: >
          Usage state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual PNF descriptor resource.
          This attribute can be modified with the PATCH method.
272
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
273
274
      _links:
        required:
275
276
277
          - pnfd_content
          - self
        type: object
278
        description: >
279
          Links to resources related to this resource.
280
281
        properties:
          self:
282
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
283
          pnfd_content:
284
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
285
    description: >
286
      This type represents a response for the query PNFD operation.
287

288
  CreatePnfdInfoRequest:
289
    type: object
290
291
    properties:
      userDefinedData:
292
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
293
294
295
296
    description: >
      User-defined data for the PNF descriptor resource to be created.
      It shall be present when the user defined data is set for
      the individual PNF descriptor resource to be created.
297

298
  NsdmSubscriptionRequest:
299
    type: object
300
    required:
301
      - callbackUri
302
    properties:
303
304
305
306
307
308
309
      filter:
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
        type: string
        description: >
          The URI of the endpoint to send the notification to.
      authentication:
310
311
312
313
        description: >
          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.
314
        $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication"
315
    description: >
316
317
      This type represents a subscription request related to notifications
      about NSD management.
318

319
  NsdmSubscription:
320
    type: object
321
    required:
322
323
324
      - id
      - callbackUri
      - _links
325
    properties:
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
      id:
        description: >
          Identifier of this subscription resource.
        $ref: "../../definitions/SOL005_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/NsdmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
      _links:
        type: object
        description: >
          Links to resources related to this resource.
        properties:
          self:
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
348
    description: >
349
      This type represents a subscription related to notifications about NSD management.
350

351
352
353
354
355
356
357
358
359
360
  NsdmNotificationsFilter:
    type: object
    description: >
      This type represents a subscription filter related to notifications
      about NSD management. It shall comply with the provisions defined in Table
      5.5.3.2-1 of GS NFV-SOL 005. 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).
361
362
363
364
365
366

      NOTE 1: The attributes "nsdId" and "nsdInfoId" are alternatives to reference to a particular NSD in a filter.
      They should not be used both in the same filter instance, but one alternative should be chosen.

      NOTE 2: The attributes "pnfdId" and "pnfdInfoId" are alternatives to reference to a particular PNFD in a filter.
      They should not be used both in the same filter instance, but one alternative should be chosen.
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
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
    properties:
      notificationTypes:
        description: >
          Match particular notification types. Permitted values: NsdOnBoardingNotification,
          NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification
          PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.
          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:
            - NsdOnBoardingNotification
            - NsdOnboardingFailureNotification
            - NsdChangeNotification
            - NsdDeletionNotification
            - PnfdOnBoardingNotification
            - PnfdOnBoardingFailureNotification
            - PnfdDeletionNotification
      nsdInfoId:
        description: >
          Match the NsdInfo identifier which is allocated by the NFVO.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        description: >
          Match the NSD identifier, which is allocated by the NSD designer.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdName:
        description: >
          Match the name of the on boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      nsdVersion:
        description: >
          Match the NSD version listed as part of this attribute.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
      nsdDesigner:
        description: >
          Match the NSD designer of the on-boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      nsdInvariantId:
        description: >
          Match the NSD invariant identifier which is allocated
          by the NSD designer and identifies an NSD in a
          version independent manner.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      vnfPkgIds:
        description: >
          Match VNF packages with a package identifier listed
          in the attribute.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdInfoIds:
        description: >
          Match the PnfdInfo identifier for the PNFD
          referenced by the on-boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nestedNsdInfoIds:
        description: >
          Match the NsdInfo identifier for the nested NSD
          referenced by the on-boarded NSD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdOnboardingState:
        description: >
          Match particular on-boarding state of the NSD.
        type: array
        items:
          $ref: "#/definitions/NsdOnboardingStateType"
      nsdOperationalState:
        description: >
          Match particular operational state of the on-boarded NSD.
        type: array
        items:
          $ref: "#/definitions/NsdOperationalStateType"
      nsdUsageState:
        description: >
          Match particular usage state of the on-boarded NSD.
        type: array
        items:
          $ref: "#/definitions/NsdUsageStateType"
      pnfdId:
        description: >
          Match the PNFD identifier which is copied from the PNFD content.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdName:
        description: >
          Match the name of the on-boarded PNFD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      pnfdVersion:
        description: >
          Match the PNFD designer of the on-boarded PNFD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
      pnfdProvider:
        description: >
          Match the provider of the on-boarded PNFD.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      pnfdInvariantId:
        description: >
          Match the PNFD in a version independent manner.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdOnboardingState:
        description: >
          Match particular on-boarding state of the PNFD.
        type: array
        items:
          $ref: "#/definitions/PnfdOnboardingStateType"
      pnfdUsageState:
        description: >
          Match the usage state of the individual PNF descriptor resource.
        type: array
        items:
          $ref: "#/definitions/PnfdUsageStateType"

507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
  NsdArchiveArtifactInfo:
    type: object
    description: >
      This type represents an artifact contained in an NSD archive.
      It shall comply with provisions defined in Table 5.5.3.5-1.
    required:
      - artifactPath
      - checksum
    properties:
      artifactPath:
        description: >
          Path in the NSD archive, which identifies the artifact and
          also allows to access a copy of the artifact.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      checksum:
        description: >
523
524
          Checksum of the artifact file. Permitted hash algorithms are 
          defined in ETSI GS NFV-SOL 007.
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
      metadata:
        description: >
          The metadata of the artifact that are available in the NSD Archive,
          such as Content type, size, creation date, etc.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  PnfdArchiveArtifactInfo:
    type: object
    description: >
      This type represents an artifact contained in a PNFD archive.
      It shall comply with provisions defined in Table 5.5.3.6-1.
    required:
      - artifactPath
      - checksum
    properties:
      artifactPath:
        description: >
          Path in the PNFD archive, which identifies the artifact and
          also allows to access a copy of the artifact.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      checksum:
        description: >
548
549
          Checksum of the artifact file. Permitted hash algorithms are 
          defined in ETSI GS NFV-SOL 004.
550
551
552
553
554
555
556
557
558
559
560
561
562
563
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Checksum"
      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/SOL005_def.yaml#/definitions/String"
      metadata:
        description: >
          The metadata of the artifact that are available in the PNFD Archive,
          such as Content type, size, creation date, etc.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
  NsdOperationalStateType:
    type: string
    description: >
      The enumeration NsdOperationalStateType shall comply with the provisions
      defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational
      state of the resource.
      ENABLED = The operational state of the resource is enabled.
      DISABLED = The operational state of the resource is disabled.
    enum:
      - ENABLED
      - DISABLED

  NsdUsageStateType:
    type: string
    description: >
      The enumeration NsdUsageStateType shall comply with the provisions
      defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state
      of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource
      is not-in-use.
    enum:
      - IN_USE
      - NOT_IN_USE

  NsdOnboardingStateType:
    type: string
    description: >
      The enumeration NsdOnboardingStateType shall comply with the provisions
      defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
      state of the NSD.
593
      CREATED = The NSD information object has been created.
594
595
      UPLOADING = The associated NSD content is being uploaded.
      PROCESSING = The associated NSD content is being processed, e.g. validation.
596
597
      ONBOARDED = The associated NSD content has been on-boarded.
      ERROR = There was an error during upload or processing of the NSD content.
598
599
600
601
602
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED
603
      - ERROR
604
605
606
607
608
609
610

  PnfdOnboardingStateType:
    type: string
    description: >
      The enumeration PnfdOnboardingStateType shall comply with the provisions
      defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state
      of the individual PNF descriptor resource.
611
      CREATED = The PNF descriptor resource has been created.
612
613
      UPLOADING = The associated PNFD content is being uploaded.
      PROCESSING = The associated PNFD content is being processed, e.g. validation.
614
615
      ONBOARDED = The associated PNFD content has been on-boarded.
      ERROR = There was an error during upload or processing of the associated PNFD content.
616
617
618
619
620
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDING
621
      - ERROR
622
623
624
625
626
627
628
629
630
631
632

  PnfdUsageStateType:
    type: string
    description: >
      The enumeration PnfdUsageStateType shall comply with the provisions
      defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state
      of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource
      is not-in-use.
    enum:
      - IN_USE
      - NOT_IN_USE