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.

Sign up for GitHub

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

Update configuration to match PKCS12 support #5181

Merged
merged 4 commits into from
Mar 7, 2025
Merged

Update configuration to match PKCS12 support #5181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa1a262
refactor: use correct environment variable
npepinpe Mar 7, 2025
2d60107
refactor: add missing PKCS12 support configuration
npepinpe Mar 7, 2025
3ff6145
refactor: backport to older versions
npepinpe Mar 7, 2025
32b394a
style: apply review feedback
npepinpe Mar 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions docs/self-managed/zeebe-deployment/configuration/broker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,19 +160,25 @@ network:

### zeebe.broker.network.security

| Field | Description | Example Value |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| 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`. | |
| Field | Description | Example Value |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| 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
Expand Down
16 changes: 11 additions & 5 deletions docs/self-managed/zeebe-deployment/configuration/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,11 +242,14 @@ You can read more about intra-cluster security on [its dedicated page](../securi

:::

| Field | Description | Example value |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| 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`. | |
| Field | Description | Example value |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| 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

Expand All @@ -255,6 +258,9 @@ security:
enabled: false
certificateChainPath: null
privateKeyPath: null
keyStore:
filePath: null
password: null
```

### zeebe.gateway.cluster.security.authentication
Expand Down
4 changes: 2 additions & 2 deletions docs/self-managed/zeebe-deployment/security/secure-cluster-communication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ security:
# Currently only supports PKCS#12 format.
keyStore:
# The path for the keystore file
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_PKCS12_FILEPATH
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_FILEPATH
filePath:

# 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_PKCS12_PASSWORD
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_PASSWORD
password:
```

Expand Down
10 changes: 8 additions & 2 deletions versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/broker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-8.6/self-managed/zeebe-deployment/configuration/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -231,6 +234,9 @@ security:
enabled: false
certificateChainPath: null
privateKeyPath: null
keyStore:
filePath: null
password: null
```

### zeebe.gateway.cluster.security.authentication
Expand Down
4 changes: 2 additions & 2 deletions ...sion-8.6/self-managed/zeebe-deployment/security/secure-cluster-communication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ security:
# Currently only supports PKCS#12 format.
keyStore:
# The path for the keystore file
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_PKCS12_FILEPATH
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_FILEPATH
filePath:

# 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_PKCS12_PASSWORD
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_PASSWORD
password:
```

Expand Down
10 changes: 8 additions & 2 deletions versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/broker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-8.7/self-managed/zeebe-deployment/configuration/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -255,6 +258,9 @@ security:
enabled: false
certificateChainPath: null
privateKeyPath: null
keyStore:
filePath: null
password: null
```

### zeebe.gateway.cluster.security.authentication
Expand Down
4 changes: 2 additions & 2 deletions ...sion-8.7/self-managed/zeebe-deployment/security/secure-cluster-communication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@ security:
# Currently only supports PKCS#12 format.
keyStore:
# The path for the keystore file
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_PKCS12_FILEPATH
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_FILEPATH
filePath:

# 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_PKCS12_PASSWORD
# This setting can also be overridden using the environment variable ZEEBE_BROKER_NETWORK_SECURITY_KEYSTORE_PASSWORD
password:
```

Expand Down
Loading