Skip to content

Commit

Permalink
replace camunda/zeebe with camunda/camunda (#3829)
Browse files Browse the repository at this point in the history
Co-authored-by: Amara Graham <akeller@users.noreply.github.com>
  • Loading branch information
2 people authored and pepopowitz committed Oct 16, 2024
1 parent 50dc3db commit 1e70ea1
Show file tree
Hide file tree
Showing 15 changed files with 27 additions and 28 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.MD
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ the Apache Spark contributor guidelines, and the Kubernetes contributor guide.
[git]: https://git-scm.com/
[github]: https://skills.github.com/
[contributor license agreement]: https://cla-assistant.io/camunda-cloud/camunda-cloud-documentation
[code style guidelines]: https://github.com/camunda/zeebe/wiki/Code-Style
[code style guidelines]: https://github.com/camunda/camunda/wiki/Code-Style
[testing best practices]: https://docs.camunda.io/docs/apis-tools/java-client/zeebe-process-test/
[technical writing style guide]: ./howtos/technical-writing-styleguide.md
[pull requests and code review]: https://github.com/camunda/zeebe/wiki/Pull-Requests-and-Code-Reviews
[pull requests and code review]: https://github.com/camunda/camunda/wiki/Pull-Requests-and-Code-Reviews
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ On `open`, the job worker waits `pollInterval` milliseconds and then polls for `

When a poll fails with an error response, the job worker applies a backoff strategy. It waits for some time, after which it polls again for more jobs. This gives a Zeebe cluster some time to recover from a failure. In some cases, you may want to configure this backoff strategy to better fit your situation.

The retry delay (i.e. the time the job worker waits after an error before the next poll for new jobs) is provided by the [`BackoffSupplier`](https://github.com/camunda/zeebe/blob/1.3.14/clients/java/src/main/java/io/camunda/zeebe/client/api/worker/BackoffSupplier.java). You can replace it using the `.backoffSupplier()` method on the [`JobWorkerBuilder`](https://github.com/camunda/zeebe/blob/main/zeebe/clients/java/src/main/java/io/camunda/zeebe/client/api/worker/JobWorkerBuilderStep1.java).
The retry delay (i.e. the time the job worker waits after an error before the next poll for new jobs) is provided by the [`BackoffSupplier`](https://github.com/camunda/camunda/blob/1.3.14/clients/java/src/main/java/io/camunda/zeebe/client/api/worker/BackoffSupplier.java). You can replace it using the `.backoffSupplier()` method on the [`JobWorkerBuilder`](https://github.com/camunda/camunda/blob/main/zeebe/clients/java/src/main/java/io/camunda/zeebe/client/api/worker/JobWorkerBuilderStep1.java).

By default, the job worker uses an exponential backoff implementation, which you can configure using `BackoffSupplier.newBackoffBuilder()`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Furthermore, data is also sent Operate and Optimize, which store data in Elastic

The data you attach to a process instance (process variables) will influence disk space requirements. For example, it makes a big difference if you only add one or two strings (requiring ~ 1kb of space) to your process instances, or a full JSON document containing 1MB.

Assuming a [typical payload of 15 process variables (simple strings, numbers or booleans)](https://github.com/camunda/zeebe/blob/1.3.14/benchmarks/project/src/main/resources/bpmn/typical_payload.json) we measured the following approximations for disk space requirements using Camunda Cloud SaaS 1.2.4. Please note, that these are not exact numbers, but they might give you an idea what to expect:
Assuming a [typical payload of 15 process variables (simple strings, numbers or booleans)](https://github.com/camunda/camunda/blob/1.3.14/benchmarks/project/src/main/resources/bpmn/typical_payload.json) we measured the following approximations for disk space requirements using Camunda Cloud SaaS 1.2.4. Please note, that these are not exact numbers, but they might give you an idea what to expect:

* Zeebe: 75 kb / PI
* Operate: 57 kb / PI
Expand Down Expand Up @@ -141,7 +141,7 @@ Camunda Cloud defines three fixed hardware packages you can select from. The tab
| Max Total Number of Process Instances | 5.4 M | 5.4 M | |
| Approx resources provisioned **\*\*** | 15 vCPU, 20 GB mem, 640 GB disk | 28 vCPU, 50 GB mem, 640 GB disk | 56 vCPU, 85 GB mem, 1320 GB disk |

**\*** The numbers in the table where measured using Camunda Cloud 1.2.4 and [the official benchmark project](https://github.com/camunda/zeebe/tree/1.3.14/benchmarks). It uses a [ten task process](https://github.com/camunda/zeebe/blob/1.3.14/benchmarks/project/src/main/resources/bpmn/ten_tasks.bpmn). To calculate day-based metrics, a equal distribution over 24 hours is assumed.
**\*** The numbers in the table where measured using Camunda Cloud 1.2.4 and [the official benchmark project](https://github.com/camunda/camunda/tree/1.3.14/benchmarks). It uses a [ten task process](https://github.com/camunda/camunda/blob/1.3.14/benchmarks/project/src/main/resources/bpmn/ten_tasks.bpmn). To calculate day-based metrics, a equal distribution over 24 hours is assumed.


**\*\*** These are the resource limits configured in the Kubernetes cluster and are always subject to change.
Expand Down Expand Up @@ -227,5 +227,4 @@ If you are in doubt about which package to choose, you can do a load test with a

This is recommended if you exceed the above numbers of three million process instances per day.

You can look at the [Zeebe benchmark project](https://github.com/camunda/zeebe/blob/1.3.14/benchmarks/setup/README.md#benchmarking-camunda-cloud-saas). While this project will not run out-of-the-box (e.g. you need need to build starter and worker code yourself and use self-created Docker images), you can use it as a starting point for own endavours.

You can look at the [Zeebe benchmark project](https://github.com/camunda/camunda/blob/1.3.14/benchmarks/setup/README.md#benchmarking-camunda-cloud-saas). While this project will not run out-of-the-box (e.g. you need need to build starter and worker code yourself and use self-created docker images), you can use it as a starting point for own endavours.
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public void retrieveMoney(final JobClient client, final ActivatedJob job) {
}
```

In the background, a worker starts a polling component and [a thread pool](https://github.com/camunda-cloud/zeebe/blob/d24b31493b8e22ad3405ee183adfd5a546b7742e/clients/java/src/main/java/io/camunda/zeebe/client/impl/ZeebeClientImpl.java#L179-L183) to [handle the polled jobs](https://github.com/camunda/zeebe/blob/1.3.14/clients/java/src/main/java/io/camunda/zeebe/client/impl/worker/JobPoller.java#L109-L111). The [**default thread pool size is one**](https://github.com/camunda-cloud/zeebe/blob/760074f59bc1bcfb483fab4645501430f362a475/clients/java/src/main/java/io/camunda/zeebe/client/impl/ZeebeClientBuilderImpl.java#L49). If you need more, you can enable a thread pool:
In the background, a worker starts a polling component and [a thread pool](https://github.com/camunda-cloud/zeebe/blob/d24b31493b8e22ad3405ee183adfd5a546b7742e/clients/java/src/main/java/io/camunda/zeebe/client/impl/ZeebeClientImpl.java#L179-L183) to [handle the polled jobs](https://github.com/camunda/camunda/blob/1.3.14/clients/java/src/main/java/io/camunda/zeebe/client/impl/worker/JobPoller.java#L109-L111). The [**default thread pool size is one**](https://github.com/camunda-cloud/zeebe/blob/760074f59bc1bcfb483fab4645501430f362a475/clients/java/src/main/java/io/camunda/zeebe/client/impl/ZeebeClientBuilderImpl.java#L49). If you need more, you can enable a thread pool:

```java
ZeebeClient client = ZeebeClient.newClientBuilder()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ We use both the [Camunda Community Hub](https://github.com/Camunda-Community-Hub

If you built something for the Zeebe ecosystem, we encourage you to [add it to the Camunda Community Hub](https://github.com/Camunda-Community-Hub/community/issues/new?assignees=&labels=&template=new-community-extension-proposal-template.md&title=) using the **New Community Extension Proposal** template.

If you're interested in contributing to the main Zeebe repository (versus creating an extension that lives in its own repository), be sure to start with the [Contributing to Zeebe](https://github.com/camunda/zeebe/blob/main/CONTRIBUTING.md) guide in GitHub.
If you're interested in contributing to the main Zeebe repository (versus creating an extension that lives in its own repository), be sure to start with the [Contributing to Zeebe](https://github.com/camunda/camunda/blob/main/CONTRIBUTING.md) guide in GitHub.

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ configuration file.
Once an exporter is configured, the next time Zeebe is started the exporter starts receiving records. Note that it is only guaranteed to see records produced from that point on.

Find a reference implementation in the form of the Zeebe-maintained
[Elasticsearch exporter](https://github.com/camunda/zeebe/tree/1.3.14/exporters/elasticsearch-exporter).
[Elasticsearch exporter](https://github.com/camunda/camunda/tree/1.3.14/exporters/elasticsearch-exporter).

The main impact exporters have on a Zeebe cluster is that they remove the burden of persisting data indefinitely.

Expand All @@ -34,7 +34,7 @@ If no exporters are configured, Zeebe automatically erases data when it is not n

Regardless of how an exporter is loaded (whether through an external JAR or not),
all exporters interact in the same way with the broker, which is defined by the
[exporter interface](https://github.com/camunda/zeebe/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/Exporter.java).
[exporter interface](https://github.com/camunda/camunda/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/Exporter.java).

## Loading

Expand All @@ -61,7 +61,7 @@ Different exporters can therefore depend on the same third-party libraries witho

Exporter-specific configuration is handled through the exporter's `[exporters.args]`
nested map. This provides a simple `Map<String, Object>`, which is passed directly
in the form of a [configuration](https://github.com/camunda/zeebe/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/context/Configuration.java) object when the broker calls the `Exporter#configure(Configuration)` method.
in the form of a [configuration](https://github.com/camunda/camunda/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/context/Configuration.java) object when the broker calls the `Exporter#configure(Configuration)` method.

Configuration occurs at two different phases: during the broker startup phase, and
once every time a leader is elected for a partition.
Expand All @@ -71,7 +71,7 @@ once every time a leader is elected for a partition.
At any given point, there is exactly one leader node for a given partition.

Whenever a node becomes the leader for a partition, it runs an instance of an
[exporter stream processor](https://github.com/camunda/zeebe/tree/1.3.14/broker/src/main/java/io/camunda/zeebe/broker/exporter/stream/ExporterDirector.java).
[exporter stream processor](https://github.com/camunda/camunda/tree/1.3.14/broker/src/main/java/io/camunda/zeebe/broker/exporter/stream/ExporterDirector.java).

This stream processor creates exactly one instance of each configured exporter,
and forwards every record written on the stream to each of these in turn.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ The exporter system provides an event stream of state changes within Zeebe. This
- Analysis of historic process data for auditing, business intelligence, etc.
- Tracking [incidents](/components/concepts/incidents.md) created by Zeebe

The exporter includes an API you can use to stream data into a storage system of your choice. Zeebe includes an out-of-the-box [Elasticsearch exporter](https://github.com/camunda/zeebe/tree/1.3.14/exporters/elasticsearch-exporter), and other [community-contributed exporters](https://awesome.zeebe.io) are also available.
The exporter includes an API you can use to stream data into a storage system of your choice. Zeebe includes an out-of-the-box [Elasticsearch exporter](https://github.com/camunda/camunda/tree/1.3.14/exporters/elasticsearch-exporter), and other [community-contributed exporters](https://awesome.zeebe.io) are also available.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ starts receiving records. Note that it is only guaranteed to see records
produced from that point on.

Find a reference implementation in the form of the Zeebe-maintained
[Elasticsearch exporter](https://github.com/camunda/zeebe/tree/1.3.14/exporters/elasticsearch-exporter).
[Elasticsearch exporter](https://github.com/camunda/camunda/tree/1.3.14/exporters/elasticsearch-exporter).

The main impact exporters have on a Zeebe cluster is that they remove the burden
of persisting data indefinitely.
Expand All @@ -44,7 +44,7 @@ If no exporters are configured, Zeebe automatically erases data when it is not n

Regardless of how an exporter is loaded (whether through an external JAR or not),
all exporters interact in the same way with the broker, which is defined by the
[exporter interface](https://github.com/camunda/zeebe/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/Exporter.java).
[exporter interface](https://github.com/camunda/camunda/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/Exporter.java).

## Loading

Expand Down Expand Up @@ -75,7 +75,7 @@ Additionally, exporters use the system class loader for system classes, or class

Exporter-specific configuration is handled through the exporter's `[exporters.args]`
nested map. This provides a `Map<String, Object>` passed directly
in the form of a [configuration](https://github.com/camunda/zeebe/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/context/Configuration.java) object when the broker calls the `Exporter#configure(Configuration)` method.
in the form of a [configuration](https://github.com/camunda/camunda/tree/1.3.14/exporter-api/src/main/java/io/camunda/zeebe/exporter/api/context/Configuration.java) object when the broker calls the `Exporter#configure(Configuration)` method.

Configuration occurs at two different phases: during the broker startup phase, and
once every time a leader is elected for a partition.
Expand All @@ -85,7 +85,7 @@ once every time a leader is elected for a partition.
At any given point, there is exactly one leader node for a given partition.

Whenever a node becomes the leader for a partition, it runs an instance of an
[exporter stream processor](https://github.com/camunda/zeebe/tree/1.3.14/broker/src/main/java/io/camunda/zeebe/broker/exporter/stream/ExporterDirector.java).
[exporter stream processor](https://github.com/camunda/camunda/tree/1.3.14/broker/src/main/java/io/camunda/zeebe/broker/exporter/stream/ExporterDirector.java).

This stream processor creates exactly one instance of each configured exporter,
and forwards every record written on the stream to each of these in turn.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Let's discuss gRPC and supported clients."
Zeebe clients connect to brokers via a stateless gateway.

For the communication between client and gateway, [gRPC](https://grpc.io/) is used. The communication protocol is defined using Protocol Buffers v3 ([proto3](https://developers.google.com/protocol-buffers/docs/proto3)), and you can find it in the
[Zeebe repository](https://github.com/camunda/zeebe/tree/1.3.14/gateway-protocol).
[Zeebe repository](https://github.com/camunda/camunda/tree/1.3.14/gateway-protocol).

## What is gRPC?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ With Zeebe you can:
- Use as part of a software as a service (SaaS) offering with Camunda Cloud or deploy with Docker and Kubernetes (in the cloud or on-premises) with Camunda Cloud Self-Managed.
- Scale horizontally to handle very high throughput.
- Rely on fault tolerance and high availability for your processes.
- Export processes data for monitoring and analysis (currently only available through the [Elasticsearch exporter](https://github.com/camunda/zeebe/tree/1.3.14/exporters/elasticsearch-exporter) added in Camunda Cloud Self-Managed).
- Export processes data for monitoring and analysis (currently only available through the [Elasticsearch exporter](https://github.com/camunda/camunda/tree/1.3.14/exporters/elasticsearch-exporter) added in Camunda Cloud Self-Managed).
- Engage with an active community.

For documentation on deploying Zeebe as part of Camunda Cloud Self-Managed, refer to the [deployment guide](../../self-managed/zeebe-deployment/index.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ camunda.operate:
## Zeebe Elasticsearch exporter
Operate imports data from Elasticsearch indices created and filled in by the [Zeebe Elasticsearch Exporter](https://github.com/camunda/zeebe/tree/1.3.14/exporters/elasticsearch-exporter).
Operate imports data from Elasticsearch indices created and filled in by the [Zeebe Elasticsearch Exporter](https://github.com/camunda/camunda/tree/1.3.14/exporters/elasticsearch-exporter).
Therefore, settings for this Elasticsearch connection must be defined and must correspond to the settings on the Zeebe side.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ camunda.tasklist:
## Zeebe Elasticsearch exporter
Tasklist imports data from Elasticsearch indices created and filled in by [Zeebe Elasticsearch Exporter](https://github.com/camunda/zeebe/tree/1.3.14/exporters/elasticsearch-exporter).
Tasklist imports data from Elasticsearch indices created and filled in by [Zeebe Elasticsearch Exporter](https://github.com/camunda/camunda/tree/1.3.14/exporters/elasticsearch-exporter).
Therefore, settings for this Elasticsearch connection must be defined and correspond to the settings on the Zeebe side.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ The default configuration is not suitable for a standalone gateway node. To run

We provide templates that contain all possible configuration settings, along with explanations for each setting:

- [`config/application.yaml` Standalone Broker (with embedded gateway)](https://github.com/camunda/zeebe/tree/1.3.14/dist/src/main/config/application.yaml) - Default configuration containing only the most common configuration settings. Use this as the basis for a single broker deployment for test or development.
- [`config/broker.standalone.yaml.template` Standalone Broker (with embedded gateway)](https://github.com/camunda/zeebe/tree/1.3.14/dist/src/main/config/broker.standalone.yaml.template) - Complete configuration template for a standalone broker with embedded gateway. Use this as the basis for a single broker deployment for test or development.
- [`config/broker.yaml.template` Broker Node (without embedded gateway)](https://github.com/camunda/zeebe/tree/1.3.14/dist/src/main/config/broker.yaml.template) - Complete configuration template for a broker node without embedded gateway. Use this as the basis for deploying multiple broker nodes as part of a cluster.
- [`config/gateway.yaml.template`](https://github.com/camunda/zeebe/tree/1.3.14/dist/src/main/config/gateway.yaml.template) - Complete configuration template for a standalone gateway.
- [`config/application.yaml` Standalone Broker (with embedded gateway)](https://github.com/camunda/camunda/tree/1.3.14/dist/src/main/config/application.yaml) - Default configuration containing only the most common configuration settings. Use this as the basis for a single broker deployment for test or development.
- [`config/broker.standalone.yaml.template` Standalone Broker (with embedded gateway)](https://github.com/camunda/camunda/tree/1.3.14/dist/src/main/config/broker.standalone.yaml.template) - Complete configuration template for a standalone broker with embedded gateway. Use this as the basis for a single broker deployment for test or development.
- [`config/broker.yaml.template` Broker Node (without embedded gateway)](https://github.com/camunda/camunda/tree/1.3.14/dist/src/main/config/broker.yaml.template) - Complete configuration template for a broker node without embedded gateway. Use this as the basis for deploying multiple broker nodes as part of a cluster.
- [`config/gateway.yaml.template`](https://github.com/camunda/camunda/tree/1.3.14/dist/src/main/config/gateway.yaml.template) - Complete configuration template for a standalone gateway.

:::note
These templates also include the corresponding environment variables to use for every setting.
Expand Down
Loading

0 comments on commit 1e70ea1

Please sign in to comment.