Commit Graph

11009 Commits

Author SHA1 Message Date
Zac Dover
0ebfb3eda8 doc/cephfs: edit "is mount helper present"
Edit the section called "Is mount helper present?", the title of which
prior to this commit was "Is mount helper is present?". Other small
disambiguating improvements have been made to the text in the section.
An unselectable prompt has been added before a command.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-14 16:40:14 +10:00
Yuri Weinstein
8761bbe16c docs: removed centos 8 and added squid to the build matrix
Signed-off-by: Yuri Weinstein <yweinste@redhat.com>
2024-07-12 06:42:02 -07:00
Zac Dover
56c9388155 doc/radosgw: s/http/HTTP/
s/http/HTTP/ in doc/radosgw/s3/authentication.rst, as suggested by
Anthony D'Atri in the location linked in the "Fixes:" line below.

Fixes: https://github.com/ceph/ceph/pull/58436#discussion_r1667088045

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-11 13:50:56 +10:00
Adam King
029b4ea10f
Merge pull request #57535 from rkachach/fix_issue_66095
Adding support for ceph mgmt-gateway

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2024-07-10 10:33:06 -04:00
Matthew Vernon
d1a7cc4978 doc: Correct link to "Device management"
The current link goes to `cephadm/services/rados/operations/devices` which is a 404, it instead needs to be `rados/operations/devices/`.

Signed-off-by: Matthew Vernon <mvernon@wikimedia.org>
2024-07-10 06:06:30 +10:00
Redouane Kachach
a093ba7e38
mgr/cephadm: adding documentation for cephadm mgmt-gateway service
Signed-off-by: Redouane Kachach <rkachach@ibm.com>
2024-07-09 15:27:33 +02:00
Adam Kupczyk
fe2bc060b2
Merge pull request #57369 from YiteGu/bluestore-offline-trim
tools/bluestore: Add command 'trim' to ceph-bluestore-tool
2024-07-09 13:20:19 +02:00
spdfnet
d94f90b757 doc/cephfs: fix typo
blanacer -> balancer

Signed-off-by: spdfnet <32593931+spdfnet@users.noreply.github.com>
2024-07-08 09:03:35 +01:00
Casey Bodley
05cab64b9c doc/rgw: update s3 authentication
authentication.rst described the steps to generate a v2 signature,
without reference to aws docs. replace that with sections that reference
aws docs for v2 and v4 signatures. list which values of the request
header x-amz-content-sha256 are supported for v4

Fixes: https://tracker.ceph.com/issues/42888

Signed-off-by: Casey Bodley <cbodley@redhat.com>
2024-07-04 15:59:07 -04:00
Zac Dover
9d164d2b11
Merge pull request #58368 from zdover23/wip-doc-2024-07-01-rados-config-mon-lookup-dns
doc/rados: document manually passing search domain

Reviewed-by: Lander Duncan <landerduncan@nyu.edu>
Reviewed-by: Cole Mitchell <cole.mitchell.ceph@gmail.com>
2024-07-05 04:25:25 +10:00
Zac Dover
98938a0312 doc/rados: document manually passing search domain
Document how to manually pass the search domain to "mon_dns_srv_name" in
doc/rados/configuration/mon-lookup-dns.rst.

This commit is made in response to a request by Lander Duncan that was made on the [ceph-users] mailing list, and can be seen here: https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/F7V4CWLIYCAJ4JXI2JLNY6QPCFPR4SLA/

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-04 03:52:55 +10:00
Casey Bodley
1272408faf
Merge pull request #57985 from thotz/add-storage-adminops-api
rgw/adminops: add option to provide storageclass adminops user apis

Reviewed-by: Matt Benjamin <mbenjamin@redhat.com>
2024-07-02 20:55:25 +01:00
Zac Dover
6b149e4f6a doc/start: remove mention of Centos 8 support
Remove information so that it is clear that Centos 8 will no longer be
supported by Ceph.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-02 04:19:12 +10:00
Zac Dover
4f8903cf80 doc/cephfs: update cephfs-shell link
Repair the link to cephfs-shell.rst in doc/cephfs/cephfs-shell.rst that
was broken in https://github.com/ceph/ceph/pull/41165/ when
doc/cephfs/cephfs-shell.rst was moved to doc/man/8/cephfs-shell.rst.

This commit is made in response to a request by Lander Duncan that was
made on the [ceph-users] mailing list, and can be seen here: https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/thread/F7V4CWLIYCAJ4JXI2JLNY6QPCFPR4SLA/

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-01 15:57:40 +10:00
Zac Dover
2f386ffa6d doc/start: s/overprovsioning/overprovisioning/
Restore a missing "i" in "overprovisioning" in
doc/start/hardware-recommendations.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-01 13:27:40 +10:00
Zac Dover
7a78dda0a9 doc/cephfs: take Anthony's suggestion
Incorporate Anthony's suggestion in
https://github.com/ceph/ceph/pull/57567#discussion_r1607016050 into
doc/cephfs/fs-volumes.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-29 22:11:55 +10:00
Venky Shankar
cac7dcd634 Merge PR #53755 into main
* refs/pull/53755/head:
	PendingReleaseNotes: add note about CephFS set_vxattrs
	doc/cephfs: Update docs to match remove functionality and respective vxattrs
	qa: Add test coverage for vxattr behavior
	qa: Add removexattr to support setfattr removal.
	mds: Implement remove for ceph vxattrs

Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Milind Changire <mchangir@redhat.com>
2024-06-27 19:58:50 +05:30
Zac Dover
c432d9f08f
Merge pull request #58287 from pereman2/libradospp-example-doc
doc/rados: update how to install c++ header files

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ronen Friedman <rfriedma@redhat.com>
2024-06-27 22:21:08 +10:00
N Balachandran
9f43c67a63 doc/dev: Fix typos in encoding.rst
Signed-off-by: N Balachandran <nibalach@redhat.com>
2024-06-27 12:52:09 +05:30
Pere Diaz Bou
7e87441601 doc/rados: update how to install c++ header files
In this example librados2-devel only install C header files on fedora 40,
therefore I added libradospp-devel to the command to include C++ header files.

Signed-off-by: Pere Diaz Bou <pere-altea@hotmail.com>
2024-06-26 15:57:47 +02:00
Zac Dover
cf5ce305b2
Merge pull request #58226 from zdover23/wip-doc-2024-06-24-rados-troubleshooting-osd-debugging-slow-requests
doc/rados: edit troubleshooting-osd.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-06-26 15:53:07 +10:00
Patrick Donnelly
c8053b11e7
Merge PR #53503 into main
* refs/pull/53503/head:
	qa: add tests for `mds last-seen` command
	doc/cephfs: add documentation for `mds last-seen`
	PendingReleaseNotes: add note on last-seen command
	mon/MDSMonitor: add command to lookup when mds was last seen
	mon/MDSMonitor: set birth time on FSMap during encode
	pybind/mgr/dashboard: show context diff for openapi check

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2024-06-25 12:27:28 -04:00
Zac Dover
2e777cb4f8 doc/rados: credit Prashant for a procedure
Credit Prashant D for creating the stretch-mode workaround procedure for
retrieving the correct size of datacenters.

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-25 17:19:49 +10:00
Adam King
40b7ec6256
Merge pull request #57339 from phlogistonjohn/jjm-smb-login-control
smb: add login control access parameters to share resource

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
2024-06-24 08:35:29 -04:00
Zac Dover
8b211b9c7f doc/rados: edit troubleshooting-osd.rst
Make minor changes to the "Debugging Slow Requests" section of
doc/rados/troubleshooting/troubleshooting-osd.rst in preparation
for an expansion of this section in response to a reqeust from Joel
Davidow.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-24 20:32:30 +10:00
Patrick Donnelly
0efe88dd5d
Merge PR #58121 into main
* refs/pull/58121/head:
	doc: add documentation for `ceph auth rotate`
	PendingReleaseNotes: add note for new `auth rotate`
	qa: test `auth rotate`
	mon/AuthMonitor: add `ceph auth rotate` command

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2024-06-23 14:32:00 -04:00
Zac Dover
785020f212 doc/start: add links to Beginner's Guide
Add two links to Sage Weil's overview talks about Ceph.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-23 17:11:31 +10:00
Zac Dover
e46e6cd30a
Merge pull request #58156 from zdover23/wip-doc-2024-06-20-rados-troubleshooting-mon
doc/rados: followup to PR#58057

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-06-22 16:21:20 +10:00
Zac Dover
64d61b7595
Merge pull request #58109 from zdover23/wip-doc-2024-06-18-rados-ops-stretch-mode
doc/rados: add stretch_rule workaround

Reviewed-by: Prashant D <pdhange@redhat.com>
2024-06-21 15:49:01 +10:00
Patrick Donnelly
cb5086ec82
doc/cephfs: add documentation for mds last-seen
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-06-20 21:32:56 -04:00
Patrick Donnelly
b871bbebe0
doc: add documentation for ceph auth rotate
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-06-20 21:31:13 -04:00
Zac Dover
2e999a26ef doc/rados: followup to PR#58057
Incorporate Anthony D'Atri's suggestions in
https://github.com/ceph/ceph/pull/58057

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-20 21:43:53 +10:00
Zac Dover
45f1639232 doc/start: add wiki to Beginner's Guide
Add the Redmine Ceph Wiki to the Ceph Beginner's Guide.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-20 13:54:24 +10:00
John Mulligan
a44d01f626 doc: document smb share login_control and restrict_access options
Signed-off-by: John Mulligan <jmulligan@redhat.com>
2024-06-19 09:29:42 -04:00
Adam King
73b599d3c5
Merge pull request #57294 from phlogistonjohn/jjm-smb-free-customize
mgr/smb: add custom config options to share and cluster resources

Reviewed-by: Adam King <adking@redhat.com>
2024-06-19 09:17:51 -04:00
Gregory O'Neill
3888cf7707 doc: clarify availability vs integrity 2024-06-18 17:26:03 -04:00
Ilya Dryomov
e879ce83c0
Merge pull request #58112 from nbalacha/wip-doc-typo-180624
doc/rbd: fix typos in NVMe-oF docs

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2024-06-18 16:18:35 +02:00
N Balachandran
0cd415c53b doc/rbd: fix typos in NVMe-oF docs.
Signed-off-by: N Balachandran <nibalach@redhat.com>
2024-06-18 16:09:51 +05:30
Matan Breizman
35d257bfaa doc/dev/crimson: CPU cores allocation
CPU cores allocation and
add crimson-smp vstart flag

Signed-off-by: Matan Breizman <mbreizma@redhat.com>

Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2024-06-18 17:12:14 +10:00
Zac Dover
007385a3ef doc/rados: add stretch_rule workaround
Add a method for defining a CRUSH rule that returns the actual value of
the total available size.

Fixes: https://tracker.ceph.com/issues/56650

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-18 15:22:41 +10:00
John Mulligan
a65ca9fa79 doc: add subsections on custom share and custom global options
Document the options, the risk of using it, and the "magic key-value"
pair needed to enable it.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2024-06-17 11:17:00 -04:00
Zac Dover
5134aeb78b doc/dev: link to ceph.io leads list
Remove the docs.ceph.com list of team leads, and link to the list of
leads on ceph.io.

Fixes: https://tracker.ceph.com/issues/66392

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-18 00:39:10 +10:00
Zac Dover
d071ad2575 doc/rados: explain replaceable parts of command
Add an explanation that directs the reader to replace the "X" part of
the command "ceph tell mon.X mon_status" with the value specific to the
reader's Ceph cluster (which is (probably) not "X").

In the future, such replaceable strings in commands may be bounded by
angle brackets ("<" and ">").

This improvement to the documentation was suggested on the [ceph-users]
email list by Joel Davidow. This email, an absolute model of user
engagement with an upstream project, can be reviewed here:
https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/message/KF67F5TXFSSTPXV7EKL6JKLA5KZQDLDQ/

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-15 21:55:18 +10:00
Zac Dover
0629f47faf doc/rados: add pg-states and pg-concepts to tree
Add "pg-states" and "pg-concepts" to the left tree pane on
docs.ceph.com.

This commit has been made in response to a request from the upstream
made in https://pad.ceph.com/p/Report_Documentation_Bugs.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-13 21:29:47 +10:00
Jiffin Tony Thottan
a3273c8425 rgw/adminops: add option to provide storageclass adminops user apis
In the `radosgw-admin user` command, the default storage class can
defined. This capability is missing in the adminops api.

Fixes https://tracker.ceph.com/issues/66439

Signed-off-by: Jiffin Tony Thottan <thottanjiffin@gmail.com>
2024-06-13 16:50:07 +05:30
Zac Dover
be6d0645c4 doc/glossary: Add "S3"
Add "S3" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-12 09:11:35 +10:00
Adam King
4098fa130a
Merge pull request #57180 from phlogistonjohn/jjm-smb-linked-res
mgr/smb: cluster linked  join auth and users/groups resource types

Reviewed-by: Adam King <adking@redhat.com>
2024-06-11 12:20:30 -04:00
Zac Dover
6fb9a5ef81 doc/rados: improve leader/peon monitor explanation
Add an explanation of leader-peon conditions that obtain when the
cluster is in the "HEALTH_OK" state. Previously, the text discussed
these two monitor states only in the context of a health detail entry.

This improvement to the documentation was suggested on the [ceph-users]
email list by Joel Davidow. This email, an absolute model of user
engagement with an upstream project, can be reviewed here: https://lists.ceph.io/hyperkitty/list/ceph-users@ceph.io/message/KF67F5TXFSSTPXV7EKL6JKLA5KZQDLDQ/

I will list Joel Davidow here as the co-author for the sake of more
expediently getting this change into the documentation, but though he is
listed as the co-author, he is the true author.

Co-authored-by: Joel Davidow <jdavidow@nso.edu>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-11 08:16:34 +10:00
Zac Dover
74cc624d00 doc/start: remove "intro.rst"
Remove "start/intro.rst", which has been renamed "start/index.rst" in
order to follow the conventions followed elsewhere in the documentation.

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

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-10 05:55:48 +10:00
Zac Dover
b2d413ee9d doc/glossary.rst: add "OpenStack Swift" and "Swift"
Add "OpenStack Swift" and "Swift" entries to the glossary.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-09 11:22:39 +10:00