Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the SM desktop modeler instructions #4584

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
+42 −19
Draft

Update the SM desktop modeler instructions #4584

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
619b568
update sm desktop modeler deploy
conceptualshark Nov 7, 2024
076eb22
add permissions
conceptualshark Nov 8, 2024
2f572db
Reword instructions
conceptualshark Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 42 additions & 19 deletions docs/self-managed/modeler/desktop-modeler/deploy-to-self-managed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
<Tabs groupId="auth" defaultValue="basic" queryString values={
[
{label: 'Basic', value: 'basic' },
{label: 'OAuth', value: 'oauth' }
]}>

:::caution
<TabItem value='basic'>

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)
</TabItem>

4. Select **Basic**, and input your username and password in case your gateway requires basic authentication:
<TabItem value='oauth'>

![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://<keycloak base url>/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://<keycloak base url>/auth/realms/camunda-platform/protocol/openid-connect/token`. |
| OAuth audience | The permission name for Zeebe. | `zeebe-api` |

![oauth configuration](./img/deploy-with-oauth.png)
</TabItem>
</Tabs>

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)
Loading