Skip to content

Commit ad46d4c

Browse files
AnthonyTsu1984github-actions[bot]
authored andcommitted
Apply automatic changes
1 parent 296d702 commit ad46d4c

File tree

738 files changed

+55260
-19189
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

738 files changed

+55260
-19189
lines changed

docs/tutorials/backup-and-restore/backup-and-restore.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,24 @@ title: "Backup & Restore | Cloud"
33
slug: /backup-and-restore
44
sidebar_label: "Backup & Restore"
55
beta: FALSE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "Data backup and restore for your data stored in Zilliz Cloud clusters. | Cloud"
811
type: origin
912
token: VvikwOKc9iZ5vBkgMnycrXKmnId
10-
sidebar_position: 7
13+
sidebar_position: 8
1114
keywords:
1215
- zilliz
1316
- vector database
1417
- cloud
1518
- backup
1619
- restore
17-
- vectordb
18-
- multimodal vector database retrieval
19-
- Retrieval Augmented Generation
20-
- Large language model
20+
- llm eval
21+
- Sparse vs Dense
22+
- Dense vector
23+
- Hierarchical Navigable Small Worlds
2124

2225
---
2326

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: "Cross-Region Backup | Cloud"
3+
slug: /backup-to-other-regions
4+
sidebar_label: "Cross-Region Backup"
5+
beta: FALSE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
9+
notebook: FALSE
10+
description: "Cross-region backup in Zilliz Cloud enhances data protection by copying backups to multiple cloud regions. It safeguards against regional outages and supports disaster recovery, business continuity, and high availability by minimizing risks from localized failures. | Cloud"
11+
type: origin
12+
token: ESVGwTkn8iLfUakSSrkc5dWJnye
13+
sidebar_position: 3
14+
keywords:
15+
- zilliz
16+
- vector database
17+
- cloud
18+
- backup
19+
- files
20+
- view
21+
- Similarity Search
22+
- multimodal RAG
23+
- llm hallucinations
24+
- hybrid search
25+
26+
---
27+
28+
import Admonition from '@theme/Admonition';
29+
30+
31+
import Supademo from '@site/src/components/Supademo';
32+
33+
# Cross-Region Backup
34+
35+
Cross-region backup in Zilliz Cloud enhances data protection by copying backups to multiple cloud regions. It safeguards against regional outages and supports disaster recovery, business continuity, and high availability by minimizing risks from localized failures.
36+
37+
This guide walks you through how to use cross-region backup on Zilliz Cloud.
38+
39+
Currently, clusters on Azure do not support cross-region backup.
40+
41+
<Admonition type="info" icon="📘" title="Notes">
42+
43+
<p>This feature is available only to <strong>Dedicated</strong> clusters.</p>
44+
45+
</Admonition>
46+
47+
## Limits\{#limits}
48+
49+
- **Access control**: You must be a **project admin**, **organization owner**, or have a **custom role** with backup privileges.
50+
51+
- **Excluded from backup**:
52+
53+
- Collection TTL settings
54+
55+
- Password for the default user `db_admin` (a new password is generated during [restore](./restore-from-snapshot))
56+
57+
- Cluster dynamic and scheduled scaling settings
58+
59+
- **Cluster shard settings**: Backed up but may be adjusted during restore if the cluster CU size is reduced, due to shard-per-CU limits. See [Zilliz Cloud Limits](./limits#shards) for details.
60+
61+
- **Backup job restrictions**: Cross-region backup copy job will start after original backup job is completed.
62+
63+
## Procedures\{#procedures}
64+
65+
You can enable cross-region backup either when [creating a backup manually](./create-snapshot) or when [scheduling automatic backups](./schedule-automatic-backups).
66+
67+
- **Manual backup:** If you choose cross-region backup during manual creation, all copied backups are permanently retained.
68+
69+
- **Scheduled backup:** If you choose cross-region backup during scheduled backups, you must configure a retention period for the copied backup file in each region.
70+
71+
<Admonition type="info" icon="📘" title="Notes">
72+
73+
<p>You can select regions only for the same cloud provider as the original region.</p>
74+
75+
</Admonition>
76+
77+
The following demo shows how to use cross-region backup when manually creating a backup. For details about how to use cross-region backup while scheduling automatic backups, refer to [Schedule Automatic Backups](./schedule-automatic-backups).
78+
79+
<Supademo id="cmgkg6um62deokrn973s89qfx?utm_source=link" title="" />
80+
81+
In the [Jobs](./job-center) list, you will first see the original backup job. Once it completes, additional jobs appear for copying the backup file to each selected region, with one record per region.
82+
83+
## Billing implications\{#billing-implications}
84+
85+
When you choose cross-region backup, two types of charges may apply:
86+
87+
- **Storage cost:** Based on the region where the copied backup file is stored. To understand how storage cost is calculated, see [Storage Cost](./storage-cost).
88+
89+
- **Data transfer cost:** Based on the traffic between the source region and the target regions. To understand how storage cost is calculated, see [Data Transfer Cost](./data-transfer-cost).
90+
91+
For detailed rates, see [Pricing Guide](https://zilliz.com/pricing/pricing-guide).
92+
93+
### Example\{#example}
94+
95+
Suppose your cluster is deployed in **GCP us-west1 (Oregon)** and you need to copy the backup file of this cluster to two different regions, **GCP us-east4 (Virginia, USA)** and **GCP europe-west3 (Frankfurt)**:
96+
97+
- **Original Backup File Size**: 20 GB
98+
99+
- **Retention Period of Copied Backups**: 1 Month
100+
101+
- **Unit Price**:
102+
103+
- The unit price of backup storage on GCP is **&#36;0.02/GB per month**.
104+
105+
- Data transfer from GCP us-west1 (Oregon) to GCP us-central1 (Iowa) is billed at the same-continent cross-region rate of **&#36;0.02/GB**.
106+
107+
- Data transfer from GCP us-west1 (Oregon) to GCP europe-west3 (Frankfurt) is billed at the different-continent cross-region rate of **&#36;0.08/GB**.
108+
109+
The following is the cost calculation:
110+
111+
- **Storage cost:** `20 GB × $0.02/GB per month × 1 month × 2 copies = $0.80`
112+
113+
- **Data transfer cost:** `(20 GB × $0.02/GB) + (20 GB × $0.08/GB) = $2.00`
114+
115+
- **Total cost:** `$0.80 (storage) + $2.00 (data transfer) = $2.80`
116+

docs/tutorials/backup-and-restore/create-snapshot.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ title: "Create Backup | Cloud"
33
slug: /create-snapshot
44
sidebar_label: "Create Backup"
55
beta: FALSE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "In Zilliz Cloud, a backup is a copy of the data that allows you to restore the entire cluster or specific collections in the event of data loss or system failure. | Cloud"
811
type: origin
@@ -13,10 +16,10 @@ keywords:
1316
- vector database
1417
- cloud
1518
- backup
16-
- Managed vector database
17-
- Pinecone vector database
18-
- Audio search
19-
- what is semantic search
19+
- vector search algorithms
20+
- Question answering system
21+
- llm-as-a-judge
22+
- hybrid vector search
2023

2124
---
2225

@@ -27,19 +30,19 @@ import Supademo from '@site/src/components/Supademo';
2730

2831
# Create Backup
2932

30-
In Zilliz Cloud, a backup is a copy of the data that allows you to restore the entire cluster or specific collections in the event of data loss or system failure.
33+
In Zilliz Cloud, a backup is a copy of the data that allows you to restore the entire cluster or specific collections in the event of data loss or system failure.
3134

32-
Backup creation incurs additional [charges](/docs/understand-cost#backup-cost), with pricing based on the cloud region where the backup is stored. All backup files are stored in the same cloud region as the source cluster. For example, a cluster in `AWS us-west-2` will have its backups stored in `AWS us-west-2`.
35+
Backup creation incurs additional [charges](./storage-cost), with pricing based on the cloud region where the backup is stored. All backup files are stored in the same cloud region as the source cluster. For example, a cluster in `AWS us-west-2` will have its backups stored in `AWS us-west-2`.
3336

3437
This guide explains how to **manually create backups**. To automate backup creation, see [Schedule Automatic Backups](./schedule-automatic-backups).
3538

3639
<Admonition type="info" icon="📘" title="Notes">
3740

38-
<p>The backup and restore feature is exclusively available to <strong>Dedicated</strong> clusters. </p>
41+
<p>This feature is available only to <strong>Dedicated</strong> clusters.</p>
3942

4043
</Admonition>
4144

42-
## Limits{#limits}
45+
## Limits\{#limits}
4346

4447
- **Access control**: You must be a **project admin**, **organization owner**, or have a **custom role** with backup privileges.
4548

@@ -49,6 +52,8 @@ This guide explains how to **manually create backups**. To automate backup creat
4952

5053
- Password for the default user `db_admin` (a new password is generated during [restore](./restore-from-snapshot))
5154

55+
- Cluster dynamic and scheduled scaling settings
56+
5257
- **Cluster shard settings**: Backed up but may be adjusted during restore if the cluster CU size is reduced, due to shard-per-CU limits. See [Zilliz Cloud Limits](./limits#shards) for details.
5358

5459
- **Backup job restrictions**:
@@ -61,17 +66,17 @@ This guide explains how to **manually create backups**. To automate backup creat
6166

6267
- Automatic backups will still run if a manual backup is already in progress.
6368

64-
## Create cluster backup{#create-cluster-backup}
69+
## Create cluster backup\{#create-cluster-backup}
6570

66-
You can create a backup of an entire cluster and later restore either the whole cluster or selected collections.
71+
You can create a backup of an entire cluster and later restore either the whole cluster or selected collections. If you need to copy your backup file to other cloud regions for disaster recover, you can configure the copy policies while creating a backup. For details, refer to [Copy To Other Regions](./backup-to-other-regions).
6772

68-
### Via web console{#via-web-console}
73+
### Via web console\{#via-web-console}
6974

7075
The following demo shows how to create a cluster backup on the Zilliz Cloud web console.
7176

7277
<Supademo id="cmcske0x90dpa9st802gnvbz9" title="" />
7378

74-
### Via RESTful API{#via-restful-api}
79+
### Via RESTful API\{#via-restful-api}
7580

7681
The following example creates a backup for the cluster `in01-xxxxxxxxxxxxxx`. For details about the RESTful API, see [Create Backup](/reference/restful/create-backup-v2).
7782

@@ -98,17 +103,17 @@ The following is an example output. A backup job is generated and you can check
98103
}
99104
```
100105

101-
## Create collection backup{#create-collection-backup}
106+
## Create collection backup\{#create-collection-backup}
102107

103-
To back up a specific collection or a subset of collections in a cluster, create a collection-level backup.
108+
To back up a specific collection or a subset of collections in a cluster, create a collection-level backup. If you need to copy your backup file to other cloud regions for disaster recover, you can configure the copy policies while creating a backup. For details, refer to [Copy To Other Regions](./backup-to-other-regions).
104109

105-
### Via web console{#via-web-console}
110+
### Via web console\{#via-web-console}
106111

107112
The following demo shows how to create a collection backup on the web console.
108113

109114
<Supademo id="cmcskksub0dra9st8cy34b2vi" title="" />
110115

111-
### Via RESTful API{#via-restful-api}
116+
### Via RESTful API\{#via-restful-api}
112117

113118
The following example creates a backup for the collection `medium_articles` in the cluster `in01-xxxxxxxxxxxxxx`. For details about the RESTful API, see [Create Backup](/reference/restful/create-backup-v2).
114119

@@ -142,12 +147,14 @@ The following is an example output. A backup job is generated and you can check
142147
}
143148
```
144149

145-
## FAQs{#faqs}
150+
## FAQs\{#faqs}
146151

147152
**How long does a backup job take?**
153+
148154
Backup duration depends on the size of your data. As a reference, backing up 700 MB typically takes about 1 second. If your cluster contains more than 1,000 collections, the process may take slightly longer.
149155

150156
**Can I perform DDL (Data Definition Language) operations during a backup?**
157+
151158
It is recommended to avoid major DDL (Data Definition Language) operations—such as creating or dropping collections—while a backup is in progress, as they may interfere with the process or lead to inconsistent results.
152159

153160
**Will backup files be deleted if the original cluster is dropped?**

docs/tutorials/backup-and-restore/export-backup-files.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,14 @@ title: "Export Backup Files | Cloud"
33
slug: /export-backup-files
44
sidebar_label: "Export Backup Files"
55
beta: PRIVATE
6+
added_since: FALSE
7+
last_modified: FALSE
8+
deprecate_since: FALSE
69
notebook: FALSE
710
description: "You can export backup files to object storage using the Zilliz Cloud console. | Cloud"
811
type: origin
912
token: QUTDwkbTTiA2UlkWYDlc796ensf
10-
sidebar_position: 4
13+
sidebar_position: 5
1114
keywords:
1215
- zilliz
1316
- vector database
@@ -17,10 +20,10 @@ keywords:
1720
- integrate
1821
- object
1922
- storage
20-
- hallucinations llm
21-
- Multimodal search
22-
- vector search algorithms
23-
- Question answering system
23+
- milvus open source
24+
- how does milvus work
25+
- Zilliz vector database
26+
- Zilliz database
2427

2528
---
2629

@@ -33,21 +36,21 @@ You can export backup files to object storage using the Zilliz Cloud console.
3336

3437
<Admonition type="info" icon="📘" title="Notes">
3538

36-
<p>This feature is in <strong>Private Preview</strong> for clusters on the <strong>Dedicated-Enterprise</strong> plan. To enable this feature or learn about the associated costs, contact <a href="https://support.zilliz.com/hc/en-us">Zilliz Cloud support</a>.</p>
39+
<p>This feature is in <strong>Private Preview</strong> for <strong>Dedicated</strong> clusters in <strong>Enterprise</strong> projects. To enable this feature or learn about the associated costs, contact <a href="https://support.zilliz.com/hc/en-us">Zilliz Cloud support</a>.</p>
3740

3841
</Admonition>
3942

40-
## Before you start{#before-you-start}
43+
## Before you start\{#before-you-start}
4144

42-
- You have integrated Zilliz Cloud with your object storage. For detailed steps, refer to [Integrate with AWS S3](./integrate-with-aws-s3) and [Integrate with Azure Blob Storage](./integrate-with-azure-blob-storage).
45+
- You have integrated Zilliz Cloud with your object storage. For detailed steps, refer to [Integrate with AWS S3](./integrate-with-aws-s3), [Integrate with Azure Blob Storage](./integrate-with-azure-blob-storage), or [Integrate with Google Cloud Storage](./integrate-with-gcp).
4346

4447
- You have **Organization Owner** or **Project Admin** access to the project. If you do not have necessary permissions, contact your Zilliz Cloud administrator.
4548

46-
## Procedure{#procedure}
49+
## Procedure\{#procedure}
4750

4851
You can export backup files from Zilliz Cloud either via the Zilliz Cloud console or through the RESTful API.
4952

50-
### Export via Zilliz Cloud console{#export-via-zilliz-cloud-console}
53+
### Export via Zilliz Cloud console\{#export-via-zilliz-cloud-console}
5154

5255
1. Log in to the [Zilliz Cloud console](https://cloud.zilliz.com/login).
5356

@@ -65,17 +68,17 @@ You can export backup files from Zilliz Cloud either via the Zilliz Cloud consol
6568

6669
- **Cloud Region of Cluster in Backup File**: Displays the cloud region where the backup file was created.
6770

68-
- **Integration**: Select the object storage provider integrated with Zilliz Cloud. Currently, AWS S3 is supported. For more information, refer to [Integrate with AWS S3](./integrate-with-aws-s3).
71+
- **Integration**: Select the object storage provider integrated with Zilliz Cloud.
6972

7073
- **Integration Configuration**: Choose the specific bucket you configured for the backup export.
7174

7275
- **Directory**: Enter the directory path in your object storage bucket where the exported backup file will be stored.
7376

7477
1. Then, click **Export**.
7578

76-
![export-backup-file](/img/export-backup-file.png)
79+
![export-backup-file](/img/export-backup-file.png "export-backup-file")
7780

78-
### Export through RESTful API{#export-through-restful-api}
81+
### Export through RESTful API\{#export-through-restful-api}
7982

8083
Before you can export backup files from Zilliz Cloud via the [Export Backup Files](/reference/restful/export-backup-files-v2) RESTful API endpoint, you have to integrate one of your AWS S3 buckets with Zilliz Cloud and obtain its integration ID. For details, refer to [Obtain the integration ID](./integrate-with-aws-s3#obtain-the-integration-id).
8184

@@ -106,7 +109,7 @@ The response to the above request would be a Job ID as follows:
106109
}
107110
```
108111

109-
## Monitor export progress{#monitor-export-progress}
112+
## Monitor export progress\{#monitor-export-progress}
110113

111114
Once you click **Export**, an export job is generated automatically:
112115

@@ -120,9 +123,9 @@ Once you click **Export**, an export job is generated automatically:
120123

121124
- **ERROR**: The job failed. This can occur if a resource used by the export process, such as the Role ARN or the backup file, is deleted during the job execution.
122125

123-
![monitor-export-job](/img/monitor-export-job.png)
126+
![monitor-export-job](/img/monitor-export-job.png "monitor-export-job")
124127

125-
## Cancel export job{#cancel-export-job}
128+
## Cancel export job\{#cancel-export-job}
126129

127130
If your job remains in the **IN PROGRESS** status and you decide not to proceed, you can cancel the job by clicking **Cancel** in the **Actions** column.
128131

0 commit comments

Comments
 (0)