MEC010-2_AppLcm.yaml 84.8 KB
Newer Older
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    LcmOperation:
      title: LcmOperation
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - INSTATIATE
      - OPERATE
      - TERMINATE
      type: string
      description: Type of the actual LCM operation represented by this application instance LCM operation occurrence
      examples:
      - INSTATIATE
Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccNotification:
      title: AppLcmOpOccNotification
Elian Kraja's avatar
Elian Kraja committed
      required:
      - id
      - notificationType
      - operationType
      - operationState
      - subscriptionId
      - timeStamp
      - appLcmOpOccId
      - appInstanceId
      - _links
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        id:
          type: string
          description: "''"
Elian Kraja's avatar
Elian Kraja committed
        notificationType:
          type: string
          description: Discriminator for the different notification types. Shall be set to "AppLcmOpOccStateChangeSubscription" for this notification type.
        operationType:
          type: string
          description: Type of the LCM operation represented by this application instance LCM operation occurrence.
          enum:
            - INSTANTIATE
            - OPERATE
            - TERMINATE 
        operationState:
          type: string
          enum:
            - STARTING
            - PROCESSING
            - COMPLETED
            - FAILED
            - FAILED_TEMP
Elian Kraja's avatar
Elian Kraja committed
        subscriptionId:
          type: string
          description: Identifier of the subscription related to this notification.
Elian Kraja's avatar
Elian Kraja committed
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
        appLcmOpOccId:
          type: string
          description: Identifier of application lifecycle management operation occurrence.
Elian Kraja's avatar
Elian Kraja committed
        appInstanceId:
          type: string
          description: Identifier of application instance.
Elian Kraja's avatar
Elian Kraja committed
        _links:
          $ref: '#/components/schemas/AppLcmOpOccNotification.links'
      description: "'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'"



    
    AppInstanceIdentifierCreationNotification:
      title: AppInstanceIdentifierCreationNotification
      required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - appInstanceId
      - _links
      type: object
      properties:
        id:
          type: string
        notificationType:
          type: string
          description: Discriminator for the different notification types. Shall be set to "AppIdentifierCreationSubscription" for this notification type.
        subscriptionId:
          type: string
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
        appInstanceId:
          type: string
        _links:
          $ref: '#/components/schemas/Notification._links'
    
    Notification._links:
      type: object
      required:
        - subscription
        - appInstance
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
        appInstance:
          $ref: '#/components/schemas/LinkType'
    
    AppInstanceIdentifierDeletionNotification:
      title: AppInstanceIdentifierDeletionNotification
      required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - appInstanceId
      - _links
      type: object
      properties:
        id:
          type: string
        notificationType:
          type: string
          description: Discriminator for the different notification types. Shall be set to "AppIdentifierDeletionSubscription" for this notification type.
        subscriptionId:
          type: string
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
        appInstanceId:
          type: string
        _links:
          $ref: '#/components/schemas/Notification._links'


Elian Kraja's avatar
Elian Kraja committed
    AppLcmOpOccNotification.links:
      title: AppLcmOpOccNotification.links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - appInstance
      - subscription
      - appLcmOpOcc
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        appInstance:
          $ref: '#/components/schemas/LinkType'
        subscription:
          $ref: '#/components/schemas/LinkType'
        appLcmOpOcc:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this resource.
Elian Kraja's avatar
Elian Kraja committed
    InstantiateAppRequest:
      title: InstantiateAppRequest
      required:
      - selectedMECHostInfo
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        locationConstraints:
          $ref: '#/components/schemas/LocationConstraints'
        selectedMECHostInfo:
          type: array
          items:
            $ref: '#/components/schemas/MECHostInformation'
          description: Describes the information of selected host for the application instance. See note 2.
        vimConnectionInfo:
Elian Kraja's avatar
Elian Kraja committed
          type: array
          items:
            $ref: '#/components/schemas/VimConnectionInfo'
          description: >-
            Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.

            This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.
Elian Kraja's avatar
Elian Kraja committed
        virtualComputeDescriptor:
          type: string
          description: 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 the application instance to be created. This attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD.
Elian Kraja's avatar
Elian Kraja committed
        virtualStorageDescriptor:
          type: array
          items:
            type: string
          description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.
        appTermCandsForCoord:
          $ref: '#/components/schemas/AppTermCandsForCoord'
    
    AppTermCandsForCoord:
      type: object
      required:
        - terminationOptions
      properties:
        terminationOptions:
          type: array
          items:
           $ref: '#/components/schemas/AppTermCandsForCoord.terminationOptions'

    
    AppTermCandsForCoord.terminationOptions:
      type: object
      required:
        - appInstIdTerminationCands
      properties:
        appInstIdTerminationCands:
          type: array
          items:
            type: string
    LinkType:
      title: LinkType
Elian Kraja's avatar
Elian Kraja committed
      required:
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        href:
          type: string
          description: URI referring to a resource
Elian Kraja's avatar
Elian Kraja committed
    LocationConstraints:
      title: LocationConstraints
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        countryCode:
          type: string
          description: The two-letter ISO 3166 country code in capital letters.
Elian Kraja's avatar
Elian Kraja committed
        civicAddressElement:
          type: array
          items:
            $ref: '#/components/schemas/CivicAddressElement'
        area:
          type: object
          description: Geographic area. Shall be absent if the "civicAddressElement" attribute is present. The content of this attribute shall follow the provisions for the "Polygon" geometry object as defined in IETF RFC 7946 [8], for which
      description: "'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'"
Elian Kraja's avatar
Elian Kraja committed
    CivicAddressElement:
      title: CivicAddressElement
Elian Kraja's avatar
Elian Kraja committed
      required:
      - caType
      - caValue
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        caType:
          type: integer
          description: "'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'"
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
        caValue:
          type: string
          description: "'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'"
      description: "'The civic address.'"
Elian Kraja's avatar
Elian Kraja committed
    MECHostInformation:
      title: MECHostInformation
      required:
      - hostId
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        hostId:
          type: object
          description: Deployment-specific information to identify a MEC host. This information can be structured to cater for host identification schemes that are more complex than a simple identifier, e.g. when referring to the structure of an NFVI.
Elian Kraja's avatar
Elian Kraja committed
        hostName:
          type: string
          description: Human-readable name of MEC host.
    OperateAppRequest:
      title: OperateAppRequest
Elian Kraja's avatar
Elian Kraja committed
      required:
      - changeStateTo
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        changeStateTo:
          $ref: '#/components/schemas/ChangeStateTo'
        gracefulStopTimeout:
          type: integer
          description: 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 note 1 and note 2.
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
        stopType:
          $ref: '#/components/schemas/StopType'
    StopType:
      title: StopType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - FORCEFUL
      - GRACEFUL
Elian Kraja's avatar
Elian Kraja committed
      type: string
      description: Signals forceful or graceful stop
      examples:
      - FORCEFUL
    ChangeStateTo:
      title: ChangeStateTo
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - STARTED
      - STOPPED
      type: string
      description: The desired operational state
      examples:
      - STARTED
Elian Kraja's avatar
Elian Kraja committed
    ProblemDetails:
      title: ProblemDetails
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
Elian Kraja's avatar
Elian Kraja committed
        status:
          type: integer
          description: The HTTP status code for this occurrence of the problem
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
        title:
          type: string
          description: A short, human-readable summary of the problem type
Elian Kraja's avatar
Elian Kraja committed
        type:
          type: string
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
Elian Kraja's avatar
Elian Kraja committed
    TerminateAppRequest:
      title: TerminateAppRequest
      required:
      - terminationType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        gracefulTerminationTimeout:
          type: integer
          description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources."
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
        terminationType:
          $ref: '#/components/schemas/TerminationType'
    TimeStamp:
      title: TimeStamp
Elian Kraja's avatar
Elian Kraja committed
      required:
      - nanoSeconds
      - seconds
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        nanoSeconds:
          type: integer
          description: The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
        seconds:
          type: integer
          description: The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          contentEncoding: int32
Elian Kraja's avatar
Elian Kraja committed
    TerminationType:
      title: TerminationType
Elian Kraja's avatar
Elian Kraja committed
      enum:
      - FORCEFUL
      - GRACEFUL
      type: string
      description: "'Indicates whether forceful or graceful termination is requested.'"
      examples:
      - FORCEFUL
Elian Kraja's avatar
Elian Kraja committed
    VimConnectionInfo:
      title: VimConnectionInfo
      required:
      - id
      - vimType
      type: object
Elian Kraja's avatar
Elian Kraja committed
      properties:
        accessInfo:
          type: object
          description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
Elian Kraja's avatar
Elian Kraja committed
        extra:
          type: object
          description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
Elian Kraja's avatar
Elian Kraja committed
        id:
          type: string
          description: The identifier of the VIM Connection. This identifier is managed by the MEO.
Elian Kraja's avatar
Elian Kraja committed
        interfaceInfo:
          type: object
          description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
Elian Kraja's avatar
Elian Kraja committed
        vimId:
          type: string
          description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.
Elian Kraja's avatar
Elian Kraja committed
        vimType:
          type: string
          description: Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available.
    Links:
      title: Links
Elian Kraja's avatar
Elian Kraja committed
      required:
      - subscription
Elian Kraja's avatar
Elian Kraja committed
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
      description: Links to resources related to this notification.