Commit Graph

9435 Commits

Author SHA1 Message Date
Zac Dover
e55c3b114b doc/dev: add submodule-update link to dev guide
This commit links to the procedure in install/clone-source.rst that
explains how to update submodules.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-13 03:30:42 +10:00
Zac Dover
9382a90342 doc/install: improve updating submodules procedure
This commit beefs up the "Updating Submodules" procedure,
which (prior to this commit) was quite brief.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-12 18:27:42 +10:00
Zac Dover
8f4ad5dc9d doc/glossary: add "ceph monitor" entry
This commit adds information to the "ceph monitor" entry in
glossary.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-12 03:20:07 +10:00
Venky Shankar
296ba0641a
Merge pull request #48196 from neesingh-rh/wip-human-readable-volume-info
mgr/volumes: Add human-readable flag to volume info command

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
2022-10-11 16:48:19 +05:30
Marcus Watts
5deb213ae5
Merge pull request #45395 from tobias-urdin/rgw-keystone-service-token
rgw/auth: Add service token support for Keystone auth
2022-10-11 05:49:30 -04:00
Zac Dover
52971eb9ac doc/security: improve grammar in CVE-2022-0670.rst
This commit accepts the suggestions made by Cole Mitchell in
https://github.com/ceph/ceph/pull/48404.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-11 14:36:10 +10:00
zdover23
eaf211cd53
Merge pull request #48423 from zdover23/wip-doc-2022-10-11-releases-pacific-grammar
doc/releases: improve grammar in pacific.rst

Reviewed-by: Laura Flores <lflores@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-10-11 02:38:44 +10:00
Casey Bodley
4b8ce7b0ba
Merge pull request #46772 from cbodley/wip-rgw-doc-bucket-index
doc/dev/radosgw: start describing the bucket index

Reviewed-by: J. Eric Ivancich <ivancich@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-10-10 11:22:46 -04:00
Zac Dover
560d7590fd doc/releases: improve grammar in pacific.rst
This commit accepts the grammar suggestions that were made by Cole
Mitchell in https://github.com/ceph/ceph/pull/48404.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-11 00:19:19 +10:00
Zac Dover
6877b592a2 doc/various: update link to CRUSH pdf
This commit updates link to the research paper that announces and
explains the CRUSH algorithm. This link was broken in the migration from
the old Ceph website to ceph.io.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-09 17:09:30 +10:00
Mary Frances
72922c5ad2 doc: Fixes spelling errors in vault.rst
Signed-off-by: Mary Frances underacloud.tech@gmail.com
2022-10-07 19:06:55 -07:00
Adam King
66c4dc563a
Merge pull request #48374 from rkachach/fix_issue_57769
doc/cephadm: fixing grafana cert/key generation documentation

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2022-10-07 12:30:31 -04:00
Redouane Kachach
d526be8961
doc/cephadm: fixing grafana cet/key generation documentation
Fixes: https://tracker.ceph.com/issues/57769

Signed-off-by: Redouane Kachach <rkachach@redhat.com>
2022-10-07 17:45:05 +02:00
Adam King
3ad11fd461
Merge pull request #47934 from phlogistonjohn/jjm-nfs-sectype
mgr/nfs: add sectype option

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
2022-10-06 14:51:25 -04:00
Venky Shankar
ae1f163816
Merge pull request #48319 from gregsfortytwo/wip-57737-cephfs-doc
doc: discuss the standard multi-tenant CephFS security model

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Kotresh HR <khiremat@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Ken Dreyer <kdreyer@redhat.com>
2022-10-06 10:40:30 +05:30
Zac Dover
5c17509b0a doc/install: clone-source.rst s/master/main
s/master/main in doc/install/clone-source.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-06 14:30:07 +10:00
Greg Farnum
91e7c7de6a doc: discuss the standard multi-tenant CephFS security model
Fixes: https://tracker.ceph.com/issues/57737

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2022-10-05 15:16:37 +00:00
John Mulligan
764ccf998b doc/mgr/nfs: document --sectype option for export create commands
Add documentation for the option to specify the sectype (for enabling kerberos)
when creating a new export.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
2022-10-05 10:25:06 -04:00
zdover23
9cfd351ab2
Merge pull request #44564 from zdover23/wip-doc-2022-01-13-44150-cleanup-grafana-data-source-name
doc/mgr: name data source in "Man Install & Config"

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by:  Laura Flores <lflores@redhat.com>
2022-10-05 19:51:03 +10:00
Zac Dover
a70b720032 doc/rados: refine English in crush-map-edits.rst
This commit makes several refinements to the English in
rados/operations/crush-map-edits.rst, which refinements were suggested
by Cole Mitchell and Anthony D'Atri in the discussion of PR#48085.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-05 15:25:21 +10:00
zdover23
7fbefc9256
Merge pull request #48085 from zdover23/wip-doc-2022-09-14-rados-ops-crush-map-prompt-update
doc/rados: update prompts in crush-map-edits.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2022-10-05 11:20:14 +10:00
Radoslaw Zarzynski
bf46d3736d
Merge pull request #47458 from rzarzynski/wip-all-kickoff-r
kickoff v18 reef

Reviewed-by: Ilya Dryomov <idryomov@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
Reviewed-by: Guillaume Abrioux <gabrioux@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Laura Flores <lflores@redhat.com>
2022-10-04 22:39:19 +02:00
zdover23
9cd816f009
Merge pull request #48346 from zdover23/wip-doc-2022-10-03-glossary-remove-redundancies
doc/glossary.rst: remove duplicates

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-10-05 00:29:19 +10:00
Ilya Dryomov
21543030b7 doc/dev/release-checklists: mention LIBRBD_VER_MINOR and VERSION
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2022-10-04 14:19:25 +02:00
Radoslaw Zarzynski
130704e815 doc, qa/standalone/mon/misc: verify that len(monmap.features.persistent) == 10
Also updates the release checklist.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-10-04 00:27:28 +02:00
Radoslaw Zarzynski
895f7aa991 doc/dev/release-checklists.rst: document vX.0.0 tagging and mark it complete.
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-10-04 00:27:28 +02:00
Casey Bodley
e4a967fec8
Merge pull request #48155 from liangmingyuanneo/wip-rgw-aync-refcount
rgw: async refcount operate in copy_obj

Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
2022-10-03 13:14:25 -04:00
Zac Dover
0692b22354 doc/glossary.rst: remove duplicates
This commit removes similar but distinct entries for the following:
   * CephFS
   * Ceph Client

Removal of a glossary term that is referred to in the body of the
documentation suite requires the alteration of the text string
that refers to the glossary term. Alterations of this kind have
been made to doc/architecture.rst and doc/rados/api/index.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-03 22:51:35 +10:00
Venky Shankar
b0021de5fa
Merge pull request #48292 from kotreshhr/doc-symlink-fix
doc: Fix disaster recovery doc

Reviewed-by: Venky Shankar <vshankar@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Dhairya Parmar <dparmar@redhat.com>
2022-10-03 11:14:33 +05:30
Venky Shankar
8b7537964b
Merge pull request #48179 from batrick/i57598
qa: use correct recovery procedure for alternate meta pools

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2022-10-03 10:07:13 +05:30
Zac Dover
10b33bdabe doc/glossary.rst: alphabetize glossary terms
This commit (finally) alphabetizes the terms in the glossary.
This is not a grammar-correcting or usage-correcting commit.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-03 09:54:26 +10:00
=
1b4f6a2318 rgw: async refcount operate in copy_obj
Signed-off-by: Mingyuan Liang <liangmingyuan@baidu.com>
2022-10-03 02:07:54 +08:00
Zac Dover
dff8f7663a doc/rados: fix prompts in erasure-code.rst
This commit adds unselectable prompts to doc/rados/
erasure-code.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-02 14:55:46 +10:00
zdover23
9109ee0d72
Merge pull request #48322 from zdover23/wip-doc-2022-10-01-rados-ops-ec-front-matter-rewrite
doc/rados: rewrite EC intro

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2022-10-01 14:32:10 +10:00
Zac Dover
d7ba4f8ff6 doc/rados: rewrite EC intro
This PR rewrites the front matter in the "Erasure Code"
section of the RADOS documentation. Previously, the information
in this section was syntactically confused. I have also fleshed
out the distinction between erasure coding and replication.

Co-Author: Cole Mitchell <cole.mitchell@gmail.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-01 13:31:09 +10:00
Josh Durgin
7e03873a35
Merge pull request #43567 from jdurgin/wip-gov
doc/governance: add proposed structure

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2022-09-30 20:05:29 -07:00
Josh Durgin
4c3794805d doc: merge new and old governance description
Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2022-09-30 19:44:10 -04:00
Josh Durgin
cde306afcd doc/governance: updates based on review comments
Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2022-09-30 19:27:29 -04:00
Laura Flores
83a9c14754
Merge pull request #48072 from ceph/wip-yuriw-release-17.2.4-main
doc: 17.2.4 Release Notes
2022-09-30 15:22:50 -05:00
Yuri Weinstein
6760084ba2 doc: 17.2.4 Release Notes
Fixes: https://tracker.ceph.com/issues/57472
Signed-off-by: Yuri Weinstein <yweinste@redhat.com>
Signed-off-by: Laura Flores <lflores@redhat.com>
2022-09-30 14:59:03 -05:00
Josh Durgin
14615e350e doc/governance: update based on review and CLT discussions
Clarified some parts of council that were discussed previously,
specifying the number of members and a staggered term.

Added a bit more about the steering committee - thinking the meetings
could be split between tactical (3/4 weeks) and strategic (monthly),
and still open to anyone to join the discussion, but restricted to
only members voting.

Removed the meeting section since that belongs more in a separate
place, like the ceph.io website.

Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2022-09-30 15:31:07 -04:00
Josh Durgin
6dbe0424f9 doc/governance: add proposed structure
This is Sage's summary of the Ceph leadership team discussions around
this topic. Still many details to be worked out, this is just one
concrete proposal as a basis for further discussion.

Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2022-09-30 15:31:07 -04:00
Kotresh HR
b6898efcb7 doc: Fix disaster recovery doc
Fixes: https://tracker.ceph.com/issues/57734
Signed-off-by: Kotresh HR <khiremat@redhat.com>
2022-09-30 12:07:26 +05:30
Casey Bodley
8fdbc9f3da doc/dev/radosgw: describe the bucket index
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2022-09-29 15:33:16 -04:00
Neeraj Pratap Singh
2c8add629d doc: documenting the --human_readable flag for volume info cmd
Fixes: https://tracker.ceph.com/issues/57620
Signed-off-by: Neeraj Pratap Singh <neesingh@redhat.com>
2022-09-29 12:01:02 +05:30
Ernesto Puerta
7f41f15745
Merge pull request #47131 from aaryanporwal/vrt-doc-update
doc/dev: mgr/dashboard: Replace broken link

Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2022-09-26 13:22:11 +02:00
Zac Dover
b8472b98e2 doc/dev: improve presentation of note (git remote)
This commit corrects the formatting of a note that previously
did not make console output and commands as clear as this commit
makes them.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-09-25 13:41:35 +10:00
Nizamudeen A
1acdb44108
Merge pull request #47265 from s0nea/wip-dashboard-redirect-fqdn
mgr/dashboard: add option to resolve ip addr

Reviewed-by: Pegonzal <NOT@FOUND>
Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2022-09-23 10:59:24 +05:30
Adam King
2784a70271
Merge pull request #47756 from dparmar18/wip-dparmar-cephadm-after-revert
pybind/mgr/cephadm/upgrade: allow upgrades without reducing max_mds

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2022-09-22 09:54:06 -04:00
Tobias Urdin
319d94030c rgw/doc: Replace underscores with spaces for config opt
Also fixes a gramatical error in the documentation text
itself.

Signed-off-by: Tobias Urdin <tobias.urdin@binero.com>
2022-09-21 20:33:29 +00:00