The CLAMP Automation Composition Runtime Lifecycle Management uses the following system-level dialogues. These dialogues enable the CLAMP runtime capabilities described in Section 2 of TOSCA Defined Automation Compositions: Architecture and Design. Design Time dialogues will be described in future releases of the system.
Table of Contents |
---|
...
2 Commissioning Dialogues
Commissioning dialogues are used to commission and decommission Automation Composition Type definitions and to set the values of Common Parameters.
...
- The Automation Composition Type must be created, that is the Automation Composition Type definition must be loaded and stored in the database. This step may be carried out over the REST interface or using SDC distribution.
- The Common Properties of the Automation Composition type must be assigned values and those values must be stored in the database. This step is optional only if all mandatory common properties have default values. The Common Property values may be set and amended over and over again in multiple sessions until the Automation Composition Type is primed.
- The Automation Composition Type Definition and the Common Property values must be primed, which is sent to the concerned participants. Once an Automation Composition Type is primed, its Common Property values can no longer be changed. To change Common Properties on a primed Automation Composition Type, all instances of the Automation Composition Type must be removed and the Automation Composition Type must be de-primed.
...
2.1 Commissioning an Automation Composition Type Definition using the ACM REST Interface
PlantUML Macro |
---|
@startuml participant REST participant ACM_Runtime database Commissioned_ACM_Inventory REST -> ACM_Runtime: Commission Automation Composition Type Definition alt Automation Composition Type exists and has Instances ACM_Runtime -> REST: Type Definition Commissioning Failed else ACM_Runtime -> Commissioned_ACM_Inventory: Store Automation Composition Type Definition ACM_Runtime -> ACM_Runtime: Trigger Priming of Automation Composition Type Definition ACM_Runtime -> REST: Type Definition Commissioned end @enduml |
...
2.2 Commissioning an Automation Composition Type Definition using SDC
PlantUML Macro |
---|
@startuml participant SDC participant Policy_Distribution participant ACM_Runtime SDC -> Policy_Distribution: [DMaaP] CSAR containing Automation Composition Type Definition Policy_Distribution -> ACM_Runtime: Commission Automation Composition Type Definition\n(See Commissioning Sequence Diagram) Policy_Distribution <- ACM_Runtime: Result of commissioning Policy_Distribution -> SDC: [DMaaP] Return result of Deployment @enduml |
...
2.3 Deleting an Automation Composition Type Definition
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime participant Participant database Commissioned_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Parameterization CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Common Parameter Definitions alt Automation Composition Type Definition not Commissioned on Participants CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Common Parameters for GUI CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Common Parameter Definitions CLAMP_GUI -> CLAMP_GUI: Render UI for Common Parameters CLAMP_GUI -> CLAMP_GUI: Get values for Common Parameters from user CLAMP_GUI -> CLAMP_Runtime: [REST] Set values for Common Parameters CLAMP_Runtime -> Commissioned_ACM_Inventory: Store values for Common Parameters CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameter values stored else Automation Composition Type Definition already Commissioned on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen commissioned on participants end @enduml |
...
2.4 Priming an Automation Composition Type Definition on Participants
The Priming operation sends Automation Composition Type definitions and common property values to participants. Once an Automation Composition Type definition is primed, its property values can on longer be changed until it is de-primed.
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime participant Participant database Commissioned_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Priming on Participants CLAMP_GUI -> CLAMP_Runtime: [REST] Prime Automation Composition Type Definition on Participants alt Automation Composition Type Definition not Primed on Participants CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Common Parameter Values for Automation Composition Type Definition alt Common Parameter values set for Automation Composition Type Definition CLAMP_Runtime -> Participants: [DMaaP] Update Participants with Automation Composition Type Definition and values for Common Parameters CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition priming ordered on participants else Automation Composition Type Definition already primed on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] Common Parameters not set\non Automation Composition Type Definition end else Automation Composition Type Definition already primed on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] Cannot set Common Parameters on\nAutomation Composition Type Definition that has\nbeen primed on participants end == Participant Responses == Participants -> CLAMP_Runtime: [DMaaP] Result of Update with Automation Composition Type Definition and values for Common Parameters CLAMP_Runtime -> Commissioned_ACM_Inventory: Store result of Automation Composition Type Definition Update on Participant == Supervision == loop forever CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions loop over each Automation Composition Type Definition alt Automation Composition Type Definition Participant priming underway CLAMP_Runtime -> Commissioned_ACM_Inventory: read result of Automation Composition Type Definition Updates from participants alt Updates completed on all participants CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition as primed on Participants else Updates not completed alt Priming of Automation Composition Type Definition on participants timed out CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition priming as timed out on Participants CLAMP_Runtime -> CLAMP_Runtime: Log error else Wait for updates to complete end end else Automation Composition Type Definition Participant priming not underway end end end @enduml |
...
2.5 De-Prime an Automation Composition Type Definition on Participants
This dialogue allows an Automation Composition Type Definition to be de-primed so that it can be deleted or its common parameter values can be altered.
...
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime participant Participant database Commissioned_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for de-priming on Participants CLAMP_GUI -> CLAMP_Runtime: [REST] De-prime Automation Composition Type Definition on Participants alt Automation Composition Type Definition primed on Participants alt Automation Composition Instances do not exist for Automation Composition Type Definition CLAMP_Runtime -> Participants: [DMaaP] Update Participants, removing Automation Composition Type Definition and values for Common Parameters CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition de-priming ordered on participants else Automation Composition Instances exist for Automation Composition Type Definition CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition cannot be\n de-primed on participants\nit is in use on Automation Compositions end else Automation Composition Type Definition not primed on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition has not\nbeen primed on participants end == Participant Responses == Participants -> CLAMP_Runtime: [DMaaP] Result of Update to remove Automation Composition Type Definition and values for Common Parameters CLAMP_Runtime -> Commissioned_ACM_Inventory: Store result of Automation Composition Type Definition Update on Participant == Supervision == loop forever CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions loop over each Automation Composition Type Definition alt Automation Composition Type Definition Participant de-prime underway CLAMP_Runtime -> Commissioned_ACM_Inventory: read result of Automation Composition Type Definition Updates from participants alt Updates completed on all participants CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition as de-primeed on Participants else Updates not completed alt De-priming of Automation Composition Type Definition on participants timed out CLAMP_Runtime -> Commissioned_ACM_Inventory: set Automation Composition Type Definition de-priming as timed out on Participants CLAMP_Runtime -> CLAMP_Runtime: Log error else Wait for updates to complete end end else Automation Composition Type Definition Participant de-prime not underway end end end @enduml |
...
2.6 Decommissioning an Automation Composition Type Definition in CLAMP
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime database Commissioned_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition for Decommissioning CLAMP_GUI -> CLAMP_Runtime: [REST] Decommission Automation Composition Type Definition alt Automation Composition Type Definition not primed on Participants CLAMP_Runtime -> Commissioned_ACM_Inventory: Delete Automation Composition Type Definition CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definition Decommissioned else Automation Composition Type Definition is Commissioned on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Type Definition cannot be decommissioned\nit is primed on participants end @enduml |
...
2.7 Reading Commissioned Automation Composition Type Definitions
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime database Commissioned_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned @enduml |
...
3. Instantiation Dialogues
Instantiation dialogues are used to create, set parameters on, instantiate, update, and remove Automation Composition instances.
Assume a suitable Automation Composition Definition exists in the Commissioned Automation Composition Inventory. To get an Automation Composition instance running one would, for example, execute dialogues 2.1, 2.3, and 2.4.
...
3.1 Creating an Automation Composition Instance
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime database Commissioned_ACM_Inventory database Instantiated_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Type Definitions CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definitions CLAMP_Runtime -> CLAMP_GUI: [REST] Type Definitions returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Type Definition to use to create Automation Composition Instance CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions CLAMP_Runtime -> Commissioned_ACM_Inventory: Read Automation Composition Type Definition CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user CLAMP_GUI -> CLAMP_Runtime: [REST] Request Creation of Automation Composition Instance CLAMP_Runtime -> CLAMP_Runtime: Create Automation Composition Instance CLAMP_Runtime -> Instantiated_ACM_Inventory: Store First Version of Automation Composition Instance CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated @enduml |
Note that this dialogue creates the Automation Composition Instance in the Instantiated Automation Composition Inventory. The instance is sent to the participants using the process described in the dialogue in Section 2.3.
...
3.2 Updating Instance Specific Parameters on an Automation Composition Instance
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime database Instantiated_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read Automation Composition Instances CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instances returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to Update Parameters CLAMP_GUI -> CLAMP_GUI: Step version of Automation Composition Instance as Major/Minor/Patch CLAMP_GUI -> CLAMP_Runtime: [REST] Fetch GUI fields for Instance Specific Parameter Definitions CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Type Definition CLAMP_Runtime -> CLAMP_Runtime: Generate fields for Instance Specific Parameters for GUI CLAMP_Runtime -> CLAMP_GUI: [REST] Return GUI fields Instance Specific Parameter Definitions CLAMP_GUI -> CLAMP_GUI: Render UI for Instance Specific Parameters CLAMP_GUI -> CLAMP_GUI: Get values for Instance Specific Parameters from user CLAMP_GUI -> CLAMP_Runtime: [REST] Request Update of Automation Composition Instance CLAMP_Runtime -> CLAMP_Runtime: Update Automation Composition Instance CLAMP_Runtime -> Instantiated_ACM_Inventory: Store New Version of Automation Composition Instance CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance Updated @enduml |
...
3.3 Updating an Automation Composition Instance with a Configuration on Participants
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime participant Participant database Instantiated_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read all configuration versions of Automation Composition Instance CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all configuration versions of Automation Composition Instance CLAMP_Runtime -> CLAMP_GUI: [REST] All configuration versions of Automation Composition Instance returned CLAMP_GUI -> CLAMP_GUI: Select configuration version of Automation Composition Instance for Instantiation Participants CLAMP_GUI -> CLAMP_Runtime: [REST] Instantiate selected configuration version of Automation Composition Instance on Participants alt Selected configuration version of Automation Composition Instance not instantiated on Participants CLAMP_Runtime -> Instantiated_ACM_Inventory: Read configuration version of Automation Composition Instance CLAMP_Runtime -> Participants: [DMaaP] Update Participants with configuration version of Automation Composition Instance CLAMP_Runtime -> CLAMP_GUI: [REST] Instantiation of configuration version of Automation Composition Instance ordered on participants else Selected configuration version of Automation Composition Instance instantiated on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] configuration version of Automation Composition Instance already instantiated on participants end == Participant Responses == Participants -> CLAMP_Runtime: [DMaaP] Result of update of configuration version of Automation Composition Instance on participant CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of update of configuration version of Automation Composition Instance on participant == Supervision == loop forever CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances loop over each Automation Composition Instance alt Automation Composition Instance configuration version update underway on participants CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition updates from participants alt Updates completed on all participants CLAMP_Runtime -> Instantiated_ACM_Inventory: set configuration version of Automation Composition Instance as Instantiated on Participants CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall configuration version of Automation Composition Instance state as Instantiated else Updates not completed alt Instantiation of Automation Composition Instance on participants timed out CLAMP_Runtime -> Instantiated_ACM_Inventory: set configuration version Automation Composition Instance Instantiation as timed out on Participants CLAMP_Runtime -> CLAMP_Runtime: Log error else Wait for updates to complete end end else Automation Composition Instance configuration version update on participants not underway end end end @enduml |
...
3.4 Changing the state of an Automation Composition Instance on Participants
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime participant Participant database Instantiated_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Instantiated Automation Composition Instances CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Automation Composition Instances returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance on which to change state and specify new state CLAMP_GUI -> CLAMP_Runtime: [REST] Change state of selected Automation Composition Instance on Participants alt Selected Automation Composition Instance instantiated on Participants CLAMP_Runtime -> Participants: [DMaaP] Request change of state of Automation Composition Instance CLAMP_Runtime -> CLAMP_GUI: [REST] Change of state of Automation Composition Instance ordered on participants else Selected Automation Composition Instance not instantiated on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants end == Participant Responses == Participants -> CLAMP_Runtime: [DMaaP] Result of State Change of Automation Composition Instance on participant CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of State Change of Automation Composition Instance on participant == Supervision == loop forever CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances loop over each Automation Composition Instance alt Automation Composition Instance State Change underway on participants CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition State Change from participants alt Updates completed on all participants CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance state as changed on Participants CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall Automation Composition Instance state as changed else Updates not completed alt Automation Composition Instance State Change on participants timed out CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition State Change as timed out on Participants CLAMP_Runtime -> CLAMP_Runtime: Log error else Wait for updates to complete end end else Automation Composition Instance State Change on participants not underway end end end @enduml |
...
3.5 De-instantiating an Automation Composition Instance from Participants
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime participant Participant database Instantiated_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Instantiated Automation Composition Instances CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Instantiated Automation Composition Instances CLAMP_Runtime -> CLAMP_GUI: [REST] All Instantiated Automation Composition Instances returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to de-instantiate CLAMP_GUI -> CLAMP_Runtime: [REST] De-instantiate selected Automation Composition Instance on Participants alt Selected Automation Composition Instance instantiated on Participants CLAMP_Runtime -> Participants: [DMaaP] Update Participants to remove Automation Composition Instance CLAMP_Runtime -> CLAMP_GUI: [REST] De-instantiation of Automation Composition Instance ordered on participants else Selected Automation Composition Instance not instantiated on Participants CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance not instantiated on participants end == Participant Responses == Participants -> CLAMP_Runtime: [DMaaP] Result of update of Automation Composition Instance on participant CLAMP_Runtime -> Instantiated_ACM_Inventory: Store result of update of Automation Composition Instance on participant == Supervision == loop forever CLAMP_Runtime -> Instantiated_ACM_Inventory: Read Automation Composition Instances loop over each Automation Composition Instance alt Automation Composition Instance de-instantiation update underway on participants CLAMP_Runtime -> Instantiated_ACM_Inventory: read result of Automation Composition updates from participants alt Updates completed on all participants CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance as de-instantiated on Participants CLAMP_Runtime -> Instantiated_ACM_Inventory: set overall Automation Composition Instance as de-instantiated else Updates not completed alt Automation Composition Instance de-instantiation Update timed out on participants CLAMP_Runtime -> Instantiated_ACM_Inventory: set Automation Composition Instance de-instantiation as timed out on Participants CLAMP_Runtime -> CLAMP_Runtime: Log error else Wait for updates to complete end end else Automation Composition Instance de-instantiation update on participants not underway end end @enduml |
...
3.6 Deleting an Automation Composition Instance
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime database Instantiated_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned CLAMP_GUI -> CLAMP_GUI: Select Automation Composition Instance to delete CLAMP_GUI -> CLAMP_Runtime: [REST] Delete selected Automation Composition Instance alt Selected Automation Composition Instance exists CLAMP_Runtime -> Instantiated_ACM_Inventory: Delete Automation Composition instance CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance deleted else Selected Automation Composition Instance does not exist CLAMP_Runtime -> CLAMP_GUI: [REST] Automation Composition Instance does not exist end @enduml |
...
3.7 Reading Automation Composition Instances
PlantUML Macro |
---|
@startuml participant CLAMP_GUI participant CLAMP_Runtime database Instantiated_ACM_Inventory CLAMP_GUI -> CLAMP_Runtime: [REST] Read all Automation Composition Instances CLAMP_Runtime -> Instantiated_ACM_Inventory: Read all Automation Composition Instances CLAMP_Runtime -> CLAMP_GUI: [REST] All Automation Composition Instances returned @enduml |
...