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 a warning for Keycloak URL changes after 8.5 #4294

Merged
merged 5 commits into from
Sep 18, 2024

Conversation

conceptualshark
Copy link
Contributor

Description

In 8.5, a change to Identity to use the frontend URL instead of the backend url was not documented. In some cases, users may be blocking the frontend URL, causing impacts to functionality.

This PR adds the warning to the 8.5 announcements and the 8.4 - > 8.5 upgrade guides, and adds the note for visibility in the Keycloak connection guides for 8.5 and 8.6.

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

Copy link
Contributor

github-actions bot commented Sep 12, 2024

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

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

  • versioned_docs/version-8.5/reference/announcements.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 requested a review from a team September 12, 2024 16:24
@conceptualshark
Copy link
Contributor Author

Assuming there's no config change needed, I think this represents the best places to add the note. Since it was missed in the initial announcements, I've added it to both the 8.5 and /next connection guide, so it isn't lost in prior update guides users may not think apply to them.

@mesellings mesellings requested review from mesellings and removed request for a team September 13, 2024 14:13
mesellings
mesellings previously approved these changes Sep 13, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm - just a suggestion about addressing the customer directly, but feel free to ignore 👍

@christinaausley christinaausley added component:identity Issues related with Identity project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Sep 13, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm 👍 🚀

@conceptualshark conceptualshark merged commit 5f115f8 into main Sep 18, 2024
8 checks passed
@conceptualshark conceptualshark deleted the cg-identity-breaking-changes branch September 18, 2024 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:identity Issues related with Identity project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants