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 note of temporary Helm chart alpha limitations #5153

Merged
merged 3 commits into from
Mar 7, 2025

Conversation

conceptualshark
Copy link
Contributor

@conceptualshark conceptualshark commented Mar 5, 2025

Description

Resolves https://github.com/camunda/documentation-team/issues/464

The release of 8.8.0-alpha2 delivers Orchestration-level Identity with basic authentication capabilities limited to select components. A note has been added to both the Helm installation docs and the 8.8 Announcements to ensure there is notification of this change for any alpha users.

#5154 - this issue has been created to ensure this limitation notice is removed in the next release.

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 DevEx 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 (version 8.8).
    • are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

Copy link
Contributor

github-actions bot commented Mar 5, 2025

👋 🤖 🤔 Hello, @conceptualshark! 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/announcements/880.md
  • docs/self-managed/setup/install.md
These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • docs/reference/announcements/880.md
  • docs/self-managed/setup/install.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.

@conceptualshark conceptualshark added 8.8.0-alpha2 component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Mar 5, 2025
@conceptualshark conceptualshark changed the title add note of temporary alpha limitation to installation, announcements Add note of temporary Helm chart alpha limitations Mar 5, 2025
Copy link
Contributor Author

@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.

I think calling out this limitation in the Helm install page and Announcements makes the most sense, but am open to other options. We could probably link out to additional support info once #5133 is finished.

@@ -115,6 +115,15 @@ Camunda 8.8 introduces a streamlined architecture, consolidating core components

You can download the alpha release of the unified package from the Camunda GitHub repository, either as an executable Java application (Camunda Orchestration Core) or a Docker image.

### Identity and authentication limitations in 8.8.0-alpha2
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've placed this in the section of the Announcements that deals specifically with the Helm chart, but we also have a section on the overall Identity management changes.

@conceptualshark conceptualshark requested review from megglos, Ben-Sheppard and a team March 5, 2025 17:56
megglos
megglos previously approved these changes Mar 5, 2025
Copy link
Contributor

@megglos megglos left a comment

Choose a reason for hiding this comment

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

LGTM! 🙌


The 13.0.0-alpha2 Helm chart released with Camunda 8.8.0-alpha2 establishes a new default setup to support 8.8 [Identity management updates](#identity-management-updates-saasself-managed). Currently, this setup is limited to the following components:

- The Orchestration core (Zeebe, Operate, Tasklist, and Orchestration Identity)
Copy link
Contributor

Choose a reason for hiding this comment

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

Does the "orchestration core" also include Optimize? That's what we have in glossary.md, but wasn't sure with how unique Optimize is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The slack conversation is here: https://camunda.slack.com/archives/C01H4NG9XDY/p1740070705216559

But I would hold off on any immediate follow-up based on this comment #5133 (comment) - it sounds like Optimize will help take on that discussion.


The 13.0.0-alpha2 Helm chart released with Camunda 8.8.0-alpha2 establishes a new default setup to support 8.8 [Identity management updates](#identity-management-updates-saasself-managed). Currently, this setup is limited to the following components:

- The Orchestration core (Zeebe, Operate, Tasklist, and Orchestration Identity)
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't have "Orchestration Identity" elsewhere in the docs -- do we need to newly define this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Part of #5133, so this could be linked if needed once that's merged.

@conceptualshark conceptualshark merged commit 1c23474 into main Mar 7, 2025
8 checks passed
@conceptualshark conceptualshark deleted the cg-identity-helm-alpha2 branch March 7, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.8.0-alpha2 component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants