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.

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

confine backup and restore breaking changes to the version they were introduced #4829

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ sidebar_label: "Backup and restore"
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes for [Operate and Tasklist](./operate-tasklist-backup.md), as well as [Optimize](./optimize-backup.md).
:::

You can use the backup feature of Camunda 8 Self-Managed to regularly back up the state of all of its components (Zeebe, Operate, Tasklist, and Optimize) without any downtime (except Web Modeler, see [the Web Modeler backup and restore documentation](./modeler-backup-and-restore.md)).
In case of failures that lead to data loss, you can recover the cluster from a backup.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ keywords: ["backup", "backups"]
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::warning breaking changes!
As of the Camunda 8.6 release, the `/actuator` endpoints (including `/backups`) now default to port 9600. Ensure your `management.server.port` configuration parameter is correctly set before continuing.
:::

Operate stores its data over multiple indices in Elasticsearch. Backup of Operate data includes several
Elasticsearch snapshots containing sets of Operate indices. Each backup is identified by `backupId`. For example, a backup with an ID of `123` may contain the following Elasticsearch snapshots:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ description: "How to perform a backup of Optimize data and restore the backup."
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes, including the utilized URL.

For example, `curl 'http://localhost:8092/actuator/backups'` rather than the previously used `backup`.
:::

Optimize stores its data over multiple indices in the database. To ensure data integrity across indices, a backup of Optimize data consists of two ElasticSearch/OpenSearch snapshots, each containing a different set of Optimize indices. Each backup is identified by a positive integer backup ID. For example, a backup with ID `123456` consists of the following snapshots:

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ sidebar_label: "Backup and restore"
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes for [Operate and Tasklist](./operate-tasklist-backup.md), as well as [Optimize](./optimize-backup.md).
:::

You can use the backup feature of Camunda 8 Self-Managed to regularly back up the state of all of its components (Zeebe, Operate, Tasklist, and Optimize) without any downtime (except Web Modeler, see [the Web Modeler backup and restore documentation](./modeler-backup-and-restore.md)).

A backup of a Camunda 8 cluster consists of a backup of Zeebe, Operate, Tasklist, Optimize, and exported Zeebe records in Elasticsearch. Since the data of these applications are dependent on each other, it is important that the backup is consistent across all components. The backups of individual components taken independently may not form a consistent recovery point. Therefore, you must take the backup of a Camunda 8 cluster as a whole. To ensure a consistent backup, follow the process described below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ keywords: ["backup", "backups"]
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::note
This release introduces breaking changes, including:

- The [get backup state API and response codes](#get-backup-state-api).
- The utilized URL has changed. For example, `curl 'http://localhost:8080/actuator/backups'` rather than the previously used `backup`.
- `backupId` must be of integer type now instead of string, which is in sync with Zeebe `backupId` requirements.

:::

Operate stores its data over multiple indices in Elasticsearch. Backup of Operate data includes several
Elasticsearch snapshots containing sets of Operate indices. Each backup is identified by `backupId`. For example, a backup with an id of `123` may contain the following Elasticsearch snapshots:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ description: "How to perform a backup of Optimize data and restore the backup."
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes, including the utilized URL.

For example, `curl 'http://localhost:8092/actuator/backups'` rather than the previously used `backup`.
:::

Optimize stores its data over multiple indices in Elasticsearch. To ensure data integrity across indices, a backup of Optimize data consists of two Elasticsearch snapshots, each containing a different set of Optimize indices. Each backup is identified by a positive integer backup ID. For example, a backup with ID `123456` consists of the following Elasticsearch snapshots:

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ sidebar_label: "Backup and restore"
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes for [Operate and Tasklist](./operate-tasklist-backup.md), as well as [Optimize](./optimize-backup.md).
:::

You can use the backup feature of Camunda 8 Self-Managed to regularly back up the state of all of its components (Zeebe, Operate, Tasklist, and Optimize) without any downtime (except Web Modeler, see [the Web Modeler backup and restore documentation](./modeler-backup-and-restore.md)).
In case of failures that lead to data loss, you can recover the cluster from a backup.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,6 @@ keywords: ["backup", "backups"]
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

:::note
This release introduces breaking changes, including:

- The [get backup state API and response codes](#get-backup-state-api).
- The utilized URL has changed. For example, `curl 'http://localhost:8080/actuator/backups'` rather than the previously used `backup`.
- `backupId` must be of integer type now instead of string, which is in sync with Zeebe `backupId` requirements.

:::

Operate stores its data over multiple indices in Elasticsearch. Backup of Operate data includes several
Elasticsearch snapshots containing sets of Operate indices. Each backup is identified by `backupId`. For example, a backup with an id of `123` may contain the following Elasticsearch snapshots:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ description: "How to perform a backup of Optimize data and restore the backup."
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes, including the utilized URL.

For example, `curl 'http://localhost:8092/actuator/backups'` rather than the previously used `backup`.
:::

Optimize stores its data over multiple indices in Elasticsearch. To ensure data integrity across indices, a backup of Optimize data consists of two Elasticsearch snapshots, each containing a different set of Optimize indices. Each backup is identified by a positive integer backup ID. For example, a backup with ID `123456` consists of the following Elasticsearch snapshots:

```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ sidebar_label: "Backup and restore"
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes for [Operate and Tasklist](./operate-tasklist-backup.md), as well as [Optimize](./optimize-backup.md).
:::

You can use the backup feature of Camunda 8 Self-Managed to regularly back up the state of all of its components (Zeebe, Operate, Tasklist, and Optimize) without any downtime (except Web Modeler, see [the Web Modeler backup and restore documentation](./modeler-backup-and-restore.md)).
In case of failures that lead to data loss, you can recover the cluster from a backup.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ description: "How to perform a backup of Optimize data and restore the backup."
keywords: ["backup", "backups"]
---

:::note
This release introduces breaking changes, including the utilized URL.

For example, `curl 'http://localhost:8092/actuator/backups'` rather than the previously used `backup`.
:::

Optimize stores its data over multiple indices in Elasticsearch. To ensure data integrity across indices, a backup of Optimize data consists of two Elasticsearch snapshots, each containing a different set of Optimize indices. Each backup is identified by a positive integer backup ID. For example, a backup with ID `123456` consists of the following Elasticsearch snapshots:

```
Expand Down
Loading