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

doc: add azure backup configuration to broker configuration page. #3518

Merged
merged 7 commits into from
Apr 3, 2024
Merged

doc: add azure backup configuration to broker configuration page. #3518

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ba3a42c
doc: add azure backup configuration to broker configuration page.
rodrigo-lourenco-lopes Mar 25, 2024
470237c
Merge branch 'main' into rl-document-azure-envs
rodrigo-lourenco-lopes Mar 25, 2024
d4c1a54
minor typo
christinaausley Mar 26, 2024
e24e417
style(formatting): technical review
christinaausley Apr 2, 2024
938bc73
revert change
christinaausley Apr 2, 2024
7a8d408
Update docs/self-managed/zeebe-deployment/configuration/broker.md
christinaausley Apr 3, 2024
523102f
Update docs/self-managed/zeebe-deployment/configuration/broker.md
christinaausley Apr 3, 2024
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
31 changes: 28 additions & 3 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 @@ -204,9 +204,9 @@ Use the same configuration on all brokers of this cluster.

:::

| Field | Description | Example Value |
| ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| store | Set the backup store type. Supported values are [NONE, S3, GCS]. Default value is NONE. When NONE, no backup store is configured and no backup will be taken. Use S3 to use any S3 compatible storage, including, but not limited to, Amazon S3. Use GCS to use [Google Cloud Storage](https://cloud.google.com/storage/). This setting can also be overridden using the environment variable `ZEEBE_BROKER_DATA_BACKUP_STORE`. | NONE |
| Field | Description | Example Value |
| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| store | Set the backup store type. Supported values are [NONE, S3, GCS, AZURE]. Default value is NONE. When NONE, no backup store is configured and no backup will be taken. Use S3 to use any S3 compatible storage, including, but not limited to, Amazon S3. Use GCS to use [Google Cloud Storage](https://cloud.google.com/storage/). Use AZURE to employ [Azure Cloud Storage](https://learn.microsoft.com/en-us/azure/storage/common/storage-introduction). This setting can also be overridden using the environment variable `ZEEBE_BROKER_DATA_BACKUP_STORE`. | NONE |

#### YAML snippet

Expand Down Expand Up @@ -276,6 +276,31 @@ backup:
auth: auto
```

### zeebe.broker.data.backup.azure

Configure the following if store is set to Azure.

| Field | Description | Example Value |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| endpoint | Name of the endpoint where the backup will be stored. Sets the blob service endpoint. This setting can also be overridden using the environment variable `ZEEBE_BROKER_DATA_BACKUP_AZURE_ENDPOINT`. | |
| accountName | Account name used to connect to the service. This setting can also be overridden using the environment variable `ZEEBE_BROKER_DATA_BACKUP_AZURE_ACCOUNTNAME`. | |
| accountKey | Account key used to connect to the service. This setting can also be overridden using the environment variable `ZEEBE_BROKER_DATA_BACKUP_AZURE_ACCOUNTKEY`. | |
| connectionString | The connection string to connect to the service. If this is defined, it will override the account name, account key, and endpoint. This setting can also be overridden using the environment variable `ZEEBE_BROKER_DATA_BACKUP_AZURE_CONNECTIONSTRING`. | |
| basePath | Used to define the container name where the blobs will be saved. This basePath cannot be null. This setting can also be overridden using the environment variable `ZEEBE_BROKER_DATA_BACKUP_AZURE_BASEPATH`. | |

#### YAML snippet

```yaml
backup:
store: azure
azure:
endpoint: null
accountName: null
accountKey: null
connectionString: null
basePath: null
```

### zeebe.broker.cluster

This section contains all cluster related configurations, to setup a zeebe cluster.
Expand Down
Loading