feat: versions 8.3/3.11.0 #2717

pepopowitz · 2023-10-09T19:36:43Z

Description

Part of #2432.

Releases versions 8.3 and 3.11.0!

This branch is the whole enchilada, with all the content duplicated into new 8.3 and 3.11.0 folders. It will be merged after the corresponding reviewable PR is merged into it.

When should this change go live?

This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
There is no urgency with this change.
This change or page is part of a marketing blog, conference talk, or something else on a schedule.
This functionality is already available but undocumented.
This is a bug fix or security concern.

PR Checklist

I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

github-actions · 2023-10-09T19:38:18Z

versioned_docs/version-8.3/apis-tools/operate-api/overview.md

+| authorization server url | Token issuer server                             | -                    |
+
+:::note
+For more information on how to get these values for Camunda 8, read [Manage API Clients](/docs/components/console/manage-clusters/manage-api-clients/).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'Manage API Clients'. Please specify the file extension.

github-actions · 2023-10-09T19:38:18Z

versioned_docs/version-8.3/apis-tools/operate-api/overview.md

+
+#### Authentication via Identity JWT access token
+
+This authentication method is described in [Operate Configuration - Authentication](/docs/self-managed/operate-deployment/operate-authentication/#identity).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'Operate Configuration - Authentication'. Please specify the file extension.

github-actions · 2023-10-09T19:38:18Z

versioned_docs/version-8.3/apis-tools/tasklist-api/tasklist-api-overview.md

+
+## Authentication for Self-Managed cluster
+
+The authentication is described in [Tasklist Configuration - Authentication](/docs/self-managed/tasklist-deployment/tasklist-authentication/#identity).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'Tasklist Configuration - Authentication'. Please specify the file extension.

github-actions · 2023-10-09T19:38:19Z

versioned_docs/version-8.3/apis-tools/console-api-reference.md

+- **IP Whitelist**: Configure [IP-Whitelist](../components/console/manage-clusters/manage-ip-whitelists.md) rules.
+- **Connector Secrets**: [Manage secrets](../components/console/manage-clusters/manage-secrets.md) of your clusters.
+- **Members**: [Manage members](../components/console/manage-organization/manage-users.md) of your organization.
+- **Backups**: Manage [backups](https://docs.camunda.io/docs/components/concepts/backups) of your Camunda 8 clusters (only available to Enterprise customers).


⚠️ [vale] _{reported by reviewdog 🐶}
[all.hrefProduction] Improper link format: 'backups'. Please use relative URLs.

github-actions · 2023-10-09T19:38:19Z

versioned_docs/version-8.3/apis-tools/go-client/go-get-started.md

+- Set the **type** of the second task to `fetcher-service`.
+- Set the **type** of the third task to `shipping-service`.
+
+6. Additionally, for the service task `Collect Money` set a [**task-header**](/docs/next/components/modeler/bpmn/service-tasks/#task-headers) with the key `method` and the value `VISA`. This header is used as a configuration parameter for the payment-service worker to hand over the payment method.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'task-header'. Please specify the file extension.

github-actions · 2023-10-09T19:38:21Z

versioned_docs/version-8.3/components/concepts/workflow-patterns.md

+
+A typical situation is that a process needs to wait for some event to happen, e.g. some time to pass or some external message to arrive. This is related to [Workflow Pattern 23: Transient Trigger](http://www.workflowpatterns.com/patterns/control/new/wcp23.php).
+
+In BPMN, this is implemented using [events](/docs/components/modeler/bpmn/events/) (or [receive tasks](/docs/components/modeler/bpmn/receive-tasks/)):


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'receive tasks'. Please specify the file extension.

github-actions · 2023-10-09T19:38:21Z

versioned_docs/version-8.3/components/concepts/workflow-patterns.md

+
+<span className="callout">1</span>
+
+The timer event causes the process to wait, in this case until a specific point in time is due or some duration has elapsed. Refer to [timer events](/docs/components/modeler/bpmn/timer-events/) for more details.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'timer events'. Please specify the file extension.

github-actions · 2023-10-09T19:38:21Z

versioned_docs/version-8.3/components/concepts/workflow-patterns.md

+
+<span className="callout">2</span>
+
+The process will wait for a message to arrive. The message is an external trigger provided by API and can technically be anything, from a callback (e.g. via REST), over real messaging (like AMQP), or to notifications within your system. Refer to [message events](/docs/components/modeler/bpmn/message-events/) for more details.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'message events'. Please specify the file extension.

github-actions · 2023-10-09T19:38:21Z

versioned_docs/version-8.3/components/concepts/workflow-patterns.md

+
+The process will wait for a message to arrive. The message is an external trigger provided by API and can technically be anything, from a callback (e.g. via REST), over real messaging (like AMQP), or to notifications within your system. Refer to [message events](/docs/components/modeler/bpmn/message-events/) for more details.
+
+You can read more about events in [our BPMN primer: events - waiting for something to happen](/docs/components/modeler/bpmn/bpmn-primer/#events-waiting-for-something-to-happen).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'our BPMN primer: events - waiting for something to happen'. Please specify the file extension.

github-actions · 2023-10-09T19:38:21Z

versioned_docs/version-8.3/components/concepts/workflow-patterns.md

+
+You want to react if a certain point in time is due or a specific time duration has passed. This is related to [Workflow Pattern 23: Transient Trigger](http://www.workflowpatterns.com/patterns/control/new/wcp23.php).
+
+In BPMN, you can leverage [boundary events](/docs/components/modeler/bpmn/events/#boundary-events) or [event subprocesses](/docs/components/modeler/bpmn/event-subprocesses/).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'boundary events'. Please specify the file extension.

pepopowitz · 2023-10-09T20:05:09Z

These vale comments are amazing!!!

I'm going to ignore them, though. I will fix them in a follow-up. It is nice to see all the problematic URLs for this new version (and its predecessor) in one place, that's for sure.

* chore: update cutNewVersions with new version numbers * version: sidebars * version: version manifests * version: redirects * chore: show/hide correct version banners, and customize the label for Optimize 3.11 * chore: redirects for content that moved between 8.2 and 8.3 * oops: swap the version numbers for 8.3 label * fix: map new versions to each other so cross-instance shortcuts can be resolved

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

github-actions · 2023-10-09T20:25:53Z

versioned_docs/version-8.3/components/best-practices/development/writing-good-workers.md

+description: "Service tasks within Camunda 8 require you to set a task type and implement job workers who perform whatever needs to be performed."
+---
+
+[Service tasks](/docs/components/modeler/bpmn/service-tasks/) within Camunda 8 require you to set a task type and implement [job workers](/docs/components/concepts/job-workers) who perform whatever needs to be performed. This describes that you might want to:


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'Service tasks'. Please specify the file extension.

github-actions · 2023-10-09T20:25:53Z

versioned_docs/version-8.3/components/best-practices/development/writing-good-workers.md

+description: "Service tasks within Camunda 8 require you to set a task type and implement job workers who perform whatever needs to be performed."
+---
+
+[Service tasks](/docs/components/modeler/bpmn/service-tasks/) within Camunda 8 require you to set a task type and implement [job workers](/docs/components/concepts/job-workers) who perform whatever needs to be performed. This describes that you might want to:


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'job workers'. Please specify the file extension.

github-actions · 2023-10-09T20:25:53Z

versioned_docs/version-8.3/components/best-practices/development/writing-good-workers.md

+1. Minimize what data you read for your job. In your job client, you can define which process variables you will need in your worker, and only these will be read and transferred, saving resources on the broker as well as network bandwidth.
+2. Minimize what data you write on job completion. You should explicitly not transmit the input variables of a job upon completion, which might happen easily if you simply reuse the map of variables you received as input for submitting the result.
+
+Not transmitting all variables saves resources and bandwidth, but serves another purpose as well: upon job completion, these variables are written to the process and might overwrite existing variables. If you have parallel paths in your process (e.g. [parallel gateway](/docs/components/modeler/bpmn//parallel-gateways/), [multiple instance](/docs/components/modeler/bpmn/multi-instance/)) this can lead to race conditions that you need to think about. The less data you write, the smaller the problem.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'parallel gateway'. Please specify the file extension.

github-actions · 2023-10-09T20:25:53Z

versioned_docs/version-8.3/components/best-practices/development/writing-good-workers.md

+1. Minimize what data you read for your job. In your job client, you can define which process variables you will need in your worker, and only these will be read and transferred, saving resources on the broker as well as network bandwidth.
+2. Minimize what data you write on job completion. You should explicitly not transmit the input variables of a job upon completion, which might happen easily if you simply reuse the map of variables you received as input for submitting the result.
+
+Not transmitting all variables saves resources and bandwidth, but serves another purpose as well: upon job completion, these variables are written to the process and might overwrite existing variables. If you have parallel paths in your process (e.g. [parallel gateway](/docs/components/modeler/bpmn//parallel-gateways/), [multiple instance](/docs/components/modeler/bpmn/multi-instance/)) this can lead to race conditions that you need to think about. The less data you write, the smaller the problem.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'multiple instance'. Please specify the file extension.

github-actions · 2023-10-09T20:25:53Z

versioned_docs/version-8.3/components/concepts/workflow-patterns.md

+
+You want to react if a certain point in time is due or a specific time duration has passed. This is related to [Workflow Pattern 23: Transient Trigger](http://www.workflowpatterns.com/patterns/control/new/wcp23.php).
+
+In BPMN, you can leverage [boundary events](/docs/components/modeler/bpmn/events/#boundary-events) or [event subprocesses](/docs/components/modeler/bpmn/event-subprocesses/).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'event subprocesses'. Please specify the file extension.

github-actions · 2023-10-09T20:25:56Z

...ioned_docs/version-8.3/components/best-practices/development/service-integration-patterns.md

+
+In practice, however, using the internal job instance key is not a big problem if you get responses in very short time frames (milliseconds). Whenever you have more long-running interactions, you should consider using send and receive tasks, or build your own lookup table that can also address the problems mentioned above.
+
+This is also balanced by the fact that service tasks are simply very handy. The concept is by far the easiest way to implement asynchronous request/response communication. The job instance key is generated for you and unique for every message interchange. You don’t have to think about race conditions or idempotency constraints yourself. [Timeout handling and retry logic](/docs/components/concepts/job-workers#timeouts) is built into the service task implementation of Zeebe. There is also [a clear API to let the workflow engine know of technical or business errors](/docs/components/concepts/job-workers#completing-or-failing-jobs).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'Timeout handling and retry logic'. Please specify the file extension.

github-actions · 2023-10-09T20:25:56Z

...ioned_docs/version-8.3/components/best-practices/development/service-integration-patterns.md

+
+In practice, however, using the internal job instance key is not a big problem if you get responses in very short time frames (milliseconds). Whenever you have more long-running interactions, you should consider using send and receive tasks, or build your own lookup table that can also address the problems mentioned above.
+
+This is also balanced by the fact that service tasks are simply very handy. The concept is by far the easiest way to implement asynchronous request/response communication. The job instance key is generated for you and unique for every message interchange. You don’t have to think about race conditions or idempotency constraints yourself. [Timeout handling and retry logic](/docs/components/concepts/job-workers#timeouts) is built into the service task implementation of Zeebe. There is also [a clear API to let the workflow engine know of technical or business errors](/docs/components/concepts/job-workers#completing-or-failing-jobs).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'a clear API to let the workflow engine know of technical or business errors'. Please specify the file extension.

github-actions · 2023-10-09T20:25:56Z

...ioned_docs/version-8.3/components/best-practices/development/service-integration-patterns.md

+
+**Technical implications of using send and receive tasks**
+
+Using send and receive tasks means to use [the message concept built into Zeebe](/docs/components/concepts/messages). This is a powerful concept to solve a lot of problems around cardinalities of subscriptions, correlation of the message to the right process instances, and verification of uniqueness of the message (idempotency).


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'the message concept built into Zeebe'. Please specify the file extension.

github-actions · 2023-10-09T20:25:56Z

...ioned_docs/version-8.3/components/best-practices/development/service-integration-patterns.md

+
+When using messages, you need to provide the correlation id yourself. This means that the correlation id is fully under your control, but it also means that you need to generate it yourself and make sure it is unique. You will most likely end up with generated UUIDs.
+
+You can leverage [message buffering](/docs/components/concepts/messages#message-buffering) capabilities, which means that the process does not yet need to be ready to receive the message. You could, for example, do other things in between, but this also means that you will not get an exception right away if a message cannot be correlated, as it is simply buffered. This leaves you in charge of dealing with messages that can never be delivered.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'message buffering'. Please specify the file extension.

github-actions · 2023-10-09T20:25:56Z

...ioned_docs/version-8.3/components/best-practices/development/service-integration-patterns.md

+
+## Hiding technical complexity behind call activities
+
+Whenever technical details of one service integration become complicated, you can think of creating a separate process model for the technicalities of the call and use a [call activity](/docs/components/modeler/bpmn/call-activities/) in the main process.


⚠️ [vale] _{reported by reviewdog 🐶}
[docsInstance.hrefDocsToDocs] Improper link format: 'call activity'. Please specify the file extension.

version: new versions of docs

8c18df2

github-actions bot reviewed Oct 9, 2023

View reviewed changes

pepopowitz added the hold This issue is parked, do not merge. label Oct 9, 2023

pepopowitz self-assigned this Oct 9, 2023

pepopowitz mentioned this pull request Oct 9, 2023

version 8.3: reviewable steps #2718

Merged

9 tasks

pepopowitz removed the hold This issue is parked, do not merge. label Oct 9, 2023

pepopowitz changed the title ~~[HOLD] feat: versions 8.3/3.11.0~~ feat: versions 8.3/3.11.0 Oct 9, 2023

github-actions bot reviewed Oct 9, 2023

View reviewed changes

pepopowitz requested a review from christinaausley October 9, 2023 21:42

pepopowitz enabled auto-merge (squash) October 9, 2023 21:42

pepopowitz mentioned this pull request Oct 9, 2023

Release versions 8.3 #2432

Closed

christinaausley approved these changes Oct 9, 2023

View reviewed changes

pepopowitz merged commit 2b8731f into main Oct 9, 2023
8 of 9 checks passed

pepopowitz deleted the pepopowitz/cut-8-3 branch October 9, 2023 21:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: versions 8.3/3.11.0 #2717

feat: versions 8.3/3.11.0 #2717

pepopowitz commented Oct 9, 2023 •

edited

Loading

github-actions bot left a comment

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

pepopowitz commented Oct 9, 2023 •

edited

Loading

github-actions bot left a comment

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023

github-actions bot Oct 9, 2023


		#### Authentication via Identity JWT access token

		This authentication method is described in [Operate Configuration - Authentication](/docs/self-managed/operate-deployment/operate-authentication/#identity).


		## Authentication for Self-Managed cluster

		The authentication is described in [Tasklist Configuration - Authentication](/docs/self-managed/tasklist-deployment/tasklist-authentication/#identity).


		A typical situation is that a process needs to wait for some event to happen, e.g. some time to pass or some external message to arrive. This is related to [Workflow Pattern 23: Transient Trigger](http://www.workflowpatterns.com/patterns/control/new/wcp23.php).

		In BPMN, this is implemented using [events](/docs/components/modeler/bpmn/events/) (or [receive tasks](/docs/components/modeler/bpmn/receive-tasks/)):


		<span className="callout">1</span>

		The timer event causes the process to wait, in this case until a specific point in time is due or some duration has elapsed. Refer to [timer events](/docs/components/modeler/bpmn/timer-events/) for more details.


		<span className="callout">2</span>

		The process will wait for a message to arrive. The message is an external trigger provided by API and can technically be anything, from a callback (e.g. via REST), over real messaging (like AMQP), or to notifications within your system. Refer to [message events](/docs/components/modeler/bpmn/message-events/) for more details.


		The process will wait for a message to arrive. The message is an external trigger provided by API and can technically be anything, from a callback (e.g. via REST), over real messaging (like AMQP), or to notifications within your system. Refer to [message events](/docs/components/modeler/bpmn/message-events/) for more details.

		You can read more about events in [our BPMN primer: events - waiting for something to happen](/docs/components/modeler/bpmn/bpmn-primer/#events-waiting-for-something-to-happen).


		You want to react if a certain point in time is due or a specific time duration has passed. This is related to [Workflow Pattern 23: Transient Trigger](http://www.workflowpatterns.com/patterns/control/new/wcp23.php).

		In BPMN, you can leverage [boundary events](/docs/components/modeler/bpmn/events/#boundary-events) or [event subprocesses](/docs/components/modeler/bpmn/event-subprocesses/).


		In practice, however, using the internal job instance key is not a big problem if you get responses in very short time frames (milliseconds). Whenever you have more long-running interactions, you should consider using send and receive tasks, or build your own lookup table that can also address the problems mentioned above.

		This is also balanced by the fact that service tasks are simply very handy. The concept is by far the easiest way to implement asynchronous request/response communication. The job instance key is generated for you and unique for every message interchange. You don’t have to think about race conditions or idempotency constraints yourself. [Timeout handling and retry logic](/docs/components/concepts/job-workers#timeouts) is built into the service task implementation of Zeebe. There is also [a clear API to let the workflow engine know of technical or business errors](/docs/components/concepts/job-workers#completing-or-failing-jobs).


		Technical implications of using send and receive tasks

		Using send and receive tasks means to use [the message concept built into Zeebe](/docs/components/concepts/messages). This is a powerful concept to solve a lot of problems around cardinalities of subscriptions, correlation of the message to the right process instances, and verification of uniqueness of the message (idempotency).


		When using messages, you need to provide the correlation id yourself. This means that the correlation id is fully under your control, but it also means that you need to generate it yourself and make sure it is unique. You will most likely end up with generated UUIDs.

		You can leverage [message buffering](/docs/components/concepts/messages#message-buffering) capabilities, which means that the process does not yet need to be ready to receive the message. You could, for example, do other things in between, but this also means that you will not get an exception right away if a message cannot be correlated, as it is simply buffered. This leaves you in charge of dealing with messages that can never be delivered.


		## Hiding technical complexity behind call activities

		Whenever technical details of one service integration become complicated, you can think of creating a separate process model for the technicalities of the call and use a [call activity](/docs/components/modeler/bpmn/call-activities/) in the main process.

feat: versions 8.3/3.11.0 #2717

feat: versions 8.3/3.11.0 #2717

Conversation

pepopowitz commented Oct 9, 2023 • edited Loading

Description

When should this change go live?

PR Checklist

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

pepopowitz commented Oct 9, 2023 • edited Loading

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

github-actions bot Oct 9, 2023

Choose a reason for hiding this comment

pepopowitz commented Oct 9, 2023 •

edited

Loading

pepopowitz commented Oct 9, 2023 •

edited

Loading