: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
.. 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
----------------------------------------------------------------------
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
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. _clamp-policy-gui-label:
+
+TOSCA Policy GUI
+################
+
+.. contents::
+ :depth: 4
+
+1 - How to run the Front-End Gui
+================================
+This section describes how to run the front end on your local machine.
+
+**Prerequisite:**
+
+**Building and running CLAMP**
+
+see `Clamp ACM Smoke Tests <https://docs.onap.org/projects/onap-policy-parent/en/latest/development/devtools/clamp-smoke.html>`__
+
+**Step 1:** Go to the clamp directory
+
+.. code-block:: bash
+
+ cd /clamp/extra/bin-for-dev
+
+**Step 2:** Inside the clamp directory run
+
+.. code-block:: bash
+
+ ./start-db.sh test
+
+**Step 3:** Check docker container id
+
+.. code-block:: bash
+
+ docker ps
+
+**Step 4:** Log into docker container
+
+.. code-block:: bash
+
+ docker exec -it 'container_id' bash
+
+**Step 5:** Go into mariadb shell
+
+.. code-block:: bash
+
+ mysql -u root -p
+
+**Step 6:** Enter password
+
+ strong_pitchou
+
+.. image:: images/01-gui.png
+
+**Step 7:** Go into cldsdb4 database
+
+.. code-block:: bash
+
+ use cldsdb4;
+
+**Step 8:** Verify if there is data in the following table 'loop_templates'
+
+.. code-block:: bash
+
+ select * from loop_templates;
+
+** If for some reason the database is empty do the go to the '/docker-entrypoint-initdb.d/dump' directory
+
+.. code-block:: bash
+
+ ./load-fake-data.sh
+
+**Step 9:** Once the database is up and running need to start the clamp emulator, by running the following command inside the /clamp/extra/bin-for-dev
+
+.. code-block:: bash
+
+ ./start-emulator.sh
+
+**Step 10:** Verify if mariadb and the emulator is running
+
+.. code-block:: bash
+
+ docker ps
+
+.. image:: images/02-gui.png
+
+**Step 11:** Start the backend service by running the command inside the /clamp/extra/bin-for-dev
+
+.. code-block:: bash
+
+ ./start-backend.sh
+
+
+.. _building-ui-label:
+
+2 - Checking out and building the UI
+====================================
+
+.. _Building UI
+
+**Step 1:** Checkout the UI from the repo
+
+.. code-block:: bash
+
+ git clone "https://gerrit.nordix.org/onap/policy/gui"
+
+**Step 2:** Change into the "gui" directory and run the following
+
+.. code-block:: bash
+
+ mvn clean install
+
+**Step 3:** Go into the gui-clamp/ui-react directory and run the following
+
+.. code-block:: bash
+
+ npm install
+
+**Step 4:** Start the front end UI
+
+.. code-block:: bash
+
+ npm start --scripts-prepend-node-path
+
+** If you get the following error
+
+.. image:: images/03-gui.png
+
+ gedit package.json
+
+.. code-block:: bash
+
+ change the following
+ "version": "${project.version}",
+
+ to
+
+ "version": "2.1.1",
+
+ save and close
+
+ then delete the node_modules directory
+
+ rm -rf node_modules/
+
+ then run again
+
+ npm install
+
+.. code-block:: bash
+
+ npm start --scripts-prepend-node-path
+
+**Step 5:** Once the UI starts at localhost:3000 it will ask for credentials:
+
+ Login: admin
+ Password: password
+
+3 - How to Commission/Decommission the TOSCA Service Template
+=============================================================
+
+This section describes how to commission and decommission the Tosca Service Template
+
+** Prerequisite:
+
+see clamp-policy-gui-label_
+
+**Step 1:** From the Main Menu Click on TOSCA Automation Composition Dropdown
+
+.. image:: images/04-gui.png
+
+**Step 2:** From the Dropdown Menu Select Upload Automation Composition To Commissioning
+
+.. image:: images/05-gui.png
+
+**Step 3:** On the window Upload Tosca to Commissioning API Click on the input box that says 'Please Select a file'
+
+.. image:: images/06-gui.png
+
+**Step 4:** Once the yaml file is selected click on Upload Tosca Service Template
+
+.. image:: images/07-gui.png
+
+**Step 5:** After the upload there should have a message "Upload Success" in green
+
+.. image:: images/08-gui.png
+
+**Step 6:** To validate that the TOSCA Service Template has been commissioned click on Manage Commissioned Automation Composition Template
+
+.. image:: images/09-gui.png
+
+**Step 7:** In the View Tosca Template Window click on Pull Tosca Service Template
+
+.. image:: images/10-gui.png
+
+**Step 8:** Once the Tosca Service Template has been pulled there should be a json object rendered in the window
+
+.. image:: images/11-gui.png
+
+**Step 9:** Click on Close close the window
+
+**Step 10:** Click on Edit Automation Composition Properties
+
+.. image:: images/12-gui.png
+
+**Step 11:** In the Change ACM Common Properties change the appropriate properties and click on save and there should have a popup saying 'Changes Saved. Commission When Ready...'
+
+.. image:: images/13-gui.png
+
+**Step 12:** After saving the changes click on Commission and should have a Green message saying 'Commissioning Success'
+
+.. image:: images/14-gui.png
+
+**Step 13:** To Decommission the Tosca Service Follow Step 6 and 8
+
+**Step 14:** Once the json objected is rendered in the window click on delete
+
+.. image:: images/11-gui.png
+
+**Step 14:** Once the json objected is rendered in the window click on delete
+
+.. image:: images/11-gui.png
+
+**Step 15:** If the delete is successful it should show a message "Delete Successful"
+
+.. image:: images/15-gui.png
+
+4 - How to Save Instance Properties and Change The Order State
+==============================================================
+
+This section describes how to save the instance properties and change it's order state
+
+** Prerequisite:
+
+see building-ui-label_
+
+**Step 1:** Go to the participant http directory
+
+.. code-block:: bash
+
+ cd /clamp/participant/participant-impl/participant-impl-http
+
+**Step 2:** Run he following command
+
+.. code-block:: bash
+
+ mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8080
+
+**Step 3:** Go to the participant kubernetes directory
+
+.. code-block:: bash
+
+ cd /clamp/participant/participant-impl/participant-impl-kubernetes
+
+**Step 4:** Run he following command
+
+.. code-block:: bash
+
+ mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8081
+
+**Step 5:** Go to the participant policy directory
+
+.. code-block:: bash
+
+ cd /clamp/participant/participant-impl/participant-impl-policy
+
+**Step 6:** Run he following command
+
+.. code-block:: bash
+
+ mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8082
+
+**Step 7:** From the Main Menu Click on Instantiation Management
+
+.. image:: images/16-gui.png
+
+**Step 8:** Once the window for Manage Instance is open click on Create Instance
+
+.. image:: images/17-gui.png
+
+**Step 9:** With the Window Create Instance Properties Insert a Name and change the appropriate properties and click save
+
+.. image:: images/18-gui.png
+
+**Step 10:** After clicking save it should come with a green message saying "Instantiation Properties Success"
+
+.. image:: images/19-gui.png
+
+**Step 11:** To delete an instance repeat Step 7
+
+.. image:: images/16-gui.png
+
+**Step 12:** Once the window for Manage Instance is open click on Delete
+
+.. image:: images/20-gui.png
+
+* NOTE: The only way to delete the instance properties if the order state has to be UNINITIALISED
+
+**Step 13:** To change the state click on Change in Manage Instances Window
+
+.. image:: images/20-gui.png
+
+**Step 14:** After clicking Change there should have a drop down with specific different ordered states
+
+.. image:: images/21-gui.png
+
+**Step 15:** From UNINITIALISED the user can only select Passive Ordered State
+
+.. image:: images/22-gui.png
+
+**Step 16:** Click on Save and a Message in Green "Ordered State Change Success"
+
+.. image:: images/23-gui.png
+
+* NOTE: Can't change from Passive to Running in a local developer machine, can only change in the production environment
\ No newline at end of file
Code Review / policy / parent.git / commitdiff
