Skip to content

Commit bd77b90

Browse files
committed
restructure backups page
1 parent 465bf86 commit bd77b90

File tree

7 files changed

+82
-59
lines changed

7 files changed

+82
-59
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
sidebar_label: Configurable Backups
3+
slug: /en/cloud/manage/backups/configurable-backups
4+
description: Configurable Backups
5+
title: Configurable Backups
6+
keywords: [backups, cloud backups, restore]
7+
---
8+
9+
import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
10+
import ScalePlanFeatureBadge from '@theme/badges/ScalePlanFeatureBadge';
11+
12+
<ScalePlanFeatureBadge feature="Configurable Backups" linking_verb_are="True"/>
13+
14+
ClickHouse Cloud allows you to configure the schedule for your backups for **Scale** and **Enterprise** tier services. Backups can be configured along the following dimensions based on your business needs.
15+
16+
- **Retention**: The duration of days, for which each backup will be retained. Retention can be specified as low as 1 day, and as high as 30 days with several values to pick in between.
17+
- **Frequency**: The frequency allows you to specify the time duration between subsequent backups. For instance, a frequency of "every 12 hours" means that backups will be spaced 12 hours apart. Frequency can range from "every 6 hours" to "every 48 hours" in the following hourly increments: `6`, `8`, `12`, `16`, `20`, `24`, `36`, `48`.
18+
- **Start Time**: The start time for when you want to schedule backups each day. Specifying a start time implies that the backup "Frequency" will default to once every 24 hours. Clickhouse Cloud will start the backup within an hour of the specified start time.
19+
20+
:::note
21+
The custom schedule will override the default backup policy in ClickHouse Cloud for your given service.
22+
:::
23+
24+
To configure the backup schedule for a service, go to the **Settings** tab in the console and click on **Change backup configuration**.
25+
26+
<div class="eighty-percent">
27+
![Configure backup settings](../images/backup-settings.png)
28+
</div>
29+
<br/>
30+
31+
This opens a tab to the right where you can choose values for retention, frequency, and start time. You will need to save the chosen settings for them to take effect.
32+
33+
<div class="eighty-percent">
34+
![Select backup retention and frequency](../images/backup-configuration-form.png)
35+
</div>
36+
<br/>
37+
38+
:::note
39+
Start time and frequency are mutually exclusive. Start time takes precedence.
40+
:::
41+
42+
:::note
43+
Changing the backup schedule can cause higher monthly charges for storage as some of the backups might not be covered in the default backups for the service. See ["Understanding backup cost"](./overview.md/#understanding-backup-cost) section below.
44+
:::

docs/en/cloud/manage/bring-your-own-bucket.md renamed to docs/en/cloud/manage/backups/export-backups-to-own-cloud-account.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_label: Export Backups to your Own Cloud Account
3-
slug: /en/cloud/manage/bring-your-own-bucket
3+
slug: /en/cloud/manage/backups/export-backups-to-own-cloud-account
44
title: Export Backups to your Own Cloud Account
55
---
66

@@ -9,12 +9,12 @@ import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge
99
<EnterprisePlanFeatureBadge/>
1010

1111
ClickHouse Cloud supports taking backups to your own cloud service provider (CSP) account (AWS S3, Google Cloud Storage, or Azure Blob Storage).
12-
For details of how ClickHouse Cloud backups work, including "full" vs. "incremental" backups, see the [backups](./backups.md) docs.
12+
For details of how ClickHouse Cloud backups work, including "full" vs. "incremental" backups, see the [backups](backups.md) docs.
1313

1414
Here we show examples of how to take full and incremental backups to AWS, GCP, Azure object storage as well as how to restore from the backups.
1515

1616
:::note
17-
Users should be aware that any usage where backups are being exported to a different region in the same cloud provider, or to another cloud provider (in the same or different region) will incur [data transfer](./network-data-transfer.mdx) charges.
17+
Users should be aware that any usage where backups are being exported to a different region in the same cloud provider, or to another cloud provider (in the same or different region) will incur [data transfer](../network-data-transfer.mdx) charges.
1818
:::
1919

2020
## Requirements

docs/en/cloud/manage/backups/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
slug: /en/cloud/manage/backups
3+
title: Backups
4+
description: Table of contents page for backups.
5+
keywords: [backups, configurable backups, export backups to own cloud]
6+
---
7+
8+
| Page | Description |
9+
|---------------------------|-------------|
10+
| [Overview](./overview.md) | |
11+
| | |

docs/en/cloud/manage/backups.md renamed to docs/en/cloud/manage/backups/overview.md

Lines changed: 17 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
sidebar_label: Backups
3-
slug: /en/cloud/manage/backups
4-
description: Managing backups in ClickHouse Cloud
2+
sidebar_label: Overview
3+
sidebar_position: 0
4+
slug: /en/cloud/manage/backups/overview
5+
title: Overview
56
keywords: [backups, cloud backups, restore]
67
---
78

@@ -20,65 +21,29 @@ In the screenshot below, the solid line squares show full backups and the dotted
2021

2122
On Day 1, a full backup is taken to start the backup chain. On Day 2, an incremental backup is taken, and we now have a full and incremental backup available to restore from. By Day 7, we have one full backup and six incremental backups in the chain, with the most recent two incremental backups visible to the user. On Day 8, we take a new full backup, and on Day 9, once we have two backups in the new chain, the previous chain is discarded.
2223

23-
![Backup chain](./images/backup-chain.png)
24+
![Backup chain](../images/backup-chain.png)
2425

2526
*Example backup scenario in Clickhouse Cloud*
2627

2728
## Default backup policy
2829

29-
All services will default to one backup, retained for a day with the new Pricing tiers.
30-
Users who need additional backups can do so by configuring additional backups under the settings tab of the Cloud Console.
30+
All services will default to one backup, retained for a day with the new Pricing tiers.
31+
Users who need additional backups can do so by configuring additional backups under the settings tab of the Cloud Console.
3132
No free backups are included in the new pricing.
3233

33-
## Configurable backups
34-
35-
<ScalePlanFeatureBadge feature="Configurable Backups" linking_verb_are="True"/>
36-
37-
ClickHouse Cloud allows you to configure the schedule for your backups for **Scale** and **Enterprise** tier services. Backups can be configured along the following dimensions based on your business needs.
38-
39-
- **Retention**: The duration of days, for which each backup will be retained. Retention can be specified as low as 1 day, and as high as 30 days with several values to pick in between.
40-
- **Frequency**: The frequency allows you to specify the time duration between subsequent backups. For instance, a frequency of "every 12 hours" means that backups will be spaced 12 hours apart. Frequency can range from "every 6 hours" to "every 48 hours" in the following hourly increments: `6`, `8`, `12`, `16`, `20`, `24`, `36`, `48`.
41-
- **Start Time**: The start time for when you want to schedule backups each day. Specifying a start time implies that the backup "Frequency" will default to once every 24 hours. Clickhouse Cloud will start the backup within an hour of the specified start time.
42-
43-
:::note
44-
The custom schedule will override the default backup policy in ClickHouse Cloud for your given service.
45-
:::
46-
47-
To configure the backup schedule for a service, go to the **Settings** tab in the console and click on **Change backup configuration**.
48-
49-
<div class="eighty-percent">
50-
![Configure backup settings](./images/backup-settings.png)
51-
</div>
52-
<br/>
53-
54-
This opens a tab to the right where you can choose values for retention, frequency, and start time. You will need to save the chosen settings for them to take effect.
55-
56-
<div class="eighty-percent">
57-
![Select backup retention and frequency](./images/backup-configuration-form.png)
58-
</div>
59-
<br/>
60-
61-
:::note
62-
Start time and frequency are mutually exclusive. Start time takes precedence.
63-
:::
64-
65-
:::note
66-
Changing the backup schedule can cause higher monthly charges for storage as some of the backups might not be covered in the default backups for the service. See ["Understanding backup cost"](#understanding-backup-cost) section below.
67-
:::
68-
6934
## Backup status list
7035

7136
Your service will be backed up based on the set schedule, whether it is the default daily schedule or a custom schedule picked by you. All available backups can be viewed from the **Backups** tab of the service. From here, you can see the status of the backup, the duration, as well as the size of the backup. You can also restore a specific backup using the **Actions** column.
7237

73-
![List of backups statuses](./images/backup-status-list.png)
38+
![List of backups statuses](../images/backup-status-list.png)
7439

7540
## Understanding backup cost
7641

7742
ClickHouse Cloud includes two backups for free, but choosing a schedule that requires retaining more data, or causes more frequent backups can cause additional storage charges for backups. If you do not change the default settings, you will not incur any backup cost.
7843

7944
To understand the backup cost, you can view the backup cost per service from the usage screen (as shown below). Once you have backups running for a few days with a customized schedule, you can get an idea of the cost and extrapolate to get the monthly cost for backups.
8045

81-
![Backup usage chart](./images/backup-usage.png)
46+
![Backup usage chart](../images/backup-usage.png)
8247

8348
Estimating the total cost for your backups requires you to set a schedule. We are also working on updating our [pricing calculator](https://clickhouse.com/pricing), so you can get a monthly cost estimate before setting a schedule. You will need to provide the following inputs in order to estimate the cost:
8449
- Size of the full and incremental backups
@@ -97,14 +62,14 @@ Backups are restored to a new ClickHouse Cloud service, not to the existing serv
9762

9863
After clicking on the **Restore** backup icon, you can specify the service name of the new service that will be created, and then restore this backup:
9964

100-
![Restoring a backup](./images/backup-restore.png)
65+
![Restoring a backup](../images/backup-restore.png)
10166

10267
The new service will show in the services list as `Provisioning` until it is ready:
10368

104-
<img src={require('./images/backup-service-provisioning.png').default}
105-
class="image"
106-
alt="Provisioning service in progress"
107-
style={{width: '80%'}} />
69+
<img src={require('../images/backup-service-provisioning.png').default}
70+
class="image"
71+
alt="Provisioning service in progress"
72+
style={{width: '80%'}} />
10873

10974
## Working with your restored service
11075

@@ -189,12 +154,12 @@ After you have successfully inserted the data into your original service, make s
189154

190155
<CloudNotSupportedBadge/>
191156

192-
The `UNDROP` command is not supported in ClickHouse Cloud. If you accidentally `DROP` a table, the best course of action is to restore your last backup and recreate the table from the backup.
157+
The `UNDROP` command is not supported in ClickHouse Cloud. If you accidentally `DROP` a table, the best course of action is to restore your last backup and recreate the table from the backup.
193158

194159
To prevent users from accidentally dropping tables, you can use [`GRANT` statements](/docs/en/sql-reference/statements/grant) to revoke permissions for the [`DROP TABLE` command](/docs/en/sql-reference/statements/drop#drop-table) for a specific user or role.
195160

196161
:::note
197-
To prevent accidental deletion of data, please note that by default it is not possible to drop tables >`1TB` in size in ClickHouse Cloud.
162+
To prevent accidental deletion of data, please note that by default it is not possible to drop tables >`1TB` in size in ClickHouse Cloud.
198163
Should you wish to drop tables greater than this threshold you can use setting `max_table_size_to_drop` to do so:
199164

200165
```sql
@@ -205,4 +170,4 @@ SYNC SETTINGS max_table_size_to_drop=2097152 -- increases the limit to 2TB
205170

206171
## Export backups to your own cloud account
207172

208-
For users wanting to export backups to their own cloud account, see [here](/docs/en/cloud/manage/bring-your-own-bucket).
173+
For users wanting to export backups to their own cloud account, see [here](./configurable-backups.md).

docs/en/cloud/manage/billing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Storage costs are the same across tiers and vary by region and cloud service pro
2424

2525
Storage and backups are counted towards storage costs and billed separately.
2626
All services will default to one backup, retained for a day.
27-
Users who need additional backups can do so by configuring additional [backups](./backups.md) under the settings tab of the Cloud Console.
27+
Users who need additional backups can do so by configuring additional [backups](backups/backups.md) under the settings tab of the Cloud Console.
2828

2929
### How do I estimate compression?
3030

sidebars.js

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,10 +216,12 @@ const sidebars = {
216216
label: "Backups",
217217
collapsed: true,
218218
collapsible: true,
219-
link: {type: "doc", id: "en/cloud/manage/backups"},
220219
items: [
221-
"en/cloud/manage/bring-your-own-bucket",
222-
],
220+
{
221+
type: "autogenerated",
222+
dirName: "en/cloud/manage/backups",
223+
}
224+
]
223225
},
224226
{
225227
type: "category",

src/css/custom.scss

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ body {
155155
* or in the columns on the doc homepage */
156156
filter: none;
157157
background-color: transparent;
158+
box-shadow: none;
158159
}
159160
}
160161

0 commit comments

Comments
 (0)