Document cluster mode change - #9538
Conversation
|
👋 🤖 🤔 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/.
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
left a comment
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
🔧 we need to add the required set of permissions to be able to run this operation in this guide
There was a problem hiding this comment.
The OpenAPI spec from the monorepo will include the Authz in the API view automatically when added I think.
There was a problem hiding this comment.
yeah it would be nice to at least mention it?
|
|
||
| You can also query the cluster management API on the management port (`9600` by default) to follow the change by its ID: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
💭 it would be nice to link to a general "API Reference" here 😆
There was a problem hiding this comment.
If only we had one 😃
Description
Document the mode changes for a Zeebe cluster between
recoveringandprocessingand 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?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.