Commit Graph

9811 Commits

Author SHA1 Message Date
zdover23
f780ca2e3d
Merge pull request #49820 from zdover23/wip-doc-2023-01-21-rados-config-pool-pg-config-ref
doc/rados: refine pool-pg-config-ref.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2023-01-23 21:50:59 +10:00
Zac Dover
dfb0b4a6ad doc/rados: refine ceph-conf.rst
Correct grammar and usage in ceph-conf.rst.

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-23 19:16:16 +10:00
Adam King
7bd7ce9310
Merge pull request #48801 from adk3798/extra-entrypoint-args
mgr/cephadm: support for extra entrypoint args

Reviewed-by: John Mulligan <jmulligan@redhat.com>
Reviewed-by: Michael Fritch <mfritch@suse.com>
Reviewed-by: Redouane Kachach <rkachach@redhat.com>
2023-01-22 14:21:01 -05:00
Adam King
60339fde1a
Merge pull request #49189 from pcuzner/improve-orch-host-ls
orchestrator: improvements to the orch host ls command

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2023-01-22 11:26:10 -05:00
Zac Dover
e7669539ac doc/install: refine index.rst
Refine English sentences in doc/install/index.rst. Remove adverbial
phrases of time that refer to Nautilus-era features as "new", since that
was four years ago.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-22 03:24:37 +10:00
Zac Dover
11724c9b8e doc/rados: refine pool-pg-config-ref.rst
Remove pleonasm.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-21 15:04:12 +10:00
Ilya Dryomov
510284b665
Merge pull request #49791 from idryomov/wip-doc-exclusive-lock-transitions
doc/rbd/rbd-exclusive-locks: warn about automatic lock transitions

Reviewed-by: Ramana Raja <rraja@redhat.com>
2023-01-20 14:08:10 +01:00
zdover23
26f55e2064
Merge pull request #49764 from zdover23/wip-doc-2023-01-17-ceph-volume-lvm-encryption-refine
doc/ceph-volume: refine encryption.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-01-20 20:50:42 +10:00
Ilya Dryomov
2af7252b33 doc/rbd/rbd-exclusive-locks: warn about automatic lock transitions
A lot of people aren't aware of automatic lock transitions and
wrongfully assume that exclusive lock means that the image remains
locked for as long as the client is running.  Redo the explanation
and add a warning.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2023-01-20 11:33:54 +01:00
Ilya Dryomov
c966ea99bc doc/rbd/rbd-exclusive-locks: don't mention "profile rbd" requirement twice
It's (much better) described in the Blocklisting section.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2023-01-20 11:33:24 +01:00
Zac Dover
6f7f7c8f65 doc/ceph-volume: refine encryption.rst
Improve the word choice and grammar of
doc/ceph-volume/lvm/encryption.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-20 01:46:13 +10:00
Zac Dover
f04001deb3 doc/install: link to "cephadm installing ceph"
Link to "Installing Ceph" in the cephadm documentation instead of (as
was the case before this commit) to the cephadm overview page. Anyone
who clicks on the "cephadm" link in the context of the
doc/install/index.rst page is more likely to expect installation
instructions than to expect an explanation of what cephadm is.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-19 11:50:17 +10:00
zdover23
6d583d25c5
Merge pull request #49725 from anthonyeleven/56521
doc/releases: Clarify Quincy CephFS MDS upgrade process

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2023-01-16 13:50:17 +10:00
Anthony D'Atri
680e534540
Merge pull request #49747 from zdover23/wip-doc-2023-01-16-luks-versions
doc/ceph-volume: update LUKS docs
2023-01-15 22:04:59 -05:00
zdover23
d28f96359b
Merge pull request #49716 from zdover23/wip-doc-2023-01-12-rbd-iscsi-initiator-linux-prompts
doc/rbd: refine iscsi-initiator-linux.rbd

Reviewed-by: Ilya Dryomov <idryomov@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-01-16 11:32:02 +10:00
Zac Dover
27974c1d8a doc/ceph-volume: update LUKS docs
Remove references that claim that Ceph uses only LUKS version 1.

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-16 07:46:49 +10:00
Zac Dover
26b8e9cb93 doc/rbd: format iscsi-initiator-linux.rbd better
Add prompts and clean up the lists in doc/rbd/iscsi-initiator-linux.rbd.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-16 05:39:54 +10:00
Zac Dover
84524c2646 doc/start: add RST escape character rules for bold
Explain how to escape the bold notation (**) within words in RST.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-16 05:38:07 +10:00
Zac Dover
f1c0c3ec3d doc/dev: add git branch management commands
Add git branch deleting and search commands to the "Basic Workflow" page
of the Developer Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-14 07:26:18 +10:00
Anthony D'Atri
82c9fe989f doc/releases: Clarify Quincy CephFS MDS upgrade process
Signed-off-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
2023-01-12 09:21:57 -05:00
Zac Dover
049e5aaade doc/dev: add push.autoSetupRemote instructions
Explain how to set up push.autoSetupRemote so that the origin branch is
properly set up when running "get push" without the need for the
"--set-upstream" option.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-12 06:24:55 +10:00
Zac Dover
559fea8b42 doc/cephadm: s/osd/OSD/ where appropriate
Capitalize the initialization "OSD" where it occurs in natural language
in cephadm/host-management.rst. This PR answers a request made by
Anthony D'Atri and seconded by Cole Mitchell in https://github.com/ceph/ceph/pull/49699#discussion_r1066171002.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-12 01:12:24 +10:00
colemitchell
58f33d83bc
Merge pull request #49699 from zdover23/wip-doc-2023-01-11-cephadm-host-management-removing-hosts
doc/cephadm: refine "Removing Hosts"

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-01-10 14:31:23 -05:00
colemitchell
1eb04cbc5e
Merge pull request #49703 from zdover23/wip-doc-2023-01-11-rados-operations-move-colon
doc/rados: move colon

Reviewed-by: Cole Mitchell <cole.mitchell@gmail.com>
2023-01-10 14:24:11 -05:00
Zac Dover
b1a53d7621 doc/rados: move colon
Move colon in add-or-rm-osds.rst so that the sentence reads properly.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-11 05:08:35 +10:00
Zac Dover
c28cb53390 doc/css: add top-bar padding for h3 html element
Add "scroll-margin-top: 4em;" property to h3 html element.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-11 04:48:32 +10:00
Zac Dover
2e1fd63087 doc/cephadm: refine "Removing Hosts"
An intended edit to remove a redundant indefinite article became a
longer (but still brief) full editorial pass.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-11 04:29:02 +10:00
zdover23
7c9cfc9013
Merge pull request #49692 from zdover23/wip-doc-2023-01-11-header-fix
doc/css: add "span" padding to custom.css

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-01-11 04:10:22 +10:00
Zac Dover
dd9555b0ae doc/css: add "span" padding to custom.css
Add "scroll-top-bar: 2em;" for the "span" html element in custom.css so
that the top bar doesn't get in the way of headings bounded by the "span
element".

See also https://github.com/ceph/ceph/pull/49644.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-11 01:55:55 +10:00
Ilya Dryomov
8ca3bd5042 doc/man/ceph-rbdnamer: remove obsolete udev rule
Fixes: https://tracker.ceph.com/issues/58398
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2023-01-10 13:43:03 +01:00
Jos Collin
86f8fa19e5
doc: document the relevance of mds_namespace mount option
Fixes: https://tracker.ceph.com/issues/57673
Signed-off-by: Jos Collin <jcollin@redhat.com>
2023-01-10 14:48:20 +05:30
Zac Dover
7b8f75ebd7 doc/rados: link to cephadm replacing osd section
Direct readers to the "Replacing an OSD" section in the cephadm
documentation, for cases in which the instructions in "Replacing an OSD"
in the RADOS documentation don't work.

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-10 05:11:00 +10:00
Adam King
8ee799e9cc doc/cephadm: docs for extra entrypoint args
Signed-off-by: Adam King <adking@redhat.com>
2023-01-09 13:24:50 -05:00
Zac Dover
6bede3505f doc/glossary: Clean up "Ceph Object Storage"
Remove redundant material under the "Ceph Object Storage" headword and
add a "See 'Ceph Object Store'" link. A future PR will provide a couple
of sentences that explain how object storage is what's really supporting
both CephFS and RBD.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-09 03:43:35 +10:00
Brad Fitzpatrick
c670906b49
doc: fix a typo
Signed-off-by: Brad Fitzpatrick <brad@danga.com>
2023-01-06 19:54:45 -08:00
zdover23
f87801e195
Merge pull request #49658 from zdover23/wip-doc-2023-01-15-h2-scroll-margin-top
doc/css: Add scroll-margin-top to h2 html element

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-01-07 04:02:00 +10:00
zdover23
89768e6738
Merge pull request #49653 from zdover23/wip-doc-2023-01-06-crushtool-options
doc/man: define --num-rep, --min-rep and --max-rep

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Laura Flores <lflores@redhat.com>
2023-01-07 03:57:32 +10:00
Zac Dover
af048ca911 doc/css: Add scroll-margin-top to h2 html element
Add "scroll-margin-top: 4em;" to the h2 html element's definition in
custom.css. This moves the text under all h2 html elements out of the
way of the sticky-header-style top bar, which previously obscured the
text.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-07 02:24:39 +10:00
zdover23
c439a11c70
Merge pull request #49643 from zdover23/wip-doc-2023-01-05-add-padding-to-sections
doc/_static: add scroll-margin-top to custom.css

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2023-01-07 02:13:26 +10:00
Zac Dover
10fa01d075 doc/man: define --num-rep, --min-rep and --max-rep
Explain the "--num-rep", "--min-rep", and "--max-rep" options, which are
required when running "crushtool" commands with the "--show-mappings"
flag. Originally reported by Brad Fitzpatrick.

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

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-07 02:12:26 +10:00
Mike Perez
cdfb034a08 doc: Updating Foundation members for January 2023
Signed-off-by: Mike Perez <thingee@gmail.com>
2023-01-05 15:09:05 -08:00
Zac Dover
5738271498 doc/_static: add scroll-margin-top to custom.css
Add 4em of padding to the class "section", so that linked-to
destinations are not obscured by the top bar.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-06 04:19:12 +10:00
Zac Dover
5de590b9be doc/css: add scroll-margin-top to dt elements
add "scroll-margin-top: em3;" to custom.css so that the header bar
doesn't obscure the text of headwords in glossary.rst. Note that this
applies only to elements in the documentation that are rendered into
HTML with the dt (which stands for "description term" or "description
list") tag. Other modifications will be necessary in order to ensure
that the anchor points of non-dt elements are not obscured by the header
bar.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-05 23:58:27 +10:00
zdover23
7d4812b52e
Merge pull request #49620 from bradfitz/bradfitz/doc
doc: fix a couple grammatical things

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2023-01-04 02:45:15 +10:00
Brad Fitzpatrick
b9b6011c11 doc: fix a couple grammatical things
Signed-off-by: Brad Fitzpatrick <brad@danga.com>
2023-01-03 08:37:02 -08:00
Zac Dover
6141c5f061 doc/start: add Anthony D'Atri's suggestions
Add the suggestions made by Anthony D'Atri in
https://github.com/ceph/ceph/pull/49609.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-02 23:00:55 +10:00
Zac Dover
cdc7b60354 doc/start: refine "Quirks of RST"
Refine the language that was added yesterday, language that explains how
certain aspects of RST work.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-02 14:23:22 +10:00
Zac Dover
7517404f72 doc/start: add link-related metadocumentation
Add two kinds of link-related metadocumentation (documentation about how
to write documentation) to the "Documenting Ceph" section of the "Intro
to Ceph" document: 1. metadocumentation about external links, and 2.
metadocumentation about internal links.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-01 22:06:54 +10:00
Zac Dover
7c70a66414 doc/glossary: capitalize "DAS" correctly
Correctly capitalize "Direct-Attached Storage" in the glossary. (And
test the "Quincy" branch, which seems lately not to have picked up any
docs backports.)

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-31 14:22:26 +10:00
Zac Dover
39377f7db1 doc/glossary: collate "releases" entries
Collect the "Releases"-related entries together under the "Releases"
headword, in order to give readers a sense at a glance of how the
different kinds of releases relate to one another.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-12-30 11:32:31 +10:00