diff --git a/docs/cloud/manage/backups/backups-to-own-cloud/_category_.yml b/docs/cloud/manage/backups/backups-to-own-cloud/_category_.yml new file mode 100644 index 00000000000..eefb36aab1d --- /dev/null +++ b/docs/cloud/manage/backups/backups-to-own-cloud/_category_.yml @@ -0,0 +1,3 @@ +label: 'Export Backups to your Own Cloud Account' +collapsible: true +collapsed: true diff --git a/docs/cloud/manage/backups/backups-to-own-cloud/backup_restore_from_ui.md b/docs/cloud/manage/backups/backups-to-own-cloud/backup_restore_from_ui.md new file mode 100644 index 00000000000..79c8c9b1e65 --- /dev/null +++ b/docs/cloud/manage/backups/backups-to-own-cloud/backup_restore_from_ui.md @@ -0,0 +1,361 @@ +--- +sidebar_label: 'Backup or restore from UI' +slug: /cloud/manage/backups/backup-restore-via-ui +title: 'Take a backup or restore a backup from the UI' +description: 'Page describing how to take a backup or restore a backup from the UI with your own bucket' +sidebar_position: 2 +--- + +import Image from '@theme/IdealImage' +import arn from '@site/static/images/cloud/manage/backups/arn.png' +import change_external_backup from '@site/static/images/cloud/manage/backups/change_external_backup.png' +import configure_arn_s3_details from '@site/static/images/cloud/manage/backups/configure_arn_s3_details.png' +import view_backups from '@site/static/images/cloud/manage/backups/view_backups.png' +import backup_command from '@site/static/images/cloud/manage/backups/backup_command.png' +import gcp_configure from '@site/static/images/cloud/manage/backups/gcp_configure.png' +import gcp_stored_backups from '@site/static/images/cloud/manage/backups/gcp_stored_backups.png' +import gcp_restore_command from '@site/static/images/cloud/manage/backups/gcp_restore_command.png' +import azure_connection_details from '@site/static/images/cloud/manage/backups/azure_connection_details.png' +import view_backups_azure from '@site/static/images/cloud/manage/backups/view_backups_azure.png' + +# Take a backup or restore a backup from the UI {#ui-experience} + +## AWS {#AWS} + +### Taking backups to AWS {#taking-backups-to-aws} + +#### Steps to follow in AWS {#aws-steps} + +Follow the steps below on your AWS account: + + + +##### Create an S3 bucket {#create-s3-bucket} + +Create an AWS S3 bucket in your account where you want to export backups. + +##### Create an IAM role {#create-iam-role} + +Create an IAM role that ClickHouse Cloud service will be able to assume into, +to write to this bucket - for role-based authentication: + +* a. For this role, you will need to update the IAM role trust policy to include + the following statement: + + ```json + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::463754717262:role/CH-S3-bordeaux-ar-90-ue2-29-Role" + }, + "Action": "sts:AssumeRole" + }, + ``` +* b. The ARN in this case is obtained from the ClickHouse Cloud service settings + page which looks similar to this: + +AWS S3 ARN + +##### Update permissions for role {#update-permissions-for-role} + +You will also need to update the permissions for this role so this ClickHouse +Cloud service can write to the S3 bucket. This is done by including a JSON similar +to this one in the role permissions: + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "s3:GetBucketLocation", + "s3:ListBucket" + ], + "Resource": [ + "arn:aws:s3:::testchbackups" + ], + "Effect": "Allow" + }, + { + "Action": [ + "s3:Get*", + "s3:List*", + "s3:PutObject", + "s3:DeleteObject" + ], + "Resource": [ + "arn:aws:s3:::testchbackups/*" + ], + "Effect": "Allow" + } + ] +} +``` + + + +#### Steps to follow in ClickHouse Cloud {#cloud-steps} + +Follow the steps below in the ClickHouse Cloud console to configure the external bucket: + + + +##### Change external backup {#configure-external-bucket} + +On the “Settings” page, click on `Change external backup` + +Change external backup + +##### Configure AWS IAM Role ARN and S3 bucket details {#configure-aws-iam-role-arn-and-s3-bucket-details} + +On the next screen provide the AWS IAM Role ARN and S3 bucket details: + +Configure AWS IAM Role ARN and S3 bucket details + +##### Save changes {#save-changes} + +Click on “Save External Bucket” to save the settings + +##### Changing the backup schedule from the default schedule {#changing-the-backup-schedule} + +External Backups will now happen in your bucket on the default schedule. +Alternatively, you can configure the backup schedule from the “Settings” page. +If configured differently, the custom schedule is used to write backups to your +bucket and the default schedule (backups every 24 hours) is used for backups in +the ClickHouse cloud owned bucket. + +##### View backups stored in your bucket {#view-backups-stored-in-your-bucket} + +The Backups page should display these backups in your bucket in a separate table +as shown below: + +View backups stored in your bucket + + + +### Restoring backups from AWS {#restoring-backups-from-aws} + +Follow the steps below to restore backups from AWS: + + + +##### Create a new service to restore to {#create-new-service-to-restore-to} + +Create a new service to restore the backup to. Currently, we only support +restoring a backup into a new service. + +##### Add service ARN {#add-service-arn} + +Add the newly created service’s ARN (from the service settings page in Clickhouse +Cloud console) to the trust policy for the IAM role. This is the same as the +[second step](#create-iam-role) in the AWS Steps section above. This is required +so the new service can access the S3 bucket. + +##### Get SQL command used to restore backup {#obtain-sql-command-to-restore-backup} + +Click on the “access or restore a backup” link above the list of backups in the +UI to get the SQL command to restore the backup. The command should look like +the one shown below, and you can pick the appropriate backup from the dropdown +to get the restore command for that specific backup: + +Get SQL command used to restore backup + +##### Run the restore command {#run-the-restore-command} + +Run the restore command from the SQL console in the newly created service to +restore the backup. + + + +## GCP {#gcp} + +### Taking backups to GCP {#taking-backups-to-gcp} + +Follow the steps below to take backups to GCP: + +#### Steps to follow in GCP {#gcp-steps-to-follow} + + + +##### Create a GCP storage bucket {#create-a-gcp-storage-bucket} + +Create a storage bucket in your GCP account to export backups. + +##### Generate an HMAC Key and Secret {#generate-an-hmac-key-and-secret} + +Generate an HMAC Key and Secret, which is required for password-based authentication. Follow the steps below to generate the keys: + +* a. Create a service account + * I. Navigate to the IAM & Admin section in the Google Cloud Console and select Service Accounts. + * II. Click Create Service Account, provide a name and ID, and click Create and Continue. + * III. Grant the necessary roles for Cloud Storage access (e.g., Storage Object Admin or more granular roles like + Storage Object Creator and Storage Object Viewer) to this service account. + * IV. Click Done to finalize the service account creation. + +* b. Generate the HMAC key + * I. Go to Cloud Storage in the Google Cloud Console, and select `Settings` + * II Go to the Interoperability tab. + * III. In the `Service account HMAC` section, click Create a key for a service account. + * IV. Choose the service account you created in the previous step from the dropdown menu. + * V. Click Create key. + +* c. Securely store the credentials: + * I. The system will display the Access ID (your HMAC key) and the Secret (your HMAC secret). Save these values, as + the secret will not be displayed again after you close this window. + + + +#### Steps to follow in ClickHouse Cloud {#gcp-cloud-steps} + +Follow the steps below in the ClickHouse Cloud console to configure the external bucket: + + + +##### Change external backup {#gcp-configure-external-bucket} + +On the “Settings” page, click on “Change external backup” + +Change external backup + +##### Configure GCP HMAC Key and Secret {#gcp-configure-gcp-hmac-key-and-secret} + +On the next screen provide the GCP bucket path, HMAC key and Secret +created in the previous section. + +Configure GCP HMAC Key and Secret + +##### Save external bucket {#gcp-save-external-bucket} + +Click on `Save External Bucket` to save the settings. + +##### Changing the backup schedule from the default schedule {#gcp-changing-the-backup-schedule} + +External Backups will now happen in your bucket on the default schedule. +Alternatively, you can configure the backup schedule from the `Settings` page. +If configured differently, the custom schedule is used to write backups to your +bucket and the default schedule (backups every 24 hours) is used for backups in +ClickHouse cloud owned bucket. + +##### View backups stored in your bucket {#gcp-view-backups-stored-in-your-bucket} + +The Backups page should display these backups in your bucket in a separate table as shown below + +View backups stored in your bucket + + + +### Restoring backups from GCP {#gcp-restoring-backups-from-gcp} + +Follow the steps below to restore backups from GCP: + + + +##### Create a new service to restore to {#gcp-create-new-service-to-restore-to} + +Create a new service to restore the backup to. Currently, we only support restoring a backup into a new service. + +##### Get SQL command used to restore backup {#gcp-obtain-sql-command-to-restore-backup} + +Click on the `access or restore a backup` link above the list of backups in the +UI to get the SQL command to restore the backup. The command should look like this, +and you can pick the appropriate backup from the dropdown to get the restore +command for that specific backup. You will need to add your secret access key +to the command. + +Get SQL command used to restore backup + +##### Run SQL command to restore backup {#gcp-run-sql-command-to-restore-backup} + +Run the restore command from the SQL console in the newly created service to +restore the backup. + + + +## Azure {#azure} + +### Taking backups to Azure {#taking-backups-to-azure} + +Follow the steps below to take backups to Azure: + +#### Steps to follow in Azure {#steps-to-follow-in-azure} + + + +##### Create a storage account {#azure-create-a-storage-account} + +Create a storage account or select an existing storage account in the Azure +portal where you want to store your backups. + +##### Get connection string {#azure-get-connection-string} + +* a. In your storage account overview, look for the section called `Security + networking` and click on `Access keys`. +* b. Here, you will see `key1` and `key2`. Under each key, you’ll find a `Connection string` field. +* c. Click `Show` to reveal the connection string. Copy the connection string to set up on ClickHouse Cloud. + + + +#### Steps to follow in ClickHouse Cloud {#azure-cloud-steps} + +Follow the steps below in the ClickHouse Cloud console to configure the external bucket: + + + +##### Change external backup {#azure-configure-external-bucket} + +On the `Settings` page, click on `Change external backup` + +Change external backup + +##### Provide connection string and container name for your Azure storage account {#azure-provide-connection-string-and-container-name-azure} + +On the next screen provide the Connection String and Container Name for your +Azure storage account created in the previous section: + +Provide connection string and container name for your Azure storage account + +##### Save external bucket {#azure-save-external-bucket} + +Click on `Save External Bucket` to save the settings + +##### Changing the backup schedule from the default schedule {#azure-changing-the-backup-schedule} + +External Backups will now happen in your bucket on the default schedule. Alternatively, +you can configure the backup schedule from the “Settings” page. If configured differently, +the custom schedule is used to write backups to your bucket and the default schedule +(backups every 24 hours) is used for backups in ClickHouse cloud owned bucket. + +##### View backups stored in your bucket {#azure-view-backups-stored-in-your-bucket} + +The Backups page should display these backups in your bucket in a separate table +as shown below: + +View backups stored in your bucket + + + +### Restoring backups from Azure {#azure-restore-steps} + +To restore backups from Azure, follow the steps below: + + + +##### Create a new service to restore to {#azure-create-new-service-to-restore-to} + +Create a new service to restore the backup to. Currently, we only support +restoring a backup into a new service. + +##### Get SQL command used to restore backup {#azure-obtain-sql-command-to-restore-backup} + +Click on the `access or restore a backup` link above the list of backups in the +UI to obtain the SQL command to restore the backup. The command should look like +this, and you can pick the appropriate backup from the dropdown to get the +restore command for that specific backup. You will need to add your Azure +storage account connection string to the command. + +##### Run SQL command to restore backup {#azure-run-sql-command-to-restore-backup} + +Run the restore command from the SQL console in the newly created service to +restore the backup. + + diff --git a/docs/cloud/manage/backups/backups-to-own-cloud/backup_restore_using_commands.md b/docs/cloud/manage/backups/backups-to-own-cloud/backup_restore_using_commands.md new file mode 100644 index 00000000000..0fb6132096a --- /dev/null +++ b/docs/cloud/manage/backups/backups-to-own-cloud/backup_restore_using_commands.md @@ -0,0 +1,174 @@ +--- +sidebar_label: 'Backup or restore using commands' +slug: /cloud/manage/backups/backup-restore-via-commands +title: 'Take a backup or restore a backup using commands' +description: 'Page describing how to take a backup or restore a backup with your own bucket using commands' +sidebar_position: 3 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Take a backup or restore a backup using commands {#commands-experience} + +## Requirements {#requirements} + +You will need the following details to export/restore backups to your own CSP storage bucket: + + + + 1. AWS S3 endpoint, in the format: `s3://.s3.amazonaws.com/` + For example: `s3://testchbackups.s3.amazonaws.com/backups/ + Where: + * `testchbackups` is the name of the S3 bucket to export backups to. + * `backups` is an optional subdirectory. + 2. AWS access key and secret. (for key/secret-based authentication. We also + support role based authentication which is covered in the UI experience above) +
+ + + 1. GCS endpoint, in the format: `https://storage.googleapis.com//` + 2. Access HMAC key and HMAC secret. +
+ + + 1. Azure storage connection string. + 2. Azure container name in the storage account. + 3. Azure Blob within the container. +
+ + + +## Backup / Restore to AWS S3 Bucket {#aws-s3-bucket} + +### Full Backup {#aws-full-backup} + +```sql +BACKUP TABLE system.users, +TABLE system.roles, +TABLE system.settings_profiles, +TABLE system.row_policies, +TABLE system.quotas, +TABLE system.functions, +ALL EXCEPT DATABASES INFORMATION_SCHEMA, information_schema, system +TO S3('https://testchbackups.s3.amazonaws.com/backups/', '', '') +``` + +Where `uuid` is a unique identifier, used to differentiate a set of backups. + +:::note +You will need to use a different UUID for each new backup in this subdirectory, otherwise you will get a `BACKUP_ALREADY_EXISTS` error. For example, if you are taking daily backups, you will need to use a new UUID each day. +::: + +### Incremental Backup {#aws-incremental-backup} + +```sql +BACKUP TABLE system.users, +TABLE system.roles, +TABLE system.settings_profiles, +TABLE system.row_policies, +TABLE system.quotas, TABLE system.functions, +ALL EXCEPT DATABASES INFORMATION_SCHEMA, information_schema, system +TO S3('https://testchbackups.s3.amazonaws.com/backups/', '', '') +SETTINGS base_backup = S3('https://testchbackups.s3.amazonaws.com/backups/', '', '') +``` + +### Restore from a backup {#aws-restore-backup} + +Create a new service and run the command below: + +```sql +RESTORE ALL +FROM S3('https://testchbackups.s3.amazonaws.com/backups/', + extra_credentials( + role_arn = 'arn:aws:iam::651674194215:role/test-byob-ui-role' + ) +) +``` + +See: [Configuring BACKUP/RESTORE to use an S3 Endpoint](/operations/backup#configuring-backuprestore-to-use-an-s3-endpoint) for more details. + +## Backup / Restore to Azure Blob Storage {#azure-blob-storage} + +### Full Backup {#azure-full-backup} + +```sql +BACKUP TABLE system.users, +TABLE system.roles, +TABLE system.settings_profiles, +TABLE system.row_policies, +TABLE system.quotas, +TABLE system.functions, +ALL EXCEPT DATABASES INFORMATION_SCHEMA, information_schema, system +TO AzureBlobStorage('', '', '/'); +``` + +Where `uuid` is a unique identifier, used to differentiate a set of backups. + +### Incremental Backup {#azure-incremental-backup} + +```sql +BACKUP TABLE system.users, +TABLE system.roles, +TABLE system.settings_profiles, +TABLE system.row_policies, +TABLE system.quotas, +TABLE system.functions, +ALL EXCEPT DATABASES INFORMATION_SCHEMA, information_schema, system +TO AzureBlobStorage('', '', '//my_incremental') +SETTINGS base_backup = AzureBlobStorage('', '', '') +``` + +### Restore from a backup {#azure-restore-backup} + +Create a new service and run the command below. You will need to provide the connection string, container name, and uuid: + +```sql +RESTORE ALL +FROM AzureBlobStorage( + '< AzureBlobStorage endpoint connection string >', + '', + '' +) +``` + +## Backup / Restore to Google Cloud Storage (GCS) {#google-cloud-storage} + +### Full Backup {#gcs-full-backup} + +```sql +BACKUP TABLE system.users, +TABLE system.roles, +TABLE system.settings_profiles, +TABLE system.row_policies, +TABLE system.quotas, +TABLE system.functions, +ALL EXCEPT DATABASES INFORMATION_SCHEMA, information_schema, system +TO S3('https://storage.googleapis.com//', '', '') +``` + +Where `uuid` is a unique identifier, used to differentiate a set of backups. + +### Incremental Backup {#gcs-incremental-backup} + +```sql +BACKUP TABLE system.users, +TABLE system.roles, +TABLE system.settings_profiles, +TABLE system.row_policies, +TABLE system.quotas, +TABLE system.functions, +ALL EXCEPT DATABASES INFORMATION_SCHEMA, information_schema, system +TO S3('https://storage.googleapis.com/test_gcs_backups//my_incremental', '', '') +SETTINGS base_backup = S3('https://storage.googleapis.com/test_gcs_backups/', '', '') +``` + +### Restore from a backup {#gcs-restore-backup} + +```sql +RESTORE ALL +FROM S3('https://storage.googleapis.com/testbyob/', + '', + '' +) +``` diff --git a/docs/cloud/manage/backups/backups-to-own-cloud/export-backups-to-own-cloud-account.md b/docs/cloud/manage/backups/backups-to-own-cloud/export-backups-to-own-cloud-account.md new file mode 100644 index 00000000000..72fb562af93 --- /dev/null +++ b/docs/cloud/manage/backups/backups-to-own-cloud/export-backups-to-own-cloud-account.md @@ -0,0 +1,46 @@ +--- +sidebar_label: 'Overview' +slug: /cloud/manage/backups/export-backups-to-own-cloud-account +title: 'Export Backups to your Own Cloud Account' +description: 'Describes how to export backups to your own Cloud account' +sidebar_position: 1 +--- + +import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge' + + + +ClickHouse Cloud allows exporting backups to your own cloud service provider +(CSP) account storage (AWS S3, Google Cloud Storage, or Azure Blob Storage). +For details of how ClickHouse Cloud backups work, including "full" vs. "incremental" +backups, see the [backups](/cloud/manage/backups/overview) docs. + +Here we walk through how you can export backups to your AWS, GCP, Azure object +storage as well as how to restore from these backups in your account to a new +ClickHouse Cloud service. + +:::note +Users should be aware that any usage where backups are being exported to a +different region in the same cloud provider will incur [data transfer](/cloud/manage/network-data-transfer) +charges. Currently, we do not support cross-cloud backups. +::: + +To export backups to your own cloud account, you have two options: +- You can leverage the [UI capability](/cloud/manage/backups/backup-restore-via-ui) from the cloud console. This also + allows you to also set backups to happen on a specific schedule by using [configurable backups](/cloud/manage/backups/configurable-backups). +- You can use [SQL commands](/cloud/manage/backups/backup-restore-via-commands) to export backups to your bucket. + +:::note +If you configure backups to your own bucket, ClickHouse Cloud will still take +daily backups to its own bucket. This is to ensure that we have at least one +copy of the data to restore from in case the backups in your own bucket get +corrupted. +::: + +:::warning +ClickHouse Cloud will not manage the lifecycle of backups in your bucket, as we +do not have delete permissions for this data. You are responsible for ensuring +that backups in your bucket are managed appropriately, for compliance reasons as +well as to manage cost. If the backups are corrupted and / or moved to another +location, restoring the backups will not work. +::: diff --git a/docs/cloud/manage/backups/export-backups-to-own-cloud-account.md b/docs/cloud/manage/backups/export-backups-to-own-cloud-account.md deleted file mode 100644 index 4cd5ea78b62..00000000000 --- a/docs/cloud/manage/backups/export-backups-to-own-cloud-account.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -sidebar_label: 'Export Backups to your Own Cloud Account' -slug: /cloud/manage/backups/export-backups-to-own-cloud-account -title: 'Export Backups to your Own Cloud Account' -description: 'Describes how to export backups to your own Cloud account' ---- - -import EnterprisePlanFeatureBadge from '@theme/badges/EnterprisePlanFeatureBadge' - - - -ClickHouse Cloud supports taking backups to your own cloud service provider (CSP) account (AWS S3, Google Cloud Storage, or Azure Blob Storage). -For details of how ClickHouse Cloud backups work, including "full" vs. "incremental" backups, see the [backups](overview.md) docs. - -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. - -:::note -Users should be aware that any usage where backups are being exported to a different region in the same cloud provider, will incur [data transfer](../network-data-transfer.mdx) charges. Currently we do not support cross cloud backups. -::: - -## Requirements {#requirements} - -You will need the following details to export/restore backups to your own CSP storage bucket. - -### AWS {#aws} - -1. AWS S3 endpoint, in the format: - - ```text - s3://.s3.amazonaws.com/ - ``` - - For example: - ```text - s3://testchbackups.s3.amazonaws.com/backups/ - ``` - Where: - - `testchbackups` is the name of the S3 bucket to export backups to. - - `backups` is an optional subdirectory. - -2. AWS access key and secret. AWS role based authentication is also supported and can be used in place of AWS access key and secret. - -:::note -In order to use role based authentication, please follow the Secure s3 [setup](https://clickhouse.com/docs/cloud/security/secure-s3). In addition, you will need to add `s3:PutObject`, and `s3:DeleteObject` permissions to the IAM policy described [here.](https://clickhouse.com/docs/cloud/security/secure-s3#option-2-manually-create-iam-role) -::: - -### Azure {#azure} - -1. Azure storage connection string. -2. Azure container name in the storage account. -3. Azure Blob within the container. - -### Google Cloud Storage (GCS) {#google-cloud-storage-gcs} - -1. GCS endpoint, in the format: - - ```text - https://storage.googleapis.com// - ``` -2. Access HMAC key and HMAC secret. - -
-# Backup / Restore - -## Backup / Restore to AWS S3 Bucket {#backup--restore-to-aws-s3-bucket} - -### Take a DB backup {#take-a-db-backup} - -**Full Backup** - -```sql -BACKUP DATABASE test_backups -TO S3('https://testchbackups.s3.amazonaws.com/backups/', '', '') -``` - -Where `uuid` is a unique identifier, used to differentiate a set of backups. - -:::note -You will need to use a different UUID for each new backup in this subdirectory, otherwise you will get a `BACKUP_ALREADY_EXISTS` error. -For example, if you are taking daily backups, you will need to use a new UUID each day. -::: - -**Incremental Backup** - -```sql -BACKUP DATABASE test_backups -TO S3('https://testchbackups.s3.amazonaws.com/backups/', '', '') -SETTINGS base_backup = S3('https://testchbackups.s3.amazonaws.com/backups/', '', '') -``` - -### Restore from a backup {#restore-from-a-backup} - -```sql -RESTORE DATABASE test_backups -AS test_backups_restored -FROM S3('https://testchbackups.s3.amazonaws.com/backups/', '', '') -``` - -See: [Configuring BACKUP/RESTORE to use an S3 Endpoint](/operations/backup#configuring-backuprestore-to-use-an-s3-endpoint) for more details. - -## Backup / Restore to Azure Blob Storage {#backup--restore-to-azure-blob-storage} - -### Take a DB backup {#take-a-db-backup-1} - -**Full Backup** - -```sql -BACKUP DATABASE test_backups -TO AzureBlobStorage('', '', '/'); -``` - -Where `uuid` is a unique identifier, used to differentiate a set of backups. - -**Incremental Backup** - -```sql -BACKUP DATABASE test_backups -TO AzureBlobStorage('', '', '//my_incremental') -SETTINGS base_backup = AzureBlobStorage('', '', '/') -``` - -### Restore from a backup {#restore-from-a-backup-1} - -```sql -RESTORE DATABASE test_backups -AS test_backups_restored_azure -FROM AzureBlobStorage('', '', '/') -``` - -See: [Configuring BACKUP/RESTORE to use an S3 Endpoint](/operations/backup#configuring-backuprestore-to-use-an-azureblobstorage-endpoint) for more details. - -## Backup / Restore to Google Cloud Storage (GCS) {#backup--restore-to-google-cloud-storage-gcs} - -### Take a DB backup {#take-a-db-backup-2} - -**Full Backup** - -```sql -BACKUP DATABASE test_backups -TO S3('https://storage.googleapis.com//', ', ) -``` -Where `uuid` is a unique identifier, used to differentiate a set of backups. - -**Incremental Backup** - -```sql -BACKUP DATABASE test_backups -TO S3('https://storage.googleapis.com/test_gcs_backups//my_incremental', 'key', 'secret') -SETTINGS base_backup = S3('https://storage.googleapis.com/test_gcs_backups/', 'key', 'secret') -``` - -### Restore from a backup {#restore-from-a-backup-2} - -```sql -RESTORE DATABASE test_backups -AS test_backups_restored_gcs -FROM S3('https://storage.googleapis.com/test_gcs_backups/', 'key', 'secret') -``` diff --git a/docs/cloud/manage/backups/index.md b/docs/cloud/manage/backups/index.md index d42ed0ef899..aede839aa15 100644 --- a/docs/cloud/manage/backups/index.md +++ b/docs/cloud/manage/backups/index.md @@ -5,8 +5,8 @@ description: 'Table of contents page for backups.' keywords: ['backups', 'configurable backups', 'export backups to own cloud'] --- -| Page | Description | -|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| -| [Overview](./overview.md) | Overview page for backups. | -| [Configurable Backups](./configurable-backups.md) | Learn about how Scale and Enterprise tier users can customize their backup schedules according to their specific business needs | -| [Export Backups to your Own Cloud Account](./export-backups-to-own-cloud-account.md) | Learn about an Enterprise tier feature that gives you the ability to export backups to your own cloud account. | +| Page | Description | +|-----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| [Overview](./overview.md) | Overview page for backups. | +| [Configurable Backups](./configurable-backups.md) | Learn about how Scale and Enterprise tier users can customize their backup schedules according to their specific business needs | +| [Export Backups to your Own Cloud Account](./backups-to-own-cloud/export-backups-to-own-cloud-account.md) | Learn about an Enterprise tier feature that gives you the ability to export backups to your own cloud account. | diff --git a/docs/cloud/manage/backups/overview.md b/docs/cloud/manage/backups/overview.md index 30124414b2a..f4d449f632e 100644 --- a/docs/cloud/manage/backups/overview.md +++ b/docs/cloud/manage/backups/overview.md @@ -175,4 +175,4 @@ If you want to set up a backups schedule different from the default backup sched ## Export backups to your own cloud account {#export-backups-to-your-own-cloud-account} -For users wanting to export backups to their own cloud account, see [here](./export-backups-to-own-cloud-account.md). +For users wanting to export backups to their own cloud account, see [here](./backups-to-own-cloud/export-backups-to-own-cloud-account.md). diff --git a/scripts/aspell-dict-file.txt b/scripts/aspell-dict-file.txt index 9064e1c8d20..71b05870a05 100644 --- a/scripts/aspell-dict-file.txt +++ b/scripts/aspell-dict-file.txt @@ -1089,3 +1089,5 @@ processlist Chainlit's --docs/use-cases/AI_ML/MCP/index.md-- MCP's +--docs/cloud/manage/backups/backups-to-own-cloud/backup_restore_using_commands.md-- +testchbackups diff --git a/src/css/custom.scss b/src/css/custom.scss index 9161e8722e0..d3d2231d3f9 100644 --- a/src/css/custom.scss +++ b/src/css/custom.scss @@ -1137,14 +1137,28 @@ button.DocSearch { display: block; } +.theme-admonition-warning { + .alert-icon { + background: var(--click-color-warning-text) !important; + } + + .alert-content { + background: var(--click-color-warning-background) !important; + } +} + +[data-theme='dark'] .theme-admonition-warning { + color: black !important; +} + .theme-admonition-tip { &.alert--warning { .alert-icon { - background: var(--click-color-warning-text); + background: var(--click-color-warning-text) !important; } .alert-content { - background: var(--click-color-warning-background); + background: var(--click-color-warning-background) !important; } } diff --git a/src/theme/Admonition/styles.module.css b/src/theme/Admonition/styles.module.css index a8949bfd83d..ad2690ed08c 100644 --- a/src/theme/Admonition/styles.module.css +++ b/src/theme/Admonition/styles.module.css @@ -33,6 +33,7 @@ width: 1.6em; fill: white; } + .admonitionContent { padding: 1rem; background: var(--click-color-note-background); diff --git a/static/images/cloud/manage/backups/arn.png b/static/images/cloud/manage/backups/arn.png new file mode 100644 index 00000000000..3bc54d27a98 Binary files /dev/null and b/static/images/cloud/manage/backups/arn.png differ diff --git a/static/images/cloud/manage/backups/azure_connection_details.png b/static/images/cloud/manage/backups/azure_connection_details.png new file mode 100644 index 00000000000..217ec7956ea Binary files /dev/null and b/static/images/cloud/manage/backups/azure_connection_details.png differ diff --git a/static/images/cloud/manage/backups/backup_command.png b/static/images/cloud/manage/backups/backup_command.png new file mode 100644 index 00000000000..b2a169012a2 Binary files /dev/null and b/static/images/cloud/manage/backups/backup_command.png differ diff --git a/static/images/cloud/manage/backups/change_external_backup.png b/static/images/cloud/manage/backups/change_external_backup.png new file mode 100644 index 00000000000..6137f731e17 Binary files /dev/null and b/static/images/cloud/manage/backups/change_external_backup.png differ diff --git a/static/images/cloud/manage/backups/configure_arn_s3_details.png b/static/images/cloud/manage/backups/configure_arn_s3_details.png new file mode 100644 index 00000000000..c77af50c3e1 Binary files /dev/null and b/static/images/cloud/manage/backups/configure_arn_s3_details.png differ diff --git a/static/images/cloud/manage/backups/gcp_configure.png b/static/images/cloud/manage/backups/gcp_configure.png new file mode 100644 index 00000000000..2779f16187a Binary files /dev/null and b/static/images/cloud/manage/backups/gcp_configure.png differ diff --git a/static/images/cloud/manage/backups/gcp_restore_command.png b/static/images/cloud/manage/backups/gcp_restore_command.png new file mode 100644 index 00000000000..f96f8d8016d Binary files /dev/null and b/static/images/cloud/manage/backups/gcp_restore_command.png differ diff --git a/static/images/cloud/manage/backups/gcp_stored_backups.png b/static/images/cloud/manage/backups/gcp_stored_backups.png new file mode 100644 index 00000000000..169f2a46d11 Binary files /dev/null and b/static/images/cloud/manage/backups/gcp_stored_backups.png differ diff --git a/static/images/cloud/manage/backups/view_backups.png b/static/images/cloud/manage/backups/view_backups.png new file mode 100644 index 00000000000..169f2a46d11 Binary files /dev/null and b/static/images/cloud/manage/backups/view_backups.png differ diff --git a/static/images/cloud/manage/backups/view_backups_azure.png b/static/images/cloud/manage/backups/view_backups_azure.png new file mode 100644 index 00000000000..169f2a46d11 Binary files /dev/null and b/static/images/cloud/manage/backups/view_backups_azure.png differ