X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osm_common%2Fdataclasses%2Ftemporal_dataclasses.py;h=a0e3d19bd066a750f2349937fcf47280e02ae183;hb=4ddf2c7055362b6f06ffc5b341f0cd0b54661fe6;hp=3b8a8570792a1f3726f1ffdbc917213d52bc22cd;hpb=30e050771684d560dd8e029d5a9876fd24840333;p=osm%2Fcommon.git diff --git a/osm_common/dataclasses/temporal_dataclasses.py b/osm_common/dataclasses/temporal_dataclasses.py index 3b8a857..a0e3d19 100644 --- a/osm_common/dataclasses/temporal_dataclasses.py +++ b/osm_common/dataclasses/temporal_dataclasses.py @@ -16,7 +16,51 @@ ####################################################################################### from dataclasses import dataclass +from enum import auto, IntEnum + +####################################################################################### +# 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 @@ -42,9 +86,154 @@ class VimOperationInput: op_id: str +@dataclass +class NsLcmOperationInput: + """ + Input dataclass for workflows that run as LCM operations. + + Attributes: + ----------- + + nslcmop: dict + A dictionary representing the nslcmop record from the + database. + """ + + nslcmop: dict + + +@dataclass +class NsInstantiateInput: + """ + Input dataclass for workflow that instantiate NS. + + Attributes: + ----------- + ns_uuid : str + The UUID of the NS as stored in the OSM nsr + collection in Mongo + + 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. + """ + + ns_uuid: str + op_id: str + + +@dataclass +class CharmInfo: + """ + Input dataclass for + + Attributes: + ----------- + app_name : str + + channel: str + + entity_url: str + """ + + app_name: str + channel: str + entity_url: str + + +@dataclass +class VduInstantiateInput: + """ + Input dataclass for workflow that instantiates a VDU. + + vim_uuid: str + + model_name: str + + charm_info : CharmInfo + + """ + + vim_uuid: str + model_name: str + charm_info: CharmInfo + + +@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. + + """ + + vnfr_uuid: str + + +@dataclass +class PrepareVnfInput: + """ + 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. + + """ + + vnfr_uuid: str + + +####################################################################################### # Activity Dataclasses +@dataclass +class UpdateLcmOperationStateInput: + """ + Input dataclass for updating LCM Operations in the Mongo nslcmops + collection. The following attributes will be updated automatically + - statusEnteredTime + - _admin.modified + + Attributes: + ----------- + op_id: str + The operation (task) id for this activity. This is the key + to the record in nslcmops collection that will be updated. + + op_state : LcmOperationState + A representation of the state of the specified operation id, + such as PROCESSING, COMPLETED, or FAILED. + + stage: str + Human readable checkpoint message, intended only to give the + user feedback. + + error_message: str + Human readable error message if any failure occurred. + + detailed_status : str + Human readable message providing additional details to the + operation state, such as the error message explaining why + the operation failed. + """ + + op_id: str + op_state: LcmOperationState + stage: str + error_message: str + detailed_status: str + + @dataclass class TestVimConnectivityInput: """ @@ -71,7 +260,7 @@ class UpdateVimStateInput: The UUID of the VIM account as stored in the OSM vim collection in Mongo - operational_state : str + operational_state : VimState A representation of the operational state (ENABLED or ERROR) of the VIM. @@ -82,7 +271,7 @@ class UpdateVimStateInput: """ vim_uuid: str - operational_state: str + operational_state: VimState message: str @@ -102,7 +291,7 @@ class UpdateVimOperationStateInput: The operation (task) id for this workflow. This is used to update the status of the operation in Mongo vim collection. - op_state : str + op_state : VimOperationState A representation of the state of the specified operation id, such as COMPLETED, or FAILED. @@ -114,7 +303,7 @@ class UpdateVimOperationStateInput: vim_uuid: str op_id: str - op_state: str + op_state: VimOperationState message: str @@ -132,3 +321,132 @@ class DeleteVimInput: """ vim_uuid: str + + +@dataclass +class DeployNsInput: + """ + Input dataclass for + + Attributes: + ----------- + ns_uuid : str + The UUID of the NS as stored in the OSM nsr + collection in Mongo + """ + + ns_uuid: str + + +@dataclass +class UpdateNsStateInput: + """ + Input dataclass for updating NS state in the DB + + Attributes: + ----------- + ns_uuid : str + The UUID of the NS as stored in the OSM ns + collection in Mongo + + operational_state : NsState + A representation of the operational state (ENABLED or ERROR) + of the NS. + + message : str + Human readable message providing additional details to the + operational state, such as the error message associated + with the ERROR operational_state. + """ + + ns_uuid: str + state: NsState + message: str + + +@dataclass +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 ChangeNFStateInput: + """ + Input dataclass for creating a Juju Model. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + nf_state : VnfState + A representation of the VNF state (STOPPED or STARTED). + """ + + vnfr_uuid: str + state: VnfState + + +@dataclass +class ChangeNFInstantiationStateInput: + """ + Input dataclass for creating a Juju Model. + + Attributes: + ----------- + vnfr_uuid : str + The UUID of the VNF which is stored in the OSM vnfrs + collection in Mongo. + + nf_instantiation_state : VnfInstantiationState + A representation of the VNF instantiation state (NOT_INSTANTIATED or INSTANTIATED). + + """ + + vnfr_uuid: str + state: VnfInstantiationState + + +@dataclass +class GetTaskQueueInput: + """ + Input dataclass for creating a Juju Model. + + 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