SOL005NSDescriptorManagement_def.yaml 24.1 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
13
14
15
16
17
18
19
20
21
22
23
24
25
  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.
    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"

26
  NsdInfo:
27
    type: object
28
    required:
29
30
31
32
      - id
      - nsdOnboardingState
      - nsdOperationalState
      - nsdUsageState
33
      - _links
34
35
36
37
38
    properties:
      id:
        description: >
          Identifier of the on boarded individual NS descriptor
          resource. This identifier is allocated by the NFVO.
39
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
40
41
42
43
44
45
      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.
46
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
47
      nsdName:
48
        type: string
49
        description: >
50
51
          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.
52
53
54
55
56
      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.
57
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
58
      nsdDesigner:
59
        type: string
60
        description: >
61
62
          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.
63
64
65
66
67
68
69
      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.
70
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
71
72
73
74
75
76
      vnfPkgIds:
        description: >
          Identifies the VNF package for the VNFD referenced
          by the on-boarded NS descriptor resource.
        type: array
        items:
77
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
78
79
80
81
82
83
84
      pnfdInfoIds:
        description: >
          Identifies the PnfdInfo element for the PNFD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
85
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
86
87
88
89
90
91
92
      nestedNsdInfoIds:
        description: >
          Identifies the NsdInfo element for the nested NSD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
93
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
      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"
116
117
118
119
120
121
122
      nsdOnboardingState:
        description: >
          On boarding state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on boarding procedure. See
123
          clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails"
124
125
          structure.
          It shall be present when the "nsdOnboardingState"
126
127
          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.
128
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
      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.
144
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
145
      _links:
146
        type: object
147
        required:
148
149
          - self
          - nsd_content
150
        description: >
151
          Links to resources related to this resource.
152
153
154
        properties:
          self:
            description: >
155
              URI of this resource.
156
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
157
158
          nsd_content:
            description: >
159
              Link to the NSD content resource.
160
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
161
    description: >
162
      This type represents a response for the query NSD operation.
163
164

  CreateNsdInfoRequest:
165
    type: object
166
167
    properties:
      userDefinedData:
168
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
169
    description: >
170
171
      This type creates a completely new NS descriptor resource.

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

185
  PnfdInfo:
186
    type: object
187
    required:
188
189
190
191
      - id
      - pnfdOnboardingState
      - pnfdUsageState
      - _links
192
193
194
195
196
197
    properties:
      id:
        description: >
          Identifier of the on-boarded individual PNF
          descriptor resource. This identifier is allocated by
          the NFVO.
198
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
199
200
201
202
203
204
      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.
205
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
206
207
208
209
210
      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.
211
        type: string
212
      pnfdersion:
213
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
214
215
      pnfdProvider:
        description: >
216
217
          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.
218
        type: string
219
220
221
222
223
      pnfdInvariantId:
        description: >
          Identifies a PNFD in a version independent
          manner. This attribute is invariant across versions
          of PNFD.
224
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
      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"
247
248
249
250
251
252
253
      pnfdOnboardingState:
        description: >
          On-boarding state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on-boarding procedure.
254
          See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure.
255
          It shall be present when the
256
257
          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.
258
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
259
260
261
262
263
264
265
266
      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.
267
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
268
269
      _links:
        required:
270
271
272
          - pnfd_content
          - self
        type: object
273
        description: >
274
          Links to resources related to this resource.
275
276
        properties:
          self:
277
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
278
          pnfd_content:
279
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
280
    description: >
281
      This type represents a response for the query PNFD operation.
282

283
  CreatePnfdInfoRequest:
284
    type: object
285
286
    properties:
      userDefinedData:
287
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
288
289
290
291
    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.
292

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

314
  NsdmSubscription:
315
    type: object
316
    required:
317
318
319
      - id
      - callbackUri
      - _links
320
    properties:
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
      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"
343
    description: >
344
      This type represents a subscription related to notifications about NSD management.
345

346
347
348
349
350
351
352
353
354
355
  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).
356
357
358
359
360
361

      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.
362
363
364
365
366
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
    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"

502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
  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: >
518
519
          Checksum of the artifact file. Permitted hash algorithms are 
          defined in ETSI GS NFV-SOL 007.
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
        $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: >
          Checksum of the artifact file.
        $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"

558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
  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.
587
      CREATED = The NSD information object has been created.
588
589
      UPLOADING = The associated NSD content is being uploaded.
      PROCESSING = The associated NSD content is being processed, e.g. validation.
590
591
      ONBOARDED = The associated NSD content has been on-boarded.
      ERROR = There was an error during upload or processing of the NSD content.
592
593
594
595
596
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED
597
      - ERROR
598
599
600
601
602
603
604

  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.
605
      CREATED = The PNF descriptor resource has been created.
606
607
      UPLOADING = The associated PNFD content is being uploaded.
      PROCESSING = The associated PNFD content is being processed, e.g. validation.
608
609
      ONBOARDED = The associated PNFD content has been on-boarded.
      ERROR = There was an error during upload or processing of the associated PNFD content.
610
611
612
613
614
    enum:
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDING
615
      - ERROR
616
617
618
619
620
621
622
623
624
625
626

  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