Commit Graph

7308 Commits

Author SHA1 Message Date
Kefu Chai
d3cf17da15
Merge pull request #38090 from anthonyeleven/anthonyeleven/docs-47339
doc/releases: correct spelling

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-22 14:03:09 +08:00
Anthony D'Atri
b3cede6dbc doc/releases: correct spelling
Fixes: https://tracker.ceph.com/issues/47339
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-21 18:32:40 -08:00
Sebastian Wagner
d9879eb001
Merge pull request #37576 from p-se/doc-cephadm-custom-monitoring-templates
mgr/cephadm: document setting custom monitoring templates for configuration files

Reviewed-by: Kiefer Chang <kiefer.chang@suse.com>
Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Michael Fritch <mfritch@suse.com>
2020-11-20 16:15:39 +01:00
Sebastian Wagner
66f647b00b
Merge pull request #37696 from p-se/cephadm-monitoring-grafana-tls
doc/cepham: instructions for custom Grafana TLS certs

Reviewed-by: Alexandra Settle <asettle@suse.com>
Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Michael Fritch <mfritch@suse.com>
2020-11-20 15:42:28 +01:00
Kefu Chai
4d4983dc0a doc/script/gen_state_diagram: wrap lines which is over 80 chars
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 21:05:14 +08:00
Kefu Chai
ac1f3fa4b3 doc/script/gen_state_diagram: use itertools.cycle() for cycling in colors
for better readability

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 21:05:14 +08:00
Kefu Chai
3c0bc49875 doc: pass graphviz options in conf.py
easier to maintain the options of sphinx extensions in a single place.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
cc5864234e doc: generate peering graph in conf.py
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
a14b2b42be doc/script/gen_state_diagram: add "output" parameter to emit_dot()
this allows us to reuse this python script as a module.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
e9af59a50e doc/script/gen_state_diagram: only run if called as a script
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
ba99f56f52
Merge pull request #38146 from ljishen/peering_state_model
doc: increase visibility of the peering state diagram

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-19 16:09:14 +08:00
Jianshen Liu
909bfa34e6 doc: increase visibility of the peering state diagram
Signed-off-by: Jianshen Liu <jliu120@ucsc.edu>
2020-11-18 21:26:54 -07:00
Neha Ojha
a24f40bb8d
Merge pull request #38172 from zdover23/wip-doc-dev-unit-test-list-update
doc/dev: update list in unit test section

Reviewed-By: Nathan Cutler <ncutler@suse.com>
2020-11-18 15:50:01 -08:00
Neha Ojha
becb9b6db2
Merge pull request #38133 from zdover23/wip-doc-dev-unit-tests-1-of-7
doc/dev: update unit test 1 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-18 12:19:42 -08:00
Neha Ojha
42c599bd1f
Merge pull request #38134 from zdover23/wip-doc-dev-unit-tests-2-of-7
doc/dev: update unit tests 2 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-18 12:18:55 -08:00
Patrick Donnelly
50a2c7ead0
Merge PR #38126 into master
* refs/pull/38126/head:
	doc/cephfs/health-messages: add dot between mds identifier and it's name

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-11-18 12:15:22 -08:00
pcuzner
9ba45ee661
Merge pull request #37607 from pcuzner/docs-cephadm-host-maintenance
doc/dev/cephadm: Doc defining the design for host maintenance
2020-11-19 09:03:19 +13:00
Zac Dover
491a2fa8dc doc/dev: update list in unit test section
This commit removes an unwanted extra
nested list layer from a list.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-19 03:35:19 +10:00
Zac Dover
0dd7b26fb3 doc/dev: update unit test declaration
This commit updates the text in the "How
Unit Tests Are Declared" section of
tests-unit-tests.rst. This commit breaks
long sentences into shorter sentences and
breaks a sentence into a bulleted list that
might reduce the reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-19 01:13:37 +10:00
Zac Dover
19d34666a8 doc/dev: update unit test 1 of 7
This commit updates the language at the beginning
of the Unit Test section of the developer guide.
The language in this edit is more grammatical than
it used to be, and should now reduce the reader's
cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-18 18:25:05 +10:00
Zac Dover
7425e96c86 doc/dev: update unit tests 2 of 7
This commit updates the "What does 'make
check' mean" section of the "Unit Tests" chapter
of the Developer Guide. It makes the wording a
bit less editorial and attempts to reduce the
reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-18 18:13:35 +10:00
haoyixing
fb0a650ba2 doc/cephfs/health-messages: add dot between mds identifier and it's name
After pr #37608, ceph health detail output message
have changed when mds has slow requests. So update
doc according to output.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2020-11-18 09:42:48 +08:00
Michael Fritch
35d6fde51f
Merge pull request #37901 from votdev/issue_48041_device_light
mgr/cephadm: Allow customizing mgr/cephadm/lsmcli_blink_lights_cmd per host

Reviewed-by: Michael Fritch <mfritch@suse.com>
Reviewed-by: Sebastian Wagner <swagner@suse.com>
2020-11-16 19:21:06 -07:00
Patrick Seidensal
7f5b1d8bfe doc/cephadm: document setting custom monitoring templates
Fixes: https://tracker.ceph.com/issues/47651

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-11-16 11:31:24 +01:00
Kefu Chai
64972101f7
Merge pull request #38103 from ybwang0211/link-to-balancer
doc: Fix the broken link to the "balancer"

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-16 18:30:53 +08:00
Patrick Seidensal
344c0a69b3 doc/cepham: instructions for custom Grafana TLS certs
Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-11-16 11:24:26 +01:00
ybwang0211
1144ebdf53 doc:Fix the web link that jumps to the "balancer"
In "https://docs.ceph.com/en/latest/rados/operations/upmap/#upmap", the link to "balancer" was not set correctly, so we fixed it.

Signed-off-by: wangyingbin <wangyingbin@inspur.com>
2020-11-16 16:59:24 +08:00
Kefu Chai
2a32514706 doc/rados/operation: add link to scrub_max_interval
add the reference to the per-pool setting when explaing
PG_NOT_DEEP_SCRUBBED.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-15 11:50:12 +08:00
Brad Hubbard
1464a7d588
Merge pull request #38073 from badone/wip-use-right-tunable-for-pg-scrub-doc
doc: Use correct tunable for PG_NOT_SCRUBBED

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-14 14:49:27 +10:00
Neha Ojha
a0e1a8f173
Merge pull request #38057 from zdover23/wip-doc-dev-guide-essentials-source-clean-update
doc/dev: update essentials.rst

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-13 09:42:20 -08:00
Neha Ojha
a0e7802863
Merge pull request #38036 from zdover23/wip-doc-dev-guide-basic-workflow-make-check-nov-2020
doc/dev: improve make check text

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-13 09:38:28 -08:00
Kefu Chai
3b23d14e3c
Merge pull request #38055 from tchaikov/wip-doc-conf
doc/rados/configuration: document option types

Reviewed-by: Brad Hubbard <bhubbard@redhat.com>
2020-11-13 16:58:48 +08:00
Zac Dover
ef0a9db668 doc/dev: update essentials.rst
This commit changes the noun "backup" to the
intended verb "back up" (this is one of my
technical documentation pet peeves and I couldn't
resist), and it also removes the verb "to nuke"
and replaces it with something less poetic but
more likely to be discoverable in a dictionary by
someone whose English is weak. It also adds a
missing colon.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-13 17:56:05 +10:00
Kefu Chai
520ddd6894 doc/rados/configuration: document option types
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-13 14:17:21 +08:00
Kefu Chai
24fd33d7eb doc/rados: remove superfluous "::"
this change addresses a regression introduced by
0f2489406a

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-13 14:17:21 +08:00
Brad Hubbard
61930e6428 doc: Use correct tunable for PG_NOT_SCRUBBED
Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2020-11-13 14:33:24 +10:00
Zac Dover
85a251f029 doc/dev: improve make check text
This commit fixes the references to the
"make check" section in the "notes on
pr make check test" section and improves
the wording of that section so that it
reads a bit more clearly.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-13 13:36:07 +10:00
Josh Durgin
63d0ce3f56
Merge pull request #38023 from zdover23/wip-doc-dev-guide-essentials-nov-2020
doc/dev: update essentials.rst nov 2020

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2020-11-12 17:25:43 -08:00
Zac Dover
efb9e82b94 doc/dev: update essentials.rst
This commit improves the grammar and structure
of essentials.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-13 09:41:41 +10:00
David Zafman
9e469f5b31 doc: Apply suggestions from code review
Co-authored-by: Neha Ojha <nehaojha88@gmail.com>
Co-authored-by: Josh Durgin <jdurgin@redhat.com>

Signed-off-by: David Zafman <dzafman@redhat.com>
2020-11-11 15:31:26 -08:00
David Zafman
93373746f5 osd test: Delay reporting until mon_warn_older_version_delay has passed
Move release notes description to 16.0.0 and update
Update documentation

Signed-off-by: David Zafman <dzafman@redhat.com>
2020-11-11 15:10:11 -08:00
David Zafman
18101c324a doc: Document health check DAEMON_OLD_VERSION
Signed-off-by: David Zafman <dzafman@redhat.com>
2020-11-11 15:10:11 -08:00
David Zafman
ada78607e6
Merge pull request #37941 from dzafman/wip-48077
Allowing scrub configs begin_day/end_day to include 7 and begin_hour/end_hour to include 24 is confusing

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-09 15:12:34 -08:00
David Zafman
d3cc647583 osd: Eliminate day of weeek 7 and hour 24
Add test case for permitted hours to make sure scrub doesn't start
Remove permitted hours in extended sleep test

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

Signed-off-by: David Zafman <dzafman@redhat.com>
2020-11-09 22:47:00 +00:00
Zac Dover
f17b48f72e doc/rados: ceph df output update
This commit updates the "ceph df" output
so that it is current as of October 2020.
-Add correctly formatted `ceph df` output.
-Add explanation of "DIRTY" column.
-(DATA) remains to be defined (1 instance)
-(OMAP) remains to be defined (1 instance)
-USED remains to be defined (1 instance)
-Update prompts in "Checking OSD Status"

Fixes: https://tracker.ceph.com/issues/47523
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-10 08:01:02 +10:00
Lenz Grimmer
610a2426a9
Merge pull request #37641 from henyxia/dev/henyxia/add-mgr-dashboard-prom-ssl-verify
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Patrick Seidensal <pnawracay@suse.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-11-09 15:07:57 +01:00
Gregory Farnum
703524119a
Merge pull request #37915 from gregsfortytwo/wip-stretch-fixes
Fix several stretch mode issues

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-09 03:52:07 -08:00
Jan Fajerski
47842715ba Merge PR #37741 into master
* refs/pull/37741/head:
	ceph-volume: remove mention of dmcache from docs and help text

Reviewed-by: Jan Fajerski <jfajerski@suse.com>
Reviewed-by: Rishabh Dave <ridave@redhat.com>
2020-11-09 11:33:18 +01:00
Patrick Donnelly
4052b11f18
Merge PR #36998 into master
* refs/pull/36998/head:
	doc/mgr/volumes: Document authorize/deauthorize cli commands
	qa/tasks/cephfs: test `fs subvolume authorize/deauthorize`
	mgr/volumes: Allow/deny auth IDs access to FS subvolumes
	mon/MonCap: allow 'profile mgr' to create/update/del auth IDs

Reviewed-by: Ramana Raja <rraja@redhat.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-11-06 20:51:54 -08:00
Greg Farnum
704dbe9ec2 doc: update stretch mode doc to not be a lie
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2020-11-06 06:39:33 +00:00