1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. _clamp-policy-gui-label:
11 1 - How to run the Front-End Gui
12 ================================
13 This section describes how to run the front end on your local machine.
17 **Building and running CLAMP**
19 see `Clamp ACM Smoke Tests <https://docs.onap.org/projects/onap-policy-parent/en/latest/development/devtools/clamp-smoke.html>`__
21 **Step 1:** Go to the clamp directory
25 cd /clamp/extra/bin-for-dev
27 **Step 2:** Inside the clamp directory run
33 **Step 3:** Check docker container id
39 **Step 4:** Log into docker container
43 docker exec -it 'container_id' bash
45 **Step 5:** Go into mariadb shell
51 **Step 6:** Enter password
55 .. image:: images/01-gui.png
57 **Step 7:** Go into cldsdb4 database
63 **Step 8:** Verify if there is data in the following table 'loop_templates'
67 select * from loop_templates;
69 ** If for some reason the database is empty do the go to the '/docker-entrypoint-initdb.d/dump' directory
75 **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
81 **Step 10:** Verify if mariadb and the emulator is running
87 .. image:: images/02-gui.png
89 **Step 11:** Start the backend service by running the command inside the /clamp/extra/bin-for-dev
96 .. _building-ui-label:
98 2 - Checking out and building the UI
99 ====================================
101 **Step 1:** Checkout the UI from the repo
105 git clone "https://gerrit.nordix.org/onap/policy/gui"
107 **Step 2:** Change into the "gui" directory and run the following
113 **Step 3:** Go into the gui-clamp/ui-react directory and run the following
119 **Step 4:** Start the front end UI
123 npm start --scripts-prepend-node-path
125 *If you get the following error*
127 .. image:: images/03-gui.png
133 Then change ``"version": "${project.version}",`` to ``"version": "2.1.1",``
135 Save and close, then delete the node_modules directory
149 npm start --scripts-prepend-node-path
151 **Step 5:** Once the UI starts at localhost:3000 it will ask for credentials:
156 3 - How to Commission/Decommission the TOSCA Service Template
157 =============================================================
159 This section describes how to commission and decommission the Tosca Service Template
163 See :ref:`Policy GUI Prerequisites<clamp-policy-gui-label>`
165 **Step 1:** From the Main Menu Click on TOSCA Automation Composition Dropdown
167 .. image:: images/04-gui.png
169 **Step 2:** From the Dropdown Menu Select Upload Automation Composition To Commissioning
171 .. image:: images/05-gui.png
173 **Step 3:** On the window Upload Tosca to Commissioning API Click on the input box that says 'Please Select a file'
175 .. image:: images/06-gui.png
177 **Step 4:** Once the yaml file is selected click on Upload Tosca Service Template
179 .. image:: images/07-gui.png
181 **Step 5:** After the upload there should have a message "Upload Success" in green
183 .. image:: images/08-gui.png
185 **Step 6:** To validate that the TOSCA Service Template has been commissioned click on Manage Commissioned Automation Composition Template
187 .. image:: images/09-gui.png
189 **Step 7:** In the View Tosca Template Window click on Pull Tosca Service Template
191 .. image:: images/10-gui.png
193 **Step 8:** Once the Tosca Service Template has been pulled there should be a json object rendered in the window
195 .. image:: images/11-gui.png
197 **Step 9:** Click on Close close the window
199 **Step 10:** Click on Edit Automation Composition Properties
201 .. image:: images/12-gui.png
203 **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...'
205 .. image:: images/13-gui.png
207 **Step 12:** After saving the changes click on Commission and should have a Green message saying 'Commissioning Success'
209 .. image:: images/14-gui.png
211 **Step 13:** To Decommission the Tosca Service Follow Step 6 and 8
213 **Step 14:** Once the json objected is rendered in the window click on delete
215 .. image:: images/11-gui.png
217 **Step 14:** Once the json objected is rendered in the window click on delete
219 .. image:: images/11-gui.png
221 **Step 15:** If the delete is successful it should show a message "Delete Successful"
223 .. image:: images/15-gui.png
225 4 - How to Save Instance Properties and Change The Order State
226 ==============================================================
228 This section describes how to save the instance properties and change it's order state
232 see building-ui-label_
234 **Step 1:** Go to the participant http directory
238 cd /clamp/participant/participant-impl/participant-impl-http
240 **Step 2:** Run he following command
244 mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8080
246 **Step 3:** Go to the participant kubernetes directory
250 cd /clamp/participant/participant-impl/participant-impl-kubernetes
252 **Step 4:** Run he following command
256 mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8081
258 **Step 5:** Go to the participant policy directory
262 cd /clamp/participant/participant-impl/participant-impl-policy
264 **Step 6:** Run he following command
268 mvn spring-boot:run -Dspring-boot.run.arguments=--server.port=8082
270 **Step 7:** From the Main Menu Click on Instantiation Management
272 .. image:: images/16-gui.png
274 **Step 8:** Once the window for Manage Instance is open click on Create Instance
276 .. image:: images/17-gui.png
278 **Step 9:** With the Window Create Instance Properties Insert a Name and change the appropriate properties and click save
280 .. image:: images/18-gui.png
282 **Step 10:** After clicking save it should come with a green message saying "Instantiation Properties Success"
284 .. image:: images/19-gui.png
286 **Step 11:** To delete an instance repeat Step 7
288 .. image:: images/16-gui.png
290 **Step 12:** Once the window for Manage Instance is open click on Delete
292 .. image:: images/20-gui.png
294 * NOTE: The only way to delete the instance properties if the order state has to be UNINITIALISED
296 **Step 13:** To change the state click on Change in Manage Instances Window
298 .. image:: images/20-gui.png
300 **Step 14:** After clicking Change there should have a drop down with specific different ordered states
302 .. image:: images/21-gui.png
304 **Step 15:** From UNINITIALISED the user can only select Passive Ordered State
306 .. image:: images/22-gui.png
308 **Step 16:** Click on Save and a Message in Green "Ordered State Change Success"
310 .. image:: images/23-gui.png
312 * NOTE: Can't change from Passive to Running in a local developer machine, can only change in the production environment