[OPT-1243] I can query the location of Camunda webapps Created: 04/May/18  Updated: 18/Apr/19  Resolved: 22/May/18

Status: Done
Project: Camunda Optimize
Component/s: backend
Affects Version/s: None
Fix Version/s: 2.1.0-alpha2, 2.1.0

Type: Feature Request Priority: L3 - Default
Reporter: Sebastian Stamm Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

AT:

  • There is a new endpoint GET /api/camunda
  • Querying this endpoint returns a string with the location of the camunda webapps (e.g. http://localhost:8080/camunda if cockpit is at http://localhost:8080/camunda/app/cockpit)
  • There is a configuration parameter that allows to customize the location of the webapps
  • There is a configuration parameter that allows to indicate the absence of webapps. In this case, the endpoint returns an empty string
  • REST endpoint and configuration parameters are documented


 Comments   
Comment by Johannes Heinemann [ 07/May/18 ]

The REST endpoint documentation can be found here: https://github.com/camunda/camunda-optimize/wiki/REST-API-documentation#camunda-webapps-endpoint

Comment by Sebastian Stamm [ 16/May/18 ]
  • What is the reason to have a separate camunda.webapps.enabled flag? Could we not instead check if the endpoint is provided? If no endpoint is provided, the feature obviously is disabled
  • In the development setup, the endpoint returns http://localhost:8080/camunda/, but the webapps are at http://localhost:8050/camunda/ (and can actually be configured in the /client/scripts/config.js file) I think the dev server start needs to be adjusted to accommodate that, which can be done in a separate ticket
Comment by Sebastian Stamm [ 17/May/18 ]
  • How do we want to handle multiple engines? As far as I know, each engine has its own webapp endpoint.
Comment by Sebastian Stamm [ 17/May/18 ]
  • The endpoint /api/camunda should not be secured so that it also works with shared raw data tables
Comment by Johannes Heinemann [ 18/May/18 ]

Remarks:

  • we need the flag to explicitly disable the feature. If it is disabled, the back-end will return an empty string for the endpoint.
  • the development setup is fixed
  • multiple engines are now handled as well. The webapps configuration was moved to the engines confiuration, such that every engine can have its own webapps endpoint
  • the endpoint is not secured anymore
Comment by Sebastian Stamm [ 18/May/18 ]

The documentation states that the inner object consists of the properties endpoint and name, while the implementation returns an object with the properties endpoint and engineName. The rest looks good.

Generated at Thu Nov 14 20:28:40 CET 2019 using JIRA 6.4.6#64021-sha1:33e5b454af4594f54560ac233c30a6e00459507e.