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

Clarify steps for adding an OIDC provider #4150

Merged
merged 3 commits into from
Aug 22, 2024
Merged

Conversation

conceptualshark
Copy link
Contributor

@conceptualshark conceptualshark commented Aug 13, 2024

Description

Closes #3952

The OIDC configuration instructions for MS Entra were misleading, and implied that you needed one application for every component.

  • Update the Entra ID instructions to clarify that each component needs its own application
  • Clarify steps to be more explicit
  • Update links to correct sections of MS docs
  • Add note of two clients requirement for web modeler in component section
  • Update use of heading from markdown to html to reduce broken links in the page TOC

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

@conceptualshark conceptualshark self-assigned this Aug 13, 2024
Copy link
Contributor

github-actions bot commented Aug 13, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@conceptualshark conceptualshark added component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR labels Aug 13, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 13, 2024 21:36 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs August 14, 2024 13:46 Destroyed
@conceptualshark
Copy link
Contributor Author

@conceptualshark conceptualshark marked this pull request as ready for review August 14, 2024 14:10
@conceptualshark conceptualshark requested a review from a team August 14, 2024 14:10
Copy link
Contributor

@Ben-Sheppard Ben-Sheppard left a comment

Choose a reason for hiding this comment

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

Just one comment but its NABD for me :)


4. Set the following environment variables for the component you are configuring an app for:
1. Within the Entra ID admin center, [register a new application](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) for **each** component you would like to connect.
Copy link
Contributor

Choose a reason for hiding this comment

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

Just wondering, if we have this in here for **each** component you would like to connect do we need the note above? Maybe though this is a case of making this point very clear :)

@conceptualshark conceptualshark merged commit e19f0e5 into main Aug 22, 2024
11 checks passed
@conceptualshark conceptualshark deleted the cg-oidc-consistency branch August 22, 2024 12:50
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

OIDC configruation guide is not consistent on how to configure the clients
3 participants