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 identity request management in gateway #4547

Merged
merged 3 commits into from
Nov 11, 2024

Conversation

koevskinikola
Copy link
Member

@koevskinikola koevskinikola commented Oct 31, 2024

Description

Document the Identity request management feature in the Zeebe Gateway. Since the configuration properties for this feature are experimental, we are not documenting them directly, but onlt linking to the YAML configuration templates in the camunda/camunda repository. This follows the same documentation pattern as the Broker's experimental configuration properties.

ℹ️ This PR documents the code added through the following PRs:

The fix must be released with the upcoming 8.6.x, 8.5.y, and 8.4.4 patch releases. Due to Identity's re-architecture, the bug won't be present in 8.7 so no need to document it there.

closes #4546

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/).

@koevskinikola koevskinikola requested review from remcowesterhoud and a team October 31, 2024 15:22
@koevskinikola koevskinikola self-assigned this Oct 31, 2024
Copy link
Contributor

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

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

  • versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.md
  • versioned_docs/version-8.6/self-managed/zeebe-deployment/operations/backpressure.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
Copy link
Member

akeller commented Nov 1, 2024

The fix must be released with the upcoming 8.6.x, 8.5.y, and 8.4.4 patch releases. Due to Identity's re-architecture, the bug won't be present in 8.7 so no need to document it there.

Thank you for this!

@akeller akeller added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:zeebe Issues related with Zeebe project labels Nov 1, 2024
conceptualshark
conceptualshark previously approved these changes Nov 1, 2024
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.

I moved the backpressure note to the end of the introduction if that's alright, but this is otherwise good to go on my end. 👍

I'll keep an eye on this for when it receives engineering approval, and can cut a release to the docs site then.

remcowesterhoud
remcowesterhoud previously approved these changes Nov 4, 2024
Copy link
Contributor

@remcowesterhoud remcowesterhoud left a comment

Choose a reason for hiding this comment

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

No comments from my side 👍

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.

Thanks for the version fix - let me know if you'd like this released once it's merged.

koevskinikola and others added 3 commits November 11, 2024 09:59
Document the Identity request management feature in
the Zeebe Gateway. Since the configuration properties
for this feature are experimental, we are not documenting
them directly, but onlt linking to the YAML configuration
templates in the camunda/camunda repository. This follows
the same documentation pattern as the Broker's experimental
configuration properties.
@koevskinikola koevskinikola force-pushed the 4546-identity-request-management-gateway branch from 421a2cd to 3740104 Compare November 11, 2024 08:59
@koevskinikola koevskinikola enabled auto-merge (squash) November 11, 2024 08:59
@koevskinikola
Copy link
Member Author

Hey @conceptualshark, yes, releasing this as soon as it is merged would be great, thanks!

@koevskinikola koevskinikola merged commit 6f7f273 into main Nov 11, 2024
6 checks passed
@koevskinikola koevskinikola deleted the 4546-identity-request-management-gateway branch November 11, 2024 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:zeebe Issues related with Zeebe project
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Document Identity request management in Zeebe
5 participants