From 3ff614553162d3a2022e1eaa12200832c076b061 Mon Sep 17 00:00:00 2001 From: Nicolas Pepin-Perreault Date: Fri, 7 Mar 2025 12:17:47 +0100 Subject: [PATCH] refactor: backport to older versions --- .../zeebe-deployment/configuration/broker.md | 8 ++++---- .../zeebe-deployment/configuration/gateway.md | 8 ++++---- .../zeebe-deployment/configuration/broker.md | 10 ++++++++-- .../zeebe-deployment/configuration/gateway.md | 6 ++++++ .../zeebe-deployment/configuration/broker.md | 10 ++++++++-- .../zeebe-deployment/configuration/gateway.md | 6 ++++++ 6 files changed, 36 insertions(+), 12 deletions(-) diff --git a/docs/self-managed/zeebe-deployment/configuration/broker.md b/docs/self-managed/zeebe-deployment/configuration/broker.md index 9b8201ac895..3dc84c94044 100644 --- a/docs/self-managed/zeebe-deployment/configuration/broker.md +++ b/docs/self-managed/zeebe-deployment/configuration/broker.md @@ -174,11 +174,11 @@ network: ```yaml security: enabled: false - certificateChainPath: - privateKeyPath: + certificateChainPath: null + privateKeyPath: null keyStore: - filePath: - password: + filePath: null + password: null ``` ### zeebe.broker.network.commandApi diff --git a/docs/self-managed/zeebe-deployment/configuration/gateway.md b/docs/self-managed/zeebe-deployment/configuration/gateway.md index d3c9603ed7c..ec37c281f26 100644 --- a/docs/self-managed/zeebe-deployment/configuration/gateway.md +++ b/docs/self-managed/zeebe-deployment/configuration/gateway.md @@ -256,11 +256,11 @@ You can read more about intra-cluster security on [its dedicated page](../securi ```yaml security: enabled: false - certificateChainPath: - privateKeyPath: + certificateChainPath: null + privateKeyPath: null keyStore: - filePath: - password: + filePath: null + password: null ``` ### zeebe.gateway.cluster.security.authentication diff --git a/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md b/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md index d56e04b8a86..fcd0af62525 100644 --- a/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md +++ b/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md @@ -161,14 +161,20 @@ network: | enabled | Enables TLS authentication between this gateway and other nodes in the cluster. This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_ENABLED`. | false | | certificateChainPath | Sets the path to the certificate chain file. This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_CERTIFICATECHAINPATH`. | | | privateKeyPath | Sets the path to the private key file location. This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_PRIVATEKEYPATH`. | | +| keyStore | Configures the keystore file containing both the certificate chain and the private key; currently only supports PKCS12 format. | | +| keyStore.filePath | The path for keystore file; This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_FILEPATH`. | /path/key.pem | +| keyStore.password | Sets the password for the keystore file, if not set it is assumed there is no password; This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_PASSWORD` | changeme | #### YAML snippet ```yaml security: enabled: false - certificateChainPath: - privateKeyPath: + certificateChainPath: null + privateKeyPath: null + keyStore: + filePath: null + password: null ``` ### zeebe.broker.network.commandApi diff --git a/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.md b/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.md index ff1bdb6069d..25db7e513fe 100644 --- a/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.md +++ b/versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.md @@ -223,6 +223,9 @@ You can read more about intra-cluster security on [its dedicated page](../securi | enabled | Enables TLS authentication between this gateway and other nodes in the cluster. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_ENABLED`. | false | | certificateChainPath | Sets the path to the certificate chain file. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_CERTIFICATECHAINPATH`. | | | privateKeyPath | Sets the path to the private key file location. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_PRIVATEKEYPATH`. | | +| keyStore | Configures the keystore file containing both the certificate chain and the private key; currently only supports PKCS12 format. | | +| keyStore.filePath | The path for keystore file; This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_KEYSTORE_FILEPATH`. | /path/key.pem | +| keyStore.password | Sets the password for the keystore file, if not set it is assumed there is no password; This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_KEYSTORE_PASSWORD` | changeme | #### YAML snippet @@ -231,6 +234,9 @@ security: enabled: false certificateChainPath: null privateKeyPath: null + keyStore: + filePath: null + password: null ``` ### zeebe.gateway.cluster.security.authentication diff --git a/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md b/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md index 31b92dac76d..ea0e6207f49 100644 --- a/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md +++ b/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md @@ -165,14 +165,20 @@ network: | enabled | Enables TLS authentication between this gateway and other nodes in the cluster. This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_ENABLED`. | false | | certificateChainPath | Sets the path to the certificate chain file. This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_CERTIFICATECHAINPATH`. | | | privateKeyPath | Sets the path to the private key file location. This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_PRIVATEKEYPATH`. | | +| keyStore | Configures the keystore file containing both the certificate chain and the private key; currently only supports PKCS12 format. | | +| keyStore.filePath | The path for keystore file; This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_FILEPATH`. | /path/key.pem | +| keyStore.password | Sets the password for the keystore file, if not set it is assumed there is no password; This setting can also be overridden using the environment variable `ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_PASSWORD` | changeme | #### YAML snippet ```yaml security: enabled: false - certificateChainPath: - privateKeyPath: + certificateChainPath: null + privateKeyPath: null + keyStore: + filePath: null + password: null ``` ### zeebe.broker.network.commandApi diff --git a/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/gateway.md b/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/gateway.md index 59bb03c44d6..f07429d3af3 100644 --- a/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/gateway.md +++ b/versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/gateway.md @@ -247,6 +247,9 @@ You can read more about intra-cluster security on [its dedicated page](../securi | enabled | Enables TLS authentication between this gateway and other nodes in the cluster. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_ENABLED`. | false | | certificateChainPath | Sets the path to the certificate chain file. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_CERTIFICATECHAINPATH`. | | | privateKeyPath | Sets the path to the private key file location. This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_PRIVATEKEYPATH`. | | +| keyStore | Configures the keystore file containing both the certificate chain and the private key; currently only supports PKCS12 format. | | +| keyStore.filePath | The path for keystore file; This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_KEYSTORE_FILEPATH`. | /path/key.pem | +| keyStore.password | Sets the password for the keystore file, if not set it is assumed there is no password; This setting can also be overridden using the environment variable `ZEEBE_GATEWAY_CLUSTER_SECURITY_KEYSTORE_PASSWORD` | changeme | #### YAML snippet @@ -255,6 +258,9 @@ security: enabled: false certificateChainPath: null privateKeyPath: null + keyStore: + filePath: null + password: null ``` ### zeebe.gateway.cluster.security.authentication