summaryrefslogtreecommitdiffstats
path: root/samples/yang.yaml
blob: 3b1ce27ddca0b25b2acb2891bf40e1289e147f97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
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
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
f='#n575'>575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
##############################################################################
# Copyright (c) 2017 Huawei Technologies Co.,Ltd and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
 module clearwater {

       namespace "http://localhost/ietf-inet-types.yang";

       prefix "yang";

       organization "HP";

       contact "TBD";

       description "This module defines a VNF Deployment Unit.";
     revision "2014-05-18" {

         description

           "Initial version";

         reference

           "RFC XXXX";

       }
      container clearwater {

         description

           "Vdus used in a vnfd";

       list ellis {
      key id;
      leaf id{
      type string;
      description "key ID for vdu1";
      }
         description

         "Vdu key";



         leaf instance-num {

         type uint16{
         range 1..6;}
                                 default 1;


         description

           "Number of instances of the said VDU which shall be
     instantiated";

         }

         leaf vm-image {

         type string;
         reference  "uri";


         description

           "Reference to a VM image";

         }
         container resource {
         description

               "The required resource";

             container cpu {

               description

                 "The required computation resource";



               leaf vCPU_num {

                 type uint32{
         range 4;
         }

                 description

                   "The number of virtual CPU units";

               }



               list vCPU-spec {

                 key "name";



                 description

                   "Processor characteristics for the VDU";



                 leaf name {

                   type string;

                   description

                     "Name of vCPU-spec";

                 }
         leaf description {

                   type string;

                   description

                     "Description of vCPU-spec";

                 }

                 leaf value {

                   type uint32;

                   description

                     "Value of vCPU-spec";

                 }

               }

             }

             container memory {

               description

                 "The required memory resource";

               leaf memory_size {

                 type uint32{
         range 4096;
         }

                 description

                   "Memory size, unit:MBytes";

               }

               list memory-spec {

                 key name;



                 description

                   "Memory characteristics for the VDU";



                 leaf name {

                   type string;

                   description

                     "Name of memory-spec";

                 }



                 leaf description {

                   type string;

                   description

                     "Description of memory-spec";

                 }



                 leaf value {

                   type uint32;

                   description

                     "Value of memory-spec";

                 }

          }

             }



             container disk {

               description

                 "The required storage resource";



               leaf disk-size {

                 type uint32{
     range 2048;
    }
                 description

                   "Virtual storage size, unit:MBytes";
               }



               list disk-KQI {

                 key name;



                 description

                   "Storage characteristics in the VDU";



                 leaf name {

                   type string;

                   description

                     "Name of disk-KQI";

                 }
         leaf description {

                   type string;

                   description

                     "Description of disk-KQI";

                 }



                 leaf value {

                   type uint32;

                   description

                     "Value of disk-KQI";

                 }

               }

             }



             container vnic {

               description

                 "Virtual network interface card (vnic) resource";



               leaf vnic-num {

                 type uint32{
         range 2;
         }

                 description

                   "The total number of virtual vnic";

               }
          }

           }



           container workflow-script {

             description

               "VDU workflow script";



             leaf init {

               type string;
         default "start.sh";


               description

                 "VDU initialization script";
             }



             leaf terminate {

               type string;
         default "stop.sh";


               description

                 "VDU termination script";
        }

             leaf graceful-shutdown {

               type string;
         default "shutdown.sh";


               description

                 "VDU graceful shutdown script";

             }

           }

         }
     list bono {
      key id;
      leaf id{
      type string;
      description "key ID for vdu2";
      }
         description

         "Vdu key";



         leaf instance-num {

         type uint16;
         default 3;


         description

           "Number of instances of the said VDU which shall be
     instantiated";

         }



         leaf vm-image {

         type string;
         reference "URI";


         description

           "Reference to a VM image";

         }



         container resource {
         description

               "The required resource";



             container cpu {

               description

                 "The required computation resource";



               leaf vCPU_num {

                 type uint32{
         range 3;
         }

                 description

                   "The number of virtual CPU units";

               }



               list vCPU-spec {

                 key "name";



                 description

                   "Processor characteristics for the VDU";



                 leaf name {

                   type string;

                   description

                     "Name of vCPU-spec";

                 }
         leaf description {

                   type string;

                   description

                     "Description of vCPU-spec";

                 }



                 leaf value {

                   type uint32;

                   description

                     "Value of vCPU-spec";

                 }

               }

             }



             container memory {

               description

                 "The required memory resource";



               leaf memory_size {

                 type uint32{
         range 2048;
         }

                 description

                   "Memory size, unit:MBytes";

               }

               list memory-spec {

                 key name;

                 description

                   "Memory characteristics for the VDU";



                 leaf name {

                   type string;

                   description

                     "Name of memory-spec";

                 }



                 leaf description {

                   type string;

                   description

                     "Description of memory-spec";

                 }



                 leaf value {

                   type uint32;

                   description

                     "Value of memory-spec";

                 }

          }

             }



             container disk {

               description

                 "The required storage resource";



               leaf disk-size {

                 type uint32{
         range 3000;
         }

                 description

                   "Virtual storage size, unit:MBytes";

               }



               list disk-KQI {

                 key name;



                 description

                   "Storage characteristics in the VDU";



                 leaf name {

                   type string;

                   description

                     "Name of disk-KQI";

                 }
         leaf description {

                   type string;

                   description

                     "Description of disk-KQI";

                 }



                 leaf value {

                   type uint32;

                   description

                     "Value of disk-KQI";

                 }

               }

             }



             container vnic {

               description

                 "Virtual network interface card (vnic) resource";



               leaf vnic-num {

                 type uint32{
         range 2;
         }

                 description

                   "The total number of virtual vnic";

               }
          }

           }



           container workflow-script {

             description

               "VDU workflow script";



             leaf init {

               type string;
         default "start.sh";


               description

                 "VDU initialization script";

             }



             leaf terminate {

               type string;
         default "stop.sh";


               description

                 "VDU termination script";

             }

             leaf graceful-shutdown {

               type string;
         default "shutdown.sh";


               description

                 "VDU graceful shutdown script";

             }

           }

         }

       }

   }