Skip to content

Commit

Permalink
Merge branch 'main' into 870-alpha3-release-notes
Browse files Browse the repository at this point in the history
  • Loading branch information
mesellings authored Dec 17, 2024
2 parents 15875e2 + ea02f41 commit 37491f6
Show file tree
Hide file tree
Showing 60 changed files with 1,019 additions and 775 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -160,32 +160,37 @@ Only if the increased latency does not work for your use case, for example, beca
</tr>
<tr>
<td class="tableblock halign-center valign-top" colspan="2">
<p class="tableblock">Call a named bean or java class implementing the
<p class="tableblock">
Call a named bean or java class implementing the
<code>JavaDelegate</code> interface.
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">Evaluate an expression using JUEL.</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">Use a configurable Connector
<p class="tableblock">
Use a configurable Connector
<br />
(REST or SOAP services provided out-of-the-box).
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">Pull a service task into an external worker thread and inform process engine of
completion.</p>
<p class="tableblock">
Pull a service task into an external worker thread and inform process engine of
completion.
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">Execute a script inside the engine.</p>
</td>
</tr>
<tr>
<th class="tableblock halign-left valign-top">
<p class="tableblock">Use with
<p class="tableblock">
Use with
<br />
BPMN elements.
BPMN elements.
</p>
</th>
<th class="tableblock halign-center valign-middle" colspan="5">
Expand Down Expand Up @@ -252,17 +257,20 @@ completion.</p>
</tr>
<tr>
<th class="tableblock halign-left valign-top">
<p class="tableblock">Implement
<p class="tableblock">
Implement
<br />
via
via
</p>
</th>
<td class="tableblock halign-center valign-top" colspan="2">
<p class="tableblock">Java (in same JVM)</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">Expression Language
(can reference Java code)</p>
<p class="tableblock">
Expression Language
(can reference Java code)
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">BPMN configuration</p>
Expand Down Expand Up @@ -377,9 +385,11 @@ completion.</p>
<p class="tableblock">Configure via</p>
</th>
<td class="tableblock halign-center valign-top">
<p class="tableblock">BPMN Attribute
<p class="tableblock">
BPMN Attribute
<br />
<code>serviceTask
<code>
serviceTask
<br />
camunda:
<br />
Expand All @@ -390,9 +400,11 @@ completion.</p>
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">BPMN Attribute
<p class="tableblock">
BPMN Attribute
<br />
<code>serviceTask
<code>
serviceTask
<br />
camunda:
<br />
Expand All @@ -401,9 +413,11 @@ completion.</p>
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">BPMN Attribute
<p class="tableblock">
BPMN Attribute
<br />
<code>serviceTask
<code>
serviceTask
<br />
camunda:
<br />
Expand All @@ -412,9 +426,11 @@ completion.</p>
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">BPMN Ext. Element+
<p class="tableblock">
BPMN Ext. Element+
<code>serviceTask
<code>
serviceTask
<br />
camunda:
<br />
Expand All @@ -423,9 +439,11 @@ completion.</p>
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">BPMN Attributes
<p class="tableblock">
BPMN Attributes
<br />
<code>serviceTask
<code>
serviceTask
<br />
camunda:
<br />
Expand All @@ -438,13 +456,15 @@ completion.</p>
</p>
</td>
<td class="tableblock halign-center valign-top">
<p class="tableblock">BPMN Element
<p class="tableblock">
BPMN Element
<br />
<code>script</code> or
<br />
BPMN Attribute
<br />
<code>scriptTask
<code>
scriptTask
<br />
camunda:
<br />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -327,10 +327,11 @@ public class InvoiceMDB implements MessageListener {

The provided REST API can be directly used to communicate with the workflow engine remotely.

```
POST /process-definition/key/invoice/start

Request body:

```
{
"variables": {
"invoiceId" : {"value" : "123456", "type": "String"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ Camunda 8 supports the following binding types:
<li><p>This option ensures predictable behavior by tying the two versions together, and allows you to deploy future versions of the target resource without disrupting ongoing process instances.</p></li>
<li><p>It is ideal for self-contained projects without external or shared dependencies.</p></li>
<li>
<p>To use the <code>deployment</code> binding option, create and deploy a <a href="../../../modeler/web-modeler/process-applications/#deploy-and-run-a-process-application">process application in Web Modeler</a>,
<p>
To use the <code>deployment</code> binding option, create and deploy a <a href="../../../modeler/web-modeler/process-applications/#deploy-and-run-a-process-application">process application in Web Modeler</a>,
or deploy multiple resources together via the <a href="../../../../apis-tools/zeebe-api/gateway-service/#deployresource-rpc"> Zeebe API</a>.
</p>
</li>
Expand Down
24 changes: 13 additions & 11 deletions docs/components/concepts/process-instance-creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ This command creates a new process instance and immediately responds with the pr

![create-process](assets/create-process.png)

<details>
<summary>Code example</summary>
<p>Create a process instance:
<details>
<summary>Code example</summary>
<p>
Create a process instance:

```
zbctl create instance "order-process"
Expand All @@ -38,16 +39,16 @@ Response:

```
{
"processKey": 2251799813685249,
"bpmnProcessId": "order-process",
"version": 1,
"processInstanceKey": 2251799813686019
"processKey": 2251799813685249,
"bpmnProcessId": "order-process",
"version": 1,
"processInstanceKey": 2251799813686019
}
```

</p>
</details>
</p>
</details>

### Create and await results

Expand All @@ -67,7 +68,8 @@ When the client resends the command, it creates a new process instance.

<details>
<summary>Code example</summary>
<p>Create a process instance and await results:
<p>
Create a process instance and await results:

```
zbctl create instance "order-process" --withResult --variables '{"orderId": "1234"}'
Expand Down Expand Up @@ -123,7 +125,7 @@ Start instructions are supported for both `CreateProcessInstance` commands.
<details>
<summary>Code example</summary>
<p>
Create a process instance starting before the 'ship_parcel' element:
Create a process instance starting before the 'ship_parcel' element:

```java
client.newCreateInstanceCommand()
Expand Down
4 changes: 2 additions & 2 deletions docs/components/connectors/out-of-the-box-connectors/email.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ object with a field and a value.
- If an operator is set, the criteria array must also be defined.
- Each criterion within the criteria array is applied to the specified field based on the value associated with it.

:::note
:::

#### Example Response

Expand Down Expand Up @@ -559,7 +559,7 @@ object with a field and a value.
- If an operator is set, the criteria array must also be defined.
- Each criterion within the criteria array is applied to the specified field based on the value associated with it.

:::note
:::

#### Example Response

Expand Down
2 changes: 1 addition & 1 deletion docs/components/early-access/alpha/sap/odata-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,4 @@ If the SAP OData Connector encounters an error, the boundary event will catch th

- Ensure the connection from the Cloud Foundry environment via the destination to the SAP systems works. Using the [Terminal in Business Application Studio](https://community.sap.com/t5/technology-blogs-by-sap/how-to-check-the-connectivity-to-your-backend-system-in-business/ba-p/13479832) is a quick way to verify this.
- Validate requests first in an API client before trying with the SAP OData Connector in Modeler. Then, copy over to the element template fields. This saves time and reduces potential error.
- Any payload size <= 2.5MB can be considered safe.
- Any payload size &lt;= 2.5MB can be considered safe.
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Set Output Variable {variableName} {value}

### Parameters

- {variable_name}: The name of the variable you want to set or update.
- {value}: The value you want to assign to the variable.
- \{variable_name}: The name of the variable you want to set or update.
- \{value}: The value you want to assign to the variable.

### Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ These events include the following properties:

- `diagramType`: BPMN, DMN, or Form
- Engine profile:
- `executionPlatform`: <target platform\>
- `executionPlatformVersion`: <target platform version\>
- `executionPlatform`: &lt;target platform\>
- `executionPlatformVersion`: &lt;target platform version\>

In the case of a form, the payload also includes the `formFieldTypes`:

Expand All @@ -78,8 +78,8 @@ The `Deployment Event` and `Start Instance` have the following properties:

- `diagramType`: BPMN, DMN, or Form
- Engine profile:
- `executionPlatform`: <target platform\>
- `executionPlatformVersion`: <target platform version\>
- `executionPlatform`: &lt;target platform\>
- `executionPlatformVersion`: &lt;target platform version\>

In the event of an unsuccessful deployment, an `error` property will be present in the payload containing an error code.

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/notices.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ Tasklist

The REST API functionality of Tasklist 8.2.0 and 8.2.1 allows unauthenticated access to the following methods/URLs:

- GET /v1/tasks/{taskId}
- GET /v1/tasks/\{taskId}
- POST /v1/tasks/search
- POST /v1/tasks/{taskId}/variables/search
- POST /v1/forms/{formId}
- POST /v1/variables/{variableId}
- POST /v1/tasks/\{taskId}/variables/search
- POST /v1/forms/\{formId}
- POST /v1/variables/\{variableId}

Find more information about the methods in our [Tasklist REST API documentation](/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ sidebar_label: "Connect to an existing Keycloak instance"
description: "Learn how to connect Identity to your existing Keycloak instance."
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

In this guide, we'll demonstrate how to connect Identity to your existing Keycloak instance.

## Prerequisites

- Access to your [Keycloak Admin Console](https://www.keycloak.org/docs/23.0.1/server_admin/#using-the-admin-console)
- A basic understanding of [administering realms and clients](https://www.keycloak.org/docs/23.0.1/server_admin/#assembly-managing-clients_server_administration_guide) in Keycloak.
- Access to your [Keycloak Admin Console](https://www.keycloak.org/docs/latest/server_admin/#using-the-admin-console)
- A basic understanding of [administering realms and clients](https://www.keycloak.org/docs/latest/server_admin/#assembly-managing-clients_server_administration_guide) in Keycloak

:::note
Clients in Camunda 8 SaaS and applications in Camunda 8 Self-Managed provide a similar purpose. One key difference is that for Camunda 8 SaaS, you can set up specific [client connection credentials](/guides/setup-client-connection-credentials.md), whereas in Identity, an application is created with credentials automatically assigned.
Expand All @@ -24,7 +27,15 @@ As of the 8.5.3 release, Identity uses the Keycloak frontend URL instead of the
To avoid connectivity issues, ensure your Keycloak frontend URL is accessible by adjusting your network, firewall, or security settings as needed. This adjustment is crucial to maintain the integration with Keycloak and ensure compatibility.
:::

To connect Identity to an existing Keycloak instance, take the following steps:
To connect Identity to an existing Keycloak instance, take the following steps for your Camunda installation:

<Tabs groupId="install" defaultValue="non-helm" queryString values={
[
{label: 'Non-Helm installations', value: 'non-helm' },
{label: 'Helm installations', value: 'helm' },
]}>

<TabItem value='non-helm'>

1. Log in to your Keycloak Admin Console.
2. Select the realm you would like to connect Identity to. In our example, this is **camunda-platform**.
Expand Down Expand Up @@ -56,6 +67,18 @@ To connect Identity to an existing Keycloak instance, take the following steps:
:::
13. Start Identity.

</TabItem>
<TabItem value="helm">

1. Log in to your Keycloak Admin Console.
2. Verify the name of the realm you would like to connect Identity to. In our example, this is **camunda-platform**.
![keycloak-admin-realm-select](../img/keycloak-admin-realm-select.png)
3. Set the `KEYCLOAK_REALM` [environment variable](/self-managed/identity/deployment/configuration-variables.md) to the realm you selected in **Step 2**.
4. Start Identity.

</TabItem>
</Tabs>

:::note What does Identity create when starting?
Identity creates a base set of configurations required to function successfully. To understand more about what is created and why, see [the starting configuration](/self-managed/identity/deployment/starting-configuration.md).
:::
Expand Down
10 changes: 5 additions & 5 deletions docs/self-managed/operational-guides/update-guide/840-to-850.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ Note that there is **no** actual corruption or data loss, however.

The broker health check routes have moved, and the old routes are now deprecated. Specifically, the following routes will return [a status code of 301](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301) and redirect you. See the table below about the new mappings:

| Old route | **New route** |
| --------------------------------------- | ------------------------------------------------------------- |
| http://{zeebe-broker-host}:9600/health | **http://{zeebe-broker-host}:9600/actuator/health/status** |
| http://{zeebe-broker-host}:9600/ready | **http://{zeebe-broker-host}:9600/actuator/health/readiness** |
| http://{zeebe-broker-host}:9600/startup | **http://{zeebe-broker-host}:9600/actuator/health/startup** |
| Old route | **New route** |
| ---------------------------------------- | -------------------------------------------------------------- |
| http://\{zeebe-broker-host}:9600/health | **http://\{zeebe-broker-host}:9600/actuator/health/status** |
| http://\{zeebe-broker-host}:9600/ready | **http://\{zeebe-broker-host}:9600/actuator/health/readiness** |
| http://\{zeebe-broker-host}:9600/startup | **http://\{zeebe-broker-host}:9600/actuator/health/startup** |

Please migrate to the new routes in your deployments. **If you're using the official Helm charts, then you don't have to do anything here.**

Expand Down
6 changes: 4 additions & 2 deletions docs/self-managed/zeebe-deployment/configuration/gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,8 @@ Each interceptor should be configured with the values described below:
</tr>
<tr>
<td>className</td>
<td>Entry point of the interceptor, a class which must:
<td>
Entry point of the interceptor, a class which must:
<li>implement <a href="https://grpc.github.io/grpc-java/javadoc/io/grpc/ServerInterceptor.html">io.grpc.ServerInterceptor</a></li>
<li>have public visibility</li>
<li>have a public default constructor (i.e. no-arg constructor)</li>
Expand Down Expand Up @@ -457,7 +458,8 @@ Each filter should be configured with the values described below:
</tr>
<tr>
<td>className</td>
<td>Entry point of the filter, a class which must:
<td>
Entry point of the filter, a class which must:
<li>implement <a href="https://www.javadoc.io/doc/jakarta.servlet/jakarta.servlet-api/6.0.0/jakarta.servlet/jakarta/servlet/Filter.html">jakarta.servlet.Filter</a></li>
<li>have public visibility</li>
<li>have a public default constructor (i.e. no-arg constructor)</li>
Expand Down
Loading

0 comments on commit 37491f6

Please sign in to comment.