Skip to content

Document cluster mode change - #9538

Open
panagiotisgts wants to merge 4 commits into
mainfrom
pg/59356-mode-change
Open

Document cluster mode change#9538
panagiotisgts wants to merge 4 commits into
mainfrom
pg/59356-mode-change

Conversation

@panagiotisgts

Copy link
Copy Markdown
Contributor

Description

Document the mode changes for a Zeebe cluster between recovering and processing and what's available during the recovery phase.

Available under: self-managed/components/orchestration-cluster/zeebe/operations/modes/

closes: camunda/camunda#59356

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory.
  • My changes are for an already released minor and are in a /versioned_docs directory.

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

👋 🤖 🤔 Hello, @panagiotisgts! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.9/.

  • docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@giorgionaps
giorgionaps requested review from giorgionaps and removed request for a team August 4, 2026 11:26
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated
Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated

@giorgionaps giorgionaps left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the updates! I left some wording suggestions/comments


## Change the cluster mode

Send a `PATCH` request to the `/mode` endpoint of the [Orchestration Cluster REST API](/apis-tools/orchestration-cluster-api-rest/specifications/change-cluster-mode.api.mdx). The endpoint uses the Orchestration Cluster REST API port, which is `8080` by default.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔧 we need to add the required set of permissions to be able to run this operation in this guide

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The OpenAPI spec from the monorepo will include the Authz in the API view automatically when added I think.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

yeah it would be nice to at least mention it?

Comment thread docs/self-managed/components/orchestration-cluster/zeebe/operations/modes.md Outdated

You can also query the cluster management API on the management port (`9600` by default) to follow the change by its ID:

```bash

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💭 it would be nice to link to a general "API Reference" here 😆

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

If only we had one 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

Document broker recovery mode

3 participants