Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
akeller committed Aug 30, 2024
1 parent e959ab3 commit 9f7d4f2
Show file tree
Hide file tree
Showing 16 changed files with 80 additions and 50 deletions.
4 changes: 2 additions & 2 deletions docs/apis-tools/community-clients/go-client/job-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This error code indicates the Zeebe cluster is currently under too large of a lo
By backing off, the job worker helps Zeebe by reducing the load.

:::note
Zeebe's [backpressure mechanism](../../../self-managed/zeebe-deployment/operations/backpressure) can also be configured.
Zeebe's [backpressure mechanism](/self-managed/zeebe-deployment/operations/backpressure.md) can also be configured.
:::

## Metrics
Expand Down Expand Up @@ -108,7 +108,7 @@ To avoid your workers being overloaded with too many jobs, e.g. running out of m

#### Proxying

If you're using a reverse proxy or a load balancer between your worker and your gateway, you may need to configure additional parameters to ensure the job stream is not closed unexpectedly with an error. If you observe regular 504 timeouts, read our guide on [job streaming](../../../self-managed/zeebe-deployment/zeebe-gateway/job-streaming).
If you're using a reverse proxy or a load balancer between your worker and your gateway, you may need to configure additional parameters to ensure the job stream is not closed unexpectedly with an error. If you observe regular 504 timeouts, read our guide on [job streaming](/self-managed/zeebe-deployment/zeebe-gateway/job-streaming.md).

By default, the Go job workers have a stream timeout of one hour. You can overwrite this by calling the `StreamRequestTimeout` of the job worker builder:

Expand Down
12 changes: 9 additions & 3 deletions docs/components/modeler/desktop-modeler/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,15 @@ To produce logging output, you can also run Desktop Modeler from the command lin

You try to connect (i.e., to deploy) to a remote Zeebe instance, and Desktop Modeler tells you it "cannot find a running Zeebe."

To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](/apis-tools/cli-client/index.md). If that works, [further debug your Zeebe connection](#debug-zeebe-connection-issues). If that does not work, resolve the [general connection issue](#resolve-a-general-zeebe-connection-issue) first.
<!-- NEEDS ATTENTION-->

To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](#). If that works, [further debug your Zeebe connection](#debug-zeebe-connection-issues). If that does not work, resolve the [general connection issue](#resolve-a-general-zeebe-connection-issue) first.

## Resolve a general Zeebe connection issue

You try to connect to Zeebe from both Desktop Modeler _and_ [`zbctl`](/apis-tools/cli-client/index.md), and neither of them works. General connection failures can have a couple of reasons:
<!-- NEEDS ATTENTION-->

You try to connect to Zeebe from both Desktop Modeler _and_ [`zbctl`](#), and neither of them works. General connection failures can have a couple of reasons:

### The (remote) Zeebe instance is not reachable

Expand All @@ -72,7 +76,9 @@ Secure connections to Zeebe require [HTTP/2 over TLS with protocol negotiation v

## Debug Zeebe connection issues

You can connect to Zeebe via [`zbctl`](/apis-tools/cli-client/index.md) or another API client. However, connecting through Desktop Modeler fails.
<!-- NEEDS ATTENTION-->

You can connect to Zeebe via [`zbctl`](#) or another API client. However, connecting through Desktop Modeler fails.

### Secure connection to Zeebe fails

Expand Down
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 @@ -27,7 +27,7 @@ gRPC has many beneficial features that make it a good fit for Zeebe, including:

## Supported clients

Currently, Zeebe officially supports two gRPC clients: one in [Java](/apis-tools/java-client/index.md), and one in [Golang](/apis-tools/go-client/go-get-started.md).
Currently, Zeebe officially supports a gRPC client in [Java](/apis-tools/java-client/index.md).

:::note
As of 8.5.0, the Go client does not support the REST API of the gateway.
Expand Down
12 changes: 9 additions & 3 deletions docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,9 @@ In the build stage, deploy your process or project to a cluster or embedded engi
For GitLab users, consider using [GitLab Review Apps](https://docs.gitlab.com/ee/ci/review_apps/) to provide preview environments.
:::

Deploy resources using the [`zbctl` CLI](/apis-tools/cli-client/index.md) in this pipeline step, compatible with both SaaS and Self-Managed clusters. Alternately, utilize the [Java](/apis-tools/java-client/index.md) or [Go](/apis-tools/go-client/index.md) client library or any [community-built alternatives](/apis-tools/community-clients/index.md).
<!-- NEEDS ATTENTION-->

Deploy resources using the [`zbctl` CLI](#) in this pipeline step, compatible with both SaaS and Self-Managed clusters. Alternately, utilize the [Java](/apis-tools/java-client/index.md) client library or any [community-built alternatives](/apis-tools/community-clients/index.md).

:::info Feature branches and Web Modeler installations
To maintain a single source of truth, avoid multiple Web Modeler instances for different feature branches. Instead, maintain a single Web Modeler installation for all environments, utilizing milestones to signify versioning and pipeline stages. Feature branches can be managed by cloning and merging files or projects, ensuring synchronization using VCS.
Expand Down Expand Up @@ -208,7 +210,9 @@ To retrieve the actual file `content`, iterate over the response and fetch it vi

If you are running Connectors in your process or application, you need to deploy the runtimes as well. Parse the process XML for `zeebe:taskDefinition` bindings to identify the necessary runtimes (in addition to job workers). To learn how to deploy Connector runtimes, read more [here](/self-managed/connectors-deployment/install-and-start.md) for Self-Managed, or [here](/components/connectors/custom-built-connectors/connector-sdk.md#runtime-environments) for SaaS.

Deploy resources in this pipeline step using the [`zbctl` CLI](/apis-tools/cli-client/index.md), compatible with both SaaS and Self-Managed clusters. Alternatively, utilize the Java or Go client library or any community-built alternatives.
<!-- NEEDS ATTENTION-->

Deploy resources in this pipeline step using the [`zbctl` CLI](#), compatible with both SaaS and Self-Managed clusters. Alternatively, utilize the Java or Go client library or any community-built alternatives.

#### Add environment variables via secrets

Expand Down Expand Up @@ -259,7 +263,9 @@ In case you use an embedded Zeebe engine, or want to provide a lightweight, focu

### Publish stage

Push approved changes to staging or production by deploying them to the respective clusters. You can use the [`zbctl` CLI](/apis-tools/cli-client/index.md) to deploy via your pipeline, which works both for a SaaS or Self-Managed cluster. Deployments work slightly different on SaaS and Self-Managed, since there are differences in the cluster connection. Read more about deployments [here](/apis-tools/working-with-apis-tools.md#deploy-processes-start-process-instances-and-more-using-zeebe-client-libraries).
<!-- NEEDS ATTENTION -->

Push approved changes to staging or production by deploying them to the respective clusters. You can use the [`zbctl` CLI](#) to deploy via your pipeline, which works both for a SaaS or Self-Managed cluster. Deployments work slightly different on SaaS and Self-Managed, since there are differences in the cluster connection. Read more about deployments [here](/apis-tools/working-with-apis-tools.md#deploy-processes-start-process-instances-and-more-using-zeebe-client-libraries).

#### Define resource authorizations

Expand Down
4 changes: 3 additions & 1 deletion docs/reference/announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,9 @@ This release contains the following limitations:

### Changes in supported environments

- Raised minimum Go version to 1.21 for the [Zeebe Go client](/apis-tools/go-client/index.md)
<!-- NEEDS ATTENTION-->

- Raised minimum Go version to 1.21 for the Zeebe Go client

### Camunda SaaS: New generation naming scheme

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ sidebar_label: "Zeebe connection"

You try to connect (i.e., to deploy) to a remote Zeebe cluster and Web Modeler reports an error.

To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](/apis-tools/cli-client/index.md).
<!-- NEEDS ATTENTION-->

To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](#).
If that doesn't work, resolve the general connection issue first (see [the platform deployment troubleshooting section](/self-managed/operational-guides/troubleshooting/troubleshooting.md), for example.)

If that works, further debug your Zeebe connection with the help of the information stated below. Enabling [debug logging in `modeler-restapi`](#how-can-i-debug-log-grpc--zeebe-communication) may also help to understand the issue.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,9 @@ Running dual-region setups requires the users to be able to detect any regional
## Prerequisites

- A dual-region Camunda 8 setup installed in two different regions, preferably derived from our [AWS dual-region guide](/self-managed/setup/deploy/amazon/amazon-eks/dual-region.md).
- In that guide, we're showcasing Kubernetes dual-region installation, based on the following tools:
- [Helm (3.x)](https://helm.sh/docs/intro/install/) for installing and upgrading the [Camunda Helm chart](https://github.com/camunda/camunda-platform-helm).
- [Kubectl (1.30.x)](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the Kubernetes cluster.
- [zbctl](./../../../apis-tools/cli-client/index.md) to interact with the Zeebe cluster.
- In that guide, we're showcasing Kubernetes dual-region installation, based on the following tools: - [Helm (3.x)](https://helm.sh/docs/intro/install/) for installing and upgrading the [Camunda Helm chart](https://github.com/camunda/camunda-platform-helm). - [Kubectl (1.30.x)](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the Kubernetes cluster.
<!-- NEEDS ATTENTION-->
- [zbctl](#) to interact with the Zeebe cluster.

## Terminology

Expand Down Expand Up @@ -161,7 +160,9 @@ The following alternatives to port-forwarding are possible:

In our example, we went with port-forwarding to a local host, but other alternatives can also be used.

1. Use the [zbctl client](../../../apis-tools/cli-client/index.md) to retrieve list of remaining brokers
<!-- NEEDS ATTENTION-->

1. Use the [zbctl client](#) to retrieve list of remaining brokers

```bash
kubectl --context $CLUSTER_SURVIVING port-forward services/$HELM_RELEASE_NAME-zeebe-gateway 26500:26500 -n $CAMUNDA_NAMESPACE_SURVIVING
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,9 @@ helm install $HELM_RELEASE_NAME camunda/camunda-platform \
kubectl --context "$CLUSTER_0" -n $CAMUNDA_NAMESPACE_0 port-forward services/$HELM_RELEASE_NAME-zeebe-gateway 26500:26500
```

2. Open another terminal and use [zbctl](../../../../../apis-tools/cli-client/cli-get-started.md) to print the Zeebe cluster status:
<!-- NEEDS ATTENTION-->

2. Open another terminal and use [zbctl](#) to print the Zeebe cluster status:

```shell
zbctl status --insecure --address localhost:26500
Expand Down
12 changes: 9 additions & 3 deletions docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Lastly you'll verify that the connection to your Self-Managed Camunda 8 environm
- A Kubernetes cluster; see the [eksctl](./eksctl.md) or [terraform](./terraform-setup.md) guide.
- [Helm (3.13+)](https://helm.sh/docs/intro/install/)
- [kubectl (1.28+)](https://kubernetes.io/docs/tasks/tools/#kubectl) to interact with the cluster.
- (optional) Domain name/[hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html) in Route53. This allows you to expose Camunda 8 and connect via [zbctl](../../../../../../apis-tools/cli-client/) or [Camunda Modeler](https://camunda.com/download/modeler/).
- (optional) Domain name/[hosted zone](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html) in Route53. This allows you to expose Camunda 8 and connect via [zbctl](#) or [Camunda Modeler](https://camunda.com/download/modeler/).

<!-- NEEDS ATTENTION-->

## Considerations

Expand Down Expand Up @@ -268,7 +270,9 @@ This reveals a `client-id` and `client-secret` that can be used to connect to th
<Tabs groupId="c8-connectivity">
<TabItem value="zbctl" label="zbctl">

After following the installation instructions in the [zbctl docs](/apis-tools/cli-client/index.md), we can configure the required connectivity to check that the Zeebe cluster is reachable.
After following the installation instructions in the [zbctl docs](#), we can configure the required connectivity to check that the Zeebe cluster is reachable.

<!-- NEEDS ATTENTION-->

<Tabs groupId="domain">
<TabItem value="with" label="With Domain">
Expand Down Expand Up @@ -340,7 +344,9 @@ Brokers:
Partition 3 : Leader, Healthy
```

For more advanced topics, like deploying a process or registering a worker, consult the [zbctl docs](/apis-tools/cli-client/cli-get-started.md).
<!-- NEEDS ATTENTION-->

For more advanced topics, like deploying a process or registering a worker, consult the [zbctl docs](#).

If you want to access the other services and their UI, you can port-forward those as well:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,9 @@ First, port-forward each of the components. Use a separate terminal for each com

## Connecting to the workflow engine

To interact with the Camunda workflow engine via Zeebe Gateway using [zbctl](/apis-tools/cli-client/cli-get-started.md) or a local client/worker from outside the Kubernetes cluster, run `kubectl port-forward` to the Zeebe gateway as follows:
<!-- NEEDS ATTENTION-->

To interact with the Camunda workflow engine via Zeebe Gateway using [zbctl](#) or a local client/worker from outside the Kubernetes cluster, run `kubectl port-forward` to the Zeebe gateway as follows:

```sh
kubectl port-forward svc/camunda-zeebe-gateway 26500:26500
Expand Down
4 changes: 3 additions & 1 deletion docs/self-managed/setup/deploy/local/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ You’ll know Zeebe has started successfully when you see a message similar to t
[exporter] [0.0.0.0:26501-zb-actors-1] INFO io.camunda.zeebe.broker.exporter.elasticsearch - Exporter opened
```

You can test the Zeebe Gateway by asking for the cluster topology with [zbtcl](/apis-tools/cli-client/index.md#usage):
<!-- NEEDS ATTENTION-->

You can test the Zeebe Gateway by asking for the cluster topology with [zbtcl](#):

```shell
./bin/zbctl --insecure status
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ You need to keep `port-forward` running all the time to communicate with the rem

## Accessing workflow engine

To interact with Camunda workflow engine via [Zeebe Gateway](/self-managed/zeebe-deployment/configuration/gateway.md) using [zbctl](/apis-tools/cli-client/index.md) or a local client/worker from outside the Kubernetes cluster, run `kubectl port-forward` to the Zeebe cluster as following:
<!-- NEEDS ATTENTION-->

To interact with Camunda workflow engine via [Zeebe Gateway](/self-managed/zeebe-deployment/configuration/gateway.md) using [zbctl](#) or a local client/worker from outside the Kubernetes cluster, run `kubectl port-forward` to the Zeebe cluster as following:

```
kubectl port-forward svc/camunda-zeebe-gateway 26500:26500
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Proxies which support forwarding HTTP/2 keepalive do not require any change.

The following configuration is recommended for impacted reverse proxies:

- On your client, set an explicit stream timeout of one hour. See additional examples in [Java](../../../../apis-tools/java-client/job-worker) and [Go](../../../../apis-tools/go-client/job-worker).
- On your client, set an explicit stream timeout of one hour. See additional examples in [Java](../../../../apis-tools/java-client/job-worker).
- On your reverse proxy, ensure the read response timeout is set to slightly higher than your client (for example, an hour and ten minutes).

## Nginx
Expand Down
41 changes: 20 additions & 21 deletions optimize_sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1950,27 +1950,6 @@ module.exports = {

{
Clients: [
{
"CLI client": [
docsLink("Quick reference", "apis-tools/cli-client/"),
docsLink(
"Getting started with the CLI client",
"apis-tools/cli-client/cli-get-started/"
),
],
},

{
"Go client": [
docsLink("Quick reference", "apis-tools/go-client/"),
docsLink(
"Getting started with the Go client",
"apis-tools/go-client/go-get-started/"
),
docsLink("Job worker", "apis-tools/go-client/job-worker/"),
],
},

{
"Java client": [
docsLink("Quick reference", "apis-tools/java-client/"),
Expand Down Expand Up @@ -2041,6 +2020,26 @@ module.exports = {
docsLink("Rust", "apis-tools/community-clients/rust/"),
docsLink("Spring", "apis-tools/community-clients/spring/"),
docsLink("Quarkus", "apis-tools/community-clients/quarkus/"),
{
"CLI client": [
docsLink("Quick reference", "apis-tools/cli-client/"),
docsLink(
"Getting started with the CLI client",
"apis-tools/cli-client/cli-get-started/"
),
],
},

{
"Go client": [
docsLink("Quick reference", "apis-tools/go-client/"),
docsLink(
"Getting started with the Go client",
"apis-tools/go-client/go-get-started/"
),
docsLink("Job worker", "apis-tools/go-client/job-worker/"),
],
},
],
},
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Web Modeler Self-Managed is available to [enterprise customers](../../../../refe

You try to connect (i.e., to deploy) to a remote Zeebe cluster and Web Modeler reports an error.

To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](/docs/apis-tools/cli-client/index.md).
To resolve this issue, check if you can connect to Zeebe through another client, i.e., [`zbctl`](/apis-tools/cli-client/index.md).
If that doesn't work, resolve the general connection issue first (see [the platform deployment troubleshooting section](/self-managed/platform-deployment/troubleshooting.md), for example.)

If that works, further debug your Zeebe connection with the help of the information stated below. Enabling [debug logging in `modeler-restapi`](#how-can-i-debug-log-grpc--zeebe-communication) may also help to understand the issue.
Expand All @@ -19,7 +19,7 @@ If that works, further debug your Zeebe connection with the help of the informat

### Increase the Zeebe client timeout

Web Modeler uses the [Zeebe Java client](/docs/apis-tools/java-client/index.md) to connect to Zeebe.
Web Modeler uses the [Zeebe Java client](/apis-tools/java-client/index.md) to connect to Zeebe.
Depending on your infrastructure, the default timeouts configured may be too short.

You can pass custom timeouts in milliseconds for Web Modeler's Zeebe client to `modeler-restapi` via three individual environment variables:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ Camunda 8 provides several official clients based on this API. Official clients

Official clients have been developed and tested by Camunda. They also add convenience functions (e.g. thread handling for job workers) on top of the core API.

<DocCardList items={[{type:"link", href:"/docs/next/apis-tools/cli-client/", label: "CLI client", docId:"apis-tools/cli-client/index"},
<DocCardList items={[{type:"link", href:"/docs/apis-tools/cli-client/", label: "CLI client", docId:"apis-tools/cli-client/index"},
{
type:"link", href:"/docs/next/apis-tools/go-client/go-get-started/", label: "Go client", docId:"apis-tools/go-client/index",
type:"link", href:"/docs/apis-tools/go-client/go-get-started/", label: "Go client", docId:"apis-tools/go-client/index",
},
{
type:"link", href:"/docs/next/apis-tools/java-client/", label: "Java client", docId:"apis-tools/java-client/index"
type:"link", href:"/docs/apis-tools/java-client/", label: "Java client", docId:"apis-tools/java-client/index"
}
]}/>

Expand Down

0 comments on commit 9f7d4f2

Please sign in to comment.