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

Create backup docs #3791

Merged
merged 7 commits into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
41 changes: 41 additions & 0 deletions docs/components/console/manage-clusters/cluster-backups.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: create-backups
title: Create backup
description: "If your organization works within Camunda's Enterprise plan, you can create cluster backups."
---

If your organization works within Camunda's [Enterprise](https://camunda.com/enterprise/) plan, you can create a manual and scheduled [backups](/components/concepts/backups.md) of your cluster.

:::caution
Only the three most recent successful backups of each type are kept, meaning you can have three manual and three scheduled backups. If you already have three backups of a type, the oldest backup is automatically removed.
:::

## Create a manual backup

You can create a manual backup every five hours.

To create a manual backup, take the following steps:

1. Select the **Backups** tab.
2. Click **Create manual backup**.

![cluster-details](./img/cluster-detail-backups.png)

3. A popup modal will appear with more information about manual backups, including retention. Click **Create backup**.

![cluster-details](./img/cluster-detail-backups-manual.png)

## Create a scheduled backup

To create a scheduled backup, take the following steps:

1. Select the **Backups** tab.
2. Click **Create schedule**.

![cluster-details](./img/cluster-detail-backups.png)

3. Use the dropdown to schedule the frequency for backups - daily or weekly.
4. Select the time of day you would like backups to be taken at this frequency.
5. Click **Create schedule**.

![cluster-details](./img/cluster-detail-create-scheduled-backup.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ module.exports = {
"components/console/manage-clusters/manage-api-clients",
"components/console/manage-clusters/manage-alerts",
"components/console/manage-clusters/manage-ip-allowlists",
"components/console/manage-clusters/create-backups",
"components/console/manage-clusters/manage-secrets",
"components/console/manage-clusters/settings",
],
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: create-backups
title: Create backup
description: "If your organization works within Camunda's Enterprise plan, you can create cluster backups."
---

If your organization works within Camunda's [Enterprise](https://camunda.com/enterprise/) plan, you can create a manual and scheduled [backups](/components/concepts/backups.md) of your cluster.

:::caution
Only the three most recent successful backups of each type are kept, meaning you can have three manual and three scheduled backups. If you already have three backups of a type, the oldest backup is automatically removed.
:::

## Create a manual backup

You can create a manual backup every five hours.

To create a manual backup, take the following steps:

1. Select the **Backups** tab.
2. Click **Create manual backup**.

![cluster-details](./img/cluster-detail-backups.png)

3. A popup modal will appear with more information about manual backups, including retention. Click **Create backup**.

![cluster-details](./img/cluster-detail-backups-manual.png)

## Create a scheduled backup

To create a scheduled backup, take the following steps:

1. Select the **Backups** tab.
2. Click **Create schedule**.

![cluster-details](./img/cluster-detail-backups.png)

3. Use the dropdown to schedule the frequency for backups - daily or weekly.
4. Select the time of day you would like backups to be taken at this frequency.
5. Click **Create schedule**.

![cluster-details](./img/cluster-detail-create-scheduled-backup.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
id: create-backups
title: Create backup
description: "If your organization works within Camunda's Enterprise plan, you can create cluster backups."
---

If your organization works within Camunda's [Enterprise](https://camunda.com/enterprise/) plan, you can create a manual and scheduled [backups](/components/concepts/backups.md) of your cluster.

:::caution
Only the three most recent successful backups of each type are kept, meaning you can have three manual and three scheduled backups. If you already have three backups of a type, the oldest backup is automatically removed.
:::

## Create a manual backup

You can create a manual backup every five hours.

To create a manual backup, take the following steps:

1. Select the **Backups** tab.
2. Click **Create manual backup**.

![cluster-details](./img/cluster-detail-backups.png)

3. A popup modal will appear with more information about manual backups, including retention. Click **Create backup**.

![cluster-details](./img/cluster-detail-backups-manual.png)

## Create a scheduled backup

To create a scheduled backup, take the following steps:

1. Select the **Backups** tab.
2. Click **Create schedule**.

![cluster-details](./img/cluster-detail-backups.png)

3. Use the dropdown to schedule the frequency for backups - daily or weekly.
4. Select the time of day you would like backups to be taken at this frequency.
5. Click **Create schedule**.

![cluster-details](./img/cluster-detail-create-scheduled-backup.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions versioned_sidebars/version-8.4-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@
"components/console/manage-clusters/manage-api-clients",
"components/console/manage-clusters/manage-alerts",
"components/console/manage-clusters/manage-ip-allowlists",
"components/console/manage-clusters/create-backups",
"components/console/manage-clusters/manage-secrets",
"components/console/manage-clusters/settings"
]
Expand Down
1 change: 1 addition & 0 deletions versioned_sidebars/version-8.5-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@
"components/console/manage-clusters/manage-api-clients",
"components/console/manage-clusters/manage-alerts",
"components/console/manage-clusters/manage-ip-allowlists",
"components/console/manage-clusters/create-backups",
"components/console/manage-clusters/manage-secrets",
"components/console/manage-clusters/settings"
]
Expand Down
Loading