How to enable alpha feature in camunda-platform (self managed) 8.6 version

We have a requirement to use Query API but unable to use it as the alpha feature is not enabled.
Please help with any configuration or environment variable which needs to be configured in camunda 8.6 self managed kubernetes deployment to enable alpha feature.

Hi @shilpi

query-api: Overview | Camunda 8 Docs

Regards,
Alex

1 Like

Added - name: CAMUNDA_REST_QUERY_ENABLED value: "true" in zeebe-gateway env variable, still it throws 404 for the api call.

Can you share the full yaml file (excluding sensitive data if any)?

Regards,
Alex

It throws a 500 error with CAMUNDA_REST_QUERY_ENABLED=true

{
  "type": "about:blank",
  "title": "Failed to execute UserTask Search Query",
  "status": 500,
  "detail": "Failed to execute search query",
  "instance": "/v2/user-tasks/search"
}

@chirag Which Camunda version are you using? And how does your request payload look like?

Hi @Alex_Voloshyn,

I am using self-managed cmaunda(8.6) setup(using docker-compose) in my local machine.
For enabling alpha features, I added required env file:

  zeebe: # https://docs.camunda.io/docs/self-managed/platform-deployment/docker/#zeebe
    image: camunda/zeebe:${CAMUNDA_PLATFORM_VERSION}
    container_name: zeebe
    ports:
      - "26500:26500"
      - "9600:9600"
      - "8088:8080"
    environment: # https://docs.camunda.io/docs/self-managed/zeebe-deployment/configuration/environment-variables/
      - ZEEBE_BROKER_GATEWAY_SECURITY_AUTHENTICATION_MODE=${ZEEBE_AUTHENTICATION_MODE}
      - ZEEBE_BROKER_GATEWAY_SECURITY_AUTHENTICATION_IDENTITY_ISSUERBACKENDURL=http://keycloak:18080/auth/realms/camunda-platform
      - ZEEBE_BROKER_GATEWAY_SECURITY_AUTHENTICATION_IDENTITY_AUDIENCE=zeebe-api
      - ZEEBE_BROKER_GATEWAY_SECURITY_AUTHENTICATION_IDENTITY_BASEURL=http://identity:8084
      - ZEEBE_BROKER_GATEWAY_MULTITENANCY_ENABLED=${MULTI_TENANCY_ENABLED}
      - ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_CLASSNAME=io.camunda.zeebe.exporter.ElasticsearchExporter
      - ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_URL=http://elasticsearch:9200
      # default is 1000, see here: https://github.com/camunda/zeebe/blob/main/exporters/elasticsearch-exporter/src/main/java/io/camunda/zeebe/exporter/ElasticsearchExporterConfiguration.java#L259
      - ZEEBE_BROKER_EXPORTERS_ELASTICSEARCH_ARGS_BULK_SIZE=1
      # allow running with low disk space
      - ZEEBE_BROKER_DATA_DISKUSAGECOMMANDWATERMARK=0.998
      - ZEEBE_BROKER_DATA_DISKUSAGEREPLICATIONWATERMARK=0.999
      - "JAVA_TOOL_OPTIONS=-Xms512m -Xmx512m"
      - CAMUNDA_IDENTITY_ISSUERBACKENDURL=http://keycloak:18080/auth/realms/camunda-platform
      - CAMUNDA_IDENTITY_BASEURL=http://identity:8084
      - CAMUNDA_IDENTITY_AUDIENCE=zeebe-api
      - SPRING_PROFILES_ACTIVE=identity-auth
      - CAMUNDA_REST_QUERY_ENABLED=true
    restart: always
    healthcheck:
      test: [ "CMD-SHELL", "timeout 10s bash -c ':> /dev/tcp/127.0.0.1/9600' || exit 1" ]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s
    volumes:
      - zeebe:/usr/local/zeebe/data
    networks:
      - camunda-platform
    depends_on:
      - elasticsearch
      - identity

I redeployed the zeebe container.

Still I am getting this response:

{
    "type": "about:blank",
    "title": "Failed to execute Process Instance Search Query",
    "status": 400,
    "detail": "Failed to execute search query",
    "instance": "/v2/process-instances/search"
}

Request:

curl --location 'localhost:8088/v2/process-instances/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer token' \
--data '{
    "filter": {
        "running": true
    },
    "sort": [
        {
            "field": "bpmnProcessId",
            "order": "asc"
        }
    ],
    "page": {
        "from": 0,
        "limit": 0
    }
}'