Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-1243

I can query the location of Camunda webapps

    Details

    • Type: Feature Request
    • Status: Done
    • Priority: L3 - Default
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.1.0-alpha2, 2.1.0
    • Component/s: backend
    • Labels:
      None

      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

        Activity

        sebastian.stamm Sebastian Stamm created issue -
        johannes.heinemann Johannes Heinemann made changes -
        Field Original Value New Value
        Rank Ranked higher
        johannes.heinemann Johannes Heinemann made changes -
        Status Open [ 1 ] Ready to implement [ 10000 ]
        johannes.heinemann Johannes Heinemann made changes -
        Status Ready to implement [ 10000 ] In Development [ 10312 ]
        Hide
        johannes.heinemann Johannes Heinemann added a comment -
        Show
        johannes.heinemann Johannes Heinemann added a comment - The REST endpoint documentation can be found here: https://github.com/camunda/camunda-optimize/wiki/REST-API-documentation#camunda-webapps-endpoint
        johannes.heinemann Johannes Heinemann made changes -
        Status In Development [ 10312 ] In Review [ 10212 ]
        Assignee Johannes Heinemann [ johannes.heinemann ] Sebastian Stamm [ sebastian.stamm ]
        Hide
        sebastian.stamm Sebastian Stamm added a comment -
        • 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
        Show
        sebastian.stamm Sebastian Stamm added a comment - 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
        sebastian.stamm Sebastian Stamm made changes -
        Status In Review [ 10212 ] Ready to implement [ 10000 ]
        sebastian.stamm Sebastian Stamm made changes -
        Assignee Sebastian Stamm [ sebastian.stamm ] Johannes Heinemann [ johannes.heinemann ]
        Hide
        sebastian.stamm Sebastian Stamm added a comment -
        • How do we want to handle multiple engines? As far as I know, each engine has its own webapp endpoint.
        Show
        sebastian.stamm Sebastian Stamm added a comment - How do we want to handle multiple engines? As far as I know, each engine has its own webapp endpoint.
        Hide
        sebastian.stamm Sebastian Stamm added a comment -
        • The endpoint /api/camunda should not be secured so that it also works with shared raw data tables
        Show
        sebastian.stamm Sebastian Stamm added a comment - The endpoint /api/camunda should not be secured so that it also works with shared raw data tables
        johannes.heinemann Johannes Heinemann made changes -
        Status Ready to implement [ 10000 ] In Development [ 10312 ]
        Hide
        johannes.heinemann Johannes Heinemann added a comment -

        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
        Show
        johannes.heinemann Johannes Heinemann added a comment - 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
        johannes.heinemann Johannes Heinemann made changes -
        Status In Development [ 10312 ] In Review [ 10212 ]
        Assignee Johannes Heinemann [ johannes.heinemann ] Sebastian Stamm [ sebastian.stamm ]
        Hide
        sebastian.stamm Sebastian Stamm added a comment -

        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.

        Show
        sebastian.stamm Sebastian Stamm added a comment - 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.
        sebastian.stamm Sebastian Stamm made changes -
        Status In Review [ 10212 ] Open [ 1 ]
        Assignee Sebastian Stamm [ sebastian.stamm ] Johannes Heinemann [ johannes.heinemann ]
        johannes.heinemann Johannes Heinemann made changes -
        Assignee Johannes Heinemann [ johannes.heinemann ]
        Status Open [ 1 ] Done [ 10010 ]
        Resolution Fixed [ 1 ]
        sebastian.stamm Sebastian Stamm made changes -
        Fix Version/s 2.1.0-alpha2 [ 15313 ]
        johannes.heinemann Johannes Heinemann made changes -
        Fix Version/s 2.1.0 [ 15317 ]
        johannes.heinemann Johannes Heinemann made changes -
        Labels current_release
        johannes.heinemann Johannes Heinemann made changes -
        Workflow Camunda Optimize - 2.0 [ 51084 ] Camunda Optimize - 2.4 [ 65988 ]
        johannes.heinemann Johannes Heinemann made changes -
        PM Priority -1
        johannes.heinemann Johannes Heinemann made changes -
        PM Priority -1

          People

          • Assignee:
            Unassigned
            Reporter:
            sebastian.stamm Sebastian Stamm
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: