Newer
Older
YannGarcia
committed
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
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
module ApplicationPackageLifecycleAndOperationGrantingAPI_TypesAndValues {
// JSON
import from JSON all;
// LibCommon
import from LibCommon_BasicTypesAndValues all;
// LibMec
import from LibMec_TypesAndValues all;
// LibMec_EdgePlatformApplicationEnablementAPI
import from EdgePlatformApplicationEnablementAPI_TypesAndValues all;
// LibMec_ApplicationMobilityServiceAPI
import from ApplicationMobilityServiceAPI_TypesAndValues all;
group application_descriptor_information_model {
/**
* @desc An application Descriptor (AppD) is a part of application package, and describes application requirements and rules required by application provider
* @member appDid Identifier of this MEC application descriptor. This attribute shall be globally unique
* @member appName Name to identify the MEC application
* @member appProvider Provider of the application and of the AppD
* @member appSoftVersion Identifies the version of software of the MEC application
* @member appDVersion Identifies the version of the application descriptor
* @member mecVersion Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD
* @member appInfoName Human readable name for the MEC application
* @member appDescription Human readable description of the MEC application
* @member virtualComputeDescriptor Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the virtualisation container used to realize this MEC application
* @member swImageDescriptor Describes the descriptors of the software image to be used by the virtualisation container used to realize this MEC application
* @member appExtCpd Describes external interface(s) exposed by this MEC application
* @member appServiceRequired Describes services a MEC application requires to run
* @member appServiceOptional Describes services a MEC application may use if available
* @member appServiceProduced Describes services a MEC application is able to produce to the platform or other MEC applications
* @member appFeatureRequired Describes features a MEC application requires to run
* @member appFeatureOptional Describes features a MEC application may use if available
* @member transportDependencies Transports, if any, that this application requires to be provided by the platform
* @member appTrafficRule Describes traffic rules the MEC application requires
* @member appDNSRule Describes DNS rules the MEC application requires
* @member appLatency Describes the maximum latency tolerated by the MEC application
* @member terminateAppInstanceOpConfig Configuration parameters for the Terminate application instance operation
* @member changeAppInstanceStateOpConfig Configuration parameters for the change application instance state operation
* @member userContextTransferCapability If the application supports the user context transfer capability
* @member appNetworkPolicy It represents the application network policy of carrying the application traffic
* @see ETSI GS MEC 010-2 Clause 6.2.1.2.2
*/
type record AppD {
JSON.String appDId,
JSON.String appName,
JSON.String appProvider,
JSON.String appSoftVersion,
JSON.String appDVersion,
JSON.String mecVersion,
JSON.String appInfoName optional,
JSON.String appDescription,
VirtualComputeDescriptor virtualComputeDescriptor,
SwImageDescriptor virtualStorageDescriptor optional,
AppExternalCpd appExtCpd optional,
ServiceDependency appServiceRequired optional,
ServiceDependency appServiceOptional optional,
ServiceDescriptor appServiceProduced optional,
FeatureDependency appFeatureRequired optional,
FeatureDependency appFeatureOptional optional,
TransportDependency transportDependencies optional,
TrafficRuleDescriptor appTrafficRule optional,
DNSRuleDescriptor appDNSRule optional,
LatencyDescriptor appLatency optional,
TerminateAppInstanceOpConfig terminateAppInstanceOpConfig optional,
ChangeAppInstanceStateOpConfig changeAppInstanceStateOpConfig optional,
UserContextTransferCapability userContextTransferCapability optional,
AppNetworkPolicy appNetworkPolicy optional
}
/**
* @desc The VirtualComputeDescriptor data type supports the specification of requirements related to virtual compute resources
* @member
* @see ETSI GS MEC 010-2 Clause 6.2.1.3 Type: VirtualComputeDescriptor
*/
type record VirtualComputeDescriptor {
// FIXME shall follow the definition in clause 7.1.9.2.2 of ETSI GS NFV‑IFA 011 [0], with the following consideration:
}
/**
* @desc The SwImageDescriptor data type describes the software image of a MEC application
* @member
* @see ETSI GS MEC 010-2 Clause 6.2.1.4 Type: SwImageDescriptor
*/
type record SwImageDescriptor {
// FIXME shall follow the definition in clause 7.1.6.5 of ETSI GS NFV‑IFA 011 [0], with the following consideration:
}
/**
* @desc The VirtualStorageDescriptor data type describes the virtual storage required by a MEC application
* @member
* @see ETSI GS MEC 010-2 Clause 6.2.1.5 Type: VirtualStorageDescriptor
*/
type record VirtualStorageDescriptor {
// FIXME shall follow the definition in clause 7.1.9.4 of ETSI GS NFV‑IFA 011 [0], with the following consideration:
}
/**
* @desc The AppExternalCpd data type supports the specification of MEC application requirements related to external connection point
* @member virtualNetworkInterfaceRequirements Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD
* @see ETSI GS MEC 010-2 Clause 6.2.1.6 Type: AppExternalCpd
*/
type record AppExternalCpd {
VirtualNetworkInterfaceRequirements virtualNetworkInterfaceRequirements optional
}
type record VirtualNetworkInterfaceRequirement {
// FIXME For the definition of the VirtualNetworkInterfaceRequirements, please refer to clause 7.1.6.6 of ETSI GS NFV-IFA 011 [0]. For the definition of Cpd, please refer to clause 7.1.6.3 of ETSI GS NFV-IFA 011 [0]
}
type record length(1..infinity) of VirtualNetworkInterfaceRequirement VirtualNetworkInterfaceRequirements;
/**
* @desc The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC applicationt
* @member serName The name of the service, for example, RNIS, LocationService, etc
* @member serCategory A Category reference of the service, defined in ETSI GS MEC 011 [17]i.0
* @member version The version of the service
* @member transportsSupported Indicates transports and serialization formats supported made available to the service-consuming application
* @see ETSI GS MEC 010-2 Clause 6.2.1.7 Type: ServiceDescriptor
*/
type record ServiceDescriptor {
JSON.String serName,
CategoryRef serCategory optional,
JSON.String version,
TransportsSupported transportsSupported optional
}
/**
* @desc Indicates transports and serialization formats supported made available to the service-consuming application
* @member transport Information about the transport in this binding
* @member serializers Information about the serializers in this binding, as defined in the SerializerType type in ETSI GS MEC 011 [17]i.0
* @see ETSI GS MEC 010-2 Clause 6.2.1.7 Type: ServiceDescriptor
*/
type record TransportsSupported {
TransportDescriptor transport,
SerializerType serializers
}
/**
* @desc The FeatureDependency data type supports the specification of requirements of a MEC application related to a feature of MEC platform
* @member featureName The name of the feature, for example, UserApps, UEIdentity, etc
* @member version The version of the feature
* @see ETSI GS MEC 010-2 Clause 6.2.1.8 Type: FeatureDependency
*/
type record FeatureDependency {
JSON.String featureName,
JSON.String version
}
/**
* @desc The TrafficRuleDescriptor data type describes traffic rules related to a MEC application
* @member trafficRuleId Identifies the traffic rule
* @member filterType Definition of filter type: per FLOW or PACKET
* @member priority Priority of this traffic rule within the range 0 to 255. If traffic rule conflicts, the one with higher priority take precedence
* @member trafficFilter The filter used to identify specific flow/packets that need to be handled by the MEC host
* @member action_ Identifies the action of the MEC host data plane, when a packet matches the trafficFilter
* @member dstInterface Describes the destination interface information
* @see ETSI GS MEC 010-2 Clause 6.2.1.9 Type: TrafficRuleDescriptor
*/
type record TrafficRuleDescriptor {
JSON.String trafficRuleId,
FilterType filterType,
integer priority,
TrafficFilter trafficFilter,
Action action_,
InterfaceDescriptor dstInterface optional
} with {
variant (action_) "name as 'action'";
}
type enumerated FilterType {
FLOW,
PACKET
} with {
variant "JSON: as number"
}
type enumerated Action {
DROP,
FORWARD_DECAPSULATED,
FORWARD_AS_IS,
PASSTHROUGH,
DUPLICATED_DECAPSULATED,
DUPLICATE_AS_IS
} with {
variant "JSON: as number"
}
/**
* @desc The TrafficFilter data type supports the specification of MEC application requirements related to traffic rules
* @member srcAddress An IP address or a range of IP addresses
* @member dstAddress A IP address or a range of IP addresses
* @member srcPort A port or a range of ports
* @member dstPort A port or a range of ports
* @member protocol Specify the protocol of the traffic filter
* @member tag Used for tag based traffic rule
* @member uri An URI label, in application layer
* @member packetLabel A customized packet label in network layer, as defined by the owner of the MEC platform, is used to filter the traffic
* @member srcTunnelAddressUsed for GTP tunnel based traffic rule
* @member tgtTunnelAddress Used for GTP tunnel based traffic rule
* @member srcTunnelPort Used for GTP tunnel based traffic rule
* @member qCI Used to match all packets that have the same QCI
* @member dSCP Used to match all IPv4 packets that have the same DSCP
* @member tC Used to match all IPv6 packets that have the same TC
* @see ETSI GS MEC 010-2 Clause 6.2.1.10 Type: TrafficFilter
*/
type record TrafficFilter {
JSON.String srcAddress optional,
JSON.String dstAddress optional,
JSON.String srcPort optional,
JSON.String dstPort optional,
JSON.String protocol optional,
JSON.String tag optional,
JSON.String uri optional,
JSON.String packetLabel optional,
JSON.String srcTunnelAddress optional,
JSON.String tgtTunnelAddress optional,
JSON.String srcTunnelPort optional,
JSON.String dstTunnelPort optional,
integer qCI optional,
integer dSCP optional,
integer tC optional
}
/**
* @desc The InterfaceDescriptor data type describes an interface of a MEC application
* @member interfaceType Type of interface
* @member tunnelInfo Included only if the destination address type is tunnel
* @member srcMACAddress The source address identifies the MAC address of the interface
* @member dstMACAddress The destination address identifies the MAC address of the destination
* @see ETSI GS MEC 010-2 Clause 6.2.1.11 Type: InterfaceDescriptor
*/
type record InterfaceDescriptor {
InterfaceType interfaceType,
TunnelInfo tunnelInfo optional,
JSON.String srcMACAddress optional,
JSON.String dstMACAddress optional
}
type enumerated InterfaceType {
TUNNEL,
MAC,
IP
} with {
variant "JSON: as number"
}
/**
* @desc The TunnelInfo data type supports the specification of MEC application requirements related to traffic rules
* @member tunnelType Type of tunnel
* @member tunnelDstAddress Destination address of the tunnel
* @member tunnelSrcAddress Source address of the tunnel
* @member tunnelSpecificData Parameters specific to the tunnel
* @see ETSI GS MEC 010-2 Clause 6.2.1.12 Type: TunnelInfo
*/
type record TunnelInfo {
TunnelType tunnelType,
JSON.String tunnelDstAddress,
JSON.String tunnelSrcAddress,
JSON.String tunnelSpecificData optional
}
type enumerated TunnelType {
GTP_U,
GRE
} with {
variant "JSON: as number"
}
/**
* @desc The DNSRuleDescriptor data type describes DNS rules associated with a MEC application
* @member dnsRuleId Identifies the DNS Rule
* @member domainName FQDN of the DNS rule
* @member ipAddressType Specifies the IP address type
* @member ttl Time-to-live value
* @see ETSI GS MEC 010-2 Clause 6.2.1.13 Type: DNSRuleDescriptor
*/
type record DNSRuleDescriptor {
JSON.String dnsRuleId,
JSON.String domainName,
JSON.String ipAddressType,
IpAddress ipAddress,
integer ttl optional
}
/**
* @desc The LatencyDescriptor data type describes latency requirements for a MEC application
* @member maxLatency The value of the maximum latency in nano seconds tolerated by the MEC application
* @see ETSI GS MEC 010-2 Clause 6.2.1.14 Type: LatencyDescriptor
*/
type record LatencyDescriptor {
UInt32 maxLatency
}
/**
* @desc The TerminateAppInstanceOpConfig data type supports the specification of MEC application requirements related to terminate application instance operation configuration
* @member
* @see ETSI GS MEC 010-2 Clause 6.2.1.15 Type: TerminateAppInstanceOpConfig
*/
type record TerminateAppInstanceOpConfig {
// FIXME shall follow the definition in clause 7.1.5.7 of ETSI GS NFV‑IFA 011 [0].
}
/**
* @desc The ChangeAppInstanceStateOpConfig data type supports the specification of MEC application requirements related to change application instance state operation configuration
* @member
* @see ETSI GS MEC 010-2 Clause 6.2.1.16 Type: ChangeAppInstanceStateOpConfig
*/
type record ChangeAppInstanceStateOpConfig {
// FIXME shall follow the definition in clause 7.1.5.8 of ETSI GS NFV‑IFA 011 [0].
}
/**
* @desc The ServiceDependency data type supports the specification of requirements of a service-consuming MEC application related to a MEC service
* @member serName The name of the service
* @member serCategory A Category reference of the service
* @member version The version of the service
* @member serTransportDependencies Indicates transport and serialization format dependencies of consuming the service
* @member requestedPermissions
* @see ETSI GS MEC 010-2 Clause 6.2.1.17 Type: ServiceDependency
*/
type record ServiceDependency {
JSON.String serName,
CategoryRef serCategory optional,
JSON.String version,
TransportDependency serTransportDependencies optional,
JSON.String requestedPermissions optional
}
/**
* @desc The TransportDependency data type supports the specification of requirements of a MEC application related to supported transport bindings (each being a combination of a transport with one or more serializers)
* @member transport Information about the transport in this transport binding
* @member serializers Information about the serializers in this transport binding, as defined in the SerializerType type in ETSI GS MEC 011 [17]i.0
* @member labels Set of labels that allow to define groups of transport bindings
* @see ETSI GS MEC 010-2 Clause 6.2.1.18 Type: TransportDependency
*/
type record TransportDependency {
TransportDescriptor transport,
SerializerType serializers,
Labels labels
}
type record length(1..infinity) of JSON.String Labels;
/**
* @desc The TransportDescriptor data type describes a transport
* @member name The name of this transport
* @member description Human-readable description of this transport
* @member type_ Type of the transport, as defined in the TransportTypes type in ETSI GS MEC 011 [17]i.0
* @member protocol The name of the protocol used. Shall be set to "HTTP" for a REST API
* @member version The version of the protocol used
* @member security Information about the security used by the transport in ETSI GS MEC 011 [17]i.0
* @member implSpecificInfo Additional implementation specific details of the transport
* @see ETSI GS MEC 010-2 Clause 6.2.1.19 Type: TransportDescriptor
*/
type record TransportDescriptor {
JSON.String name,
JSON.String description optional,
TransportTypes type_,
JSON.String protocol,
JSON.String version,
SecurityInfo security,
JSON.String implSpecificInfo optional
}
/**
* @desc This data type represents the information of user context transfer capability of application
* @member statefulApplication If the application is stateful, this attribute shall be set to true
* @member userContextTransferSupport This attribute shall be present if the application is stateful and shall be absent otherwise
* @see ETSI GS MEC 010-2 Clause 6.2.1.20 Type: UserContextTransferCapability
*/
type record UserContextTransferCapability {
JSON.Bool statefulApplication,
JSON.Bool userContextTransferSupport optional
}
/**
* @desc This data type represents the network policy in the application instantiation and operation
* @member steeredNetwork This attribute provides an option for the application to specify a type of network to carry the application traffic
* @member steeredNetwork Provides an option for the application to specify a type of network to carry the application traffic
* @see ETSI GS MEC 010-2 Clause 6.2.1.21 Type: AppNetworkPolicy
*/
type record AppNetworkPolicy {
SteeredNetwork steeredNetwork
}
/**
* @desc Provides an option for the application to specify a type of network to carry the application traffic
* @member cellularNetwork The application prefers to a cellular network to carry its traffic
* @member wi_fiNetwork The application prefers to a Wi-Fi network to carry its traffic
* @member fixedAccessNetwork The application prefers to a fixed access network to carry its traffic
* @see ETSI GS MEC 010-2 Clause 6.2.1.21 Type: AppNetworkPolicy
*/
type record SteeredNetwork {
JSON.Bool cellularNetwork optional,
JSON.Bool wi_fiNetwork optional,
JSON.Bool fixedAccessNetwork optional
} with {
variant (wi_fiNetwork) "name as 'wi-fiNetwork'";
}
} // End of group application_descriptor_information_model
group application_lifecycle_management_information_model {
/**
* @desc The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints
* @member countryCode The two-letter ISO 3166 [0] country code in capital letters
* @member civicAddressElement Zero or more elements comprising the civic address
* @member area Geographic area
* @see ETSI GS MEC 010-2 Clause 6.2.2.2 Type: LocationConstraints
*/
type record LocationConstraints {
JSON.String countryCode optional,
CivicAddressElement civicAddressElement optional,
Polygon area optional
}
type record CivicAddressElement {
integer caType,
JSON.String caValue
}
type record Geometry {
JSON.String type_,
Coordinates coordinates
} with {
variant (type_) "name as 'type'";
}
type record of JSON.Number Coordinate;
type record of Coordinate Coordinates;
type record Property {
JSON.String key,
JSON.String value_
} with {
variant (value_) "name as 'value'";
}
type record of Property Properties;
type record Polygon {
JSON.String type_,
Geometry geometry,
Properties properties,
JSON.String this_
} with {
variant (type_) "name as 'type'";
variant (this_) "name as 'this'";
}
/**
* @desc The data type of CreateAppInstanceRequest represents the parameters for creating a new application instance resource
* @member appDId The application descriptor identifier
* @member appInstanceName Human-readable name of the application instance to be created
* @member appInstanceDescription Human-readable description of the application instance to be created
* @member appPlacementInfo Describes the information of selected MEC platform for the application instance to associate
* @see ETSI GS MEC 010-2 Clause 6.2.2.3 Type: CreateAppInstanceRequest
*/
type record CreateAppInstanceRequest {
JSON.String appDId,
JSON.String appInstanceName optional,
JSON.String appInstanceDescription optional,
MepInformation appPlacementInfo optional
}
/**
* @desc The data type of AppInstanceInfo represents the parameters of instantiated application instance resources
* @member id Identifier of the application instance represented by this data type
* @member appInstanceName Name of the application instance
* @member appInstanceDescription Human-readable description of the application instance to be created
* @member appDId The application descriptor identifier is managed by the application provider to identify the application descriptor in a globally unique way
* @member appProvider The onboarded application package provider name
* @member appName The onboarded application name
* @member appSoftVersion The application software version
* @member appDVersion Version of the application descriptor
* @member appPkgId Identifier of the onboarded application package
* @member vimConnectionInfo Information about VIM connections to be used for managing the resources for the application instance
* @member nsInstanceId Identifier of the NS instance created by NFVO in which the MEC application has been instantiated as a VNF instance
* @member vnfInstanceId Identifier of the VNF instance created by VNFM that the MEC application has been instantiated as
* @member instantiationState Instantiation state of the application instance
* @member instantiatedAppState Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED
* @member instantiatedAppState Operational state is applicable in the instantiation state INSTANTIATED
* @member _links Links to resources related to this resource
* @see ETSI GS MEC 010-2 Clause 6.2.2.4 Type: AppInstanceInfo
*/
type record AppInstanceInfo {
JSON.String id,
JSON.String appInstanceName optional,
JSON.String appInstanceDescription optional,
JSON.String appDId,
JSON.String appProvider,
JSON.String appName,
JSON.String appSoftVersion,
JSON.String appDVersion,
JSON.String appPkgId,
VimConnectionInfo vimConnectionInfo optional,
JSON.String nsInstanceId optional,
JSON.String vnfInstanceId optional,
InstantiationState instantiationState,
InstantiatedAppState instantiatedAppState optional,
CommunicationInterface communicationInterface optional,
Link links
} with {
variant (links) "name as '_links'";
}
type record Link {
LinkType self_,
LinkType instantiate optional,
LinkType terminate optional,
LinkType operate optional,
LinkType configure_platform_for_app optional
} with {
variant (self_) "name as 'self'";
}
type record InstantiatedAppState {
OperationalState operationalState optional,
LocationInformation appInstLocation optional
}
type enumerated InstantiationState {
INSTANTIATED,
NOT_INSTANTIATED
}
type enumerated OperationalState {
STARTED,
STOPPED
}
/**
* @desc The data type of AppInstanceInfo represents the parameters of instantiated application instance resources
* @member appInstSelectorType
* @member appInstances
* @member appsFromProviders Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers
* @see ETSI GS MEC 010-2 Clause 6.2.2.5 Type: AppInstanceSubscriptionFilter
*/
type record AppInstanceSubscriptionFilter {
AppInstSelectorType appInstSelectorType,
AppInstances appInstances optional,
appsFromProviders appsFromProviders optional
}
type enumerated AppInstSelectorType {
VOID (0),
APP_IDENTITY (1),
APP_NAME (2),
APP_D_ID (3),
APP_FROM_PROVIDER (4)
} with {
variant "JSON: as number"
}
type record length(1..infinity) of JSON.String AppInstances;
/**
* @desc Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers
* @member appProvider Name of the application provider to match
* @member appProducts Match application instances that belong to application products with certain product names, from one particular provider
* @see ETSI GS MEC 010-2 Clause 6.2.2.5 Type: AppInstanceSubscriptionFilter
*/
type record AppsFromProvider {
JSON.String appProvider,
AppProducts appProducts optional
}
type record length(1..infinity) of AppsFromProvider appsFromProviders;
type record AppProduct {
JSON.String appName,
Versions versions optional
}
type record length(1..infinity) of AppProduct AppProducts;
type record Version {
JSON.String appSoftVersion,
JSON.String appDVersion optional
}
type record length(1..infinity) of Version Versions;
/**
* @desc This data type represents a subscription filter criteria to match an application LCM operation occurrence
* @member appInstanceSubscriptionFilter this attribute contains filter criteria that selects one or more application instances on which to receive "LCM operation occurrence" notifications
* @member notificationTypes Match particular notification types
* @member operationTypes Type of the LCM operation represented by this application instance LCM operation occurrence
* @member operationStates Type of the LCM operation state represented by this application instance LCM operation occurrence
* @see ETSI GS MEC 010-2 Clause 6.2.2.6 Type: AppLcmOpOccSubscriptionFilter
*/
type record AppLcmOpOccSubscriptionFilter {
AppInstanceSubscriptionFilter appInstanceSubscriptionFilter optional,
JSON.String notificationTypes optional,
OperationTypes operationTypes optional,
OperationStates operationStates optional
}
type enumerated OperationType {
INSTANTIATE,
OPERATE,
TERMINATE,
INVALID_OPERATE // For BI purpose only
YannGarcia
committed
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
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
}
type record length(1..infinity) of OperationType OperationTypes;
type enumerated OperationState {
STARTING,
PROCESSING,
COMPLETED,
FAILED,
FAILED_TEMP
}
type record length(1..infinity) of OperationState OperationStates;
/**
* @desc This data type represents request parameters of the "Instantiate Application" operation
* @member virtualComputeDescriptor Describes CPU and memory requirements, as well as optional additional requirements, such as disk and acceleration related capabilities, of the virtualisatio n container used to realize the application instance to be created
* @member virtualStorageDescriptor Defines descriptors of virtual storage resources to be used by the application instance to be created
* @member selectedMECHostInfo Describes the information of selected host for the application instance
* @member locationConstraints Defines the location constraints for the application instance to be created
* @member vimConnectionInfo Information about VIM connections to be used for managing the resources for the application instance, or refer to external/externally-managed virtual links
* @member appTermCandsForCoord Provides sets of applications as termination candidate alternatives that the MEO/MEAO shall select from when utilizing the coordinate LCM operation exchange
* @see ETSI GS MEC 010-2 Clause 6.2.2.7 Type: InstantiateAppRequest
*/
type record InstantiateAppRequest {
VirtualComputeDescriptor virtualComputeDescriptor optional,
VirtualStorageDescriptor virtualStorageDescriptor optional,
MECHostInformation selectedMECHostInfo,
LocationConstraints locationConstraints optional,
VimConnectionInfo vimConnectionInfo optional,
AppTermCandsForCoord appTermCandsForCoord optional
}
/**
* @desc This data type represents request parameters of the "Operate Application" operation
* @member changeStateTo The desired operational state
* @member stopType The stop type
* @member gracefulStopTimeout The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application
* @see ETSI GS MEC 010-2 Clause 6.2.2.8 Type: OperateAppRequest
*/
type record OperateAppRequest {
OperationalState changeStateTo,
StopType stopType optional,
UInt32 gracefulStopTimeout optional
}
type enumerated StopType {
FORCEFUL,
GRACEFUL
}
/**
* @desc This data type represents request parameters of the "Terminate Application Request" operation
* @member terminationType Indicates whether forceful or graceful termination is requested
* @member gracefulTerminationTimeout This attribute is only applicable in case of graceful termination
* @see ETSI GS MEC 010-2 Clause 6.2.2.9 Type: TerminateAppRequest
*/
type record TerminateAppRequest {
TerminationType terminationType,
UInt32 gracefulTerminationTimeout optional
}
type StopType TerminationType;
/**
* @desc The data type represents a subscription to notification of application instance operational state change
* @member id Identifier of the subscription to application instance operational state change notification
* @member subscriptionType Shall be set to "AppInstanceStateChangeSubscription"
* @member appInstanceState Application instance state subscribed to
* @member appInstanceSubscriptionFilter Criteria used to select application instances on which to send notifications related to this subscription
* @member callbackUri The URI of the endpoint for the subscription related notification to be sent to
* @member links Links to resources related to this resource
* @see ETSI GS MEC 010-2 Clause 6.2.2.10 Type: AppInstSubscriptionInfo
*/
type record AppInstSubscriptionInfo {
JSON.String id,
JSON.String subscriptionType,
AppInstanceState appInstanceState optional,
AppInstanceSubscriptionFilter appInstanceSubscriptionFilter optional,
JSON.AnyURI callbackUri,
AppInstSubscriptionInfo_Link links
} with {
variant (links) "name as '_links'";
}
type enumerated AppInstanceState {
NOT_INSTANTIATED,
STARTED,
STOPPED
}
type record AppInstSubscriptionInfo_Link {
LinkType self_
} with {
variant (self_) "name as 'self'";
}
/**
* @desc This data type represents an application instance notification for informing the subscribers about operational state of application instance resources
* @member id Identifier of this notification
* @member notificationType Discriminator for the different notification types
* @member appInstanceState Application instance state
* @member subscriptionId Identifier of the subscription related to this notification
* @member timeStamp Date and time of the notification generation
* @member appInstanceId Identifier of application instance
* @member appPkgId Identifier of the onboarded application package
* @member appDId The application descriptor identifier identifies the application package and the application descriptor in a globally unique way
* @member appInstLocation Location of the MEC application instance
* @member links A link to the related subscription
* @see ETSI GS MEC 010-2 Clause 6.2.2.11 Type: AppInstNotification
*/
type record AppInstNotification {
JSON.String id,
NotificationType notificationType,
AppInstanceState appInstanceState optional,
JSON.String subscriptionId,
TimeStamp timeStamp,
JSON.String appInstanceId,
JSON.String appPkgId,
JSON.String appDId,
LocationInformation appInstLocation optional,
AppInstNotification_Links links
} with {
variant (links) "name as '_links'";
}
type record AppInstNotification_Links {
LinkType subscription
}
/**
* @desc The data type represents the input parameters of "subscription operation" to notification of application lifecycle management for the operational state change of application instance
* @member subscriptionType Shall be set to "AppInstanceStateChangeSubscription"
* @member callbackUri The URI of the endpoint for the subscription related notification to be sent to
* @member appInstanceState Only send notifications for application instances that are in one of the states listed in this attribute
* @member appInstanceSubscriptionFilter Criteria used to filter application instances for which to send notifications related to this subscription
* @see ETSI GS MEC 010-2 Clause 6.2.2.12 Type: AppInstSubscriptionRequest
*/
type record AppInstSubscriptionRequest {
JSON.String subscriptionType,
JSON.AnyURI callbackUri,
AppInstanceState appInstanceState optional,
AppInstanceSubscriptionFilter appInstanceSubscriptionFilter optional
}
/**
* @desc This data type represents an application lifecycle management operation occurrence
* @member id Identifier of the subscription to application LCM operation occurrence notification
* @member operationState Operation state
* @member stateEnteredTime Date and time when the current state was entered
* @member startTime Date and time of the start of the operation
* @member lcmOperationType of the actual LCM operation represented by this application instance LCM operation occurrence
* @member operationParams Input parameters of the LCM operation
* @member isCancelPending If the application LCM operation occurrence operationState is in "PROCESSING" state and the operation is being cancelled, this attribute shall be set to true
* @member cancelMode The mode of an cancellation
* @member links Link to the application instance that the operation applies to
* @see ETSI GS MEC 010-2 Clause 6.2.2.13 Type: AppLcmOpOcc
*/
type record AppLcmOpOcc {
JSON.String id,
OperationState operationState,
TimeStamp stateEnteredTime,
TimeStamp startTime,
LcmOperation lcmOperation,
OperationParams operationParams optional,
JSON.Bool isCancelPending optional,
CancelMode cancelMode optional,
AppLcmOpOcc_Link links
} with {
variant (links) "name as '_links'";
}
type OperationType LcmOperation;
type union OperationParams {
InstantiateAppRequest instantiateAppRequest,
OperateAppRequest operateAppRequest,
TerminateAppRequest terminateAppRequest
}
type record AppLcmOpOcc_Link {
LinkType self_,
LinkType appInstance
} with {
variant (self_) "name as 'self'";
}
/**
* @desc This data type represents a subscription request to notification of application life cycle management operation occurrence
* @member subscriptionType Shall be set to "AppLcmOpOccStateChangeSubscription"
* @member callbackUri The URI of the endpoint for the subscription related notification to be sent to
* @member appLcmOpOccSubscriptionFilter Subscription filter criteria to match specific application LCM operation occurrences
* @see ETSI GS MEC 010-2 Clause 6.2.2.14 Type: AppLcmOpOccSubscriptionRequest
*/
type record AppLcmOpOccSubscriptionRequest {
JSON.String subscriptionType,
JSON.AnyURI callbackUri,
AppLcmOpOccSubscriptionFilter appLcmOpOccSubscriptionFilter optional
}
/**
* @desc This data type represents a subscription to notifications of application life cycle management operation occurrence
* @member id Identifier of this subscription resource
* @member subscriptionType Shall be set to "AppLcmOpOccStateChangeSubscription"
* @member appLcmOpOccSubscriptionFilter Criteria used to select application LCM operation occurrences on which to send notifications related to this subscription
* @member callbackUri The URI of the endpoint for the subscription related notification to be sent to
* @member links Links to resources related to this resource
* @see ETSI GS MEC 010-2 Clause 6.2.2.15 Type: AppLcmOpOccSubscriptionInfo
*/
type record AppLcmOpOccSubscriptionInfo {
JSON.String id,
JSON.String subscriptionType,
JSON.AnyURI callbackUri,
AppLcmOpOccSubscriptionFilter appLcmOpOccSubscriptionFilter optional,
AppLcmOpOccSubscriptionInfo_Link links
} with {
variant (links) "name as '_links'";
}
type record AppLcmOpOccSubscriptionInfo_Link {
LinkType self_
} with {
variant (self_) "name as 'self'";
}
/**
* @desc This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers
* @member id Identifier of this notification
* @member notificationType Discriminator for the different notification types
* @member operationType Discriminator for the different notification types
* @member operationState Operation state
* @member subscriptionId Identifier of the subscription to this notification
* @member timeStamp Date and time of the notification generation
* @member appLcmOpOccId Identifier of application lifecycle management operation occurrence
* @member appInstanceId Identifier of application instance
* @member links Links to resources related to this notification
* @member links Links to resources related to this resource
* @see ETSI GS MEC 010-2 Clause 6.2.2.16 Type: AppLcmOpOccNotification
*/
type record AppLcmOpOccNotification {
JSON.String id,
NotificationType notificationType,
OperationType operationType,
OperationState operationState,
JSON.String subscriptionId,
TimeStamp timeStamp,
JSON.String appInstanceId,
AppLcmOpOccNotification_Link links
} with {
variant (links) "name as '_links'";
}
type record AppLcmOpOccNotification_Link {
LinkType appInstance,
LinkType subscription,
LinkType appLcmOpOcc
}
/**
* @desc The data type represents the parameters of MEC host information
* @member hostName Human-readable name of MEC host
* @member hostId KeyValuePairs
* @see ETSI GS MEC 010-2 Clause 6.2.2.17 Type: MECHostInformation
*/
type record MECHostInformation {
JSON.String hostName optional,
KeyValuePairs hostId
}
/**
* @desc The VimConnectionInfo data type specifies the connection information of VIM for managing the resources of the application instance
* @member id The identifier of the VIM Connection
* @member vimId The identifier of the VIM instance
* @member vimType Discriminator for the different types of the VIM information
* @member interfaceInfo Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM
* @member accessInfo Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups
* @member extra VIM type specific additional information
* @see ETSI GS MEC 010-2 Clause 6.2.2.18 Type: VimConnectionInfo
*/
type record VimConnectionInfo {
JSON.String id,
JSON.String vimId optional,
JSON.String vimType,
KeyValuePairs interfaceInfo optional,
KeyValuePairs accessInfo optional,
KeyValuePairs extra optional
}
/**
* @desc The data type represents a subscription link list of notification on application lifecycle management
* @member links List of hyperlinks related to the resource
* @see ETSI GS MEC 010-2 Clause 6.2.2.19 Type: AppInstanceSubscriptionLinkList
*/
type record SubscriptionLinkList {
SubscriptionLinkList_Link links
} with {
variant (links) "name as '_links'";
}
type record SubscriptionLinkList_Link {
LinkType self_,
SubscriptionLinkList_Link_Subscriptions subscriptions optional
} with {
variant (self_) "name as 'self'";
}
type record SubscriptionLinkList_Link_Subscription {
JSON.AnyURI href,
AppInstanceSubscriptionType subscriptionType
}
type record length(1..infinity) of SubscriptionLinkList_Link_Subscription SubscriptionLinkList_Link_Subscriptions;
/**
* @desc String representing the type of a subscription
* @see ETSI GS MEC 010-2 Clause 6.2.2.20.2 Simple data types
*/
type JSON.String AppInstanceSubscriptionType;
/**
* @desc This data type represents the parameters for configuring the MEP to run an application instance
* @member appServiceRequired Describes services a MEC application requires to run
* @member appServiceOptional Describes services a MEC application may use if available
* @member appServiceProduced Describes services a MEC application is able to produce to the platform or other MEC applications
* @member appFeatureRequired Describes features a MEC application requires to run
* @member transportDependencies Transports, if any, that this application requires to be provided by the platform
* @member appTrafficRule Describes traffic rules the MEC application requires
* @member appDNSRule Describes DNS rules the MEC application requires
* @member appLatency Describes the maximum latency tolerated by the MEC application
* @member userContextTransferCapability If the application supports the user context transfer capability, this attribute shall be included
* @member appNetworkPolicy If present, it represents the application network policy of carrying the application traffic
* @see ETSI GS MEC 010-2 Clause 6.2.2.21 Type: ConfigPlatformForAppRequest
*/
type record ConfigPlatformForAppRequest {
ServiceDependency appServiceRequired optional,
ServiceDependency appServiceOptional optional,
ServiceDependency appServiceProduced optional,
FeatureDependency appFeatureRequired optional,
FeatureDependency appFeatureOptional optional,
TransportDependency transportDependencies optional,
TrafficRuleDescriptor appTrafficRule optional,
DNSRuleDescriptor appDNSRule optional,
LatencyDescriptor appLatency optional,
UserContextTransferCapability userContextTransferCapability optional,
AppNetworkPolicy appNetworkPolicy optional
}
/**
* @desc The data type represents the parameters of MEC platform information
* @member mepName Human-readable name of MEC platform
* @member mepId Deployment-specific identifier of MEC platform
* @see ETSI GS MEC 010-2 Clause 6.2.2.22 Type: MepInformation
*/
type record MepInformation {
JSON.String mepName optional,
JSON.String mepId optional
}
/**
* @desc The AppTermCandsForCoord data type represents the parameters to provide candidates of applications to terminate in pre-emption situations for LCM coordination exchanges
* @member terminationOptions Sets of application options for the MEO/MEAO to select from as candidates for termination
* @see ETSI GS MEC 010-2 Clause 6.2.2.23 Type: AppTermCandsForCoord
*/
type record AppTermCandsForCoord {
TerminationOptions terminationOptions
}
type record TerminationOption {
AppInstIdTerminationCands appInstIdTerminationCands
}
type record length(1..infinity) of JSON.String AppInstIdTerminationCands;
type record length(1..infinity) of TerminationOption TerminationOptions;
/**
* @desc The data type represents the input parameters of "subscription operation" to notification of application instance identifier creation
* @member subscriptionType Shall be set to "AppIdentifierCreationSubscription"
* @member callbackUri The URI of the endpoint for the subscription related notification to be sent to
* @member appInstanceSubscriptionFilter Criteria used to filter application instances for which to send notifications related to this subscription
* @see ETSI GS MEC 010-2 Clause 6.2.2.25 Type: AppInstIdCreationSubscriptionRequest
*/
type record AppInstIdCreationSubscriptionRequest {
JSON.String subscriptionType,
JSON.AnyURI callbackUri,
AppInstanceSubscriptionFilter appInstanceSubscriptionFilter optional
}
/**
* @desc The data type represents a subscription to notification of application instance identifier creation
* @member id Identifier of the subscription to application instance operational state change notification
* @member subscriptionType Shall be set to "AppIdentifierCreationSubscription"
* @member callbackUri The URI of the endpoint for the subscription related notification to be sent to
* @member appInstanceSubscriptionFilter Criteria used to select application instances on which to send notifications related to this subscription
* @member links Links to resources related to this resource