Skip to content

Commit

Permalink
Merge branch 'main' into docs-rename-console
Browse files Browse the repository at this point in the history
  • Loading branch information
christinaausley authored Sep 7, 2023
2 parents 21e11bb + e6b82d3 commit 282ed8c
Show file tree
Hide file tree
Showing 151 changed files with 1,342 additions and 1,330 deletions.
2 changes: 1 addition & 1 deletion docs/apis-tools/go-client/go-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -538,5 +538,5 @@ processDefinitionKey:2251799813685255 bpmnProcessId:"order-process-4" version:

## What's next?

- Learn more about the [concepts behind Zeebe](/components/concepts/what-is-camunda-platform-8.md).
- Learn more about the [concepts behind Zeebe](/components/concepts/what-is-camunda-8.md).
- Learn more about [BPMN processes](/components/modeler/bpmn/bpmn-primer.md).
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ There are several _advantages using the greenfield stack_:

### Considering Camunda Platform 8 instead

Camunda Platform 8 is an alternative process automation offering that catches up on funcationality quickly. For new projects, consider using Camunda Platform 8 from the start. You can find [a quick comparison of concepts in the docs](/guides/migrating-from-camunda-platform-7/conceptual-differences.md). Note that architecturally, the recommended greenfield stack in this best practice is close to what you do using Camunda Platform 8.
Camunda Platform 8 is an alternative process automation offering that catches up on funcationality quickly. For new projects, consider using Camunda Platform 8 from the start. You can find [a quick comparison of concepts in the docs](/guides/migrating-from-camunda-7/conceptual-differences.md). Note that architecturally, the recommended greenfield stack in this best practice is close to what you do using Camunda Platform 8.

### Getting started with the greenfield stack

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ One advantage of using Java delegates is that, if you develop in Java, this is a
### General recommendation
In general, we _recommend to use external tasks_ to apply a general architecture and mindset, that allows to [leverage Camunda Platform 8 easier](/guides/migrating-from-camunda-platform-7/migration-readiness.md#prepare-for-smooth-migrations). This typically outweights the following downsides of external tasks:
In general, we _recommend to use external tasks_ to apply a general architecture and mindset, that allows to [leverage Camunda Platform 8 easier](/guides/migrating-from-camunda-7/migration-readiness.md#prepare-for-smooth-migrations). This typically outweights the following downsides of external tasks:
- A slightly increased complexity for Java projects, because they have to handle seperate Java clients.
- A slightly increased overhead compared to Java delegates, as all comunication with the engine is remote, even if it runs in the same Java VM.
Expand Down
10 changes: 5 additions & 5 deletions docs/components/components-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ id: components-overview
title: Overview Components
sidebar_label: Overview Components
slug: /components/
description: "This section contains product manual content for each component in Camunda Platform 8, including conceptual content."
description: "This section contains product manual content for each component in Camunda 8, including conceptual content."
keywords: ["process automation tools"]
---

This section contains product manual content for each component in Camunda Platform 8, including conceptual content. Together, these components comprise the Camunda Platform 8 SaaS experience.
This section contains product manual content for each component in Camunda 8, including conceptual content. Together, these components comprise the Camunda 8 SaaS experience.

- [Concepts](concepts/what-is-camunda-platform-8.md) - Learn more about a variety of Camunda Platform 8 topics with this conceptual documentation on clusters, processes, job workers, workflow patterns, and more.
- [Concepts](concepts/what-is-camunda-8.md) - Learn more about a variety of Camunda 8 topics with this conceptual documentation on clusters, processes, job workers, workflow patterns, and more.
- [Console](console/introduction-to-console.md) - With this management application for the included products, create and delete clusters, manage API clients and alerts, and more.
- [Modeler](modeler/about-modeler.md) - Design and implement diagrams using Camunda's modeling tools, including Web Modeler and Desktop Modeler.
- [Connectors](connectors/introduction.md) - Integrate with external systems using these reusable building blocks.
- [Zeebe](zeebe/zeebe-overview.md) - Define processes graphically in BPMN 2.0, choose any gRPC-supported programming language to implement your workers, build processes that react to events from Apache Kafka, and more using this process automation engine powering Camunda Platform 8.
- [Zeebe](zeebe/zeebe-overview.md) - Define processes graphically in BPMN 2.0, choose any gRPC-supported programming language to implement your workers, build processes that react to events from Apache Kafka, and more using this process automation engine powering Camunda 8.
- [Operate](operate/operate-introduction.md) - Monitor and troubleshoot process instances running in Zeebe, and carry out key operations such as resolving incidents and updating process instance variables with Operate.
- [Tasklist](tasklist/introduction-to-tasklist.md) - Implement business processes alongside user tasks in Zeebe, and orchestrate human workflows critical to your business to reduce time-to-value for your process orchestration projects with this interface for manual work.
- [Optimize]($optimize$/components/what-is-optimize) - Geared toward business stakeholders, Optimize offers business intelligence tooling for Camunda enterprise customers. By leveraging data collected during process execution, users can collaboratively examine areas in business processes for improvement.
Expand All @@ -26,6 +26,6 @@ Additionally, Camunda hosts a section of [Best Practices](./best-practices/best-

:::note Looking for deployment guides?

Deployment guides for Camunda Platform 8 components are available in the [Self-Managed section](/self-managed/about-self-managed.md).
Deployment guides for Camunda 8 components are available in the [Self-Managed section](/self-managed/about-self-managed.md).

:::
12 changes: 6 additions & 6 deletions docs/components/concepts/backups.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: backups
title: "Backups"
description: "Learn more about Backups in Camunda Platform 8 SaaS."
description: "Learn more about Backups in Camunda 8 SaaS."
---

<span class="badge badge--enterprise-only">Camunda Platform Enterprise</span>
<span class="badge badge--enterprise-only">Camunda Enterprise</span>

You can use the backup feature of Camunda Platform 8 SaaS to regularly back up the state of all of its components (Zeebe, Operate, Tasklist, and Optimize) with _zero downtime_. In case of failures that lead to data loss, you can request to restore the backup.
You can use the backup feature of Camunda 8 SaaS to regularly back up the state of all of its components (Zeebe, Operate, Tasklist, and Optimize) with _zero downtime_. In case of failures that lead to data loss, you can request to restore the backup.

A Camunda Platform 8 SaaS backup consists of a data backup of Zeebe, Operate, Tasklist, Optimize, and the backup of exported Zeebe records in Elasticsearch. Since the data of these applications depend on each other, the backup must be consistent across all components. Therefore, the backup of a Camunda Platform 8 Cluster is taken as a whole.
A Camunda 8 SaaS backup consists of a data backup of Zeebe, Operate, Tasklist, Optimize, and the backup of exported Zeebe records in Elasticsearch. Since the data of these applications depend on each other, the backup must be consistent across all components. Therefore, the backup of a Camunda 8 Cluster is taken as a whole.

With backups, you can capture snapshots of your data and applications while they are actively in use, resulting in zero downtime or disruption to your operations. Backups are designed specifically for disaster recovery purposes. Backups should not be used for archival of process data.

Expand Down Expand Up @@ -38,9 +38,9 @@ The backup operations can be performed programmatically using the Console API. T

## Restore

If you need to restore your Camunda Platform 8 Cluster from a backup, please follow these steps:
If you need to restore your Camunda 8 Cluster from a backup, please follow these steps:

1. [Contact Camunda support](https://camunda.com/services/support/) to request a restore for your backup.
1. Our support team will assist you with the restoration process and guide you through the necessary steps to recover your cluster from the backup.
2. Our support team will assist you with the restoration process and guide you through the necessary steps to recover your cluster from the backup.

For any further assistance or questions related to backups or restorations, please feel free to reach out to our support team.
4 changes: 2 additions & 2 deletions docs/components/concepts/clusters.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: clusters
title: "Clusters"
description: "Learn more about the clusters available in your Camunda Platform 8 plan."
description: "Learn more about the clusters available in your Camunda 8 plan."
---

A cluster is a provided group of nodes that run Camunda Platform 8. By default, Camunda Platform 8 clusters are production-ready.
A cluster is a provided group of nodes that run Camunda 8. By default, Camunda 8 clusters are production-ready.

Professional and Enterprise plan customers can create as many production or development clusters as they want.

Expand Down
4 changes: 2 additions & 2 deletions docs/components/concepts/data-retention.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: data-retention
title: "Data retention"
description: "In Camunda Platform 8 SaaS, the following data retention strategies are implemented. This is necessary as the amount of data can grow significantly over time."
description: "In Camunda 8 SaaS, the following data retention strategies are implemented. This is necessary as the amount of data can grow significantly over time."
---

In Camunda Platform 8 SaaS, the following data retention strategies are implemented. This is necessary as the amount of data can grow significantly overtime. These settings are a balance between performance and usability.
In Camunda 8 SaaS, the following data retention strategies are implemented. This is necessary as the amount of data can grow significantly overtime. These settings are a balance between performance and usability.

## Default retention time of each application

Expand Down
2 changes: 1 addition & 1 deletion docs/components/concepts/expressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ An expression is written in **FEEL** (**Friendly Enough Expression Language**).
- Simple syntax designed for business professionals and developers
- Three-valued logic (true, false, null)

Camunda Platform 8 integrates the [FEEL Scala](https://github.com/camunda/feel-scala) engine to evaluate FEEL expressions. The following sections cover common use cases in Zeebe. A complete list of supported expressions can be found in [FEEL expressions](/components/modeler/feel/what-is-feel.md).
Camunda 8 integrates the [FEEL Scala](https://github.com/camunda/feel-scala) engine to evaluate FEEL expressions. The following sections cover common use cases in Zeebe. A complete list of supported expressions can be found in [FEEL expressions](/components/modeler/feel/what-is-feel.md).

### Access variables

Expand Down
2 changes: 1 addition & 1 deletion docs/components/concepts/incidents.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Incidents"
description: "A process instance is stuck at a particular point, and requires user interaction to resolve the problem."
---

In Camunda Platform 8, an incident represents a problem in process execution. This means a process instance is stuck at a particular point, and requires user interaction to resolve the problem.
In Camunda 8, an incident represents a problem in process execution. This means a process instance is stuck at a particular point, and requires user interaction to resolve the problem.

Incidents are created in different situations, including the following:

Expand Down
6 changes: 3 additions & 3 deletions docs/components/concepts/job-workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A job has the following properties:

Job workers request jobs of a certain type on a regular interval (i.e. polling). This interval and the number of jobs requested are configurable in the Zeebe client.

If one or more jobs of the requested type are available, Zeebe (the workflow engine inside Camunda Platform 8) will stream activated jobs to the worker. Upon receiving jobs, a worker performs them and sends back a `complete` or `fail` command for each job, depending on if the job could be completed successfully.
If one or more jobs of the requested type are available, Zeebe (the workflow engine inside Camunda 8) will stream activated jobs to the worker. Upon receiving jobs, a worker performs them and sends back a `complete` or `fail` command for each job, depending on if the job could be completed successfully.

For example, the following process might generate three different types of jobs: `process-payment`, `fetch-items`, and `ship-parcel`:

Expand Down Expand Up @@ -56,13 +56,13 @@ With **long polling**, a request will be kept open while no jobs are available.

Zeebe decouples creation of jobs from performing the work on them. It is always possible to create jobs at the highest possible rate, regardless if there is a job worker available to work on them. This is possible because Zeebe queues jobs until workers request them.

This increases the resilience of the overall system. Camunda Platform 8 is highly available so job workers don't have to be highly available. Zeebe queues all jobs during any job worker outages, and progress will resume as soon as workers come back online.
This increases the resilience of the overall system. Camunda 8 is highly available so job workers don't have to be highly available. Zeebe queues all jobs during any job worker outages, and progress will resume as soon as workers come back online.

This also insulates job workers against sudden bursts in traffic. Because workers request jobs, they have full control over the rate at which they take on new jobs.

## Completing or failing jobs

After working on an activated job, a job worker informs Camunda Platform 8 that the job has either `completed` or `failed`.
After working on an activated job, a job worker informs Camunda 8 that the job has either `completed` or `failed`.

- When the job worker completes its work, it sends a `complete job` command along with any variables, which in turn is merged into the process instance. This is how the job worker exposes the results of its work.
- If the job worker can not successfully complete its work, it sends a `fail job` command. Fail job commands include the number of remaining retries, which is set by the job worker.
Expand Down
16 changes: 8 additions & 8 deletions docs/components/concepts/outbound-connectors-job-workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,28 @@ If they both share the same core functionality, how do they differ, and when sho
## Delivery

A Connector is reusable code, written as an `OutboundConnectorFunction` using the [Connector SDK](/components/connectors/custom-built-connectors/connector-sdk.md#runtime-logic).
It is not a standalone application, you cannot start it and have it work on Camunda Platform 8 jobs.
It is not a standalone application, you cannot start it and have it work on Camunda 8 jobs.
Instead, a Connector is delivered as a library and can be used in combination with other Connectors in a [Connector runtime environment](/components/connectors/custom-built-connectors/connector-sdk.md#runtime-environments).

In contrast, a job worker is usually part of a Zeebe Client application that can be directly executed to work on jobs.

## Reusability

A job worker usually runs as or inside a standalone Zeebe Client. Without effort, you cannot simply run this in Camunda Platform 8 SaaS or any other environment.
A job worker usually runs as or inside a standalone Zeebe Client. Without effort, you cannot simply run this in Camunda 8 SaaS or any other environment.
As a Self-Managed user, you can run it standalone, but often not directly reuse the logic in your existing Zeebe Client that you might already have.
You can manually extract the job handler from the given job worker, but you also have to ensure that it is still working as expected afterward.

In contrast, a Connector itself is environment-agnostic. There is a runtime environment for Camunda Platform 8 SaaS that can wrap and call this Connector. As the Connector developer, you don't have to worry about this as the runtime takes care of it if you developed the Connector using the Connector SDK.
In contrast, a Connector itself is environment-agnostic. There is a runtime environment for Camunda 8 SaaS that can wrap and call this Connector. As the Connector developer, you don't have to worry about this as the runtime takes care of it if you developed the Connector using the Connector SDK.

You can also run the exact same Connector (without any modification) in Camunda Platform 8 Self-Managed; either as a standalone job worker, as additional job handler in your existing Zeebe Client application, or together with other Connectors in one Zeebe Client application.
You can also run the exact same Connector (without any modification) in Camunda 8 Self-Managed; either as a standalone job worker, as additional job handler in your existing Zeebe Client application, or together with other Connectors in one Zeebe Client application.
This all comes with the Connector SDK, and there is no additional code necessary to get started. However, if you need a custom environment, the Connector SDK provides a guide and default helpers to do that.

## Focus

A job worker is often a complete Zeebe Client application, dealing with environment tasks like handling variables in and out. The core logic of calling a defined URL is only part of the application.
Plus, it handles Camunda Platform 8-specific APIs like the job worker API to handle variables, complete executions, and throw errors.
Plus, it handles Camunda 8-specific APIs like the job worker API to handle variables, complete executions, and throw errors.

A Connector only consists of core business functionality. No environment tasks, no Camunda Platform 8 job worker-related code. You can run this from Camunda Platform 7 as well, if you have a runtime that takes care of this.
A Connector only consists of core business functionality. No environment tasks, no Camunda 8 job worker-related code. You can run this from Camunda 7 as well, if you have a runtime that takes care of this.
The Connector only needs input variables and access to secrets so they can be used in defined input attributes.

## Context
Expand All @@ -51,10 +51,10 @@ Having used one Connector template will make it easy for you to use the next one

It depends on your use case.

- Need access to a low-level API in Camunda Platform 8 to perform a very specific task? You are better off with job workers.
- Need access to a low-level API in Camunda 8 to perform a very specific task? You are better off with job workers.
- Want to write your worker logic in something other than Java? Job workers are your way to move forward.
- Want to create worker logic that is reusable in any environment? Write a Connector.
- Want to focus on your worker's logic and have no need for using low-level Camunda Platform 8 API? Write a Connector.
- Want to focus on your worker's logic and have no need for using low-level Camunda 8 API? Write a Connector.
- Want to provide a standardized modeling experience alongside your runtime behavior? Write a Connector.

## Learn more
Expand Down
Loading

0 comments on commit 282ed8c

Please sign in to comment.