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.

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

Add orchestration cluster glossary terms #4648

Merged
merged 6 commits into from
Dec 13, 2024
Merged

Conversation

akeller
Copy link
Member

@akeller akeller commented Nov 22, 2024

Description

This is a DRAFT because a crisp definition is not found internally. This PR will need to be nurtured by an @camunda/tech-writers to work with @felix-mueller(?) on a definition.

We should also mention the 1:many relationship between a management cluster Web Modeler + Console and an orchestration cluster in SM, but I wasn't sure if we wanted to do that here when the definition should be crisp with a link to more info.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added the target:8.7 Issues included in the 8.7 release label Nov 22, 2024
@akeller akeller mentioned this pull request Nov 22, 2024
9 tasks
Copy link
Contributor

👋 🤖 🤔 Hello, @akeller! 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.6/.

  • docs/reference/glossary.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.

@akeller akeller requested review from felix-mueller and a team November 22, 2024 17:56
docs/reference/glossary.md Outdated Show resolved Hide resolved
@@ -163,6 +167,10 @@ A message contains information to be delivered to interested parties during exec

- [Messages](/components/concepts/messages.md)

### Orchestration cluster

An orchestration cluster includes Zeebe, Operate, Tasklist, and Optimize, existing alongside the management cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

Orchestration cluster= Orchestration Cluster Core + Connectors+ Connectors Runtime
Orchestration Cluster Core = Zeebe, Operate, Tasklist, Optimize and identity

Copy link
Member Author

Choose a reason for hiding this comment

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

I added both terms, but referred to the "Orchestration Cluster Core" as follows:

Orchestration core

An orchestration core or orchestration cluster core includes Zeebe, Operate, Tasklist, Optimize, and Identity.

Would this work @theburi? Or do you want use to be specific and refer to this as "orchestration cluster core"?

@akeller
Copy link
Member Author

akeller commented Dec 2, 2024

@theburi I followed up on your doc since it sounds like some of this has changed while I was out. See my comments, particularly regarding SaaS and "core".

@akeller akeller mentioned this pull request Dec 3, 2024
9 tasks
@akeller akeller changed the title Add management and orchestration cluster glossary terms Add orchestration cluster glossary terms Dec 3, 2024
@akeller akeller requested a review from theburi December 4, 2024 21:45
@akeller akeller marked this pull request as ready for review December 4, 2024 21:46
@akeller
Copy link
Member Author

akeller commented Dec 4, 2024

@theburi can you review these terms for good working definitions? We can refine them in another PR, but I want to make sure the tech writers know how to use these moving forward.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

This matches my understanding of orchestration cluster vs core, with two comments:

  • As far as I understand, the Core will not change, but additional features might be added to the orchestration cluster - IDP and RPA? So the definition as written will need to be expanded when that occurs. I'm wondering if we have a more generic way to refer to "The orchestration core and any other optional components"?
  • From what I've seen in discussions and PRs, we're using "orchestration cluster" over "core" almost exclusively. Is "core" something we want to push externally? Does it matter to a customer if they know "core" is only X components, or can they just assume their orchestration cluster is always X components, and also inclusive of anything else added to it? If we rarely use "core" in the docs it can make the communication a little more confusing. More of a question for @theburi.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

Based on further discussion with @theburi, going ahead and approving this, as it matches what was confirmed as approved in this internal doc.

We'll just need to remember that if/when additional features get added to the orchestration cluster, they will need to be added to this list.

@akeller akeller merged commit e84c8e2 into main Dec 13, 2024
8 checks passed
@akeller akeller deleted the add-cluster-terms-glossary branch December 13, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target:8.7 Issues included in the 8.7 release
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants