diff --git a/docs/self-managed/modeler/desktop-modeler/deploy-to-self-managed.md b/docs/self-managed/modeler/desktop-modeler/deploy-to-self-managed.md index f39ada6f30..73b4d2c7ce 100644 --- a/docs/self-managed/modeler/desktop-modeler/deploy-to-self-managed.md +++ b/docs/self-managed/modeler/desktop-modeler/deploy-to-self-managed.md @@ -4,46 +4,69 @@ title: Deploy diagram description: "Desktop Modeler can directly deploy diagrams and start process instances in Camunda 8 Self-Managed." --- +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + Desktop Modeler can directly deploy diagrams and start process instances in Camunda 8 Self-Managed. Follow the steps below to deploy a diagram: 1. Click the rocket-shaped deployment icon: -![deployment icon](./img/deploy-icon.png) + ![deployment icon](./img/deploy-icon.png) 2. Click **Camunda 8 Self-Managed**: -![deployment configuration](./img/deploy-empty.png) + ![deployment configuration](./img/deploy-empty.png) 3. Input the `Cluster endpoint`: -:::note -You can connect to Camunda 8 both securely and insecurely through the `https` and `http` protocols. + :::note + You can connect to Camunda 8 both securely and insecurely through the `https` and `http` protocols. + + Secured connections to a remote endpoint will only be established if the remote server certificate is trusted by the app. Ensure that signing trusted roots and intermediate certificates [are known to the app](/components/modeler/desktop-modeler/flags/flags.md#zeebe-ssl-certificate). + ::: + + :::caution + + Multi-tenancy is only available with authentication enabled [through Identity](/self-managed/identity/what-is-identity.md), and [enabled in all required components](/self-managed/concepts/multi-tenancy.md). + + ::: + + ![deployment via Camunda 8](./img/deploy-endpoint.png) + +4. Select your authentication method, and input the required credentials: -Secured connections to a remote endpoint will only be established if the remote server certificate is trusted by the app. Ensure that signing trusted roots and intermediate certificates [are known to the app](/components/modeler/desktop-modeler/flags/flags.md#zeebe-ssl-certificate). -::: + -:::caution + -Multi-tenancy is only available with authentication enabled [through Identity](/self-managed/identity/what-is-identity.md), and [enabled in all required components](/self-managed/concepts/multi-tenancy.md). + For **basic authentication**, input your username and password: -::: + ![basic auth configuration](./img/deploy-with-basic-auth.png) -![deployment via Camunda 8](./img/deploy-endpoint.png) + -4. Select **Basic**, and input your username and password in case your gateway requires basic authentication: + -![basic auth configuration](./img/deploy-with-basic-auth.png) + For **OAuth**, input the credentials for your OAuth provider. These are configured as part of the default [Helm installation](/self-managed/setup/install.md) and can be discovered in [Identity](/docs/self-managed/identity/what-is-identity.md), or are set by Zeebe [environment variables](/self-managed/zeebe-deployment/security/client-authorization.md#environment-variables). -5. Select **OAuth**, and input the credentials in case your gateway requires authentication with OAuth: + ![oauth configuration](./img/deploy-with-oauth.png) -:::note -The OAuth URL needs to contain the full path to the token endpoint, i.e. `https:///auth/realms/camunda-platform/protocol/openid-connect/token`. -::: + | Name | Description | Example value | + | --------------- | ------------------------------------ | ----------------------------------------------------------------------------------------- | + | Client ID | The name of your Zeebe client. | `zeebe` | + | Client secret | The password of your Zeebe client. | `zecret` | + | OAuth token url | The full path to the token endpoint. | `https:///auth/realms/camunda-platform/protocol/openid-connect/token`. | + | OAuth audience | The permission name for Zeebe. | `zeebe-api` | -![oauth configuration](./img/deploy-with-oauth.png) + + -6. Select the **Remember** checkbox if you want to locally store the connection information. +5. Select the **Remember** checkbox if you want to locally store the connection information. -7. Click **Deploy** to perform the deployment. +6. Click **Deploy** to perform the deployment. ![deployment successful](./img/deploy-success.png)