You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc/radosgw: Fix section header levels in multisite-sync-policy.rst
The section header levels are reversed so the hierarchy in the TOC is
incorrect. Switch around the section header levels to make the TOC
hierarchy correct, for example individual examples are children of the
"Examples" section.
Signed-off-by: Ville Ojamo <[email protected]>
Copy file name to clipboardExpand all lines: doc/radosgw/multisite-sync-policy.rst
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,11 +44,11 @@ The S3 bucket replication API has also been implemented, and allows users to cre
44
44
45
45
46
46
Sync Policy Control Reference
47
-
=============================
47
+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48
48
49
49
50
50
Get Sync Policy
51
-
~~~~~~~~~~~~~~~
51
+
===============
52
52
53
53
To retrieve the current zonegroup sync policy, or a specific bucket policy:
54
54
@@ -58,7 +58,7 @@ To retrieve the current zonegroup sync policy, or a specific bucket policy:
58
58
59
59
60
60
Create Sync Policy Group
61
-
~~~~~~~~~~~~~~~~~~~~~~~~
61
+
========================
62
62
63
63
To create a sync policy group:
64
64
@@ -70,7 +70,7 @@ To create a sync policy group:
70
70
71
71
72
72
Modify Sync Policy Group
73
-
~~~~~~~~~~~~~~~~~~~~~~~~
73
+
========================
74
74
75
75
To modify a sync policy group:
76
76
@@ -82,7 +82,7 @@ To modify a sync policy group:
82
82
83
83
84
84
Show Sync Policy Group
85
-
~~~~~~~~~~~~~~~~~~~~~~
85
+
======================
86
86
87
87
To show a sync policy group:
88
88
@@ -93,7 +93,7 @@ To show a sync policy group:
93
93
94
94
95
95
Remove Sync Policy Group
96
-
~~~~~~~~~~~~~~~~~~~~~~~~
96
+
========================
97
97
98
98
To remove a sync policy group:
99
99
@@ -104,7 +104,7 @@ To remove a sync policy group:
104
104
105
105
106
106
Create Sync Flow
107
-
~~~~~~~~~~~~~~~~
107
+
================
108
108
109
109
To create or update directional sync flow:
110
110
@@ -133,7 +133,7 @@ Where zones are a comma separated list of all the zones that need to add to the
133
133
134
134
135
135
Remove Sync Flow Zones
136
-
~~~~~~~~~~~~~~~~~~~~~~
136
+
======================
137
137
138
138
To remove directional sync flow:
139
139
@@ -172,7 +172,7 @@ To remove symmetrical sync flow:
172
172
173
173
174
174
Create Sync Pipe
175
-
~~~~~~~~~~~~~~~~
175
+
================
176
176
177
177
To create sync group pipe, or update its parameters:
178
178
@@ -208,7 +208,7 @@ User id can be set for user mode, and will be the user under which the sync oper
208
208
209
209
210
210
Remove Sync Pipe
211
-
~~~~~~~~~~~~~~~~
211
+
================
212
212
213
213
To remove specific sync group pipe params, or the entire pipe:
214
214
@@ -227,7 +227,7 @@ To remove specific sync group pipe params, or the entire pipe:
227
227
228
228
229
229
Sync Info
230
-
~~~~~~~~~
230
+
=========
231
231
232
232
To get information about the expected sync sources and targets (as defined by the sync policy):
233
233
@@ -241,12 +241,12 @@ Since a bucket can define a policy that defines data movement from it towards a
241
241
242
242
243
243
Examples
244
-
========
244
+
~~~~~~~~
245
245
246
246
The system in these examples includes 3 zones: ``us-east`` (the master zone), ``us-west``, ``us-west-2``.
247
247
248
248
Example 1: Two Zones, Complete Mirror
249
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
249
+
=====================================
250
250
251
251
This is similar to older (pre Octopus) sync capabilities, but being done via the new sync policy engine. Note that changes to the zonegroup sync policy require a period update and commit.
252
252
@@ -348,7 +348,7 @@ entries as can be seen in the example.
348
348
349
349
350
350
Example 2: Directional, Entire Zone Backup
351
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
351
+
==========================================
352
352
353
353
Also similar to older sync capabilities. In here we add a third zone, ``us-west-2`` that will be a replica of ``us-west``, but data will not be replicated back from it.
354
354
@@ -443,7 +443,7 @@ Whereas ``us-west-2`` has only source and no destinations:
443
443
444
444
445
445
Example 3: Mirror a Specific Bucket
446
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
446
+
===================================
447
447
448
448
Using the same group configuration, but this time switching it to ``allowed`` state, which means that sync is allowed but not enabled.
449
449
@@ -466,7 +466,7 @@ And we will create a bucket level policy rule for existing bucket ``buck2``. Not
466
466
467
467
468
468
Example 4: Limit Bucket Sync to Specific Zones
469
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
469
+
==============================================
470
470
471
471
This will only sync ``buck3`` to ``us-east`` (from any zone that flow allows to sync into ``us-east``).
472
472
@@ -481,7 +481,7 @@ This will only sync ``buck3`` to ``us-east`` (from any zone that flow allows to
481
481
482
482
483
483
Example 5: Sync From a Different Bucket
484
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
484
+
=======================================
485
485
486
486
Note that bucket sync only works (currently) across zones and not within the same zone.
487
487
@@ -565,7 +565,7 @@ Note that there are resolved hints, which means that the bucket ``buck5`` found
565
565
566
566
567
567
Example 6: Sync to Different Bucket
568
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
568
+
===================================
569
569
570
570
The same mechanism can work for configuring data to be synced to (vs. synced from as in the previous example). Note that internally data is still pulled from the source at the destination zone:
571
571
@@ -586,7 +586,7 @@ A wildcard bucket name means the current bucket in the context of bucket sync po
586
586
Combined with the configuration in Example 5, we can now write data to ``buck6`` on ``us-east``, data will sync to ``buck5`` on ``us-west``, and from there it will be distributed to ``buck4`` on ``us-east``, and on ``us-west-2``.
587
587
588
588
Example 7: Source Filters
589
-
~~~~~~~~~~~~~~~~~~~~~~~~~
589
+
=========================
590
590
591
591
Sync from ``buck8`` to ``buck9``, but only objects that start with ``foo/``:
592
592
@@ -680,7 +680,7 @@ Prefixes and tags can be combined, in which object will need to have both in ord
680
680
681
681
682
682
Example 8: Destination Params: Storage Class
683
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
683
+
============================================
684
684
685
685
Storage class of the destination objects can be configured:
686
686
@@ -696,7 +696,7 @@ Storage class of the destination objects can be configured:
696
696
697
697
698
698
Example 9: Destination Params: Destination Owner Translation
Set the destination objects owner as the destination bucket owner.
702
702
This requires specifying the uid of the destination bucket:
@@ -712,7 +712,7 @@ This requires specifying the uid of the destination bucket:
712
712
713
713
714
714
Example 10: Destination Params: User Mode
715
-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
715
+
=========================================
716
716
717
717
User mode makes sure that the user has permissions to both read the objects, and write to the destination bucket. This requires that the uid of the user (which in its context the operation executes) is specified.
0 commit comments