add web modeler configuration draft

camunda · Sep 20, 2024 · c8b3396 · c8b3396
1 parent 72881cf
commit c8b3396
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 7 deletions.
diff --git a/docs/components/modeler/web-modeler/deploy-process-application.md b/docs/components/modeler/web-modeler/deploy-process-application.md
@@ -17,7 +17,7 @@ To deploy your process application:
 1. Open the [main process](create-a-process-application.md#main-process).
 1. Select **Deploy** to open the **Deploy process application** modal.
    <p><img src={DeployImg} alt="Deploy a process application" /></p>
-1. Turn on the toggle for the cluster stage you want to deploy to.
+1. Turn on the toggle for the cluster stage you want to deploy to. In Self-Managed, you may be prompted to enter your cluster details manually if no [configuration](/self-managed/modeler/web-modeler/configuration/configuration.md#clusters) is provided.
 1. Perform any other actions as required, such as:
    - Unpausing the chosen cluster if it has been auto-paused. Select **Resume cluster** within the **Cluster Details**.
    - Managing the cluster. Select **Manage**.

diff --git a/docs/components/modeler/web-modeler/play-your-process.md b/docs/components/modeler/web-modeler/play-your-process.md
@@ -14,11 +14,9 @@ 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 will be prompted to provide the [details](#use-play-with-camunda-self-managed) of your cluster:
+In Self-Managed, you are prompted to select from any 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 enter your cluster details [manually](#use-play-with-camunda-self-managed).
 
-![play cluster config](img/play-cluster-configuration.png)
-
-This starts a Play environment that utilizes your selected development cluster in SaaS, or the specified cluster in a Self-Managed setup.
+A Play environment is then started that utilizes your selected development cluster in SaaS, or the specified cluster in a Self-Managed setup.
 
 The current version of the active process and all its dependencies, like called processes or DMN files, are automatically deployed to the Play environment. An error or warning is raised if a file fails to deploy, is missing, or a Connector secret isn’t filled out.
 
@@ -175,9 +173,9 @@ 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 provide the details of your cluster.
+After selecting the **Play** tab in Self-Managed, you are prompted to select from any clusters defined in your Web Modeler [configuration](/self-managed/modeler/web-modeler/configuration/#clusters). The Camunda 8 Docker Compose distribution provides one cluster configured by default.
 
-See the table below for the requirement for each field, as well as an example value:
+If no cluster is configured, Web Modeler will request the following cluster details to use for deployment:
 
 | Name              | Description                                     | Example value                                                                      |
 | ----------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------- |

diff --git a/docs/components/modeler/web-modeler/run-or-publish-your-process.md b/docs/components/modeler/web-modeler/run-or-publish-your-process.md
@@ -37,6 +37,8 @@ To deploy, click **Deploy** in the upper right corner of the modeling screen:
 
 ![The deploy dialog of a BPMN diagram](img/web-modeler-deploy.png)
 
+In Self-Managed, you can deploy your diagram to any cluster defined in your Web Modeler [configuration](/self-managed/modeler/web-modeler/configuration/configuration.md#clusters). If no configuration is found, you are prompted to enter your cluster details manually.
+
 ### Before deploying a process
 
 - Make sure your process is free of errors, otherwise it can't be deployed. Use the [problems panel to detect and fix errors](./fix-problems-in-your-diagram.md).

diff --git a/docs/self-managed/modeler/web-modeler/configuration/configuration.md b/docs/self-managed/modeler/web-modeler/configuration/configuration.md
@@ -107,6 +107,27 @@ Refer to the [advanced logging configuration guide](./logging.md#logging-configu
 
 Refer to the [advanced SSL configuration guide](./ssl.md) for additional details on how to set up secure connections (incoming & outgoing) to the Web Modeler components.
 
+### 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.
+
+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.                 | `https://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`                      |
+
 ## Configuration of the `webapp` component
 
 ### General