Skip to content

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
berndruecker committed Mar 29, 2019
1 parent a46f684 commit a2e9412
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 8 deletions.
Binary file added docs/optimize.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions optimize-as-a-service/manifest.yml
@@ -1,9 +1,7 @@
---
applications:
- name: camunda-on-pcf-optimize
path: target/camunda-on-pcf-optimize-as-a-service.jar
# services:
# - camunda-elastic
# path: target/camunda-on-pcf-optimize-as-a-service.jar
env:
HTTP_PORT: 8080
HTTPS_PORT: 8081
Expand Down
43 changes: 38 additions & 5 deletions optimize-as-a-service/readme.md
@@ -1,14 +1,47 @@
# Running Camunda Optimize on PCF

Optimize is a business analysis tool that can make sense of data in Camunda engines. Please not that this is not available within the community edition and needs an enterprise subscription. Nevertheless I wanted to include it here, as customers ask about it anyway.
[Camunda Optimize](https://camunda.com/products/optimize/) is a business analysis tool that can make sense of data in Camunda engines. Please not that this is not available within the community edition and needs an [enterprise subscription](https://camunda.com/enterprise/). Nevertheless I wanted to include it here, as customers ask about running it on PCF.

Optimize is - like the Camunda engine - a Java application, so you can also run it using the Java build pack of PCF. In order to properly configure Optimize this repo provides a small overlay project you can build and push, either locally, or again using your CI/CD pipeline.
![](../docs/optimize.png)

Optimize is - like the Camunda engine - a Java application, so you can also run it using the Java build pack of PCF. It requires a REST connection to Camunda and an Elastic datasource to store data.

In order to properly configure Optimize this repo provides a small overlay project you can build and push, either locally, or again using your CI/CD pipeline as shown in the [Camunda as a Service / NodeJS sample](../../../nodejs-sample/).

# Screencast

<a href="http://www.youtube.com/watch?feature=player_embedded&v=w_EOtS9-pWU" target="_blank"><img src="http://img.youtube.com/vi/w_EOtS9-pWU/0.jpg" alt="Screencast" width="480" border="10" /></a>

# Step-by-step

1. Build this project locally. Make sure you have your [Camunda Enterprise Edition login configured](https://docs.camunda.org/get-started/apache-maven/#enterprise-edition-1).

```
mvn clean install
```

# Screencast
You can [get a trial license](https://camunda.com/download/enterprise/) here.

2. Edit the config for your Camunda and Elastic installation in the [manifest.yml](manifest.yml), e.g.:

```
CAMUNDA_REST_ENDPOINT: http://camunda-on-pcf-engine-as-a-service.cfapps.io/rest
CAMUNDA_REST_AUTH_ENABLED: false
CAMUNDA_REST_USERNAME:
CAMUNDA_REST_PASSWORD:
CAMUNDA_WEBAPP_ENDPOINT: http://camunda-on-pcf-engine-as-a-service.cfapps.io/
ELASTIC_CLUSTERNAME: elasticsearch
ELASTIC_HOST: d104d2bf325044f183612f8c0c74bebd.europe-west1.gcp.cloud.es.io
ELASTIC_PORT: 9243
ELASTIC_SSL_ENABLED: true
ELASTIC_USERNAME: elastic
ELASTIC_PASSWORD: Aps0k8j9vnvipKdVxYUIhjR1
```

3. Push optimize to PCF:

```
cf push -f target/camunda-on-pcf-optimize-as-a-service.jar
```

This video walks you through the procedure:
ADD YOUTUBE VIDEO HERE
4. Now you can access Optimize via the Route PCF creates, e.g. [http://camunda-on-pcf-optimize.cfapps.io/](http://camunda-on-pcf-optimize.cfapps.io/). Login with the credentials from the Camunda installation, which in the default case is *demo* / *demo*.

0 comments on commit a2e9412

Please sign in to comment.