Add cluster ID to the topology API #6794
Merged
+25
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rodrigo-lourenco-lopes
force-pushed
the
rl-cluster-id-api
branch
from
0c0d091 to
eaef17c
Compare
|
👋 🤖 🤔 Hello, @mesellings! 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.8/.
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. |
|
@lenaschoenburg @camunda/tech-writers do you have time to review this PR this week? :) |
lenaschoenburg
previously approved these changes
Oct 9, 2025
|
@rodrigo-lourenco-lopes shouldn't this be done in the API so that it is then picked up in the generated docs? If we change it directly in the docs, it will get overwritten when the docs are next generated? |
1 task
rodrigo-lourenco-lopes
force-pushed
the
rl-cluster-id-api
branch
from
eaef17c to
1f0c927
Compare
|
@mesellings the changes in the API were made in this PR but some of the files I changed here are just examples of the topology response, while others are part of the api definition. Which of these files are generated from the API? |
github-merge-queue bot
pushed a commit
to camunda/camunda
that referenced
this pull request
Oct 14, 2025
## Description The goal of this PR is firstly to fix the starter and worker configuration to allow it again to run against saas when configuring the helm benchmark to do so. This requires that we override the credentials necessary to connect with saas. I created a [benchmark](https://grafana.dev.zeebe.io/d/zeebe-dashboard/zeebe?orgId=1&var-DS_PROMETHEUS=prometheus&var-cluster=$__all&var-namespace=rl-starter-and-worker-fix&var-pod=$__all&var-partition=$__all&var-memory_state=committed&from=now-6h&to=now&timezone=browser) based on this branch to make sure that we dont break the base case where the starter connects to the cluster in its own namespace. The fix works in conjuction with this [PR](camunda/camunda-docs#6794) in the benchmar repo. I also changed the name of the variables to be in line with the ones generated when we create the Saas API client so that we can copy directly the env variables to our local environment and deploy the worker and starter this way to run against saas, only needing to additionally add `ZEEBE_AUTH_TYPE=OAUTH`. ## Checklist <!--- Please delete options that are not relevant. Boxes should be checked by reviewer. --> - [ ] Enable backports when necessary (fex. [for bug fixes](https://github.com/camunda/camunda/blob/main/CONTRIBUTING.md#backporting-changes) or [for CI changes](https://github.com/camunda/camunda/wiki/CI-&-Automation#when-to-backport-ci-changes)). ## Related issues closes #
mesellings
approved these changes
Oct 15, 2025
There was a problem hiding this comment.
@rodrigo-lourenco-lopes all lgtm - does this need to be backported to the 8.8 docs as well now that these docs are for 8.9?
github-project-automation
bot
moved this from 👀 In Review
to ✅ Done
in Documentation Team
|
@mesellings no, the cluster ID functionality is not present in 8.8. |
tsedekey
pushed a commit
to camunda/camunda
that referenced
this pull request
Oct 15, 2025
## Description The goal of this PR is firstly to fix the starter and worker configuration to allow it again to run against saas when configuring the helm benchmark to do so. This requires that we override the credentials necessary to connect with saas. I created a [benchmark](https://grafana.dev.zeebe.io/d/zeebe-dashboard/zeebe?orgId=1&var-DS_PROMETHEUS=prometheus&var-cluster=$__all&var-namespace=rl-starter-and-worker-fix&var-pod=$__all&var-partition=$__all&var-memory_state=committed&from=now-6h&to=now&timezone=browser) based on this branch to make sure that we dont break the base case where the starter connects to the cluster in its own namespace. The fix works in conjuction with this [PR](camunda/camunda-docs#6794) in the benchmar repo. I also changed the name of the variables to be in line with the ones generated when we create the Saas API client so that we can copy directly the env variables to our local environment and deploy the worker and starter this way to run against saas, only needing to additionally add `ZEEBE_AUTH_TYPE=OAUTH`. ## Checklist <!--- Please delete options that are not relevant. Boxes should be checked by reviewer. --> - [ ] Enable backports when necessary (fex. [for bug fixes](https://github.com/camunda/camunda/blob/main/CONTRIBUTING.md#backporting-changes) or [for CI changes](https://github.com/camunda/camunda/wiki/CI-&-Automation#when-to-backport-ci-changes)). ## Related issues closes #
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the cluster ID to the /topology responses in the next version of the documents.
closes: camunda/camunda#37663
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory (version 8.8)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.