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.

Sign up for GitHub

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 special config for Web Modeler application/client #4499

Merged
merged 5 commits into from
Nov 19, 2024
Merged

Add special config for Web Modeler application/client #4499

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9d3763c
Add special config for Web Modeler application/client
ingorichtsmeier Oct 22, 2024
0aa0c19
Merge branch 'main' into web-modeler-oidc-keycloak
ingorichtsmeier Nov 15, 2024
dae3f6b
Remove Keycloak mentioning to keep generic style
ingorichtsmeier Nov 15, 2024
db55286
update instructions and backport
conceptualshark Nov 18, 2024
02baca6
edit app to application
conceptualshark Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/self-managed/setup/guides/connect-to-an-oidc-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@ configuration](#component-specific-configuration) to ensure the components are c
<h3>Steps</h3>

1. In your OIDC provider, create an application for each of the components you want to connect. The expected redirect URI of the component you are configuring an app for can be found in [component-specific configuration](#component-specific-configuration).
2. Make a note of the following values for each application you create:
2. For all components except Web Modeler, the application has to be of confidential access type. For Web Modeler, which is a single page web application, the application has to be of public access type.
Copy link
Contributor

Choose a reason for hiding this comment

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

To make this additionally generic, would the following be appropriate?:

Suggested change
2. For all components except Web Modeler, the application has to be of confidential access type. For Web Modeler, which is a single page web application, the application has to be of public access type.
2. For all Components, ensure the appropriate application type is used:
- **Operate, Tasklist, Optimize, Identity:** Web apps requiring confidential access/a confidential client
- **Modeler, Console:** Single-page applications requiring public access/a public client
except Web Modeler, ensure the application is confidential. For Web Modeler, which is a single page web application, the application has to be of public access type.

I've added Console here as it's listed as a single-page app so I expect it would have the same requirements as Web Modeler - do you know if this assumption is correct? I think this bridges the gap between the original Keycloak ask and also remaining generic for other OIDC providers which might require a version of this information.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @conceptualshark, I haven't used Console in my self-managed setup so far, but it is mentioned in the MS Entra section. It should be correct to add it here.
Your change improved it a lot, let's go to master!
Thank you!

3. Make a note of the following values for each application you create:
- Client ID
- Client secret
- Audience
3. Set the following environment variables for the component you are configuring an app for:
4. Set the following environment variables for the component you are configuring an app for:

<Tabs groupId="optionsType" defaultValue="env" queryString values={[{label: 'Environment variables', value: 'env' },{label: 'Helm values', value: 'helm' }]} >
<TabItem value="env">
Expand Down
5 changes: 3 additions & 2 deletions ...ioned_docs/version-8.5/self-managed/setup/guides/connect-to-an-oidc-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@ configuration](#component-specific-configuration) to ensure the components are c
<h3>Steps</h3>

1. In your OIDC provider, create an application for each of the components you want to connect. The expected redirect URI of the component you are configuring an app for can be found in [component-specific configuration](#component-specific-configuration).
2. Make a note of the following values for each application you create:
2. For all components except Web Modeler, the application has to be of confidential access type. For Web Modeler, which is a single page web application, the application has to be of public access type.
3. Make a note of the following values for each application you create:
- Client ID
- Client secret
- Audience
3. Set the following environment variables for the component you are configuring an app for:
4. Set the following environment variables for the component you are configuring an app for:

<Tabs groupId="optionsType" defaultValue="env" queryString values={[{label: 'Environment variables', value: 'env' },{label: 'Helm values', value: 'helm' }]} >
<TabItem value="env">
Expand Down
5 changes: 3 additions & 2 deletions ...ioned_docs/version-8.6/self-managed/setup/guides/connect-to-an-oidc-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@ configuration](#component-specific-configuration) to ensure the components are c
<h3>Steps</h3>

1. In your OIDC provider, create an application for each of the components you want to connect. The expected redirect URI of the component you are configuring an app for can be found in [component-specific configuration](#component-specific-configuration).
2. Make a note of the following values for each application you create:
2. For all components except Web Modeler, the application has to be of confidential access type. For Web Modeler, which is a single page web application, the application has to be of public access type.
3. Make a note of the following values for each application you create:
- Client ID
- Client secret
- Audience
3. Set the following environment variables for the component you are configuring an app for:
4. Set the following environment variables for the component you are configuring an app for:

<Tabs groupId="optionsType" defaultValue="env" queryString values={[{label: 'Environment variables', value: 'env' },{label: 'Helm values', value: 'helm' }]} >
<TabItem value="env">
Expand Down