diff options
| author |   adheli.tavares <adheli.tavares@est.tech> | 2022-04-05 10:36:08 +0100 |
|---|---|---|
| committer | Adheli Tavares <adheli.tavares@est.tech> | 2022-04-13 08:26:38 +0000 |
| commit | ec1d537663eea6764322993c4bbc684c984fceb2 (patch) | |
| tree | 379509c788b63e7613cd29b0ac4a8575bff478f7 /docs/clamp | |
| parent | 098fc7241447a12cd635e3ec606cdd7e1f4d0fad (diff) | |
Updating clamp documentation
- rename control loop to acm on system level dialogues
- update uml images with acm naming
Issue-ID: POLICY-4066
Change-Id: Ia4db7a25967e9e2de424180c31154bedf1851eae
Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
Diffstat (limited to 'docs/clamp')
33 files changed, 85 insertions, 82 deletions
diff --git a/docs/clamp/acm/api-protocol/system-level-dialogues.rst b/docs/clamp/acm/api-protocol/system-level-dialogues.rst index 676ffc9b..6d3f82d6 100644 --- a/docs/clamp/acm/api-protocol/system-level-dialogues.rst +++ b/docs/clamp/acm/api-protocol/system-level-dialogues.rst @@ -10,37 +10,37 @@ System Level Dialogues :depth: 4 -The CLAMP Control Loop Runtime Lifecycle Management uses the following system level dialogues. -These dialogues enable the CLAMP runtime capabilities described in :ref:`Section 2 of -TOSCA Defined Control Loops: Architecture and Design <controlloop-capabilities>`. +The CLAMP Automation Composition Runtime Lifecycle Management uses the following system level +dialogues. These dialogues enable the CLAMP runtime capabilities described in +:ref:`Section 2 of TOSCA Defined Automation Compositions: Architecture and Design <acm-capabilities>`. Design Time dialogues will be described in future releases of the system. 1 Commissioning Dialogues ========================= -Commissioning dialogues are used to commission and decommission Control Loop Type definitions -and to set the values of Common Parameters. +Commissioning dialogues are used to commission and decommission Automation Composition Type +definitions and to set the values of Common Parameters. -Commissioning a Control Loop Type is a three-step process: +Commissioning an Automation Composition Type is a three-step process: -#. The Control Loop Type must be created, that is the Control Loop 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 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 Control Loop 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 Control Loop Type is primed. +#. 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 Control Loop Type Definition and the Common Property values must be primed, that is - sent to the concerned participants. Once a Control Loop Type is primed, its Common Property - values can no longer be changed. To change Common Properties on a primed Control Loop Type, - all instances of the Control Loop Type must be removed and the Control Loop Type must be - de-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. -1.1 Commissioning a Control Loop Type Definition using the CLAMP GUI --------------------------------------------------------------------- +1.1 Commissioning an Automation Composition Type Definition using the CLAMP GUI +------------------------------------------------------------------------------- This dialogue corresponds to a "File → Import" menu on the CLAMP GUI. The documentation of future releases of the system will describe how the Design Time functionality interacts @@ -48,116 +48,118 @@ with the Runtime commissioning API. .. image:: ../images/system-dialogues/comissioning-clamp-gui.png -1.2 Commissioning a Control Loop Type Definition using SDC ----------------------------------------------------------- +1.2 Commissioning an Automation Composition Type Definition using SDC +--------------------------------------------------------------------- .. image:: ../images/system-dialogues/comissioning-sdc.png -1.3 Setting Common Properties for a Control Loop Type Definition ----------------------------------------------------------------- +1.3 Setting Common Properties for an Automation Composition Type Definition +--------------------------------------------------------------------------- This dialogue sets the values of common properties. The values of the common properties may be set, updated, or deleted at will, as this dialogue saves the properties to the database but does not send the definitions or properties to the participants. However, -once a Control Loop Type Definition and its properties are primed -(See :ref:`Section 1.4 <priming-cl-label>`), the properties cannot be changed until the control loop type -definition is de-primed (See :ref:`Section 1.5 <depriming-cl-label>`). +once an Automation Composition Type Definition and its properties are primed +(See :ref:`Section 1.4 <priming-acm-label>`), the properties cannot be changed until the +Automation Composition type definition is de-primed (See +:ref:`Section 1.5 <depriming-acm-label>`). .. image:: ../images/system-dialogues/common-properties-type-definition.png -.. _priming-cl-label: +.. _priming-acm-label: -1.4 Priming a Control Loop Type Definition on Participants ----------------------------------------------------------- -The Priming operation sends Control Loop Type definitions and common property values -to participants. Once a Control Loop Type definition is primed, its property values +1.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. -.. image:: ../images/system-dialogues/priming-cl-type-definition.png +.. image:: ../images/system-dialogues/priming-acm-type-definition.png -.. _depriming-cl-label: +.. _depriming-acm-label: -1.5 De-Prime a Control Loop Type Definition on Participants ------------------------------------------------------------ +1.5 De-Prime an Automation Composition Type Definition on Participants +---------------------------------------------------------------------- -This dialogue allows a Control Loop Type Definition to be de-primed so that it can be +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. -.. image:: ../images/system-dialogues/depriming-cl-type-definition.png +.. image:: ../images/system-dialogues/depriming-acm-type-definition.png -1.6 Decommissioning a Control Loop Type Definition in CLAMP ------------------------------------------------------------ +1.6 Decommissioning an Automation Composition Type Definition in CLAMP +---------------------------------------------------------------------- -.. image:: ../images/system-dialogues/decommission-cl-type-definition.png +.. image:: ../images/system-dialogues/decommission-acm-type-definition.png -1.7 Reading Commissioned Control Loop Type Definitions ------------------------------------------------------- +1.7 Reading Commissioned Automation Composition Type Definitions +---------------------------------------------------------------- -.. image:: ../images/system-dialogues/read-commision-cl-type-definition.png +.. image:: ../images/system-dialogues/read-commision-acm-type-definition.png 2. Instantiation Dialogues ========================== Instantiation dialogues are used to create, set parameters on, instantiate, update, -and remove Control Loop instances. +and remove Automation Composition instances. -Assume a suitable Control Loop Definition exists in the Commissioned Control Loop Inventory. -To get a Control Loop instance running one would, for example, execute dialogues -:ref:`2.1 <creating-cl-instance>`, :ref:`2.3 <updating-cl-instance-config>`, and -:ref:`2.4 <changing-cl-instance-state>`. +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 +:ref:`2.1 <creating-acm-instance>`, :ref:`2.3 <updating-acm-instance-config>`, and +:ref:`2.4 <changing-acm-instance-state>`. -.. _creating-cl-instance: +.. _creating-acm-instance: -2.1 Creating a Control Loop Instance ------------------------------------- +2.1 Creating an Automation Composition Instance +----------------------------------------------- -.. image:: ../images/system-dialogues/create-cl-instance.png +.. image:: ../images/system-dialogues/create-acm-instance.png .. note:: - This dialogue creates the Control Loop Instance in the Instantiated Control Loop Inventory. - The instance is sent to the participants using the process described in the dialogue in - :ref:`Section 2.3 <updating-cl-instance-config>`. + 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 :ref:`Section 2.3 <updating-acm-instance-config>`. -2.2 Updating Instance Specific Parameters on a Control Loop Instance --------------------------------------------------------------------- +2.2 Updating Instance Specific Parameters on an Automation Composition Instance +------------------------------------------------------------------------------- -.. image:: ../images/system-dialogues/update-instance-params-cl.png +.. image:: ../images/system-dialogues/update-instance-params-acm.png -.. _updating-cl-instance-config: +.. _updating-acm-instance-config: -2.3 Updating a Control Loop Instance with a Configuration on Participants -------------------------------------------------------------------------- +2.3 Updating an Automation Composition Instance with a Configuration on Participants +------------------------------------------------------------------------------------ -.. image:: ../images/system-dialogues/update-cl-instance-config-participants.png +.. image:: ../images/system-dialogues/update-acm-instance-config-participants.png -.. _changing-cl-instance-state: +.. _changing-acm-instance-state: -2.4 Changing the state of a Control Loop Instance on Participants ------------------------------------------------------------------ +2.4 Changing the state of an Automation Composition Instance on Participants +---------------------------------------------------------------------------- -.. image:: ../images/system-dialogues/change-cl-instance-state-participants.png +.. image:: ../images/system-dialogues/change-acm-instance-state-participants.png -2.5 De-instantiating a Control Loop Instance from Participants --------------------------------------------------------------- +2.5 De-instantiating an Automation Composition Instance from Participants +------------------------------------------------------------------------- -.. image:: ../images/system-dialogues/deinstantiate-cl-from-participants.png +.. image:: ../images/system-dialogues/deinstantiate-acm-from-participants.png -2.6 Deleting a Control Loop Instance ------------------------------------- +2.6 Deleting an Automation Composition Instance +----------------------------------------------- -.. image:: ../images/system-dialogues/delete-cl-instance.png +.. image:: ../images/system-dialogues/delete-acm-instance.png -2.7 Reading Control Loop Instances ----------------------------------- +2.7 Reading Automation Composition Instances +-------------------------------------------- -.. image:: ../images/system-dialogues/read-cl-instance.png +.. image:: ../images/system-dialogues/read-acm-instance.png -1. Monitoring Dialogues +3. Monitoring Dialogues ======================= -Monitoring dialogues are used to monitor and to read statistics on Control Loop Instances. +Monitoring dialogues are used to monitor and to read statistics on Automation Composition Instances. 3.1 Reporting of Monitoring Information and Statistics by Participants ---------------------------------------------------------------------- @@ -183,16 +185,17 @@ Monitoring dialogues are used to monitor and to read statistics on Control Loop 4. Supervision Dialogues ======================== -Supervision dialogues are used to check the state of Control Loop Instances and Participants. +Supervision dialogues are used to check the state of Automation Composition Instances and +Participants. 4.1 Supervise Participants -------------------------- .. image:: ../images/system-dialogues/supervise-participants.png -4.2 Supervise Control Loops ---------------------------- +4.2 Supervise Automation Compositions +------------------------------------- -.. image:: ../images/system-dialogues/supervise-controlloops.png +.. image:: ../images/system-dialogues/supervise-acms.png End of Document diff --git a/docs/clamp/acm/images/system-dialogues/change-acm-instance-state-participants.png b/docs/clamp/acm/images/system-dialogues/change-acm-instance-state-participants.png Binary files differnew file mode 100644 index 00000000..8c009dd4 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/change-acm-instance-state-participants.png diff --git a/docs/clamp/acm/images/system-dialogues/change-cl-instance-state-participants.png b/docs/clamp/acm/images/system-dialogues/change-cl-instance-state-participants.png Binary files differdeleted file mode 100644 index 8892f07d..00000000 --- a/docs/clamp/acm/images/system-dialogues/change-cl-instance-state-participants.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/comissioning-clamp-gui.png b/docs/clamp/acm/images/system-dialogues/comissioning-clamp-gui.png Binary files differindex 473cf05b..5237a7f6 100644 --- a/docs/clamp/acm/images/system-dialogues/comissioning-clamp-gui.png +++ b/docs/clamp/acm/images/system-dialogues/comissioning-clamp-gui.png diff --git a/docs/clamp/acm/images/system-dialogues/comissioning-sdc.png b/docs/clamp/acm/images/system-dialogues/comissioning-sdc.png Binary files differindex 19f3f84d..b28e4762 100644 --- a/docs/clamp/acm/images/system-dialogues/comissioning-sdc.png +++ b/docs/clamp/acm/images/system-dialogues/comissioning-sdc.png diff --git a/docs/clamp/acm/images/system-dialogues/common-properties-type-definition.png b/docs/clamp/acm/images/system-dialogues/common-properties-type-definition.png Binary files differindex 06fa8967..9fac8555 100644 --- a/docs/clamp/acm/images/system-dialogues/common-properties-type-definition.png +++ b/docs/clamp/acm/images/system-dialogues/common-properties-type-definition.png diff --git a/docs/clamp/acm/images/system-dialogues/create-acm-instance.png b/docs/clamp/acm/images/system-dialogues/create-acm-instance.png Binary files differnew file mode 100644 index 00000000..4d732e8e --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/create-acm-instance.png diff --git a/docs/clamp/acm/images/system-dialogues/create-cl-instance.png b/docs/clamp/acm/images/system-dialogues/create-cl-instance.png Binary files differdeleted file mode 100644 index 88a67648..00000000 --- a/docs/clamp/acm/images/system-dialogues/create-cl-instance.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/decommission-acm-type-definition.png b/docs/clamp/acm/images/system-dialogues/decommission-acm-type-definition.png Binary files differnew file mode 100644 index 00000000..12c9d3a0 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/decommission-acm-type-definition.png diff --git a/docs/clamp/acm/images/system-dialogues/decommission-cl-type-definition.png b/docs/clamp/acm/images/system-dialogues/decommission-cl-type-definition.png Binary files differdeleted file mode 100644 index c4051eee..00000000 --- a/docs/clamp/acm/images/system-dialogues/decommission-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/deinstantiate-acm-from-participants.png b/docs/clamp/acm/images/system-dialogues/deinstantiate-acm-from-participants.png Binary files differnew file mode 100644 index 00000000..11b77994 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/deinstantiate-acm-from-participants.png diff --git a/docs/clamp/acm/images/system-dialogues/deinstantiate-cl-from-participants.png b/docs/clamp/acm/images/system-dialogues/deinstantiate-cl-from-participants.png Binary files differdeleted file mode 100644 index 174250c0..00000000 --- a/docs/clamp/acm/images/system-dialogues/deinstantiate-cl-from-participants.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/delete-acm-instance.png b/docs/clamp/acm/images/system-dialogues/delete-acm-instance.png Binary files differnew file mode 100644 index 00000000..5043989d --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/delete-acm-instance.png diff --git a/docs/clamp/acm/images/system-dialogues/delete-cl-instance.png b/docs/clamp/acm/images/system-dialogues/delete-cl-instance.png Binary files differdeleted file mode 100644 index 8417017f..00000000 --- a/docs/clamp/acm/images/system-dialogues/delete-cl-instance.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/depriming-acm-type-definition.png b/docs/clamp/acm/images/system-dialogues/depriming-acm-type-definition.png Binary files differnew file mode 100644 index 00000000..b8b26f54 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/depriming-acm-type-definition.png diff --git a/docs/clamp/acm/images/system-dialogues/depriming-cl-type-definition.png b/docs/clamp/acm/images/system-dialogues/depriming-cl-type-definition.png Binary files differdeleted file mode 100644 index 60d97805..00000000 --- a/docs/clamp/acm/images/system-dialogues/depriming-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/monitoring-by-participants.png b/docs/clamp/acm/images/system-dialogues/monitoring-by-participants.png Binary files differindex 69ceabf8..19723b30 100644 --- a/docs/clamp/acm/images/system-dialogues/monitoring-by-participants.png +++ b/docs/clamp/acm/images/system-dialogues/monitoring-by-participants.png diff --git a/docs/clamp/acm/images/system-dialogues/priming-acm-type-definition.png b/docs/clamp/acm/images/system-dialogues/priming-acm-type-definition.png Binary files differnew file mode 100644 index 00000000..c5926f39 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/priming-acm-type-definition.png diff --git a/docs/clamp/acm/images/system-dialogues/priming-cl-type-definition.png b/docs/clamp/acm/images/system-dialogues/priming-cl-type-definition.png Binary files differdeleted file mode 100644 index 46f93480..00000000 --- a/docs/clamp/acm/images/system-dialogues/priming-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/read-acm-instance.png b/docs/clamp/acm/images/system-dialogues/read-acm-instance.png Binary files differnew file mode 100644 index 00000000..a2910c1f --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/read-acm-instance.png diff --git a/docs/clamp/acm/images/system-dialogues/read-cl-instance.png b/docs/clamp/acm/images/system-dialogues/read-cl-instance.png Binary files differdeleted file mode 100644 index 611039b9..00000000 --- a/docs/clamp/acm/images/system-dialogues/read-cl-instance.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/read-commision-acm-type-definition.png b/docs/clamp/acm/images/system-dialogues/read-commision-acm-type-definition.png Binary files differnew file mode 100644 index 00000000..411d8288 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/read-commision-acm-type-definition.png diff --git a/docs/clamp/acm/images/system-dialogues/read-commision-cl-type-definition.png b/docs/clamp/acm/images/system-dialogues/read-commision-cl-type-definition.png Binary files differdeleted file mode 100644 index 3a308787..00000000 --- a/docs/clamp/acm/images/system-dialogues/read-commision-cl-type-definition.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/statistics-housekeeping.png b/docs/clamp/acm/images/system-dialogues/statistics-housekeeping.png Binary files differindex 6cbfda52..0d3d169f 100644 --- a/docs/clamp/acm/images/system-dialogues/statistics-housekeeping.png +++ b/docs/clamp/acm/images/system-dialogues/statistics-housekeeping.png diff --git a/docs/clamp/acm/images/system-dialogues/supervise-acms.png b/docs/clamp/acm/images/system-dialogues/supervise-acms.png Binary files differnew file mode 100644 index 00000000..2634fa6a --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/supervise-acms.png diff --git a/docs/clamp/acm/images/system-dialogues/supervise-controlloops.png b/docs/clamp/acm/images/system-dialogues/supervise-controlloops.png Binary files differdeleted file mode 100644 index c24d3a09..00000000 --- a/docs/clamp/acm/images/system-dialogues/supervise-controlloops.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/supervise-participants.png b/docs/clamp/acm/images/system-dialogues/supervise-participants.png Binary files differindex 2439d926..0a26180e 100644 --- a/docs/clamp/acm/images/system-dialogues/supervise-participants.png +++ b/docs/clamp/acm/images/system-dialogues/supervise-participants.png diff --git a/docs/clamp/acm/images/system-dialogues/update-acm-instance-config-participants.png b/docs/clamp/acm/images/system-dialogues/update-acm-instance-config-participants.png Binary files differnew file mode 100644 index 00000000..7979cd80 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/update-acm-instance-config-participants.png diff --git a/docs/clamp/acm/images/system-dialogues/update-cl-instance-config-participants.png b/docs/clamp/acm/images/system-dialogues/update-cl-instance-config-participants.png Binary files differdeleted file mode 100644 index f16ebc2b..00000000 --- a/docs/clamp/acm/images/system-dialogues/update-cl-instance-config-participants.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/update-instance-params-acm.png b/docs/clamp/acm/images/system-dialogues/update-instance-params-acm.png Binary files differnew file mode 100644 index 00000000..e9217365 --- /dev/null +++ b/docs/clamp/acm/images/system-dialogues/update-instance-params-acm.png diff --git a/docs/clamp/acm/images/system-dialogues/update-instance-params-cl.png b/docs/clamp/acm/images/system-dialogues/update-instance-params-cl.png Binary files differdeleted file mode 100644 index ec84ed35..00000000 --- a/docs/clamp/acm/images/system-dialogues/update-instance-params-cl.png +++ /dev/null diff --git a/docs/clamp/acm/images/system-dialogues/view-monitoring-info.png b/docs/clamp/acm/images/system-dialogues/view-monitoring-info.png Binary files differindex 5937d2f1..e63d60bc 100644 --- a/docs/clamp/acm/images/system-dialogues/view-monitoring-info.png +++ b/docs/clamp/acm/images/system-dialogues/view-monitoring-info.png diff --git a/docs/clamp/acm/images/system-dialogues/view-statistics.png b/docs/clamp/acm/images/system-dialogues/view-statistics.png Binary files differindex 451a5d92..099c5cd9 100644 --- a/docs/clamp/acm/images/system-dialogues/view-statistics.png +++ b/docs/clamp/acm/images/system-dialogues/view-statistics.png |
