Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

replace camunda/zeebe with camunda/camunda #3829

Merged
merged 3 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
2 changes: 1 addition & 1 deletion api/zeebe/zeebe-openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ info:
description: API for communicating with the Zeebe cluster.
license:
name: Zeebe Community License Version 1.1
url: https://github.com/camunda/zeebe/blob/main/licenses/ZEEBE-COMMUNITY-LICENSE-1.1.txt
url: https://github.com/camunda/camunda/blob/main/licenses/ZEEBE-COMMUNITY-LICENSE-1.1.txt
externalDocs:
description: Find out more
url: https://docs.camunda.io/docs/apis-tools/zeebe-api-rest/overview/
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/cli-client/cli-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Quickly install via the package manager `npm`. The corresponding package is [her
npm i -g zbctl
```

You can also download a binary for your operating system from the [Zeebe GitHub releases page](https://github.com/camunda/zeebe/releases).
You can also download a binary for your operating system from the [Zeebe GitHub releases page](https://github.com/camunda/camunda/releases).

### Connection settings

Expand Down
18 changes: 9 additions & 9 deletions docs/apis-tools/go-client/go-get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ module github.com/zb-user/zb-example

go 1.21

require github.com/camunda/zeebe/clients/go/v8@v8.5.0
require github.com/camunda/camunda/clients/go/v8@v8.5.0
```

3. Set the connection settings and client credentials as environment variables in your terminal:
Expand All @@ -65,8 +65,8 @@ package main
import (
"context"
"fmt"
"github.com/camunda/zeebe/clients/go/v8/pkg/zbc"
"github.com/camunda/zeebe/clients/go/v8/pkg/pb"
"github.com/camunda/camunda/clients/go/v8/pkg/zbc"
"github.com/camunda/camunda/clients/go/v8/pkg/pb"
"os"
)

Expand Down Expand Up @@ -291,9 +291,9 @@ package main
import (
"context"
"fmt"
"github.com/camunda/zeebe/clients/go/v8/pkg/entities"
"github.com/camunda/zeebe/clients/go/v8/pkg/worker"
"github.com/camunda/zeebe/clients/go/v8/pkg/zbc"
"github.com/camunda/camunda/clients/go/v8/pkg/entities"
"github.com/camunda/camunda/clients/go/v8/pkg/worker"
"github.com/camunda/camunda/clients/go/v8/pkg/zbc"
"log"
"os"
)
Expand Down Expand Up @@ -407,9 +407,9 @@ package main
import (
"context"
"fmt"
"github.com/camunda/zeebe/clients/go/v8/pkg/entities"
"github.com/camunda/zeebe/clients/go/v8/pkg/worker"
"github.com/camunda/zeebe/clients/go/v8/pkg/zbc"
"github.com/camunda/camunda/clients/go/v8/pkg/entities"
"github.com/camunda/camunda/clients/go/v8/pkg/worker"
"github.com/camunda/camunda/clients/go/v8/pkg/zbc"
"log"
"os"
)
Expand Down
6 changes: 3 additions & 3 deletions docs/apis-tools/go-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ module github.com/zb-user/zb-example

go 1.21

require github.com/camunda/zeebe/clients/go/v8@v8.5.0
require github.com/camunda/camunda/clients/go/v8@v8.5.0
```

## Bootstrapping
Expand All @@ -27,7 +27,7 @@ package main
import (
"context"
"fmt"
"github.com/camunda/zeebe/clients/go/v8/pkg/zbc"
"github.com/camunda/camunda/clients/go/v8/pkg/zbc"
)

func main() {
Expand Down Expand Up @@ -86,7 +86,7 @@ package main
import (
"context"
"fmt"
"github.com/camunda/zeebe/clients/go/v8/pkg/zbc"
"github.com/camunda/camunda/clients/go/v8/pkg/zbc"
"os"
)

Expand Down
6 changes: 3 additions & 3 deletions docs/apis-tools/go-client/job-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ jobWorker.Close()

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/main/clients/go/pkg/worker/backoffSupplier.go). You can replace it using the `.BackoffSupplier()` method on the [`JobWorkerBuilder`](https://github.com/camunda/zeebe/blob/main/clients/go/pkg/worker/jobWorker_builder.go).
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/main/clients/go/pkg/worker/backoffSupplier.go). You can replace it using the `.BackoffSupplier()` method on the [`JobWorkerBuilder`](https://github.com/camunda/camunda/blob/main/clients/go/pkg/worker/jobWorker_builder.go).

By default, the job worker uses an exponential backoff implementation, which you can configure by making your own [`ExponentialBackoffSupplier`](https://github.com/camunda/zeebe/blob/main/clients/go/pkg/worker/exponentialBackoffSupplier.go).
By default, the job worker uses an exponential backoff implementation, which you can configure by making your own [`ExponentialBackoffSupplier`](https://github.com/camunda/camunda/blob/main/clients/go/pkg/worker/exponentialBackoffSupplier.go).

The backoff strategy is especially useful for dealing with the `GRPC_STATUS_RESOURCE_EXHAUSTED` error response (refer to [gRPC technical error handling](/apis-tools/zeebe-api/technical-error-handling.md)).

Expand All @@ -62,7 +62,7 @@ Zeebe's [backpressure mechanism](../../../self-managed/zeebe-deployment/operatio

## Metrics

The job worker exposes metrics through a custom interface: [JobWorkerMetrics](https://github.com/camunda/zeebe/blob/main/clients/go/pkg/worker/jobWorkerMetrics.go).
The job worker exposes metrics through a custom interface: [JobWorkerMetrics](https://github.com/camunda/camunda/blob/main/clients/go/pkg/worker/jobWorkerMetrics.go).

:::note
By default, job workers will not track any metrics, and it's up to the caller to specify an implementation if they wish to make use of this feature.
Expand Down
4 changes: 2 additions & 2 deletions docs/apis-tools/java-client/job-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If streaming is enabled (via `streamEnabled`), it will also open a long-living s

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/b9165e9759143e80e7e3bd2a884837cf141276a1/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/b9165e9759143e80e7e3bd2a884837cf141276a1/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/b9165e9759143e80e7e3bd2a884837cf141276a1/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/b9165e9759143e80e7e3bd2a884837cf141276a1/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 All @@ -48,7 +48,7 @@ Zeebe's [backpressure mechanism](../../../self-managed/zeebe-deployment/operatio

## Metrics

The job worker exposes metrics through a custom interface: [JobWorkerMetrics](https://github.com/camunda/zeebe/blob/main/clients/java/src/main/java/io/camunda/zeebe/client/api/worker/JobWorkerMetrics.java). These represent specific callbacks used by the job worker to keep track of various internals, e.g. count of jobs activated, count of jobs handled, etc.
The job worker exposes metrics through a custom interface: [JobWorkerMetrics](https://github.com/camunda/camunda/blob/main/clients/java/src/main/java/io/camunda/zeebe/client/api/worker/JobWorkerMetrics.java). These represent specific callbacks used by the job worker to keep track of various internals, e.g. count of jobs activated, count of jobs handled, etc.

:::note
By default, job workers will not track any metrics, and it's up to the caller to specify an implementation if they wish to make use of this feature.
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/spring-zeebe-sdk/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ zeebe.client.worker.max-jobs-active=32
zeebe.client.worker.threads=1
```

For a full set of configuration options, see [ZeebeClientConfigurationProperties.java](https://github.com/camunda/zeebe/blob/main/spring-boot-starter-camunda-sdk/src/main/java/io/camunda/zeebe/spring/client/properties/ZeebeClientConfigurationProperties.java).
For a full set of configuration options, see [ZeebeClientConfigurationProperties.java](https://github.com/camunda/camunda/blob/main/spring-boot-starter-camunda-sdk/src/main/java/io/camunda/zeebe/spring/client/properties/ZeebeClientConfigurationProperties.java).

:::note
We generally do not advise using a thread pool for workers, but rather implement asynchronous code, see [writing good workers](/components/best-practices/development/writing-good-workers.md) for additional details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ API for communicating with the Zeebe cluster.
<h3 style={{ marginBottom: "0.25rem" }}>License</h3>
<a
href={
"https://github.com/camunda/zeebe/blob/main/licenses/ZEEBE-COMMUNITY-LICENSE-1.1.txt"
"https://github.com/camunda/camunda/blob/main/licenses/ZEEBE-COMMUNITY-LICENSE-1.1.txt"
}
>
Zeebe Community License Version 1.1
Expand Down
2 changes: 1 addition & 1 deletion docs/apis-tools/zeebe-api/gateway-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "The Zeebe client gRPC API is exposed through a single gateway serv

The Zeebe client gRPC API is exposed through a single gateway service. The current version of the protocol buffer file
can be found in
the [Zeebe repository](https://github.com/camunda/zeebe/blob/main/zeebe/gateway-protocol/src/main/proto/gateway.proto).
the [Zeebe repository](https://github.com/camunda/camunda/blob/main/zeebe/gateway-protocol/src/main/proto/gateway.proto).

## `ActivateJobs` RPC

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Furthermore, data is also sent Operate and Optimize, which store data in Elastic
Elasticsearch needs enough memory available to load a large amount of this data into memory.
:::

Assuming a [typical payload of 15 process variables (simple strings, numbers or booleans)](https://github.com/camunda/zeebe/blob/main/zeebe/benchmarks/project/src/main/resources/bpmn/typical_payload.json) we measured the following approximations for disk space requirements using Camunda 8 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/main/zeebe/benchmarks/project/src/main/resources/bpmn/typical_payload.json) we measured the following approximations for disk space requirements using Camunda 8 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
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/main/zeebe/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/main/zeebe/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
2 changes: 1 addition & 1 deletion docs/components/concepts/job-workers.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ If you're using the raw `StreamActivatedJobs` RPC, or want to add support for th

If you wish to test this, you can do so by simulating a very slow worker with your new implementation. Then, start generating many jobs on the server side (e.g. create many process instances with lots of jobs). You should then observe backpressure via server side metrics, or many `Job.YIELD` commands written to the log.

Refer to the [Java and Go implementations](https://github.com/camunda/zeebe/tree/main/clients) for more information.
Refer to the [Java and Go implementations](https://github.com/camunda/camunda/tree/main/clients) for more information.

#### Detecting backpressure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ This conversion will only be applied to the XML deployed to the cluster; the dia

#### Known issues with linked forms

##### Wrong form used for user task - [zeebe/#16311](https://github.com/camunda/zeebe/issues/16311)
##### Wrong form used for user task - [zeebe/#16311](https://github.com/camunda/camunda/issues/16311)

Some users have encountered an issue that was present in Camunda `8.4.0`, `8.4.1`, and `8.4.2` where linked forms did not correspond correctly to their tasks, leading to discrepancies in workflow execution. We have identified and rectified this issue in the Camunda `8.4.3` release, ensuring that tasks are now generated with the correct forms, as intended in your workflow design.

Expand Down
2 changes: 1 addition & 1 deletion docs/components/zeebe/technical-concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,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/main/zeebe/exporters/elasticsearch-exporter), and other [community-contributed exporters](https://github.com/camunda-community-hub/awesome-camunda-platform-8) 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/main/zeebe/exporters/elasticsearch-exporter), and other [community-contributed exporters](https://github.com/camunda-community-hub/awesome-camunda-platform-8) are also available.
2 changes: 1 addition & 1 deletion docs/components/zeebe/technical-concepts/protocols.md
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, a mix of REST and [gRPC](https://grpc.io/) is used. The gRPC 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/main/zeebe/gateway-protocol). There, you will also find the OpenAPI v3 spec for the REST portion of the gateway API.
[Zeebe repository](https://github.com/camunda/camunda/tree/main/zeebe/gateway-protocol). There, you will also find the OpenAPI v3 spec for the REST portion of the gateway API.

Note that while gRPC requires HTTP/2, the REST API can work with either HTTP/1.1 or HTTP/2.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ Offering an automatically testable and review-ready process preview mandates a d

##### Using fully-featured clusters

For local preview environments, you can deploy a comprehensive [Zeebe](https://github.com/camunda/zeebe) cluster including Operate and Tasklist. Options include using docker-compose or Kubernetes via Helm. All necessary endpoints and UIs are available for thorough process/application testing. Opt for a cluster version aligned with your production cluster to ensure process compatibility.
For local preview environments, you can deploy a comprehensive [Zeebe](https://github.com/camunda/camunda) cluster including Operate and Tasklist. Options include using docker-compose or Kubernetes via Helm. All necessary endpoints and UIs are available for thorough process/application testing. Opt for a cluster version aligned with your production cluster to ensure process compatibility.

##### Using embedded Zeebe engines

Expand Down
Loading
Loading