Commit Graph

10373 Commits

Author SHA1 Message Date
Rishabh Dave
5b1f679ff4
Merge pull request #53390 from rishabh-d-dave/cephfs-doc-admin
doc/cephfs: write cephfs commands fully in docs

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Zac Dover <zac.dover@proton.me>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2023-09-11 22:19:37 +05:30
Yuval Lifshitz
f53f3aeba9
Merge pull request #53073 from kchheda3/wip-filter-noti-uid
rgw/notification: Filter topic list based on uid

reviewed-by: yuvalif
2023-09-11 17:21:47 +03:00
Anthony D'Atri
04e5b5083a
Merge pull request #53383 from zdover23/wip-doc-2023-09-11-glossary-ceph-client-link
doc/glossary: link to "ceph clients" from entry
2023-09-11 09:53:53 -04:00
Rishabh Dave
e63b573d3e doc/cephfs: write cephfs commands fully in docs
We write CephFS commands incompletely in docs. For example, "ceph tell
mds.a help" is simply written as "tell mds.a help". This might confuse
the reader and it won't harm to write the command in full.

Fixes: https://tracker.ceph.com/issues/62791
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-09-11 15:25:46 +05:30
Alvin Owyong
f944fa8ddb
doc: Add warning on manual CRUSH rule removal
Add warning for "osd erasure-code-profile rm" section under rados/operations.

Signed-off-by: Alvin Owyong <70066269+alvinowyong@users.noreply.github.com>
2023-09-11 17:15:15 +08:00
Zac Dover
fd9c8c9e2f doc/glossary: link to "ceph clients" from entry
Link to the "Ceph Clients" section of doc/architecture.rst from the
"Ceph Clients" entry in the glossary. A glossary entry should be a short
summary of the topic with which it deals, and it should direct the
reader to further and more detailed reading if the reader is interested.
This does that.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-11 15:18:40 +10:00
Zac Dover
436fbf7a3e doc/architecture.rst - edit a sentence
Change the sentence structure of a sentence because the verb
"experience" looked like the abstract noun "experience" when I read it
with fresh eyes. I chose the perhaps TESOL-unfriendly verb "incur", but
I believe it is right.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-11 02:38:26 +10:00
zdover23
e900cf5f32
Merge pull request #53353 from zdover23/wip-doc-2023-09-10-architecture-1-of-x
doc/architecture.rst - edit up to "Cluster Map"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-09-10 21:43:44 +10:00
Zac Dover
b3538f8ade doc/architecture.rst - edit up to "Cluster Map"
Edit doc/architecture.rst up to "Cluster Map", but not including
"Cluster Map".

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-10 21:16:33 +10:00
Anthony D'Atri
1de6ea7c8f
Merge pull request #53341 from alvinowyong/wip-doc-create-osd-warning
doc/cephadm/services: Add package conflict warning to osd.rst
2023-09-09 16:08:59 -04:00
Alvin Owyong
38ec8e0692
docs: update warning message
truncated warning message according to comments

Signed-off-by: Alvin Owyong <70066269+alvinowyong@users.noreply.github.com>
2023-09-09 01:21:42 +08:00
Alvin Owyong
5e803567c7
docs: add warning about potential package conflict
Add warning for "creating new osds" section under cephadm services.

Signed-off-by: Alvin Owyong <70066269+alvinowyong@users.noreply.github.com>
2023-09-09 00:25:04 +08:00
Zac Dover
d009f0757c doc/configuration: edit "bg" in mon-config-ref.rst
Edit the English in the section "Background" in
doc/rados/configuration/mon-config-ref.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-08 22:03:54 +10:00
J. Eric Ivancich
815481c637
Merge pull request #51071 from ivancich/wip-versioned-reindex
rgw: reindex of objects in versioned buckets

Reviewed-by: Casey Bodley <cbodley@redhat.com>
2023-09-07 12:43:59 -04:00
Rishabh Dave
849fbd1d5b
Merge pull request #41779 from rishabh-d-dave/fs-auth-subcmd
mon,osd,mds: allow fs authorize to update caps

Reviewed-by: Radosław Zarzyński <rzarzyns@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2023-09-07 18:39:58 +05:30
Rishabh Dave
f203542c3e doc/cephfs: add doc for fs authorize since it can now also update caps
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2023-09-07 11:37:17 +05:30
Laura Flores
536e8f582f
Merge pull request #50948 from ideepika/wip-tracing-debug-quincy
src/common: add debug logs to opentelementry tracing
2023-09-06 13:18:18 -04:00
zdover23
abae53b65e
Merge pull request #53300 from zdover23/wip-doc-2023-09-06-rados-operations-pools-bulk-flag
doc/rados: add bulk flag to pools.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-09-07 02:10:48 +10:00
zdover23
f1a65b3eb0
Merge pull request #53314 from zdover23/wip-doc-2023-09-07-man-radosgw-bucket-radoslist
doc/man: radosgw-admin.rst typo

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-09-07 02:06:18 +10:00
Rishabh Dave
f9a01cf385
Merge pull request #51942 from trociny/wip-61599
mds: optionally forbid to use standby for another fs as last resort

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Rishabh Dave <ridave@redhat.com>
2023-09-06 20:26:33 +05:30
Zac Dover
fb808732e8 doc/man: radosgw-admin.rst typo
Edit the text in the "bucket radoslist" entry.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-07 00:23:06 +10:00
Zac Dover
31f1224f61 doc/rados: add bulk flag to pools.rst
Add a link in pools.rst to the section in placement-groups.rst
describing the commands used to manage pools that are flagged "--bulk".

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-07 00:15:51 +10:00
Zac Dover
fa40b7ef56 doc/man: remove docs about support for unix domain sockets
doc/man: support for unix domain sockets is not implemented, hence we
removed documentation about it.

(Note: the changes in this commit were the work of Rok Jaklič in
https://github.com/ceph/ceph/pull/48537. This pull request has been
raised because that pull request was for some mysterious reason causing
merge conflicts that were never resolved.)

Co-authored-by: Rok Jaklič rjaklic@gmail.com
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-09-06 16:33:43 +10:00
Adam King
794f4d16c6
Merge pull request #53052 from phlogistonjohn/cephadm-split-refactor
cephadm: refactor cephadm into multiple files

Reviewed-by: Adam King <adking@redhat.com>
2023-09-05 12:11:46 -04:00
kchheda3
2547d27b4b rgw/notification: Filter topic list based on uid on radosgw-admin
Signed-off-by: kchheda3 <kchheda3@bloomberg.net>
2023-09-05 10:22:54 -04:00
Ali Masarwa
4abb31a5f4 RGW: added a per topic configuration to control the notification persistency
Signed-off-by: Ali Masarwa <ali.saed.masarwa@gmail.com>
2023-09-04 10:20:55 +03:00
Anthony D'Atri
d986537f9b doc/man/8: improve radosgw-admin.rst
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2023-09-03 09:56:44 -04:00
Anthony D'Atri
c837584207
Merge pull request #50360 from tgfree7/wip-doc-2023-03-03-multisite-migrating-a-single-site
doc/radosgw: multisite - edit "migrating a single-site"
2023-09-03 08:05:17 -04:00
Dmitry Kvashnin
fdbd567d91 doc/start: correct ABC test chart
Signed-off-by: Dmitry Kvashnin <dm.kvashnin@gmail.com>
2023-09-01 10:53:18 +00:00
Ilya Dryomov
0795c27447 doc: 16.2.14 release notes follow-up
Address review comments that remained outstanding in
https://github.com/ceph/ceph/pull/53107:

- CephFS capitalization
- missing PR in the list of changes

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2023-08-31 10:55:47 +02:00
Laura Flores
a8ad05f169
Merge pull request #53107 from ceph/wip-yuriw-release-16.2.14-main
doc: 16.2.14 Release Notes
2023-08-30 17:24:55 -05:00
J. Eric Ivancich
522785e053 rgw: allow multisite specification used w/ rgw-restore-bucket-index script
When the metadata for a bucket is requested only the default
realm/zonegroup/zone is currently supported. This adds three new
command-line options to rgw-restore-bucket-index:

    -r <realm-name>
    -g <zonegroup-name>
    -z <zone-name>

The multisite specification will then be used in invocations of
`radosgw-admin`, such as to query the zone, get metadata, and invoke
the "object reindex" subcommand.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2023-08-30 14:41:15 -04:00
J. Eric Ivancich
c02906ae64 rgw: enhances rgw-restore-bucket-index script
This enhances the script to both process versioned buckets correctly
and to handle object names that begin with underscore.

If the bucket is versioned it submits each version chronologically
(based on mtime) to be reindexed in order to "replay" the modification
of objects. However mtime is not a perfect indicator. So additionally
it looks at the OLH object to determine the most recent version and
the script makes sure that it is replayed last. The order of previous
versions is likely correct, but not guaranteed to be so.

Additional logic is added to handle objects with names that begin with
underscore ('_') since that's used as a delimiter and needs to be
escaped and rados object locators are also used.

A man page for the script is added.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2023-08-30 14:41:15 -04:00
John Mulligan
d09e32ad2b doc: update release checklist for new cephadm constants file
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2023-08-30 14:02:15 -04:00
Zac Dover
f0df9e1ea9 doc/cephadm: edit "Adding Hosts" in install.rst
Edit the English in the "Adding Hosts" section of
doc/cephadm/install.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-08-30 08:33:09 +10:00
Yuri Weinstein
5f95050e12 doc: 16.2.14 Release Notes
Signed-off-by: Yuri Weinstein <yweinste@redhat.com>
2023-08-29 07:52:10 -07:00
Milind Changire
d7dfac8111
Merge PR #52686 into main
* refs/pull/52686/head:
	PendingReleaseNotes: note about mandatory fs argument
	doc/cephfs: add note about mandatory --fs argument to snap-schedule
	qa: add test for mandatory fs argument to snap-schedule commands
	mgr/snap-schedule: tweaks to keep mypy happy
	mgr/snap_schedule: validate fs before execution

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
2023-08-29 20:13:50 +05:30
Ilya Dryomov
aa2c5c09a0
Merge pull request #51964 from idryomov/wip-doc-drop-journal-max-fetch-bytes
doc: drop mention of rbd_mirror_journal_max_fetch_bytes option

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Mykola Golub <mgolub@suse.com>
2023-08-29 14:43:00 +02:00
Ilya Dryomov
b239a8b90a doc: drop mention of rbd_mirror_journal_max_fetch_bytes option
It was removed in commit 1ef12ea0d2 ("rbd-mirror: remove
rbd_mirror_journal_max_fetch_bytes option") in 2019.  Commit
32375cb789 ("doc: misc clarity and capitalization") added a "tip"
mentioning it in 2020 in an attempt to capture advice [1].

[1] https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/IHMGNFLWCD5E5R4W5S2BSSKEB5X3N4S4/

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2023-08-29 13:41:47 +02:00
Zac Dover
46352decff doc: test
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-08-29 09:36:26 +10:00
Zac Dover
f10781a281 doc/cephadm: add ssh note to install.rst
Add a note instructing the reader to have ssh running before the
"cephadm bootstrap" command is run.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-08-29 09:35:45 +10:00
Patrick Donnelly
b0f2e060b0
Merge PR #53144 into main
* refs/pull/53144/head:
	doc: reformat so note is not part of code

Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
2023-08-28 10:27:55 -04:00
Zac Dover
e19b9cea62 doc/start: edit os-recommendations.rst
Improve the grammar in one sentence of the "Platforms" section of
doc/start/os-recommendations.rst. Improving that grammar involved
splitting the sentence into two sentences, but that's life. Update:
Anthony substantially rewrote this, so credit for this should rightly
go to him.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-08-28 22:10:12 +10:00
Zac Dover
3b8877481a doc/cephadm: edit sentence in mgr.rst
Improve the grammar in the first sentence of
doc/cephadm/services/mgr.rst. This is a small change, but I could not
resist.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-08-27 06:31:12 +10:00
zdover23
42d7c10ab8
Merge pull request #53161 from Svelar/doc_cephadm
doc/cephadm: update cephadm reef version

Reviewed-by: Zac Dover <zac.dover@proton.me>
2023-08-26 17:00:29 +10:00
Rongqi Sun
d9888a4223 doc/cephadm: update cephadm reef version
Signed-off-by: Rongqi Sun <sunrongqi@huawei.com>
2023-08-26 14:50:00 +08:00
Milind Changire
8c29772fbe
doc/cephfs: add note about mandatory --fs argument to snap-schedule
Signed-off-by: Milind Changire <mchangir@redhat.com>
2023-08-25 21:34:40 +05:30
zdover23
a2cd852731
Merge pull request #53125 from batrick/volume-spec
doc: expand and consolidate mds placement

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-08-25 06:29:44 +10:00
Patrick Donnelly
b3aad53a19
doc: reformat so note is not part of code
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2023-08-24 15:17:47 -04:00
Patrick Donnelly
3a5f9dc37a
doc: expand and consolidate mds placement
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2023-08-24 08:55:47 -04:00