Skip to content

Conversation

Ben-Sheppard
Copy link
Contributor

Description

Closes #6671

This PR updates the overview page for Orchestration Identity focusing on renaming the existing Helm tab to be application.yaml and adding a helm tab where necessary.

Additionally I spotted some inconsistencies in the property reference recently change too so included a cleanup here.

As per the linked issue, I looked for additional places but couldn't immediately spot any relevant configuration for the new architecture where the config is and didn't want to block this PR because of that. If there are additional places I will follow up with them.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.8).
  • My changes are for an already released minor and are in a /versioned_docs directory.

Copy link
Contributor

github-actions bot commented Oct 1, 2025

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

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

christinaausley
christinaausley previously approved these changes Oct 1, 2025
Copy link
Member

@ThorbenLindhauer ThorbenLindhauer 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 preparing, please see my detailed comments.

In addition, on the initialization page please also add a Helm tab to the example for the default user configuration.


| Property | Description | Default value |
| ---------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------ |
| `orchestration.security.authentication.oidc.audiences` | Comma-separated list of audiences to validate in the OIDC token. | |
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
| `orchestration.security.authentication.oidc.audiences` | Comma-separated list of audiences to validate in the OIDC token. | |
| `orchestration.security.authentication.oidc.audience` | Comma-separated list of audiences to validate in the OIDC token. | |

See https://github.com/camunda/camunda-platform-helm/blob/de19d5e1f609a3ed615b5507817581c01f4f86a8/charts/camunda-platform-8.8/templates/orchestration/files/_application-unified.yaml#L102

And I believe that takes a single value (might be wrong though). See also the Helm value orchestration.security.authentication.oidc.backwardsCompatibleAudiences that we could mention here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I decided to not document this property here, its a property that is automatically set by the helm charts when required and I'm not sure its inclusion here adds much value in typical operation

Copy link
Member

Choose a reason for hiding this comment

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

It's part of the migration guide here: https://docs.camunda.io/docs/next/self-managed/deployment/helm/upgrade/upgrade-hc-870-880/#values-key-changes

Anyway, I don't mind too much not documenting it, you can decide.

@Ben-Sheppard Ben-Sheppard force-pushed the 6671-adjust-properties-for-identity-initialization branch from aca6e97 to 68ae2fd Compare October 7, 2025 14:56
@christinaausley
Copy link
Contributor

@Ben-Sheppard Just let me know when you are ready for final review 👍

@Ben-Sheppard Ben-Sheppard force-pushed the 6671-adjust-properties-for-identity-initialization branch from 68ae2fd to 1f1cb03 Compare October 14, 2025 19:49
@christinaausley christinaausley added component:identity Issues related with Identity project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Oct 15, 2025
Copy link
Member

@ThorbenLindhauer ThorbenLindhauer left a comment

Choose a reason for hiding this comment

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

Thanks, looks good to me.

Re the one open discussion, feel free to decide in either direction.

@ThorbenLindhauer
Copy link
Member

Ah, and one more comment: Now that the 8.8 docs are released, this needs a "backport" into the 8.8 directory.

@Ben-Sheppard
Copy link
Contributor Author

Thank you @ThorbenLindhauer - the changes are already applied to the 8.8 docs 👍🏻

This is ready for a final review @christinaausley :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

8.8.0 component:identity Issues related with Identity project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

Provide the correct application and Helm properties for Identity initialization

3 participants