Commit Graph

937 Commits

Author SHA1 Message Date
Zac Dover
d1f2e9f3a6 doc/radosgw: s/zone group/zonegroup/g et alia
s/zone group/zonegroup/ where simple greps failed to find instances of
"zone group" that were spread across two lines; break a paragraph into
two paragraphs so that each paragraph has a thematic idea of its own.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-28 12:55:08 +10:00
Zac Dover
ce2bd7cb26 doc/rgw: caption a diagram
Add an explanation of a diagram that shows how object data is replicated
between zones within a zonegroup.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-28 04:36:08 +10:00
Anthony D'Atri
7a29b2dd74
Merge pull request #50274 from zdover23/wip-doc-2023-02-27-radosgw-multisite-remove-tertiary
doc/rgw: remove "tertiary", link to procedure
2023-02-27 08:43:58 -05:00
Zac Dover
8e273199d0 doc/rgw: remove "tertiary", link to procedure
Remove the term "tertiary zone" and replace it with "second secondary
zone" (because there is no such thing as a tertiary zone). Link to the
procedure for creating a secondary zone in a place where such a link is
helpful to the reader.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-27 18:40:14 +10:00
Zac Dover
35edcc17c9 doc/radosgw: multisite - edit "functional changes"
Improve the wording of the section "Functional Changes from Infernalis"
in doc/radosgw/multisite.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-27 18:30:54 +10:00
Zac Dover
495eb97fd7 doc/glossary: Add "zone" to glossary.rst
Add "Zone" to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-27 04:23:34 +10:00
Soumya Koduri
9f0440e6d5
Merge pull request #50098 from soumyakoduri/wip-skoduri-cloud-trans-azure
rgw/cloud: Add custom headers for objects transitioned to cloud

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2023-02-23 17:49:31 +05:30
Anthony D'Atri
d5bf55bcd6 doc: preen cephadm/troubleshooting.rst and radosgw/placement.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2023-02-23 02:12:34 -05:00
Zac Dover
ffbc5ea2b9 doc/glossary: add "Bucket"
Add "Bucket" to the glossary. The definition added here is just a first
attempt, but a man's reach must exceed his grasp, or what's a heaven
for?

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-23 15:53:39 +10:00
Zac Dover
bbc229340f doc/rgw: clarify multisite.rst top matter
Improve the pragmatics of the top matter of multisite.rst. Organize the
text into sections, where doing so makes the nature of multi-site
configurations clearer.

Co-authored-by: Cole Mitchell <cole.mitchell@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-22 13:59:12 +10:00
zdover23
01ad87ef30
Merge pull request #50165 from zdover23/wip-doc-2023-02-19-radosgw-multisite-multisite-top-matter-cleanup
doc/rgw: multisite ref. top matter cleanup

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-02-21 14:52:21 +10:00
Zac Dover
76eae93ab8 doc/rgw: session-tags.rst - fix link to keycloak
Fix a link in the doc/radosgw/session-tags.rst file that was intended to
link to the doc/radosgw/keycloak.rst file.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-21 13:55:03 +10:00
zdover23
3aae102209
Merge pull request #43145 from pritha-srivastava/wip-rgw-sts-doc-fixes
rgw/sts: correcting documentation errors.

Reviewed-by: Matt Benjamin <mbenjamin@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-02-21 13:48:28 +10:00
Soumya Koduri
9c3264fd94 rgw/cloud: Add custom headers for objects transitioned to cloud
Some of the cloud services, (like MCG Noobaa/Azure Namespace store),
may not be able to map and store the objects which contain s3 style
metadata keys.

To help such services determine if the objects being transitioned
are from RGW and whether or not ignore such attrs, added below two
headers for the objects being copied/transitioned from RGW -

1) x-rgw-cloud : true/false
(set to "true" if the object is being transitioned/synced from RGW)

2) x-rgw-cloud-keep-attrs : true/false
- if set to default "true" , the cloud service should store all the
x-amz-meta-* attrs. If cannot be mapped/stored, the operation
should fail
- if set to "false", the destination cloud can ignore such attrs and
just store the object data being sent.

Also fixed a bug in the cloudtier module wherein the user-defined attrs
were not being copied to the cloud endpoint as part of transition

Fixes: https://tracker.ceph.com/issues/57980
Fixes: https://tracker.ceph.com/issues/58796

Signed-off-by: Soumya Koduri <skoduri@redhat.com>
2023-02-20 23:03:53 +05:30
Zac Dover
6e6010a313 doc/rgw: refine "Setting a Zonegroup"
Streamline the "Setting a Zonegroup" section by separating out the
necessary prerequisite reading from the procedure itself.

I also corrected a typo in the word "following" in an unrelated section.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-20 17:37:49 +10:00
Zac Dover
db2a562485 doc/rgw: multisite ref. top matter cleanup
Edit the top matter in "Multi-site Configuration Reference" so that it
is semantically more natural.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-19 23:20:45 +10:00
Zac Dover
b54b1b6bf5 doc/radosgw: s/execute/run/ in multisite.rst
Replace "execute" with "run" in fourteen out of fifteen instances in
multisite.rst. "Execute" is plain old too grand in most of these
instances.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-19 16:46:49 +10:00
Zac Dover
5cea2529c4 doc/rgw: refine "Realms" section
Make various syntactical and semantic improvements to "Realms" section.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-16 10:11:41 +10:00
zdover23
a9a0262b10
Merge pull request #50119 from zdover23/wip-doc-2023-02-15-multisite-zonegroup-spelling-correction
doc/rgw: s/[Zz]one [Gg]roup/zonegroup/g
2023-02-16 09:37:13 +10:00
Zac Dover
5e8aed3367 doc/glossary: add "realm" to glossary
Add the term "Realm" to the glossary, and link to the section in the RGW
documentation that provides more information about realms.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-15 17:51:41 +10:00
Zac Dover
956c54b7c9 doc/rgw: s/[Zz]one [Gg]roup/zonegroup/g
Change all instances of "Zone Group" and "Zone group" and "zone group"
to "Zonegroup" or "zonegroup".

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-15 15:30:17 +10:00
zdover23
c7e891901d
Merge pull request #50108 from zdover23/wip-doc-2023-02-13-multisite-multisite-config-reference
doc/rgw: refine "Multi-site Config Ref" (1 of x)

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-02-15 14:39:36 +10:00
Zac Dover
2d45a4e5e0 doc/rgw: refine "Multi-site Config Ref" (1 of x)
Refine the syntax (and in some cases, the semantics) of the English in
"Multi-site Configuration Reference" in doc/radosgw/multisite.rst. This
is a long section, so more PRs are likely.

https://tracker.ceph.com/issues/58632

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Co-authored-by: Casey Bodley <cbodley@redhat.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-15 08:39:32 +10:00
Casey Bodley
e25a7e86e9 doc/rgw: update links to examples/rgw
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2023-02-14 07:33:57 -05:00
Zac Dover
40c82f8ef6 doc/rgw: "Migrating Single Site to Multi-Site"
Refine "Migrating Single-site System to Multi-site" in
doc/radosgw/multisite.rst.

https://tracker.ceph.com/issues/58632

Co-authored-by: Cole Mitchell <cole.mitchell@gmail.com>
Co-authored-by: Anthonh D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-13 22:06:33 +10:00
Zac Dover
815359800c doc/rgw: refine "Failover and Disaster Recovery"
English grammar and syntax pass for "Failover and Disaster Recovery" in
doc/radosgw/multisite.rst.

https://tracker.ceph.com/issues/58632

Co-authored-by: Cole Mitchell <cole.mitchell@gmail.com>
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-12 09:47:16 +10:00
Zac Dover
2c6f0ab538 doc/rgw: refine "Configuring Secondary Zones"
English grammar and syntax pass (and some pragmatics, too, where I had
enough understanding to be helpful that way) for "Configuring Secondary
Zones" in doc/radosgw/multisite.rst.

https://tracker.ceph.com/issues/58632

Co-authored-by: Cole Mitchell <cole.mitchell@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-10 12:48:26 +10:00
Zac Dover
c3a1770d4c doc/rgw: refine multisite to "config 2ndary zones"
Refine the English in doc/radosgw/multisite.rst up to (but not
including) "Configure Secondary Zones".

https://tracker.ceph.com/issues/58632

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-09 00:32:44 +10:00
Zac Dover
85816fbca0 doc/radosgw: refine "Maintenance" in multisite.rst
Refine the text in the "Maintenance" section of
doc/radosgw/multisite.rst.

https://tracker.ceph.com/issues/58632

Co-authored-by: Cole Mitchell <cole.mitchell@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-08 10:12:50 +10:00
Zac Dover
805a9baeea doc/rgw: refine ~50-~140 of multisite.rst
Remove pleonasm from approximately line 50 to line 140 of
doc/rgw/multisite.rst.

Follows https://github.com/ceph/ceph/pull/49993.

https://tracker.ceph.com/issues/58632

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-02-07 05:00:55 +10:00
Zac Dover
6721196ff1 doc/rgw: refine 1-50 of multisite.rst
Refine the English in the first fifty lines of multisite.rst. This is
part of a project whose goal is the creation of a document that will
impart a good aerial view of RGW to a first-time reader in the minimum
number of words.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-02-06 07:10:15 +10:00
Zac Dover
f4f5183543 doc/rgw: refine "Zones" in multisite.rst
Clean up the English under the section called "Zones". Part of a larger
project aimed at giving the reader more understanding earlier in the
documentation of how buckets and zones and zone groups and endpoints
work.

https://tracker.ceph.com/issues/58632

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-02-03 17:21:54 +10:00
Anthony D'Atri
bf0d756240
Merge pull request #49497 from BryceCao/wip-fix-mfa.rst-spelling-mistake
doc/radosgw: fix spelling mistake in mfa.rst
2022-12-20 22:28:49 -05:00
cao.leilc
86109954ea doc/radosgw: fix spelling mistake in mfa.rst
Signed-off-by: caolei <cao.leilc@inspur.com>
2022-12-21 10:44:41 +08:00
Cory Snyder
9052ca420f rgw: add 'inline_data' zone placement info option
Adds a new RGW zone placement info option to control whether
an object's first data chunk is placed in the head object.
This allows admins to make a tradeoff between optimizing for
PUT/GET performance vs. DELETE performance for some cluster
configurations.

Fixes: https://tracker.ceph.com/issues/57965
Signed-off-by: Cory Snyder <csnyder@iland.com>
2022-12-12 03:24:35 -05:00
Casey Bodley
2e08de5b8d
Merge pull request #48554 from giubacc/rgw_dns_name_multivalue
rgw: add multivalue support to rgw_dns_name config option

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2022-12-09 12:54:13 -05:00
Casey Bodley
ce0bec673c
Merge pull request #48996 from yuvalif/wip-yuval-remove-pubsub
remove pubsub from the RGW

Reviewed-by: Casey Bodley <cbodley@redhat.com>
Reviewed-by: Daniel Gryniewicz <dang@redhat.com>
Reviewed-by: Ronen Friedman <rfriedma@redhat.com>
2022-12-01 09:00:26 -05:00
gaoweinan
8e4fa5f3ad doc/radosgw:Fix index error
Fix index error.There is a sentence in the note of chapter "Pool Placement and storage classes": "If you have not done any previous Multisite Configuration", so it seems that chapter "Multisite Configuration" precedes chapter "Pool Placement and storage classes", but actually chapter "Multisite Configuration" follows chapter "Pool Placement and storage classes" in the index.

Fix:https://tracker.ceph.com/issues/58134

Signed-off-by: gaoweinan <gaoweinan@inspur.com>
2022-12-01 10:19:45 +08:00
gaoweinan
fc830e6aa1 doc/radosgw/swift: Fix repeated word
Fix repeated word in swift API

fix:https://tracker.ceph.com/issues/58124

Signed-off-by: gaoweinan <gaoweinan@inspur.com>
2022-12-01 08:48:58 +08:00
Yuval Lifshitz
0fecbe2476 rgw/pubsub: remove unnecessary REST abstraction layer
this was used for an already deprecated non s3 API for pubsub
also, some texts changes in docs and error messages

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2022-11-30 18:55:01 +00:00
Yuval Lifshitz
0989166a63 rgw/pubsub: remove pusub sync module functionality
also update the documentation

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2022-11-30 18:48:11 +00:00
Zac Dover
d3db815fd5 doc/radosw: improve radosgw text
Punch up the paragraph about the Ceph Object Gateway daemon (radosgw).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-20 14:23:16 +10:00
Zac Dover
fc253d91b2 doc/radosgw: improve "Ceph Object Gateway" text
Reduce ambiguity in the definition of "Ceph Object Gateway".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-13 07:28:45 +10:00
stevenhua
870e8e7b3f doc/radosgw: fix command error blank 2022-11-01 09:53:02 +08:00
Zac Dover
d85c14bb30 doc/radosgw: add prompts to multisite.rst
Add unselectable prompts to multisite.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-28 23:37:16 +10:00
zdover23
bc11fa71d6
Merge pull request #47582 from snosratiershad/docs/correct-add-system-user-to-the-master-zone-command
docs: correct add system user to the master zone command

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2022-10-28 21:14:03 +10:00
wangyingbin
3acbed815a doc: Change 'ReST' to 'REST' in doc/radosgw/layout.rst
In doc/radosgw/layout.rst, 'ReST' is not spelled properly, so we change it to 'REST'.

Signed-off-by: wangyingbin <wangyingbin@inspur.com>
2022-10-28 16:23:44 +08:00
Giuseppe Baccini
f62fff1f4c
rgw: add multivalue support to rgw_dns_name config option
rgw_dns_name configuration option has extended to define multiple
domain values.
This option is now interpreted as a comma separated list of DNS names.

Example:

rgw_dns_name = cname.domain.com,cname2.domain2.com, cname3.domain3.com

Signed-off-by: Giuseppe Baccini <giuseppe.baccini@suse.com>
2022-10-21 10:53:42 +02:00
Zac Dover
b1e589343d doc/radosgw: refine "notifications" and "events"
This commit refines the English in the "Notifications"
and "Events" sections of the notifications.rst page
(the "Bucket Notifications" page).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-21 13:34:34 +10:00
Zac Dover
a69dd10ddb doc/radosgw: refine "bucket notifications"
This commit refines the English in the "Bucket Notifications REST API"
section of the notifications.rst page (the "Bucket Notifications" page).

Co-author: Cole Mitchell <cole.mitchell@gmail.com>

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-20 06:24:43 +10:00