X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osm_common%2Fdataclasses%2Ftemporal_dataclasses.py;h=de541f2e9592af45d0c6f9766e9a9e5d754d732b;hb=4407a0e03c999f5729874d48fe6dd6013e4e5812;hp=9bd637808f9ba36b839b4c00d0e17fb3318581eb;hpb=36a62b88b9ad60b2355fab6ab2868c5f10b192c7;p=osm%2Fcommon.git diff --git a/osm_common/dataclasses/temporal_dataclasses.py b/osm_common/dataclasses/temporal_dataclasses.py index 9bd6378..de541f2 100644 --- a/osm_common/dataclasses/temporal_dataclasses.py +++ b/osm_common/dataclasses/temporal_dataclasses.py @@ -17,6 +17,49 @@ from dataclasses import dataclass from enum import auto, IntEnum +from typing import List + + +####################################################################################### +# Defining States +class VimState(IntEnum): + PROCESSING = auto() + ENABLED = auto() + ERROR = auto() + + +class VimOperationState(IntEnum): + COMPLETED = auto() + FAILED = auto() + + +class NsState(IntEnum): + PROCESSING = auto() + INSTANTIATED = auto() + ERROR = auto() + + +class VnfLcmOperationState(IntEnum): + PROCESSING = auto() + COMPLETED = auto() + FAILED = auto() + + +class VnfInstantiationState(IntEnum): + NOT_INSTANTIATED = auto() + INSTANTIATED = auto() + + +class VnfState(IntEnum): + STOPPED = auto() + STARTED = auto() + + +class LcmOperationState(IntEnum): + PROCESSING = auto() + COMPLETED = auto() + FAILED = auto() + ####################################################################################### # Workflow Dataclasses @@ -61,43 +104,68 @@ class NsLcmOperationInput: @dataclass -class NsInstantiateInput: +class CharmInfo: """ - Input dataclass for workflow that instantiate NS. + Input dataclass for Attributes: ----------- - ns_uuid : str - The UUID of the NS as stored in the OSM nsr - collection in Mongo + app_name : str - op_id: str - The operation (task) id for this workflow. This is used - by the workflow at the end to update the status of the - operation in Mongo vim collection. + channel: str + + entity_url: str """ - ns_uuid: str - op_id: str + app_name: str + channel: str + entity_url: str @dataclass -class CharmInfo: +class GetVimCloudInput: """ - Input dataclass for + Input dataclass for get vim cloud activity. Attributes: ----------- - app_name : str + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. - channel: str + """ - entity_url: str + vnfr_uuid: str + + +@dataclass +class GetVimCloudOutput: """ + Output dataclass for get vim cloud activity. - app_name: str - channel: str - entity_url: str + Attributes: + ----------- + cloud : str + Type of the cloud which is used to Deploy VNF. + """ + + cloud: str + + +@dataclass +class VduComputeConstraints: + """ + Input dataclass for VDU constraints + + Attributes: + ----------- + cores : int (Number of virtual CPUs) + + mem: int (GB) + """ + + cores: int + mem: int @dataclass @@ -111,21 +179,73 @@ class VduInstantiateInput: charm_info : CharmInfo + constraints: VduComputeConstraints + + cloud: VIM cloud type + + config: Config details of application """ vim_uuid: str model_name: str charm_info: CharmInfo + constraints: VduComputeConstraints + cloud: str + config: dict -####################################################################################### -# Activity Dataclasses +@dataclass +class VnfInstantiateInput: + """ + Input dataclass for workflow that instantiates a VNF. + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. -class LcmOperationState(IntEnum): - PROCESSING = auto() - COMPLETED = auto() - FAILED = auto() + model_name: str + + """ + + vnfr_uuid: str + model_name: str + + +@dataclass +class GetNsRecordInput: + """ + Input dataclass for getting NS record activity. + + Attributes: + ----------- + nsr_uuid : + The UUID of the NS record which is stored in the OSM nsrs + collection in Mongo. + + """ + + nsr_uuid: str + + +@dataclass +class GetNsRecordOutput: + """ + Output dataclass for getting NS record activity. + + Attributes: + ----------- + nsr : dict + NS record retrieved from Database.. + + """ + + nsr: dict + + +####################################################################################### +# Activity Dataclasses @dataclass @@ -181,12 +301,6 @@ class TestVimConnectivityInput: vim_uuid: str -class VimState(IntEnum): - PROCESSING = auto() - ENABLED = auto() - ERROR = auto() - - @dataclass class UpdateVimStateInput: """ @@ -213,11 +327,6 @@ class UpdateVimStateInput: message: str -class VimOperationState(IntEnum): - COMPLETED = auto() - FAILED = auto() - - @dataclass class UpdateVimOperationStateInput: """ @@ -281,12 +390,6 @@ class DeployNsInput: ns_uuid: str -class NsState(IntEnum): - PROCESSING = auto() - INSTANTIATED = auto() - ERROR = auto() - - @dataclass class UpdateNsStateInput: """ @@ -314,9 +417,29 @@ class UpdateNsStateInput: @dataclass -class CreateModelInput: +class ModelInfo: + """ + Contains the information related to a model. + + Attributes: + ----------- + vim_uuid : str + The UUID of the VIM as stored in the OSM vim_accounts + collection in Mongo. + + model_name : str + Name of the Juju model used to deploy charms. + """ + + vim_uuid: str + model_name: str + + +@dataclass +class CheckCharmStatusInput: """ - Input dataclass for creating a Juju Model. + Input dataclass for checking on a specific charm's deployment + status Attributes: ----------- @@ -326,7 +449,142 @@ class CreateModelInput: model_name : str Name of the model to create in Juju. + + application_name : str + Name of the application that the state is going to be + awaited. + + poll_interval : int (optional) + Time, in seconds, to wait between status checks. """ vim_uuid: str model_name: str + application_name: str + poll_interval: int = 1 + + +@dataclass +class ChangeVnfStateInput: + """ + Input dataclass for changing VNF State. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + state : VnfState + A representation of the VNF state (STOPPED or STARTED). + """ + + vnfr_uuid: str + state: VnfState + + +@dataclass +class ChangeVnfInstantiationStateInput: + """ + Input dataclass for changing VNF Instantiation State. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + state : VnfInstantiationState + A representation of the VNF instantiation state (NOT_INSTANTIATED or INSTANTIATED). + + """ + + vnfr_uuid: str + state: VnfInstantiationState + + +@dataclass +class GetTaskQueueInput: + """ + Input dataclass for get task queue activity. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + """ + + vnfr_uuid: str + + +@dataclass +class GetTaskQueueOutput: + """ + Output dataclass for get task queue activity. + + Attributes: + ----------- + task_queue : str + Name of the queue which is used to Deploy VNF. + """ + + task_queue: str + + +@dataclass +class GetVnfDetailsInput: + """ + Input dataclass for get vnf details activity. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + """ + + vnfr_uuid: str + + +@dataclass +class GetVnfDetailsOutput: + """ + Output dataclass for get vnf details activity. + + Attributes: + ----------- + vnfr : dict + VNF record retrieved from Database. + + vnfd : dict + VNF descriptor retrieved from Database. + """ + + vnfr: dict + vnfd: dict + + +@dataclass +class GetVnfRecordIdsInput: + """ + Attributes: + ----------- + ns_uuid : str + The UUID of the NS from which to retrieve the VNF records. + """ + + ns_uuid: str + + +@dataclass +class GetVnfRecordIdsOutput: + """ + Attributes: + ----------- + vnfr_ids : list[str] + List of the VNF record IDs associated with the NS. + """ + + vnfr_ids: List[str]