url correction and improve API doc
[so.git] / docs / developer_info / Camunda_Cockpit_Community_Edition.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2017 Huawei Technologies Co., Ltd.
4
5 Camunda Cockpit Community Edition
6 =================================
7
8 On a deployed instance of SO, you can use the Camunda_Cockpit to view BPMN 2.0 workflow definitions in the deployment.
9
10 .. _Camunda_Cockpit: https://camunda.org/features/cockpit/
11
12 Unfortunately, the Community Edition of Camunda included with SO is not fully featured.  It cannot be used to inspect running and completed process instances.  For that, the Enterprise Edition is required.
13
14 Logging In
15 -----------
16
17 Because port 8080 on the docker host machine is forwarded to port 8080 in the SO docker container you can log into the cockpit by browsing to this URL:
18
19   http://*dockerhost*:8080/camunda/app/admin/default/#/login
20
21   Where dockerhost is the docker host system.
22
23 If you can use a browser on the docker host system, then use a localhost address:
24
25   http://localhost:8080/camunda/app/admin/default/#/login
26
27 The user is "admin" and the password is the same as the jboss admin password, which is not displayed here.
28
29 .. image:: ../images/Camunda_Cockpit_1.png
30
31 Viewing Process Definitions
32 ---------------------------
33
34 Use the drop-down menu next to the home icon and select the "Cockpit" option:
35
36 .. image:: ../images/Camunda_Cockpit_2.png
37
38 The number of deployed process definitions should be displayed.  Click on it.
39
40 .. image:: ../images/Camunda_Cockpit_3.png
41
42 Now you should see an actual list of deployed process definitions.  You can click on any of them to view them.
43
44 .. image:: ../images/Camunda_Cockpit_4.png