This (very long) PR does a few things:
- Rewrites the "Data Location" section of the Operations
docs
- Rewrites the "Health Checks" section of the Operations
docs
- Adds prompts to commands
- Adds console-output formatting to the places where it
is appropriate
- Adds several section headers where appropriate, to
signpost to the reader what is currently under discussion
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR turned out to be a 3-in-1:
(1) improves syntax and formatting of "Logging to stdout"
(2) improves syntax and formatting of "Logging to files"
(3) replaces all carets with tildes in 3rd-level section
headers in operations.rst (./build-doc was crying
about inconsistency when I fed it tildes, but tildes
and not carets are the RST standard according to
https://docutils.sourceforge.io/ \
docs/user/rst/quickstart.html#sections
so the carets had to go.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
ceph orch host drain removes all daemons from a host so it can be safely removed
ceph orch host rm will only remove host that a safe to remove
Signed-off-by: Daniel Pivonka <dpivonka@redhat.com>
This PR makes some improvements to the "Potential
Problems" section of the "Upgrading Ceph" chapter
of the cephadm documentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR improves the section "Canceling an Upgrade"
in the "Upgrading Ceph" chapter of the cephadm
documentation.
I removed an extraneous prompt and rewrote a sentence
so that it was congruent with other sentences in similar
places elsewhere in the documentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR improves the section "Monitoring the Upgrade"
in the "Upgrading Ceph" chapter of the cephadm documentation.
This PR introduces a couple of section breaks with signposting
information in their titles, and rewrites some sentences in order
to reduce the cognitive load of the reader.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR (slightly) improves the text in the section "Starting
the Upgrade" in the "Upgrading Ceph" chapter of the cephadm
documentation.
This is a very minor update, and does little but bring the sentences
into agreement with many other sentences that I've already written.
This is done to give the reader an almost tabular sense of what to
expect when looking at our docs.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR makes a couple of minor improvements to the text under the
top-level section "Upgrading Ceph" in the "Upgrading Ceph" chapter of
the cephadm documentation.
This one, mercifully, contains only a couple of changes.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites and reformats the section "Disabling Automatic
Deployment of Daemons" in the "Service Management" chapter of the
cephadm guide.
I've rewritten some sentences, removed some "please"s, and added
some section titles so that the content in this is better
signposted.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
service-management.rst contained a section called
"Deployment of Daemons" that needed a rewrite by
a native English speaker.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR removes "Octopus" from the curl-based installation
procedure.
After we moved on to Pacific, referring to Octopus looks wrong.
It looks wrong because it now is wrong.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR improves the flow and syntax of the
sentences in the "Setting a Limit" section of the
"Service Management" chapter of the cephadm documentation.
(This section is about setting limits to the number of
daemons created, and about limiting the creation of daemons
to a specified number of hosts.)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This removes an extraneous "the" and reworks a
sentence so that it adheres to the grammatical
rules of the English language.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR adds parallel construction to the "Service
Specification" section of the "Service Managment"
chapter of the cephadm documentation.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR creates parallel structure for the
text in the "Daemon Status" section of the
cephadm Service Management chapter.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* refs/pull/41483/head:
cephadm: stop passing --no-hosts to podman
mgr/nfs: use host.addr for backend IP where possible
mgr/cephadm: convert host addr if non-IP to IP
mgr/dashboard,prometheus: new method of getting mgr IP
doc/cephadm: remove any reference to the use of DNS or /etc/hosts
mgr/cephadm: use known host addr
mgr/cephadm: resolve IP at 'orch host add' time
Reviewed-by: Sebastian Wagner <swagner@suse.com>
This PR improves the syntax of the "Service
Status" section of the "Service Managment"
section of the cephadm guide. This includes
pretty significant reworking of the information
in the section, so vetting this one might be
annoying. Anyway, I think I've lowered the
cognitive load on the reader.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* refs/pull/39550/head:
mgr/cephadm: induce retune of osd memory on osd creation
qa/tasks/cephadm.conf: autotune osd memory by default
mgr/cephadm: do not autotune when _no_autotune_memory label is present
mgr/cephadm: autotune osd memory
common: add osd_memory_target_autotune
mgr/cephadm: report memory usage, request (limit) in 'orch ps'
doc/cephadm/host-management: document _admin group
mgr/orchestrator: fix help formatting
Reviewed-by: Adam King <adking@redhat.com>
- set osd_memory_target_autotune=true to enable
- tuning is periodic (check every 10m by default)
- tuned values are reflected by osd_memory_target config options scoped
to the host
- only make a change if it appears that we will affect at least 1 of the
relevant OSDs
- attempt to clean out conflicting options. (This is imperfect, since any
manner of weirdly-scoped config options could be responsible; we only
attempt to clean out one scoped directly to the osd name.)
Signed-off-by: Sage Weil <sage@newdream.net>
This is the second half of PR#41241.
This PR creates a sub-subsection that explains
a configuration step that is sometimes necessary
when configuring monitoring in Ceph clusters. (The
configuration step involves DNS zones.)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR streamlines the grammar in the subsection
called "Configuring SSL/TLS for Grafana" in the
monitoring.rst file. It also corrects the prompt
rst.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR corrects various minor usage errors in
the subsection "Deploying Monitoring with cephadm"
of the "monitoring" section of the cephadm guide.
It also adds prompts, and cleans up the list rst a
bit.
This is the first of two PRs planned for this section.
The second PR will create a sub-subsection that explains
an additional installation step that is necessary when
a Ceph cluster and a user accessing that cluster are in
different DNS zones. But that's another story, for another
PR.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR rewrites the text in "Using Customized
Container Images" so that it is just a bit
clearer, and it also formats the prompt in the
text correctly.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This PR fixes the prompts in this section and
makes the sentences a tiny bit less onerous for
the reader.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* refs/pull/40924/head:
mgr/cephadm: check hostname resolution before adding host
cephadm: provide a way to checkhost connection without /etc/hosts passed the shell
doc/cephadm: remove /etc/hosts from list of hostname resoltion methods
Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Adam King <adking@redhat.com>
* refs/pull/40941/head:
qa/suites/rados/cephadm/smoke-roleless: test client-keyring
qa/tasks/cephadm.py: adjust client.admin key mode; place on all hosts
cephadm: distribute client.admin keyring+conf to label:_admin on bootstrap
doc/cephadm: document the default 'admin' label
mgr/cephadm: 'ceph orch client-keyring ...' commands to manage keyring files
mgr/cephadm: reimplement ceph.conf pushing
mgr/cephadm: use _write_remote_file for ceph.conf
mgr/cephadm: _write_remote_file helper
mgr/cephadm: add placementspec for which hosts get ceph.conf
Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Adam King <adking@redhat.com>
This PR adds a note to the cephadm installation
guide that informs users that only podman version
2.0.0 and higher work with Ceph, with the
exception of podman version 2.2.1, which does
not work with Ceph. There is also a note regarding
kubic stable 3.0.1 working, but only with newer
kernels.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Teach cephadm to manage keyring files on cluster hosts. These keys must
already exist in the mon auth database--cephadm does not create them if
they don't exist (and will issue warnings to the log if they do not).
A ceph.conf is pushed implicitly along with the keyring file.
Each keyring added will be pushed to the hosts described by the placement
spec with the appropriate ownership and mode. If the ownership, mode, or
path are modified, the files are rewritten or removed as need.
If the client-keyring entry is removed, the keyring files are removed.
Signed-off-by: Sage Weil <sage@newdream.net>
This tiny PR fixes an issue that I thought
I had squashed into PR#40914: a missing
word, "device", which was caught by Josh
Durgin during review.
Alas. I had not then caught it.
Here then it is, corrected at last.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
Add a config option to control which hosts (by default, *) get a
ceph.conf (if the bool manage_etc_ceph_ceph_conf option is enabled).
We don't modify the existing option because changing a type makes for a
messy migration: we have to sort out which section the config option is
in to change it. Also, a simple on/off which is more friendly than
specifying "*" to enable something.
Signed-off-by: Sage Weil <sage@newdream.net>
* refs/pull/40938/head:
mgr/cephadm: less noise about osd specs
mgr/cephadm: kick serve loop when adding/removing labels
mgr/cephadm: do not place osds on _no_schedule hosts
doc/cephadm: document _no_schedule label
mgr/cephadm: fix 'orch ls' count to reflect schedulable hosts
mgr/cephadm: do not schedule on _no_schedule hosts
Reviewed-by: Juan Miguel Olmo <jolmomar@redhat.com>
Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Michael Fritch <mfritch@suse.com>
This PR improves the readbility and elegance of
the "Advanced OSD Service Specifications" section
of the OSD chapter of the cephadm guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
* refs/pull/40712/head:
doc/cephadm: wrong command for single daemon events
Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Juan Miguel Olmo <jolmomar@redhat.com>
This commit improves the wording of the "Declarative
State" section of the "OSD Service" chapter of the
Cephadm Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
It may be that the virtual IP we want to use is not in the same network
as any existing IPs on the host. In that case, allow the spec to specify
a list of networks to match against existing IPs so that a match will
identify an ethernet interface to use.
Signed-off-by: Sage Weil <sage@newdream.net>
This fixes a small typo in the cephadm/iscsi documentation
s/iSCSI Ganesha gateway/iSCSI gateway/
Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
* refs/pull/40500/head:
doc/cephadm: remove keepalived_user from haproxy docs
Reviewed-by: Juan Miguel Olmo <jolmomar@redhat.com>
Reviewed-by: Adam King <adking@redhat.com>
This commit rewrites the entire "Remove an OSD"
section of the "OSD Service" chapter of the
cephadm book.
I got carried away and didn't break this one into
four smaller PRs, and I'm sorry in advance to
whomever ends up reviewing this. I'll break "Advanced
OSD Service Specifications", the next section in the
queue, into multiple sections.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This rewrites the "dry run" section of the "OSD Service"
chapter of the Cephdam documentation. This commit makes
minor changes that reduce the cognitive load of the
reader.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
This reorganizes the section "Deploy OSDs"
in the "OSD Service" chapter of the Cephadm
Guide. Two new sections, "Listing Storage
Devices" and "Creating New OSDs" gather
information under headings in a sensible way,
making the information more accessible to someone
skimming this Guide.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
