Update the SM desktop modeler instructions #4584
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,9 @@ 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: | ||
|
|
@@ -30,20 +33,40 @@ Multi-tenancy is only available with authentication enabled [through Identity](/ | |
|
|
||
|  | ||
|
|
||
| 4. Select your authentication method, and input the required credentials: | ||
|
|
||
| <Tabs groupId="auth" defaultValue="basic" queryString values={ | ||
| [ | ||
| {label: 'Basic', value: 'basic' }, | ||
| {label: 'OAuth', value: 'oauth' } | ||
| ]}> | ||
|
|
||
| <TabItem value='basic'> | ||
|
|
||
| For **basic authentication**, input your username and password: | ||
|
|
||
|  | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem value='oauth'> | ||
|
|
||
| For **OAuth**, input the credentials for your OAuth provider. These are configured as part of the default [Helm installation](/self-managed/platform-deployment/helm-kubernetes/deploy.md) and can be discovered in [Identity](/self-managed/identity/what-is-identity.md), or are set by Zeebe [environment variables](/self-managed/zeebe-deployment/security/client-authorization.md#environment-variables). | ||
|
|
||
|  | ||
|
|
||
| | 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` | | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| 5. Select the **Remember** checkbox if you want to locally store the connection information. | ||
|
|
||
| 6. Click **Deploy** to perform the deployment. | ||
|
|
||
|  | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,9 @@ 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: | ||
|
|
@@ -30,20 +33,40 @@ Multi-tenancy is only available with authentication enabled [through Identity](/ | |
|
|
||
|  | ||
|
|
||
| 4. Select your authentication method, and input the required credentials: | ||
|
|
||
| <Tabs groupId="auth" defaultValue="basic" queryString values={ | ||
| [ | ||
| {label: 'Basic', value: 'basic' }, | ||
| {label: 'OAuth', value: 'oauth' } | ||
| ]}> | ||
|
|
||
| <TabItem value='basic'> | ||
|
|
||
| For **basic authentication**, input your username and password: | ||
|
|
||
|  | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem value='oauth'> | ||
|
|
||
| For **OAuth**, input the credentials for your OAuth provider. These are configured as part of the default [Helm installation](/self-managed/platform-deployment/helm-kubernetes/deploy.md) and can be discovered in [Identity](/self-managed/identity/what-is-identity.md), or are set by Zeebe [environment variables](/self-managed/zeebe-deployment/security/client-authorization.md#environment-variables). | ||
|
|
||
|  | ||
|
|
||
| | 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` | | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| 5. Select the **Remember** checkbox if you want to locally store the connection information. | ||
|
|
||
| 6. Click **Deploy** to perform the deployment. | ||
|
|
||
|  | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
|
|
||
|  | ||
|
|
||
| 2. Click **Camunda 8 Self-Managed**: | ||
|
|
||
|  | ||
|
|
||
| 3. Input the `Cluster endpoint`: | ||
|
|
||
| :::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). | ||
|
|
||
| ::: | ||
|
|
||
|  | ||
|
|
||
| 4. Select your authentication method, and input the required credentials: | ||
|
|
||
| <Tabs groupId="auth" defaultValue="basic" queryString values={ | ||
| [ | ||
| {label: 'Basic', value: 'basic' }, | ||
| {label: 'OAuth', value: 'oauth' } | ||
| ]}> | ||
|
|
||
| <TabItem value='basic'> | ||
|
|
||
| For **basic authentication**, input your username and password: | ||
|
|
||
|  | ||
|
|
||
| </TabItem> | ||
|
|
||
| <TabItem value='oauth'> | ||
|
|
||
| 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](/self-managed/identity/what-is-identity.md), or are set by Zeebe [environment variables](/self-managed/zeebe-deployment/security/client-authorization.md#environment-variables). | ||
|
|
||
|  | ||
|
|
||
| | 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` | | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| 5. Select the **Remember** checkbox if you want to locally store the connection information. | ||
|
|
||
| 6. Click **Deploy** to perform the deployment. | ||
|
|
||
|  | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Input or enter? Just checking input is the correct term here 👍