Skip to content

Commit c3bb396

Browse files
committed
opensearch btar
1 parent 290af35 commit c3bb396

File tree

1 file changed

+93
-21
lines changed

1 file changed

+93
-21
lines changed

docs/platform/concepts/backup-to-another-region.md

Lines changed: 93 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ sidebar_label: Backup to another region
55
---
66

77
import RelatedPages from "@site/src/components/RelatedPages";
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
810

911
In addition to the primary service backup, you can have a secondary backup in an alternative location.
1012

@@ -19,26 +21,101 @@ region. BTAR can bolster data resilience and helps improve data protection again
1921
disasters in the primary backup region. When the primary region is down, BTAR allows
2022
forking the service from an additional copy of the backup residing in a secondary region.
2123

22-
BTAR is supported for the following services:
24+
## Limitations
25+
26+
- The cloud provider for your additional backup region must match the cloud provider for
27+
your service and the primary backup.
28+
- Secondary backup can only be restored in the region where it was stored.
29+
30+
### Supported services
31+
32+
BTAR is only supported for the following service types:
2333

2434
- Aiven for PostgreSQL®
2535
- Aiven for MySQL®
2636
- Aiven for OpenSearch®
2737

38+
### Service-specific limitations
39+
40+
<Tabs groupId="group1">
41+
<TabItem value="sql-relational" label="PostgreSQL & MySQL" default>
42+
43+
- To
44+
[restore your service from an additional backup](/docs/platform/howto/btar/manage-backup-to-another-region)
45+
using point-in-time recovery (PITR), set up the time to no earlier than the time of
46+
taking the oldest replicated base backup.
47+
- Secondary backup is generated only after a primary backup is complete, and there might
48+
be a data replication lag between the primary region and the secondary region.
49+
50+
</TabItem>
51+
<TabItem value="non-sql-search-analytics" label="OpenSearch">
52+
53+
- The synchronization of snapshots between the regions works only for base snapshots created
54+
after the BTAR activation.
55+
- Point-in-time recovery (PITR) is not supported for
56+
[restoring your service from an additional backup](/docs/platform/howto/btar/manage-backup-to-another-region).
57+
- Although a base snapshot in the primary region and its corresponding BTAR snapshot in
58+
the secondary region are generated at the same time, there might be some negligible data
59+
discrepancies between them.
60+
2861
## How BTAR works
2962

30-
When you enable the backup to another region (BTAR) feature, an additional service backup
31-
is created in the cloud region of your choice that is alternative to the primary backup
63+
When you enable the backup to another region (BTAR) feature, additional service backups
64+
are created in the cloud region of your choice that is alternative to the primary backup
3265
location.
3366

67+
Restoring from a secondary backup, for example in case of an outage of the primary region,
68+
can be done by creating a fork of the service in the region where the secondary backup is
69+
located.
70+
71+
<Tabs groupId="group1">
72+
<TabItem value="sql-relational" label="PostgreSQL & MySQL" default>
73+
3474
Secondary backups are generated from primary backups, not from the service itself. For
3575
this reason, your secondary backup becomes available only after the primary backup is
3676
taken. There might be a data replication lag between the primary region and the secondary
3777
region.
3878

39-
Restoring from a secondary backup, for example in case of an outage of the primary region,
40-
can be done by creating a fork of the service in the region where the secondary backup is
41-
located.
79+
```mermaid
80+
flowchart LR
81+
subgraph Primary_region
82+
direction TB
83+
subgraph Service_X
84+
end
85+
subgraph Primary_backups
86+
direction LR
87+
PB1
88+
PB2
89+
PB3
90+
PBn
91+
end
92+
end
93+
subgraph Secondary_region
94+
direction TB
95+
subgraph Forked_service_X
96+
end
97+
subgraph Secondary_backups
98+
direction LR
99+
SB1
100+
SB2
101+
SB3
102+
SBn
103+
end
104+
end
105+
Service_X -- Default backups --> Primary_backups
106+
Primary_backups -- Cross-region backups<br/>if BTAR enabled --> Secondary_backups
107+
Secondary_backups -- Secondary backups<br/>to restore service X --> Forked_service_X
108+
Service_X -- Forking service X<br/>if primary region down --> Forked_service_X
109+
```
110+
111+
</TabItem>
112+
<TabItem value="non-sql-search-analytics" label="OpenSearch">
113+
114+
An additional snapshot repository is created in the secondary region. In this repository,
115+
BTAR snapshots are generated directly from the service. They are created and managed in
116+
sync with base snapshots in the primary region. For example, when a base snapshot is
117+
created in the primary region, its BTAR counterpart is created simultaneously in the
118+
secondary region with an identical name.
42119

43120
```mermaid
44121
flowchart LR
@@ -66,24 +143,19 @@ flowchart LR
66143
SBn
67144
end
68145
end
69-
Service_X -- Default \n backups --> Primary_backups
70-
Primary_backups -- Cross-region backups \n if BTAR enabled --> Secondary_backups
71-
Secondary_backups -- Secondary backups \n to restore service X --> Forked_service_X
72-
Service_X -- Forking service X \n if primary region down --> Forked_service_X
146+
Service_X -- Default backups --> Primary_backups
147+
Primary_backups -- Cross-region backups<br/>if BTAR enabled --> Secondary_backups
148+
Secondary_backups -- Secondary backups<br/>to restore service X --> Forked_service_X
149+
Service_X -- Forking service X<br/>if primary region down --> Forked_service_X
73150
```
74151

75-
## Limitations
152+
</TabItem>
153+
</Tabs>
76154

77-
- BTAR is supported for Aiven for MySQL®, Aiven for PostgreSQL®, and Aiven for OpenSearch®.
78-
- The cloud provider for your additional backup region must match the cloud provider for
79-
your service and the primary backup.
80-
- To
81-
[restore your service from an additional backup](/docs/platform/howto/btar/manage-backup-to-another-region)
82-
using point-in-time recovery (PITR), set up the time to no earlier than the time of
83-
taking the oldest replicated base backup.
84-
- Secondary backup can only be restored in the region where it was stored.
85-
- Secondary backup is generated only after a primary backup is complete, and there might
86-
be a data replication lag between the primary region and the secondary region.
155+
156+
157+
</TabItem>
158+
</Tabs>
87159

88160
<RelatedPages/>
89161

0 commit comments

Comments
 (0)