Adding possible configuration variables for identity and also linked it to the gateway configuration #4863

itsnuyen · 2025-01-16T16:11:36Z

Description

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

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

…it to the gateway configuration

github-actions · 2025-01-16T16:12:00Z

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

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

versioned_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md
versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.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.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

…the updated configuration parameters

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

jonathanlukas

Very good first iteration! Please reach out to me to discuss my comments :)

jonathanlukas · 2025-01-17T11:03:21Z

docs/self-managed/identity/deployment/configuration-variables.md

We will check whether and how identity will be configured in the core component of 8.7

jonathanlukas · 2025-01-17T11:05:24Z

versioned_docs/version-8.4/self-managed/identity/deployment/configuration-variables.md

@@ -27,6 +27,19 @@ As a Spring Boot application, Identity supports any standard
 | `KEYCLOAK_SETUP_CLIENT_ID`           | The client to use for authentication during setup of the provided Keycloak.         | admin-cli                                                                                                                                                                |
 | `KEYCLOAK_URL`                       | The URL of the Keycloak instance to use.                                            | http://localhost:18080/auth                                                                                                                                              |

+## Camunda Identity Configuration


The header can be misleading. Maybe "Camunda Identity SDK Configuration" would be better.

Suggested change

## Camunda Identity Configuration

## Camunda Identity SDK Configuration

jonathanlukas · 2025-01-17T11:05:36Z

versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md

@@ -27,6 +27,20 @@ As a Spring Boot application, Identity supports any standard
 | `KEYCLOAK_SETUP_CLIENT_ID`           | The client to use for authentication during setup of the provided Keycloak.         | admin-cli                                                                                                                                                                |
 | `KEYCLOAK_URL`                       | The URL of the Keycloak instance to use.                                            | http://localhost:18080/auth                                                                                                                                              |

+## Camunda Identity Configuration


The header can be misleading. Maybe "Camunda Identity SDK Configuration" would be better.

Suggested change

## Camunda Identity Configuration

## Camunda Identity SDK Configuration

jonathanlukas · 2025-01-17T11:05:41Z

versioned_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md

@@ -27,6 +27,20 @@ As a Spring Boot application, Identity supports any standard
 | `KEYCLOAK_SETUP_CLIENT_ID`           | The client to use for authentication during setup of the provided Keycloak.         | admin-cli                                                                                                                                                                |
 | `KEYCLOAK_URL`                       | The URL of the Keycloak instance to use.                                            | http://localhost:18080/auth                                                                                                                                              |

+## Camunda Identity Configuration


The header can be misleading. Maybe "Camunda Identity SDK Configuration" would be better.

Suggested change

## Camunda Identity Configuration

## Camunda Identity SDK Configuration

jonathanlukas · 2025-01-17T11:06:04Z

versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.md

@@ -251,7 +251,7 @@ security:

 :::note
 The Zeebe configuration properties for Camunda Identity are deprecated as of version `8.4.0`. Use the dedicated
-Camunda Identity properties or the [corresponding environment variables](../../identity/deployment/configuration-variables.md#core-configuration).
+Camunda Identity properties or the [corresponding environment variables](../../identity/deployment/configuration-variables.md#camunda-identity-configuration).


Suggested change

Camunda Identity properties or the [corresponding environment variables](../../identity/deployment/configuration-variables.md#camunda-identity-configuration).

Camunda Identity properties or the [corresponding environment variables](../../identity/deployment/configuration-variables.md#camunda-identity-sdk-configuration).

jonathanlukas · 2025-01-17T11:07:20Z

versioned_docs/version-8.4/self-managed/identity/deployment/configuration-variables.md

@@ -27,6 +27,19 @@ As a Spring Boot application, Identity supports any standard
 | `KEYCLOAK_SETUP_CLIENT_ID`           | The client to use for authentication during setup of the provided Keycloak.         | admin-cli                                                                                                                                                                |
 | `KEYCLOAK_URL`                       | The URL of the Keycloak instance to use.                                            | http://localhost:18080/auth                                                                                                                                              |

+## Camunda Identity Configuration
+


Add a small section that explains that these properties are used to configure the identity connection for each camunda component

jonathanlukas · 2025-01-17T11:07:27Z

versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md

@@ -27,6 +27,20 @@ As a Spring Boot application, Identity supports any standard
 | `KEYCLOAK_SETUP_CLIENT_ID`           | The client to use for authentication during setup of the provided Keycloak.         | admin-cli                                                                                                                                                                |
 | `KEYCLOAK_URL`                       | The URL of the Keycloak instance to use.                                            | http://localhost:18080/auth                                                                                                                                              |

+## Camunda Identity Configuration
+


Add a small section that explains that these properties are used to configure the identity connection for each camunda component

jonathanlukas · 2025-01-17T11:07:32Z

versioned_docs/version-8.6/self-managed/identity/deployment/configuration-variables.md

@@ -27,6 +27,20 @@ As a Spring Boot application, Identity supports any standard
 | `KEYCLOAK_SETUP_CLIENT_ID`           | The client to use for authentication during setup of the provided Keycloak.         | admin-cli                                                                                                                                                                |
 | `KEYCLOAK_URL`                       | The URL of the Keycloak instance to use.                                            | http://localhost:18080/auth                                                                                                                                              |

+## Camunda Identity Configuration
+


Add a small section that explains that these properties are used to configure the identity connection for each camunda component

jonathanlukas · 2025-01-17T11:09:03Z

docs/self-managed/identity/deployment/configuration-variables.md

+
+| Environment Variable              | Property         | Description                                                                                                                       | Default Value              |
+| --------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
+| CAMUNDA_IDENTITY_ISSUERBACKENDURL | issuerBackendUrl | The URL to the auth provider backend, used to validate tokens. This setting can also be overridden using the environment variable | -                          |


The "Property" should always contain the full path:

Suggested change

| CAMUNDA_IDENTITY_ISSUERBACKENDURL | issuerBackendUrl | The URL to the auth provider backend, used to validate tokens. This setting can also be overridden using the environment variable | - |

| CAMUNDA_IDENTITY_ISSUERBACKENDURL | camunda.identity.issuerBackendUrl | The URL to the auth provider backend, used to validate tokens. This setting can also be overridden using the environment variable | - |

jonathanlukas · 2025-01-17T11:09:49Z

docs/self-managed/identity/deployment/configuration-variables.md

+| Environment Variable              | Property         | Description                                                                                                                       | Default Value              |
+| --------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
+| CAMUNDA_IDENTITY_ISSUERBACKENDURL | issuerBackendUrl | The URL to the auth provider backend, used to validate tokens. This setting can also be overridden using the environment variable | -                          |
+| CAMUNDA_IDENTITY_AUDIENCE         | audience         | The required audience of the auth token. This setting can also be overridden using the environment variable                       | -                          |


The properties can be formatted as code to mark them.

Suggested change

| CAMUNDA_IDENTITY_AUDIENCE | audience | The required audience of the auth token. This setting can also be overridden using the environment variable | - |

| `CAMUNDA_IDENTITY_AUDIENCE` | `camunda.identity.audience` | The required audience of the auth token. This setting can also be overridden using the environment variable | - |

…s well as formating

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Adding possible configuration variables for identity and also linked …

b47814c

…it to the gateway configuration

github-actions bot assigned itsnuyen Jan 16, 2025

itsnuyen and others added 4 commits January 17, 2025 08:47

Apply suggestions from code review

2b3803b

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

chore: update docs for 8.4 and 8.5 according to the 8.6 version with …

eded661

…the updated configuration parameters

chore: adding changes from v8.4 .. v8.6 to normal docs

f6b239e

Apply suggestions from code review

7dff717

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

jonathanlukas requested changes Jan 17, 2025

View reviewed changes

itsnuyen and others added 2 commits January 17, 2025 13:55

chore: revert some changes and adding more information to the table a…

ca64c52

…s well as formating

Apply suggestions from code review

f6670ac

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

itsnuyen requested a review from jonathanlukas January 20, 2025 09:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding possible configuration variables for identity and also linked it to the gateway configuration #4863

Adding possible configuration variables for identity and also linked it to the gateway configuration #4863

itsnuyen commented Jan 16, 2025

github-actions bot commented Jan 16, 2025 •

edited

Loading

jonathanlukas left a comment

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

jonathanlukas Jan 17, 2025

	## Camunda Identity Configuration
	## Camunda Identity SDK Configuration

	Camunda Identity properties or the [corresponding environment variables](../../identity/deployment/configuration-variables.md#camunda-identity-configuration).
	Camunda Identity properties or the [corresponding environment variables](../../identity/deployment/configuration-variables.md#camunda-identity-sdk-configuration).

	\| CAMUNDA_IDENTITY_ISSUERBACKENDURL \| issuerBackendUrl \| The URL to the auth provider backend, used to validate tokens. This setting can also be overridden using the environment variable \| - \|
	\| CAMUNDA_IDENTITY_ISSUERBACKENDURL \| camunda.identity.issuerBackendUrl \| The URL to the auth provider backend, used to validate tokens. This setting can also be overridden using the environment variable \| - \|

	\| CAMUNDA_IDENTITY_AUDIENCE \| audience \| The required audience of the auth token. This setting can also be overridden using the environment variable \| - \|
	\| `CAMUNDA_IDENTITY_AUDIENCE` \| `camunda.identity.audience` \| The required audience of the auth token. This setting can also be overridden using the environment variable \| - \|

Adding possible configuration variables for identity and also linked it to the gateway configuration #4863

Are you sure you want to change the base?

Adding possible configuration variables for identity and also linked it to the gateway configuration #4863

Conversation

itsnuyen commented Jan 16, 2025

Description

When should this change go live?

PR Checklist

github-actions bot commented Jan 16, 2025 • edited Loading

jonathanlukas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 16, 2025 •

edited

Loading