From a6902337f7c04e2f8e40f86c342140dd58076333 Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Mon, 24 Jun 2024 09:38:38 -0400 Subject: [PATCH 1/2] clarify spring boot conventions for config, update spring links --- .../console-deployment/configuration.md | 3 +++ .../identity/deployment/configuration-variables.md | 5 ++--- .../operate-deployment/operate-configuration.md | 8 ++++---- .../tasklist-deployment/tasklist-configuration.md | 13 +++++++++++-- .../zeebe-deployment/configuration/configuration.md | 2 +- .../configuration/environment-variables.md | 3 ++- .../zeebe-deployment/configuration/configuration.md | 2 +- .../configuration/environment-variables.md | 3 ++- .../identity/deployment/configuration-variables.md | 5 ++--- .../operate-deployment/operate-configuration.md | 8 ++++---- .../tasklist-deployment/tasklist-configuration.md | 13 +++++++++++-- .../zeebe-deployment/configuration/configuration.md | 2 +- .../configuration/environment-variables.md | 3 ++- .../identity/deployment/configuration-variables.md | 5 ++--- .../operate-deployment/operate-configuration.md | 8 ++++---- .../tasklist-deployment/tasklist-configuration.md | 13 +++++++++++-- .../zeebe-deployment/configuration/configuration.md | 2 +- .../configuration/environment-variables.md | 3 ++- .../console-deployment/configuration.md | 3 +++ .../identity/deployment/configuration-variables.md | 5 ++--- .../operate-deployment/operate-configuration.md | 8 ++++---- .../tasklist-deployment/tasklist-configuration.md | 13 +++++++++++-- .../zeebe-deployment/configuration/configuration.md | 2 +- .../configuration/environment-variables.md | 3 ++- .../console-deployment/configuration.md | 3 +++ .../identity/deployment/configuration-variables.md | 5 ++--- .../operate-deployment/operate-configuration.md | 9 ++++----- .../tasklist-deployment/tasklist-configuration.md | 13 +++++++++++-- .../zeebe-deployment/configuration/configuration.md | 2 +- .../configuration/environment-variables.md | 3 ++- 30 files changed, 112 insertions(+), 58 deletions(-) diff --git a/docs/self-managed/console-deployment/configuration.md b/docs/self-managed/console-deployment/configuration.md index d686ed8a3d..6175e6f06f 100644 --- a/docs/self-managed/console-deployment/configuration.md +++ b/docs/self-managed/console-deployment/configuration.md @@ -9,6 +9,9 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](/reference/licenses.md#console). ::: +As a Spring Boot application, Console supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. + Console Self-Managed can be configured using environment variables and configuration parameters: ## Environment variables diff --git a/docs/self-managed/identity/deployment/configuration-variables.md b/docs/self-managed/identity/deployment/configuration-variables.md index cd1bee3c61..2cb55c61c3 100644 --- a/docs/self-managed/identity/deployment/configuration-variables.md +++ b/docs/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ## Core configuration diff --git a/docs/self-managed/operate-deployment/operate-configuration.md b/docs/self-managed/operate-deployment/operate-configuration.md index 461d72ee69..031934f332 100644 --- a/docs/self-managed/operate-deployment/operate-configuration.md +++ b/docs/self-managed/operate-deployment/operate-configuration.md @@ -3,15 +3,15 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: The following parts are configurable: diff --git a/docs/self-managed/tasklist-deployment/tasklist-configuration.md b/docs/self-managed/tasklist-deployment/tasklist-configuration.md index 3b5968b248..d33c9aef12 100644 --- a/docs/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/docs/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: ## Webserver diff --git a/docs/self-managed/zeebe-deployment/configuration/configuration.md b/docs/self-managed/zeebe-deployment/configuration/configuration.md index 0c75f4c652..d8a9135b11 100644 --- a/docs/self-managed/zeebe-deployment/configuration/configuration.md +++ b/docs/self-managed/zeebe-deployment/configuration/configuration.md @@ -85,7 +85,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/docs/self-managed/zeebe-deployment/configuration/environment-variables.md b/docs/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/docs/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/docs/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md index c3637a7eb4..3e79dc0633 100644 --- a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/configuration.md @@ -85,7 +85,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-1.3/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md index e3805c2153..0867feda5d 100644 --- a/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.2/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ### Core configuration diff --git a/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md b/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md index 921171062e..b7c9c34673 100644 --- a/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md +++ b/versioned_docs/version-8.2/self-managed/operate-deployment/operate-configuration.md @@ -3,15 +3,15 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: The following parts are configurable: diff --git a/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md b/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md index 63aa3d2676..844632fdcd 100644 --- a/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/versioned_docs/version-8.2/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: - [Webserver](#webserver) - [Elasticsearch](#elasticsearch) diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md index b0f0a60328..1975595de9 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/configuration.md @@ -87,7 +87,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-8.2/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md index 85015e5876..104b764749 100644 --- a/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.3/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ## Core configuration diff --git a/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md b/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md index ad692ea747..34a2631711 100644 --- a/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md +++ b/versioned_docs/version-8.3/self-managed/operate-deployment/operate-configuration.md @@ -3,15 +3,15 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: The following parts are configurable: diff --git a/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md b/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md index 4e5a24b7cd..c6425b50fc 100644 --- a/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/versioned_docs/version-8.3/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: ## Webserver diff --git a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md index b0f0a60328..1975595de9 100644 --- a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/configuration.md @@ -87,7 +87,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-8.3/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md b/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md index af9d62fa5e..29b404b159 100644 --- a/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md +++ b/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md @@ -9,6 +9,9 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](../../reference/licenses.md#console). ::: +As a Spring Boot application, Console supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. + Console Self-Managed can be configured using environment variables and configuration parameters: ## Environment variables diff --git a/versioned_docs/version-8.4/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.4/self-managed/identity/deployment/configuration-variables.md index 70e9fa4b34..3853d24777 100644 --- a/versioned_docs/version-8.4/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.4/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ### Core configuration diff --git a/versioned_docs/version-8.4/self-managed/operate-deployment/operate-configuration.md b/versioned_docs/version-8.4/self-managed/operate-deployment/operate-configuration.md index ac63b1ccc2..d1c30eff4b 100644 --- a/versioned_docs/version-8.4/self-managed/operate-deployment/operate-configuration.md +++ b/versioned_docs/version-8.4/self-managed/operate-deployment/operate-configuration.md @@ -3,15 +3,15 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: The following parts are configurable: diff --git a/versioned_docs/version-8.4/self-managed/tasklist-deployment/tasklist-configuration.md b/versioned_docs/version-8.4/self-managed/tasklist-deployment/tasklist-configuration.md index 855a7014f0..39e27687e0 100644 --- a/versioned_docs/version-8.4/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/versioned_docs/version-8.4/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: ## Webserver diff --git a/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/configuration.md index 0c75f4c652..d8a9135b11 100644 --- a/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/configuration.md @@ -85,7 +85,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-8.4/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). diff --git a/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md b/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md index d686ed8a3d..6175e6f06f 100644 --- a/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md +++ b/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md @@ -9,6 +9,9 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](/reference/licenses.md#console). ::: +As a Spring Boot application, Console supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. + Console Self-Managed can be configured using environment variables and configuration parameters: ## Environment variables diff --git a/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md b/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md index cd1bee3c61..2cb55c61c3 100644 --- a/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md +++ b/versioned_docs/version-8.5/self-managed/identity/deployment/configuration-variables.md @@ -5,9 +5,8 @@ sidebar_label: "Configuration variables" description: "Learn more about core configuration, component configuration, database configuration, and feature flags." --- -As Identity is a Spring Boot application, you may use the standard -Spring [configuration](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -methods. +As a Spring Boot application, Identity supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. ## Core configuration diff --git a/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md b/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md index b7d8394da0..c616d31d1d 100644 --- a/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md +++ b/versioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md @@ -3,17 +3,16 @@ id: operate-configuration title: Configuration --- -Operate is a Spring Boot application. This means every way to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) -a Spring Boot application can be applied. +As a Spring Boot application, Operate supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. By default, the configuration for Operate is stored in a YAML file (`application.yml`). All Operate-related settings are prefixed with `camunda.operate`. :::note -Configuration properties can also be defined as environment variables by converting to uppercase and replacing delimiters with `_`. +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. -For example, the property `camunda.operate.elasticsearch.clustername` can be defined as the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. +For example, the property `camunda.operate.elasticsearch.clustername` is represented by the environment variable `CAMUNDA_OPERATE_ELASTICSEARCH_CLUSTERNAME`. ::: - The following parts are configurable: ## Webserver diff --git a/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md b/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md index 3b5968b248..d33c9aef12 100644 --- a/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md +++ b/versioned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md @@ -3,9 +3,18 @@ id: tasklist-configuration title: Configuration --- -Tasklist is a Spring Boot application. This means all provided ways to [configure](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) a Spring Boot application can be applied. +As a Spring Boot application, Tasklist supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. -By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. The following components are configurable: +By default, the configuration for Tasklist is stored in a YAML file `application.yml`. All Tasklist-related settings are prefixed with `camunda.tasklist`. + +:::note +Configuration properties can be defined as environment variables using [Spring Boot conventions](https://docs.spring.io/spring-boot/reference/features/external-config.html#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables). To define an environment variable, convert the configuration property to uppercase, remove any dashes, and replace any delimiters (`.`) with `_`. + +For example, the property `server.servlet.context-path` is represented by the environment variable `SERVER_SERVLET_CONTEXT_PATH`. +::: + +The following components are configurable: ## Webserver diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md index 0c75f4c652..d8a9135b11 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md +++ b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/configuration.md @@ -85,7 +85,7 @@ Rename the configuration file to `application.yaml` and place it in the followin ### Other ways to specify the configuration file -Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config) should also work. In particular, you can use: +Zeebe uses Spring Boot for its configuration parsing. All other ways to [configure a Spring Boot application](https://docs.spring.io/spring-boot/reference/features/external-config.html) should also work. In particular, you can use: - `SPRING_CONFIG_ADDITIONAL_LOCATION` to specify an additional configuration file. - `SPRING_APPLICATION_JSON` to specify settings in JSON format. diff --git a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md index 19ffa5603e..46a78bbe95 100644 --- a/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md +++ b/versioned_docs/version-8.5/self-managed/zeebe-deployment/configuration/environment-variables.md @@ -6,7 +6,8 @@ description: "Let's take a closer look at the environment variables for configur ## Environment variables for configuration -The configuration can be provided as a file or through environment variables. Mixing both sources is also possible. In that case, environment variables have precedence over the configuration settings in the configuration file. +As a Spring Boot application, Zeebe supports any standard +[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. This configuration can be provided as a configuration file, through environment variables, or both. When both sources are used, environment variables have precedence over the configuration file. All available environment variables are documented in the [configuration file templates](configuration.md#configuration-file-templates). From e0876ee40a0b1560db10af09e13ebcc79b5eff7c Mon Sep 17 00:00:00 2001 From: Cole Garbo Date: Thu, 27 Jun 2024 13:18:26 -0400 Subject: [PATCH 2/2] remove spring note from console, add underscore explanation --- docs/self-managed/console-deployment/configuration.md | 7 ++++--- .../self-managed/console-deployment/configuration.md | 7 ++++--- .../self-managed/console-deployment/configuration.md | 7 ++++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/self-managed/console-deployment/configuration.md b/docs/self-managed/console-deployment/configuration.md index 6175e6f06f..c70ee053b6 100644 --- a/docs/self-managed/console-deployment/configuration.md +++ b/docs/self-managed/console-deployment/configuration.md @@ -9,10 +9,11 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](/reference/licenses.md#console). ::: -As a Spring Boot application, Console supports any standard -[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. +Console Self-Managed can be configured using environment variables and configuration parameters. -Console Self-Managed can be configured using environment variables and configuration parameters: +:::note +Underscores in environment variables correspond to configuration file key levels. +::: ## Environment variables diff --git a/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md b/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md index 29b404b159..1ad596b340 100644 --- a/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md +++ b/versioned_docs/version-8.4/self-managed/console-deployment/configuration.md @@ -9,10 +9,11 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](../../reference/licenses.md#console). ::: -As a Spring Boot application, Console supports any standard -[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. +Console Self-Managed can be configured using environment variables and configuration parameters. -Console Self-Managed can be configured using environment variables and configuration parameters: +:::note +Underscores in environment variables correspond to configuration file key levels. +::: ## Environment variables diff --git a/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md b/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md index 6175e6f06f..c70ee053b6 100644 --- a/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md +++ b/versioned_docs/version-8.5/self-managed/console-deployment/configuration.md @@ -9,10 +9,11 @@ description: "Read details on the configuration variables of Console Self-Manage Console Self-Managed is available only to [Enterprise customers](/reference/licenses.md#console). ::: -As a Spring Boot application, Console supports any standard -[Spring configuration](https://docs.spring.io/spring-boot/reference/features/external-config.html) method. +Console Self-Managed can be configured using environment variables and configuration parameters. -Console Self-Managed can be configured using environment variables and configuration parameters: +:::note +Underscores in environment variables correspond to configuration file key levels. +::: ## Environment variables