docs/developer_info/Camunda_Cockpit_Enterprise_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 Enterprise Edition
   6 ==================================
   7
   8 The Community Edition of Camunda is the version normally built into SO.  With the Community Edition, you can see process definitions, but you cannot inspect running or completed process instances, which is an essential debugging capability.  This capability is available only in the Enterprise Edition and requires a commercial license.  If you have such a license, you can build SO with the Enterprise Edition.  Your use must be consistent with the terms of your license, of course.
   9
  10 With the Enterprise Edition cockpit, you can:
  11
  12   * See a trace of tasks executed by a running or completed process instance.
  13   * Look at execution variables in a running or completed process instance.
  14   * Look at called subprocesses in a running or completed process instance.
  15
  16 Maven Repository for Camunda EE Artifacts
  17 ------------------------------------------
  18
  19 To build with Camunda EE, you will need a maven repository containing the Camunda EE artifacts.   This can be a nexus repository or a local repository in your filesystem.
  20
  21 To construct a local repository, start with this structure for the 7.7.3-ee version of Camunda:
  22
  23   camunda-ee-repository.zip_
  24
  25 .. _camunda-ee-repository.zip: https://wiki.onap.org/download/attachments/16001686/camunda-ee-repository.zip?version=1&modificationDate=1507838888000&api=v2
  26
  27 *NOTE*: the zip archive does not contain the actual Enterprise Edition JAR and WAR files.  It contains zero-length files as placeholders.  You will need to replace the zero-length files with files you obtain from Camunda.  The archive does contain all the poms, checksums, and metadata required to make it a functional maven repository.
  28
  29 Here's the minimum set of artifacts you need to build the SO Amsterdam release software:
  30
  31   camunda-engine-7.7.3-ee.jar
  32
  33   camunda-webapp-7.7.3-ee-classes.jar
  34
  35   camunda-webapp-7.7.3-ee.war
  36
  37   camunda-webapp-ee-jboss-standalone-7.7.3-ee.war
  38
  39   camunda-engine-cdi-7.7.3-ee.jar
  40
  41   camunda-engine-rest-7.7.3-ee-classes.jar
  42
  43   camunda-engine-plugin-spin-7.7.3-ee.jar
  44
  45   camunda-engine-plugin-connect-7.7.3-ee.jar
  46
  47   camunda-engine-rest-core-7.7.3-ee.jar
  48
  49   camunda-engine-feel-api-7.7.3-ee.jar
  50
  51   camunda-engine-feel-juel-7.7.3-ee.jar
  52
  53   camunda-engine-dmn-7.7.3-ee.jar
  54
  55   camunda-engine-spring-7.7.3-ee.jar
  56
  57   camunda-bpmn-model-7.7.3-ee.jar
  58
  59   camunda-xml-model-7.7.3-ee.jar
  60
  61   camunda-dmn-model-7.7.3-ee.jar
  62
  63   camunda-cmmn-model-7.7.3-ee.jar
  64
  65 Maven settings.xml
  66 ------------------
  67
  68 Add a profile to your maven settings.xml to include the repository containing your Camunda EE artifacts.
  69
  70 For example:
  71
  72 .. code-block:: bash
  73
  74   <profile>
  75   <!-- profile for artifacts not in public repositories -->
  76   <id>my-local-artifacts</id>
  77   <repositories>
  78     <repository>
  79       <!-- Local repository for Camunda Enterprise Edition -->
  80       <!-- YOU MUST HAVE A VALID LICENSE TO USE THIS -->
  81       <id>camunda-ee</id>
  82       <name>camunda-ee</name>
  83       <url>file:///home/john/onap/camunda-ee-repository</url>
  84     </repository>
  85   </repositories>
  86   </profile>
  87
  88 And add your profile to the list of active profiles:
  89
  90 .. code-block:: bash
  91
  92   <activeProfiles>
  93
  94   <activeProfile>my-local-artifacts</activeProfile>
  95
  96   <activeProfile>openecomp-staging</activeProfile>
  97
  98   <activeProfile>openecomp-public</activeProfile>
  99
 100   <activeProfile>openecomp-release</activeProfile>
 101
 102   <activeProfile>openecomp-snapshots</activeProfile>
 103
 104   <activeProfile>opendaylight-release</activeProfile>
 105
 106   <activeProfile>opendaylight-snapshots</activeProfile>
 107
 108   </activeProfiles>
 109
 110 Building
 111 --------
 112
 113 Add these options to the mvn command line when you build "so"
 114
 115 .. code-block:: bash
 116
 117   -Dcamunda.version=7.7.3-ee -Dcamunda.bpm.webapp.artifact=camunda-webapp-ee-jboss-standalone
 118
 119 Installation
 120 -------------
 121
 122 The cockpit is part of the SO image.  There are no special installation requirements.  When you log in, you will need to enter your license information.  Alternatively, you can insert your license directly into the camundabpmn database before you log in:
 123
 124 .. code-block:: bash
 125
 126   INSERT INTO camundabpmn.ACT_GE_PROPERTY VALUES ('camunda-license-key','YOUR-LICENCE-KEY-HERE',1);
 127
 128 Logging In
 129 -----------
 130
 131 Because port 8080 on the docker host machine is forwarded to port 8080 in the SO docker container you can log into the Enterprise Edition cockpit by browsing to this URL:
 132
 133   http://*dockerhost*:8080/camunda
 134
 135   Where dockerhost is the docker host system.
 136
 137 If you can use a browser on the docker host system, then use a localhost address:
 138
 139   http://localhost:8080/camunda
 140
 141 The user is "admin" and the password is the same as the jboss admin password, which is not displayed here.
 142
 143 .. image:: ../images/Camunda_Cockpit_Enterprise_1.png