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.

Sign up for GitHub

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

Announce Go client & zbctl deprecation #4264

Merged
merged 5 commits into from
Sep 6, 2024
Merged

Announce Go client & zbctl deprecation #4264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
45a8fbb
Announce Go client & zbctl deprecation
megglos Sep 6, 2024
c91d89d
Improved wording on zeebe go client deprecation announcement
megglos Sep 6, 2024
fc10f27
Improved language on Go client deprecation announcement
megglos Sep 6, 2024
4436729
Add deprecation announcement to all go-client pages
megglos Sep 6, 2024
ff8a653
Revised lang on go client deprecation announcement
megglos Sep 6, 2024
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
6 changes: 6 additions & 0 deletions docs/apis-tools/go-client/go-get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ sidebar_label: "Getting started with the Go client"
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::caution
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this perhaps be added to the current 8.5 docs, and should we remove all references of the Go client in the next, 8.6 docs?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CC @megglos


The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../../reference/announcements/#deprecation-zeebe-go-client--zbctl).

:::

In this tutorial, you will learn how to use the Go client in a Go application to interact with Camunda 8.

You can find a complete example on [GitHub](https://github.com/camunda/camunda-platform-get-started/tree/main/go).
Expand Down
8 changes: 7 additions & 1 deletion docs/apis-tools/go-client/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
---
id: index
title: "Go client"
title: "Go client (Deprecated)"
sidebar_label: "Quick reference"
description: "Instantiate the client by passing in the address of the cluster you want to connect to in a Go application to interact with Camunda 8."
---

:::caution
megglos marked this conversation as resolved.
Show resolved Hide resolved

The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../reference/announcements/#deprecation-zeebe-go-client--zbctl).

:::

## Dependencies

To use the [Zeebe Go client library](https://github.com/camunda/camunda-platform-get-started/tree/main/go), add the following dependency to your `go.mod`:
Expand Down
6 changes: 6 additions & 0 deletions docs/apis-tools/go-client/job-worker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ description: "Let's take a deeper look at job workers to handle jobs."
keywords: ["backpressure", "back-pressure", "back pressure"]
---

:::caution

The Zeebe Go client will be officially deprecated with the 8.6 release. For more information, see [announcements](../../../reference/announcements/#deprecation-zeebe-go-client--zbctl).

:::

The Go client provides a job worker that handles both polling and streaming for available jobs. This allows you to focus on writing code to handle the activated jobs.

On `Open`, the job worker waits `PollInterval` milliseconds and then polls for `MaxJobsActive` jobs. It then continues with the following schedule:
Expand Down
21 changes: 4 additions & 17 deletions docs/reference/announcements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ The Zeebe Java client will not be developed further and will only receive bug fi
- **Artifact ID change**:
- The `artifactId` will change from `zeebe-client-java` to `camunda-client-java`.

### Deprecation: Zeebe Go client & zbctl

The Zeebe Go Client and zbctl will be officially deprecated with the 8.6 release as part of our efforts to streamline the Camunda 8 API experience. This client and CLI utility will not get released starting with Camunda 8.6, will no longer receive new features, and will be transitioned to a community-maintained status.

### Camunda 8 SaaS - Required cluster update

:::caution
Expand Down Expand Up @@ -77,23 +81,6 @@ If you do not update the cluster by August 30th 2024, we will update the cluster

Camunda 8 Self-Managed clusters are not affected by this.

### Zeebe repo rename impacts Go client

The Camunda 8 Github repository was renamed from `http://github.com/camunda/zeebe` to `http://github.com/camunda/camunda`, impacting the Zeebe Go client path.

Starting in 8.6.0, the Zeebe Go client path should reflect the renamed repo as follows:

```go

module example.com/mymodule

require (
github.com/camunda/camunda/clients/go/v8 v8.x.y
...
)

```

### Supported environment changes (OpenJDK, ElasticSearch, Amazon OpenSearch)

Version changes are made to supported environments:
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,7 +802,7 @@ module.exports = {
],
},
{
"Go client": [
"Go client (Deprecated)": [
"apis-tools/go-client/index",
"apis-tools/go-client/go-get-started",
"apis-tools/go-client/job-worker",
Expand Down
Loading