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

External OIDC setup docs is confusing for customers #4619

Open
zalanszak opened this issue Nov 19, 2024 · 5 comments
Open

External OIDC setup docs is confusing for customers #4619

zalanszak opened this issue Nov 19, 2024 · 5 comments
Assignees
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed kind/bug Issues related with bugs in the documentation support Issues related to support tickets

Comments

@zalanszak
Copy link

On this page: https://docs.camunda.io/docs/self-managed/setup/guides/connect-to-an-oidc-provider/

At the configuration section there are environment variables and Helm values offered. However, it is not explicitly specified that they are in a XOR relation - i.e. the customer should not use both at the same time, but either the helm values or the environment variables. This confusion lead to incorrect setups in customer environments, e.g.: https://jira.camunda.com/browse/SUPPORT-24589

Please append an additional note that only one of these options should be used: either helm values or env variables, but not both!

@akeller akeller added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Nov 19, 2024
@akeller akeller added the kind/bug Issues related with bugs in the documentation label Nov 19, 2024
@akeller
Copy link
Member

akeller commented Nov 19, 2024

@conceptualshark can you please review and PR?

@conceptualshark conceptualshark self-assigned this Nov 19, 2024
@conceptualshark conceptualshark moved this from 🆕 Inbox to 🏗 In Progress in Developer Experience Nov 19, 2024
@conceptualshark
Copy link
Contributor

Left an open question with distribution on how to best handle this, as it seems related to either updating the Connectors docs for a better experience, or may need additional info on how/when env vars do not override Helm values. I think the ultimate impact may need to be in the Connectors config guide vs the OIDC docs.

@akeller akeller added the support Issues related to support tickets label Dec 2, 2024
@garima-camunda
Copy link

This came up again while discussing this support ticket. None of the support engineers were sure how to interpret the Connectors config (as shown in the screenshot).

  • Do they need to specify all the configs or would it vary depending on env variable?
  • The ones specified in "For inbound mode," do they belong to Operate?
Image

@alessandrocavalli, please add/update if I missed something or anything is not correct.

@hisImminence
Copy link
Contributor

Thanks @akeller for reaching out!

  1. To resolve the first issues mentioned by @zalanszak in the ticket:

At the configuration section there are environment variables and Helm values offered. However, it is not explicitly specified that they are in a XOR relation

--> Please review this PR (adds a simple or in the statement).

  1. For the two questions about connectors by @garima-camunda:

Do they need to specify all the configs or would it vary depending on env variable?
The ones specified in "For inbound mode," do they belong to Operate?

--> @sbuettner do you have the context to answer these and could clarify it in the doc section 🙏 ?

@sbuettner
Copy link
Contributor

The ones specified in "For inbound mode," do they belong to Operate?

The Connectors act as a Client for Operate and would need this configuration.

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 kind/bug Issues related with bugs in the documentation support Issues related to support tickets
Projects
Status: 🏗 In Progress
Development

No branches or pull requests

6 participants