Update docs for manual sync up support in ACM

Issue-ID: POLICY-5428
Change-Id: I2efaa3f473e3d0e4e2a4787dd51d096b5e8ef3b3
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>

diff --git a/docs/clamp/acm/clamp-csit.rst b/docs/clamp/acm/clamp-csit.rst
index e997f45..edc3104 100644 (file)
--- a/docs/clamp/acm/clamp-csit.rst
+++ b/docs/clamp/acm/clamp-csit.rst
@@ -33,7 +33,7 @@ ACM Integration Tests
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | RegisterParticipants                             | Sends a PUT request to ACM-R to request the participants for registration                              | Should receive a 202 Accepted response from ACM-R                                                                      |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
-| InsertDataIntoDatabase                           | Insert restored data into the Database                                                                 | Should receive a 0 response from the script                                                                            |
+| InsertDataIntoDatabase                           | Insert restored data into the Database used for testing automatic sync                                 | Should receive a 0 response from the script                                                                            |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | AcMigrationRestored                              | Migration of an automation composition restored                                                        | Should receive a 200 response and the AC instance should be migrated to to the target AC definition                    |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
@@ -45,6 +45,12 @@ ACM Integration Tests
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | DeleteACDefinitionsRestored                      | Deprime and delete of the compositions definition restored                                             | Should receive a 200 response and the AC definition should be removed in ACM-R db                                      |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| InsertDataIntoDatabase2                          | Insert restored data into the Database used for testing manual sync                                    | Should receive a 0 response from the script                                                                            |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| SyncParticipant                                  | Manual sync participants                                                                               | Should receive a 202 Accepted response and the instance/composition restored should be present in participant          |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
+| AcDeleteRestored2                                | Undeploy and delete of an automation composition restored                                              | Should receive a 202 Accepted response and the restored AC instance should have been deleted in ACM-R                  |
++--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | CommissionAcDefinitionTimeout                    | Commissions a service template for testing Prime Timeout                                               | Should receive a 201 created response from ACM_R                                                                       |
 +--------------------------------------------------+--------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
 | TimeoutPrimeACDefinition                         | Verify the priming timeout from participant sim by updating the participant sim behavior               | Should receive a 202 Accepted response from ACM-R and the stateChangeResult of AC definition should be TIMEOUT         |

diff --git a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
index 37dbd31..784ec4a 100644 (file)
--- a/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
+++ b/docs/clamp/acm/design-impl/clamp-runtime-acm.rst
@@ -30,12 +30,35 @@ Check CLAMP Runtime and Participants
 - GUI calls GET "/onap/policy/clamp/acm/v2/participants" endpoint and receives as response: all participants with supported Element Types, all replicas registered, and all compositions and instances connected. The end point supports the pagination by parameters "size" and "page"
 - GUI calls GET "/onap/policy/clamp/acm/v2/participants/{participantId}" endpoint and receives as response: the participant with supported Element Types, all replicas registered, and all compositions and instances connected. The end point supports the pagination by parameters "size" and "page"
 
-Order an immediate Participant Report from all participants
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Fetch replicas of all participants
+++++++++++++++++++++++++++++++++++
+- GUI calls GET "/onap/policy/clamp/acm/v2/participants" endpoint and receives all participants, replicas and status as response. The end point supports the pagination by parameters "size" and "page"
+- GUI calls GET "/onap/policy/clamp/acm/v2/participants/{participantId}" endpoint and receives replicas and status of a participant as response. The end point supports the pagination by parameters "size" and "page"
+
+Order an immediate Participant Report from all replicas
++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 - GUI calls PUT "/onap/policy/clamp/acm/v2/participants" endpoint
-- ACM-runtime receives the call by Rest-Api (CommissioningController)
+- ACM-runtime receives the call by Rest-Api (ParticipantController)
 - It triggers the execution to send a broadcast PARTICIPANT_STATUS_REQ message
 
+Order an immediate Participant Report from all replicas of a participant
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+- GUI calls PUT "/onap/policy/clamp/acm/v2/participants/{participantId}" endpoint
+- ACM-runtime receives the call by Rest-Api (ParticipantController)
+- It triggers the execution to send a PARTICIPANT_STATUS_REQ message
+
+Order an immediate Sync up to all replicas of all participants
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+- GUI calls PUT "/onap/policy/clamp/acm/v2/participants/sync" endpoint
+- ACM-runtime receives the call by Rest-Api (ParticipantController)
+- Initiates a manual sync operation for all registered replicas of participants sending PARTICIPANT_SYNC_MSG messages
+
+Order an immediate Sync up to all replicas of a participant
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+- GUI calls PUT "/onap/policy/clamp/acm/v2/participants/sync/{participantId}" endpoint
+- ACM-runtime receives the call by Rest-Api (ParticipantController)
+- Initiates a manual sync operation for all registered replicas of a participant sending PARTICIPANT_SYNC_MSG messages
+
 Create of a Automation Composition Definition Type
 ++++++++++++++++++++++++++++++++++++++++++++++++++
 - GUI calls POST "/onap/policy/clamp/acm/v2/compositions" endpoint with a Automation Composition Type Definition (Tosca Service Template) as body