Skip to content

Commit

Permalink
add new web modeler deploy config (#4540)
Browse files Browse the repository at this point in the history
  • Loading branch information
conceptualshark authored Nov 3, 2024
1 parent c8b76a6 commit d717ba7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/components/modeler/web-modeler/play-your-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Play is a Zeebe-powered playground environment within Web Modeler for validating

To use Play, open a BPMN diagram and click the **Play** tab. Read the [limitations and availability section](#limitations-and-availability) if this section is missing.

In Self-Managed, you are prompted to select from the clusters defined in your Web Modeler [configuration](/self-managed/modeler/web-modeler/configuration/configuration.md#clusters). The Camunda 8 Docker Compose distribution provides one cluster configured by default. If no configuration is found, you are prompted to [manually enter your cluster details](#use-play-with-camunda-self-managed).
In Self-Managed, you are prompted to select from the clusters defined in your Web Modeler [configuration](/self-managed/modeler/web-modeler/configuration/configuration.md#clusters). The Camunda 8 Helm and Docker Compose distributions provide one cluster configured by default. If no configuration is found, you are prompted to [manually enter your cluster details](#use-play-with-camunda-self-managed).

A Play environment is then started that utilizes your selected development cluster in SaaS, or the specified cluster in a Self-Managed setup.

Expand Down Expand Up @@ -179,7 +179,7 @@ Prior to the 8.6 release, Play can be accessed by installing the 8.6.0-alpha [He

## Use Play with Camunda Self-Managed

After selecting the **Play** tab in Self-Managed, you are prompted to select from the clusters defined in your Web Modeler [configuration](/self-managed/modeler/web-modeler/configuration/configuration.md#clusters). The Camunda 8 Docker Compose distribution provides one cluster configured by default.
After selecting the **Play** tab in Self-Managed, you are prompted to select from the clusters defined in your Web Modeler [configuration](/self-managed/modeler/web-modeler/configuration/configuration.md#clusters). The Camunda 8 Helm and Docker Compose distributions provide one cluster configured by default.

If no cluster is configured, Web Modeler requests the following cluster details to use for deployment:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,27 @@ import Licensing from '../../../../self-managed/react-components/licensing.md'

### Clusters

Clusters configured using the following options can be selected when deploying from Web Modeler. If no clusters are configured, your cluster information can be provided at the time of the deployment. The Camunda 8 [Docker Compose distribution](/self-managed/setup/deploy/local/docker-compose.md) provides a local Zeebe cluster configured by default.
Clusters configured using the following options can be selected when deploying from Web Modeler. If no clusters are configured, your cluster information can be provided at the time of the deployment. The Camunda 8 [Helm](/docs/self-managed/setup/install.md) and [Docker Compose](/self-managed/setup/deploy/local/docker-compose.md) distributions provide a local Zeebe cluster configured by default.

To add additional clusters, increment the `0` value for each variable (`CAMUNDA_MODELER_CLUSTERS_1_NAME`).

| Environment variable | Description | Example value |
| ---------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------- |
| `CAMUNDA_MODELER_CLUSTERS_0_NAME` | The name of your cluster. | `test cluster 1` |
| `CAMUNDA_MODELER_CLUSTERS_0_VERSION` | The Camunda version used by this cluster. | `8.6.0` |
| `CAMUNDA_MODELER_CLUSTERS_0_AUTHENTICATION` | The authentication to use with your cluster. | `OAUTH`, `NONE` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_ZEEBE_GRPC` | The address where your cluster can be reached. | `grpcs://zeebe-1.example.com:26500` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_ZEEBE_REST` | The address where the Zeebe REST API can be reached. | `https://zeebe-1.example.com:8080` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_OPERATE` | The address where Operate can be reached. | `https://operate-1.example.com` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_TASKLIST` | The address where Tasklist can be reached. | `https://tasklist-1.example.com` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_URL` | The address of your token issuer. | `https://auth.example.com/token` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_SCOPE` | A comma-separated list of the scopes to use with this cluster. | `test-scope` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_AUDIENCE_ZEEBE` | The permission name for Zeebe. | `zeebe-api` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_AUDIENCE_OPERATE` | The permission name for Operate. | `operate-api` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_AUDIENCE_TASKLIST` | The permission name for Tasklist. | `tasklist-api` |
| Environment variable | Description | Example value |
| -------------------- | ----------- | ------------- |

|
| `CAMUNDA_MODELER_CLUSTERS_0_ID` | A unique identifier to use for your cluster. | `test-cluster-1` |
| `CAMUNDA_MODELER_CLUSTERS_0_NAME` | The name of your cluster. | `test cluster 1` |
| `CAMUNDA_MODELER_CLUSTERS_0_VERSION` | The Camunda version used by this cluster. | `8.6.0` |
| `CAMUNDA_MODELER_CLUSTERS_0_AUTHENTICATION` | The authentication to use with your cluster. | `OAUTH`, `NONE` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_ZEEBE_GRPC` | The address where your cluster can be reached. | `grpcs://zeebe-1.example.com:26500` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_ZEEBE_REST` | The address where the Zeebe REST API can be reached. | `https://zeebe-1.example.com:8080` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_OPERATE` | The address where Operate can be reached. | `https://operate-1.example.com` |
| `CAMUNDA_MODELER_CLUSTERS_0_URL_TASKLIST` | The address where Tasklist can be reached. | `https://tasklist-1.example.com` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_URL` | The address of your token issuer. | `https://auth.example.com/token` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_SCOPE` | A comma-separated list of the scopes to use with this cluster. | `test-scope` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_AUDIENCE_ZEEBE` | The permission name for Zeebe. | `zeebe-api` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_AUDIENCE_OPERATE` | The permission name for Operate. | `operate-api` |
| `CAMUNDA_MODELER_CLUSTERS_0_OAUTH_AUDIENCE_TASKLIST` | The permission name for Tasklist. | `tasklist-api` |

### Database

Expand Down

0 comments on commit d717ba7

Please sign in to comment.