Merge "Updating Clamp documentation"

21 files changed, 488 insertions, 477 deletions

diff --git a/docs/clamp/acm/api-protocol/acm-participant-protocol.rst b/docs/clamp/acm/api-protocol/acm-participant-protocol.rst
new file mode 100644
index 00000000..449e2096
--- /dev/null
+++ b/docs/clamp/acm/api-protocol/acm-participant-protocol.rst
@@ -0,0 +1,483 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _acm-participant-protocol-label:
+
+The ACM Automation Composition Participant Protocol
+###################################################
+
+The CLAMP Automation Composition protocol is an asynchronous protocol that is used by the CLAMP
+runtime to coordinate lifecycle management of Automation Composition instances. The protocol
+supports the functions described in the sections below.
+
+
+Protocol Dialogues
+==================
+
+The protocol supports the dialogues described below.
+
+Participant Registration and De-Registration
+--------------------------------------------
+
+Registration when a participant comes up and update of participant with Automation Composition type
+information and common parameter values for its Automation Composition types.
+
+.. image:: ../images/acm-participants-protocol/participant-registering.png
+
+
+De-registration is executed as a participant goes down.
+
+.. image:: ../images/acm-participants-protocol/participant-deregistration.png
+
+
+Automation Composition Priming and De-Priming
+---------------------------------------------
+
+When an Automation Composition is primed, the portion of the Automation Composition Type Definition
+and Common Property values for the participants of each participant type mentioned in the
+Automation Composition Definition are sent to the participants.
+
+.. image:: ../images/acm-participants-protocol/acm-priming.png
+
+When an Automation Composition is de-primed, the portion of the Automation Composition Type
+Definition and Common Property values for the participants of each participant type mentioned in
+the Automation Composition Definition are deleted on participants.
+
+.. image:: ../images/acm-participants-protocol/acm-depriming.png
+
+
+Automation Composition Update
+-----------------------------
+
+Automation Composition Update handles creation, change, and deletion of Automation Compositions on
+participants. Change of Automation Compositions uses a semantic versioning approach and follows the
+semantics described on the page :ref:`4.1 Management of Automation Composition Instance
+Configurations <management-acm-instance-configs>`.
+
+.. image:: ../images/acm-participants-protocol/acm-update.png
+
+The handling of an *ACMUpdate* message in each participant is as shown below.
+
+.. image:: ../images/acm-participants-protocol/acm-update-msg.png
+
+Automation Composition State Change
+-----------------------------------
+
+This dialogue is used to change the state of Automation Compositions and their Automation
+Composition Elements. The CLAMP Runtime sends an Automation Composition State Change message on the
+Automation Composition to all participants. Participants that have Automation Composition Elements
+in that Automation Composition attempt an update on the state of the Automation Composition
+elements they have for that Automation Composition, and report the result back.
+
+The *startPhase* in the `Definition of TOSCA fundamental Automation Composition Types
+<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/AutomationCompositionTOSCAServiceTemplateTypes.yaml>`_
+is particularly important in Automation Composition state changes because sometimes the user wishes
+to control the order in which the state changes in Automation Composition Elements in an Automation
+Composition. In-state changes from *UNITITIALISED → PASSIVE* and from *PASSIVE → RUNNING*,
+Automation Composition elements are started in increasing order of their startPhase. In-state
+changes from *RUNNING → PASSIVE* and from *PASSIVE → UNITITIALISED*, Automation Composition
+elements are started in decreasing order of their *startPhase*.
+
+The CLAMP runtime controls the state change process described in the diagram below. The CLAMP
+runtime sends an Automation Composition state change message on DMaaP to all participants in a
+particular start phase so, in each state change multiple Automation Composition State Change
+messages are sent, one for each start phase in the Automation Composition. If more than one
+Automation Composition Element has the same start phase, those Automation Composition Elements
+receive the same Automation Composition State Change message from DMaaP and start in parallel.
+
+The Participant reads each State Change Message it sees on DMaaP. If the start phase on the
+Automation Composition State Change message matches the Start Phase of the Automation Composition
+Element, the participant processes the state change message. Otherwise, the participant ignores the
+message.
+
+.. image:: ../images/acm-participants-protocol/acm-state-change.png
+
+The handling of an ACMStateChange message in each participant is as shown below.
+
+.. image:: ../images/acm-participants-protocol/acm-state-change-msg.png
+
+Automation Composition Monitoring and Reporting
+-----------------------------------------------
+
+This dialogue is used as a heartbeat mechanism for participants, to monitor the status of
+Automation Composition Elements, and to gather statistics on Automation Compositions. The
+*ParticipantStatus* message is sent periodically by each participant. The reporting interval for
+sending the message is configurable.
+
+.. image:: ../images/acm-participants-protocol/acm-monitoring.png
+
+
+Messages
+========
+
+The CLAMP Automation Composition Participant Protocol uses the following messages. The
+descriptions below give an overview of each message. For the precise definition of the messages,
+see the `CLAMP code at Github
+<https://github.com/onap/policy-clamp/tree/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/dmaap/participant>`_
+. All messages are carried on DMaaP.
+
+
+.. list-table::
+   :widths: 15 10 10 15 15 35
+   :header-rows: 1
+
+   * - Message
+     - Source
+     - Target
+     - Purpose
+     - Important Fields
+     - Field Descriptions
+   * - ParticipantRegister
+     - Participant
+     - CLAMP Runtime
+     - Participant registers with the CLAMP runtime
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * - ParticipantRegisterAck
+     - CLAMP Runtime
+     - Participant
+     - Acknowledgment of Participant Registration
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * -
+     -
+     -
+     -
+     - Result
+     - Success/Fail
+   * -
+     -
+     -
+     -
+     - Message
+     - A message indicating the reason for failure
+   * - ParticipantUpdate
+     - CLAMP Runtime
+     - Participant
+     - CLAMP Runtime sends Automation Composition Element Definitions and Common Parameter Values
+       to Participants
+     - ParticipantDefinitionUpdateMap
+     - Map with Participant ID as its key, each value on the map is an ACMElementDefintionMap
+   * -
+     -
+     -
+     -
+     - ACMElementDefintionMap
+     - List of ACMElementDefinition values for a particular participant, keyed by its Automation
+       Composition Element Definition ID
+   * -
+     -
+     -
+     -
+     - ACMElementDefinition
+     - An ACMElementToscaServiceTemplate containing the definition of the Automation Composition
+       Element and a CommonPropertiesMap with the values of the common property values for
+       Automation Composition Elements of this type
+   * -
+     -
+     -
+     -
+     - ACMElementToscaServiceTemplate
+     - The definition of the Automation Composition Element in TOSCA
+   * -
+     -
+     -
+     -
+     - CommonPropertiesMap
+     - A <String, String> map indexed by the property name. Each map entry is the serialized value
+       of the property, which can be deserialized into an instance of the type of the property.
+   * - ParticipantUpdateAck
+     - Participant
+     - CLAMP Runtime
+     - Acknowledgment of Participant Update
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * -
+     -
+     -
+     -
+     - Result
+     - Success/Fail
+   * -
+     -
+     -
+     -
+     - Message
+     - A message indicating the reason for failure
+   * - ParticipantDeregister
+     - Participant
+     - CLAMP Runtime
+     - Participant deregisters with the CLAMP runtime
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * - ParticipantDeregisterAck
+     - CLAMP Runtime
+     - Participant
+     - Acknowledgment of Participant Deegistration
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * -
+     -
+     -
+     -
+     - Result
+     - Success/Fail
+   * -
+     -
+     -
+     -
+     - Message
+     - A message indicating the reason for failure
+   * - ACMUpdate
+     - CLAMP Runtime
+     - Participant
+     - CLAMP Runtime sends Automation Composition Element instances and Instance Specific Parameter
+       Values for an Automation Composition Instance to Participants
+     - ACMId
+     - The name and version of the Automation Composition
+   * -
+     -
+     -
+     -
+     - ParticipantUpdateMap
+     - Map with Participant ID as its key, each value on the map is an ACMElementList
+   * -
+     -
+     -
+     -
+     - ACMElementList
+     - List of ACMElement values for the Automation Composition
+   * -
+     -
+     -
+     -
+     - ACMElement
+     - An ACMElement, which contains among other things a PropertiesMap with the values of the
+       property values for this Automation Composition Element instance and a
+       ToscaServiceTemplateFragment with extra concept definitions and instances that a participant
+       may need.
+   * -
+     -
+     -
+     -
+     - PropertiesMap
+     - A <String, String> map indexed by the property name. Each map entry is the serialized value
+       of the property, which can be deserialized into an instance of the type of the property.
+   * -
+     -
+     -
+     -
+     - ToscaServiceTemplateFragment
+     - A well-formed TOSCA service template containing extra concept definitions and instances that
+       a participant may need. For example, the Policy Participant may need policy type definitions
+       or policy instances to be provided if they are not already stored in the Policy Framework.
+   * - ACMUpdateAck
+     - Participant
+     - CLAMP Runtime
+     - Acknowledgment of Automation Composition Update
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * -
+     -
+     -
+     -
+     - ACMId
+     - The name and version of the Automation Composition
+   * -
+     -
+     -
+     -
+     - ACMResult
+     - Holds a Result and Message for the overall operation on the participant and a map of Result
+       and Message fields for each Automation Composition Element of the Automation Composition on
+       this participant
+   * -
+     -
+     -
+     -
+     - Result
+     - Success/Fail
+   * -
+     -
+     -
+     -
+     - Message
+     - A message indicating the reason for failure
+   * - ACMStateChange
+     - CLAMP Runtime
+     - Participant
+     - CLAMP Runtime asks Participants to change the state of an Automation Composition
+     - ACMId
+     - The name and version of the Automation Composition
+   * -
+     -
+     -
+     -
+     - currentState
+     - The current state of the Automation Composition
+   * -
+     -
+     -
+     -
+     - orderedState
+     - The state that the Automation Composition should transition to
+   * -
+     -
+     -
+     -
+     - startPhase
+     - The start phase to which this ACMStateChange message applies
+   * - ACMStateChangeAck
+     - Participant
+     - CLAMP Runtime
+     - Acknowledgment of Automation Composition State Change
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * -
+     -
+     -
+     -
+     - ACMId
+     - The name and version of the Automation Composition
+   * -
+     -
+     -
+     -
+     - startPhase
+     - The start phase to which this ACMStateChangeAck message applies
+   * -
+     -
+     -
+     -
+     - ACMResult
+     - Holds a Result and Message for the overall operation on the participant and a map of Result
+       and Message fields for each Automation Composition Element of the Automation Composition on
+       this participant
+   * -
+     -
+     -
+     -
+     - Result
+     - Success/Fail
+   * -
+     -
+     -
+     -
+     - Message
+     - A message indicating the reason for failure
+   * - ParticipantStatusReq
+     - CLAMP Runtime
+     - Participant
+     - Request that the specified participants return a ParticipantStatus message immediately
+     - ParticipantId
+     - The ID of this participant, if not specified, all participants respond.
+   * - ParticipantStatus
+     - Participant
+     - CLAMP Runtime
+     - Periodic or on-demand report for heartbeat, Participant Status, Automation Composition
+       Status, and Automation Composition Statistics
+     - ParticipantId
+     - The ID of this participant
+   * -
+     -
+     -
+     -
+     - ParticipantType
+     - The type of the participant; maps to the capabilities of the participant in Automation
+       Composition Type Definitions
+   * -
+     -
+     -
+     -
+     - ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only)
+     - See ParticipantUpdate message above for definition of this field
+   * -
+     -
+     -
+     -
+     - ParticipantStatus
+     - The current status of the participant for monitoring
+   * -
+     -
+     -
+     -
+     - ParticipantStatistics
+     - Statistics on the participant such as uptime, or messages processed. Can include participant
+       specific data in a string blob that is opaque to CLAMP
+   * -
+     -
+     -
+     -
+     - ACMInfoMap
+     - A map of ACMInfo types indexed by ACMId, one entry for each Automation Composition
+       running on the participant
+   * -
+     -
+     -
+     -
+     - ACMInfo
+     - The ACMStatus and ACMStatistics for a given Automation Composition
+   * -
+     -
+     -
+     -
+     - ACMStatus
+     - The current status of the Automation Composition for monitoring
+   * -
+     -
+     -
+     -
+     - ACMStatistics
+     - Statistics on the Automation Composition such as uptime, or messages processed. Can include
+       participant specific data in a string blob that is opaque to CLAMP
+
+
+End of Document
diff --git a/docs/clamp/acm/api-protocol/api-protocol.rst b/docs/clamp/acm/api-protocol/api-protocol-tree.rst
index 2d509921..95ce8f08 100644
--- a/docs/clamp/acm/api-protocol/api-protocol.rst
+++ b/docs/clamp/acm/api-protocol/api-protocol-tree.rst
@@ -1,9 +1,9 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 
-.. _clamp-controlloop-api-protocol:
+.. _clamp-acm-api-protocol:
 
-CLAMP TOSCA Control Loop APIs and Protocols
-###########################################
+CLAMP TOSCA Automation Composition APIs and Protocols
+#####################################################
 
 The sections below describe the APIs and Protocols used in TOSCA Control Loops.
 
@@ -11,5 +11,5 @@ The sections below describe the APIs and Protocols used in TOSCA Control Loops.
    :maxdepth: 1
 
    system-level-dialogues
-   controlloop-participant-protocol
+   acm-participant-protocol
    controlloop-rest-apis
diff --git a/docs/clamp/acm/api-protocol/controlloop-participant-protocol.rst b/docs/clamp/acm/api-protocol/controlloop-participant-protocol.rst
deleted file mode 100644
index 2fa5336f..00000000
--- a/docs/clamp/acm/api-protocol/controlloop-participant-protocol.rst
+++ /dev/null
@@ -1,472 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-
-.. _controlloop-participant-protocol-label:
-
-The CLAMP Control Loop Participant Protocol
-###########################################
-
-The CLAMP Control Loop Participant protocol is an asynchronous protocol that is used by the
-CLAMP runtime to coordinate life cycle management of Control Loop instances. The protocol
-supports the functions described in the sections below.
-
-
-Protocol Dialogues
-==================
-
-The protocol supports the dialogues described below.
-
-Participant Registration and De-Registration
---------------------------------------------
-
-Registration when a participant comes up and update of participant with control loop type
-information and common parameter values for its control loop types.
-
-.. image:: ../images/clamp-cl-participants/participant-registering.png
-
-
-De-registration is executed as a participant goes down.
-
-.. image:: ../images/clamp-cl-participants/participant-deregistration.png
-
-
-Control Loop Priming and De-Priming
------------------------------------
-
-When a control loop is primed, the portion of the Control Loop Type Definition and Common
-Property values for the participants of each participant type mentioned in the Control Loop
-Definition are sent to the participants.
-
-.. image:: ../images/clamp-cl-participants/controlloop-priming.png
-
-When a control loop is de-primed, the portion of the Control Loop Type Definition and Common
-Property values for the participants of each participant type mentioned in the Control Loop
-Definition are deleted on participants.
-
-.. image:: ../images/clamp-cl-participants/controlloop-depriming.png
-
-
-Control Loop Update
--------------------
-
-Control Loop Update handles creation, change, and deletion of control loops on participants.
-Change of control loops uses a semantic versioning approach and follow the semantics described
-on the page `4.1 Management of Control Loop Instance Configurations <management-cl-instance-configs>`.
-
-.. image:: ../images/clamp-cl-participants/controlloop-update.png
-
-The handling of a ControlLoopUpdate message in each participant is as shown below.
-
-.. image:: ../images/clamp-cl-participants/controlloop-update-msg.png
-
-Control Loop State Change
--------------------------
-
-This dialogue is used to change the state of Control Loops and their Control Loop Elements. The
-CLAMP Runtime sends a Control Loop State Change message on the control loop to all participants.
-Participants that have Control Loop Elements in that Control Loop attempt an update on the state
-of the control loop elements they have for that control loop, and report the result back.
-
-The *startPhase* in the `Definition of TOSCA fundamental Control Loop Types
-<https://github.com/onap/policy-clamp/blob/master/common/src/main/resources/tosca/ControlLoopTOSCAServiceTemplateTypes.yaml>`_
-is particularly important in control loop state changes because sometime the user wishes to control
-the order in which the state changes in Control Loop Elements in a control loop. In state changes
-from *UNITITIALISED* → *PASSIVE* and from *PASSIVE* → *RUNNING*, control loop elements are started in
-increasing order of their *startPhase*. In state changes from *RUNNING* → *PASSIVE* and from *PASSIVE*
-→ *UNITITIALISED*, control loop elements are started in decreasing order of their *startPhase*.
-
-The CLAMP runtime controls the state change process described in the diagram below. The CLAMP runtime
-sends a Control Loop State Change message on DMaaP to all participants in a particular Start Phase so,
-in each state change multiple Control Loop State Change messages are sent, one for each Start Phase in
-the control loop. If more than one Control Loop Element has the same Start Phase, those Control Loop
-Elements receive the same Control Loop State Change message from DMaaP and start in parallel.
-
-The Participant reads each State Change Message it sees on DMaaP. If the Start Phase on the Control
-Loop State Change message matches the Start Phase of the Control Loop Element, the participant processes
-the State Change message. Otherwise the participant ignores the message.
-
-.. image:: ../images/clamp-cl-participants/controlloop-state-change.png
-
-The handling of a ControlLoopStateChange message in each participant is as shown below.
-
-.. image:: ../images/clamp-cl-participants/controlloop-state-change-msg.png
-
-Control Loop Monitoring and Reporting
--------------------------------------
-
-This dialogue is used as a heartbeat mechanism for participants, to monitor the status of Control Loop
-Elements, and to gather statistics on control loops. The ParticipantStatus message is sent periodically
-by each participant. The reporting interval for sending the message is configurable.
-
-.. image:: ../images/clamp-cl-participants/controlloop-monitoring.png
-
-
-Messages
-========
-
-The CLAMP Control Loop Participant Protocol uses the following messages. The descriptions below give
-an overview of each message. For the precise definition of the messages, see the `CLAMP code at Github
-<https://github.com/onap/policy-clamp/tree/master/models/src/main/java/org/onap/policy/clamp/controlloop/models/messages/dmaap/participant>`_
-. All messages are carried on DMaaP.
-
-
-.. list-table::
-   :widths: 15 10 10 15 15 35
-   :header-rows: 1
-
-   * - Message
-     - Source
-     - Target
-     - Purpose
-     - Important Fields
-     - Field Descriptions
-   * - ParticipantRegister
-     - Participant
-     - CLAMP Runtime
-     - Participant registers with the CLAMP runtime
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop Type
-       Definitions
-   * - ParticipantRegisterAck
-     - CLAMP Runtime
-     - Participant
-     - Acknowledgement of Participant Registration
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop Type
-       Definitions
-   * -
-     -
-     -
-     -
-     - Result
-     - Success/Fail
-   * -
-     -
-     -
-     -
-     - Message
-     - Message indicating reason for failure
-   * - ParticipantUpdate
-     - CLAMP Runtime
-     - Participant
-     - CLAMP Runtime sends Control Loop Element Definitions and Common Parameter Values to Participants
-     - ParticipantDefinitionUpdateMap
-     - Map with Participant ID as its key, each value on the map is a ControlLoopElementDefintionMap
-   * -
-     -
-     -
-     -
-     - ControlLoopElementDefintionMap
-     - List of ControlLoopElementDefinition values for a particular participant, keyed by its Control
-       Loop Element Definition ID
-   * -
-     -
-     -
-     -
-     - ControlLoopElementDefinition
-     - A ControlLoopElementToscaServiceTemplate containing the definition of the Control Loop Element
-       and a CommonPropertiesMap with the values of the common property values for Control Loop Elements
-       of this type
-   * -
-     -
-     -
-     -
-     - ControlLoopElementToscaServiceTemplate
-     - The definition of the Control Loop Element in TOSCA
-   * -
-     -
-     -
-     -
-     - CommonPropertiesMap
-     - A <String, String> map indexed by the property name. Each map entry is the serialized value of
-       the property, which can be deserialized into an instance of the type of the property.
-   * - ParticipantUpdateAck
-     - Participant
-     - CLAMP Runtime
-     - Acknowledgement of Participant Update
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop Type
-       Definitions
-   * -
-     -
-     -
-     -
-     - Result
-     - Success/Fail
-   * -
-     -
-     -
-     -
-     - Message
-     - Message indicating reason for failure
-   * - ParticipantDeregister
-     - Participant
-     - CLAMP Runtime
-     - Participant deregisters with the CLAMP runtime
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop Type
-       Definitions
-   * - ParticipantDeregisterAck
-     - CLAMP Runtime
-     - Participant
-     - Acknowledgement of Participant Deegistration
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop Type
-       Definitions
-   * -
-     -
-     -
-     -
-     - Result
-     - Success/Fail
-   * -
-     -
-     -
-     -
-     - Message
-     - Message indicating reason for failure
-   * - ControlLoopUpdate
-     - CLAMP Runtime
-     - Participant
-     - CLAMP Runtime sends Control Loop Element instances and Instance Specific Parameter Values for
-       a Control Loop Instance to Participants
-     - ControlLoopId
-     - The name and version of the Control Loop
-   * -
-     -
-     -
-     -
-     - ParticipantUpdateMap
-     - Map with Participant ID as its key, each value on the map is a ControlLoopElementList
-   * -
-     -
-     -
-     -
-     - ControlLoopElementList
-     - List of ControlLoopElement values for the Control Loop
-   * -
-     -
-     -
-     -
-     - ControlLoopElement
-     - A ControlLoopElement, which contains among other things a PropertiesMap with the values of the
-       property values for this Control Loop Element instance and a ToscaServiceTemplateFragment with
-       extra concept definitions and instances that a participant may need.
-   * -
-     -
-     -
-     -
-     - PropertiesMap
-     - A <String, String> map indexed by the property name. Each map entry is the serialized value of
-       the property, which can be deserialized into an instance of the type of the property.
-   * -
-     -
-     -
-     -
-     - ToscaServiceTemplateFragment
-     - A well-formed TOSCA service template containing extra concept definitions and instances that a
-       participant may need. For example, the Policy Participant may need policy type definitions or
-       policy instances to be provided if they are not already stored in the Policy Framework.
-   * - ControlLoopUpdateAck
-     - Participant
-     - CLAMP Runtime
-     - Acknowledgement of Control Loop Update
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop Type
-       Definitions
-   * -
-     -
-     -
-     -
-     - ControlLoopId
-     - The name and version of the Control Loop
-   * -
-     -
-     -
-     -
-     - ControlLoopResult
-     - Holds a Result and Message for the overall operation on the participant and a map of Result
-       and Message fields for each Control Loop Element of the control loop on this participant
-   * -
-     -
-     -
-     -
-     - Result
-     - Success/Fail
-   * -
-     -
-     -
-     -
-     - Message
-     - Message indicating reason for failure
-   * - ControlLoopStateChange
-     - CLAMP Runtime
-     - Participant
-     - CLAMP Runtime asks Participants to change the state of a Control Loop
-     - ControlLoopId
-     - The name and version of the Control Loop
-   * -
-     -
-     -
-     -
-     - currentState
-     - The current state of the Control Loop
-   * -
-     -
-     -
-     -
-     - orderedState
-     - The state that the Control Loop should transition to
-   * -
-     -
-     -
-     -
-     - startPhase
-     - The start phase to which this ControLoopStateChange message applies
-   * - ControlLoopStateChangeAck
-     - Participant
-     - CLAMP Runtime
-     - Acknowledgement of Control Loop State Change
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop Type
-       Definitions
-   * -
-     -
-     -
-     -
-     - ControlLoopId
-     - The name and version of the Control Loop
-   * -
-     -
-     -
-     -
-     - startPhase
-     - The start phase to which this ControLoopStateChangeAck message applies
-   * -
-     -
-     -
-     -
-     - ControlLoopResult
-     - Holds a Result and Message for the overall operation on the participant and a map of Result and
-       Message fields for each Control Loop Element of the control loop on this participant
-   * -
-     -
-     -
-     -
-     - Result
-     - Success/Fail
-   * -
-     -
-     -
-     -
-     - Message
-     - Message indicating reason for failure
-   * - ParticipantStatusReq
-     - CLAMP Runtime
-     - Participant
-     - Request that the specified participants return a ParticipantStatus message immediately
-     - ParticipantId
-     - The ID of this participant, if not specified, all participants respond.
-   * - ParticipantStatus
-     - Participant
-     - CLAMP Runtime
-     - Periodic or on-demand report for heartbeat, Participant Status, Control Loop Status, and Control
-       Loop Statistics
-     - ParticipantId
-     - The ID of this participant
-   * -
-     -
-     -
-     -
-     - ParticipantType
-     - The type of the participant, maps to the capabilities of the participant in Control Loop
-       Type Definitions
-   * -
-     -
-     -
-     -
-     - ParticipantDefinitionUpdateMap (returned in repsonse to ParticipantStatusReq only)
-     - See ParticipantUpdate message above for definition of this field
-   * -
-     -
-     -
-     -
-     - ParticipantStatus
-     - The current status of the participant for monitoring
-   * -
-     -
-     -
-     -
-     - ParticipantStatistics
-     - Statistics on the participant such as up time, or messages processed. Can include participant
-       specific data in a string blob that is opaque to CLAMP
-   * -
-     -
-     -
-     -
-     - ControlLoopInfoMap
-     - A map of ControlLoopInfo types indexed by ControlLoopId, one entry for each control loop
-       running on the participant
-   * -
-     -
-     -
-     -
-     - ControlLoopInfo
-     - The ControlLoopStatus and ControlLoopStatistics for a given control loop
-   * -
-     -
-     -
-     -
-     - ControlLoopStatus
-     - The current status of the control loop for monitoring
-   * -
-     -
-     -
-     -
-     - ControlLoopStatistics
-     - Statistics on the control loop such as up time, or messages processed. Can include participant
-       specific data in a string blob that is opaque to CLAMP
-
-
-End of Document
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-depriming.png b/docs/clamp/acm/images/acm-participants-protocol/acm-depriming.png
new file mode 100644
index 00000000..7bcc9b15
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/acm-depriming.png
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-monitoring.png b/docs/clamp/acm/images/acm-participants-protocol/acm-monitoring.png
new file mode 100644
index 00000000..dcc996e4
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/acm-monitoring.png
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-priming.png b/docs/clamp/acm/images/acm-participants-protocol/acm-priming.png
new file mode 100644
index 00000000..918a292e
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/acm-priming.png
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-state-change-msg.png b/docs/clamp/acm/images/acm-participants-protocol/acm-state-change-msg.png
new file mode 100644
index 00000000..d1393bab
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/acm-state-change-msg.png
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-state-change.png b/docs/clamp/acm/images/acm-participants-protocol/acm-state-change.png
new file mode 100644
index 00000000..fd55a069
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/acm-state-change.png
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-update-msg.png b/docs/clamp/acm/images/acm-participants-protocol/acm-update-msg.png
new file mode 100644
index 00000000..3886e440
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/acm-update-msg.png
diff --git a/docs/clamp/acm/images/acm-participants-protocol/acm-update.png b/docs/clamp/acm/images/acm-participants-protocol/acm-update.png
new file mode 100644
index 00000000..2a7aac1f
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/acm-update.png
diff --git a/docs/clamp/acm/images/clamp-cl-participants/participant-deregistration.png b/docs/clamp/acm/images/acm-participants-protocol/participant-deregistration.png
index bb2ec9a3..bb2ec9a3 100644
--- a/docs/clamp/acm/images/clamp-cl-participants/participant-deregistration.png
+++ b/docs/clamp/acm/images/acm-participants-protocol/participant-deregistration.png
diff --git a/docs/clamp/acm/images/acm-participants-protocol/participant-registering.png b/docs/clamp/acm/images/acm-participants-protocol/participant-registering.png
new file mode 100644
index 00000000..2f7b5d8e
--- /dev/null
+++ b/docs/clamp/acm/images/acm-participants-protocol/participant-registering.png
diff --git a/docs/clamp/acm/images/clamp-cl-participants/controlloop-depriming.png b/docs/clamp/acm/images/clamp-cl-participants/controlloop-depriming.png
deleted file mode 100644
index 16a923b1..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/controlloop-depriming.png
+++ /dev/null
diff --git a/docs/clamp/acm/images/clamp-cl-participants/controlloop-monitoring.png b/docs/clamp/acm/images/clamp-cl-participants/controlloop-monitoring.png
deleted file mode 100644
index f64fcd2e..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/controlloop-monitoring.png
+++ /dev/null
diff --git a/docs/clamp/acm/images/clamp-cl-participants/controlloop-priming.png b/docs/clamp/acm/images/clamp-cl-participants/controlloop-priming.png
deleted file mode 100644
index fa17429d..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/controlloop-priming.png
+++ /dev/null
diff --git a/docs/clamp/acm/images/clamp-cl-participants/controlloop-state-change-msg.png b/docs/clamp/acm/images/clamp-cl-participants/controlloop-state-change-msg.png
deleted file mode 100644
index dfcfe882..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/controlloop-state-change-msg.png
+++ /dev/null
diff --git a/docs/clamp/acm/images/clamp-cl-participants/controlloop-state-change.png b/docs/clamp/acm/images/clamp-cl-participants/controlloop-state-change.png
deleted file mode 100644
index 9ce9e490..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/controlloop-state-change.png
+++ /dev/null
diff --git a/docs/clamp/acm/images/clamp-cl-participants/controlloop-update-msg.png b/docs/clamp/acm/images/clamp-cl-participants/controlloop-update-msg.png
deleted file mode 100644
index e4c8ce84..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/controlloop-update-msg.png
+++ /dev/null
diff --git a/docs/clamp/acm/images/clamp-cl-participants/controlloop-update.png b/docs/clamp/acm/images/clamp-cl-participants/controlloop-update.png
deleted file mode 100644
index be968dc7..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/controlloop-update.png
+++ /dev/null
diff --git a/docs/clamp/acm/images/clamp-cl-participants/participant-registering.png b/docs/clamp/acm/images/clamp-cl-participants/participant-registering.png
deleted file mode 100644
index eeae2e02..00000000
--- a/docs/clamp/acm/images/clamp-cl-participants/participant-registering.png
+++ /dev/null
diff --git a/docs/clamp/clamp.rst b/docs/clamp/clamp.rst
index 484457d9..866d3b2b 100644
--- a/docs/clamp/clamp.rst
+++ b/docs/clamp/clamp.rst
@@ -13,7 +13,7 @@ described in TOSCA.
 
    acm/controlloop-architecture
    acm/defining-controlloops
-   acm/api-protocol/api-protocol
+   acm/api-protocol/api-protocol-tree
    acm/design-impl/design-impl
 
 .. note::