Commit Graph

237 Commits

Author SHA1 Message Date
Nathan Cutler
aea9fa01ae doc: globally change CRUSH ruleset to CRUSH rule
Since kraken, Ceph enforces a 1:1 correspondence between CRUSH ruleset and
CRUSH rule, so effectively ruleset and rule are the same thing, although
the term "ruleset" still survives - notably in the CRUSH rule itself, where it
effectively denotes the number of the rule.

This commit updates the documentation to more faithfully reflect the current
state of the code.

Fixes: http://tracker.ceph.com/issues/20559
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-12-11 17:15:23 +01:00
Alfredo Deza
4243085d11 doc/rados update bluestore config to use ceph-volume
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-12-04 09:51:11 -05:00
Alfredo Deza
8bbcaa7070 doc/rados update auth config examples to use ceph-volume
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-12-04 09:51:11 -05:00
Katie Holly
40e20986cd doc: correcting typos in bluestore-config-ref and bluestore-migration
Signed-off-by: Katie Holly <git@meo.ws>
2017-11-26 17:47:35 +01:00
John Spray
6fc92dc981 doc: replace injectargs usage with "config set"
Cleaner and easier.  Also implicitly documents
the config set command, which hadn't been explicitly
called out in the docs before.

Signed-off-by: John Spray <john.spray@redhat.com>
2017-11-07 11:32:26 +00:00
Kefu Chai
127d25ccbd doc: fix warning reported by "build-doc linkcheck"
all the HTTP 301 (moved permanently) should be killed.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-24 15:58:48 +08:00
Kefu Chai
d940f62203 doc: fix the desc of "osd max pg per osd hard ratio"
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-18 16:07:50 +08:00
Kefu Chai
4c7df944c7 osd: add max-pg-per-osd limit
osd will refused to create new pgs, until its pg number is lower
than the max-pg-per-osd upper bound setting.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-17 23:08:40 +08:00
Yao Zongyou
7966d3cd1d doc: fix bluestore config type error.
Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
2017-10-10 11:34:26 +08:00
Kefu Chai
d28506d7ff Merge pull request #18188 from jschmid1/wip-man-osd-config-ref-syntax
doc: fixes syntax in osd-config-ref

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-10-10 01:01:00 +08:00
Joshua Schmid
a657717449
doc: fix syntax in rst
* Fix syntax in osd max object size section.

Fixes: http://tracker.ceph.com/issues/21733
Signed-off-by: Joshua Schmid <jschmid@suse.de>
2017-10-09 17:31:45 +02:00
John Spray
177f06c925 Merge pull request #17974 from jcsp/wip-doc-mgr-iptables
doc: update firewall doc to mention ceph-mgr

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-10-05 21:48:05 +01:00
Sage Weil
23b22ddba0 Merge pull request #18115 from mogeb/rados-doc
doc: add osd_max_object_size in osd configuration

Reviewed-by: Sage Weil <sage@redhat.com>
2017-10-04 13:59:58 -05:00
Mohamad Gebai
7440a32801 doc: add osd_max_object_size in osd configuration
Having osd_max_write_size in the doc without osd_max_object_size
is confusing.

Signed-off-by: Mohamad Gebai <mgebai@suse.com>
2017-10-04 12:51:02 -04:00
John Spray
3365b09c40 doc: update firewall doc to mention ceph-mgr
Signed-off-by: John Spray <john.spray@redhat.com>
2017-09-26 17:10:31 +01:00
Alfredo Deza
88f5b93219 docs/rados warn against possible data loss if min_size cannot be met
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-09-22 17:10:11 -04:00
Alfredo Deza
8af5eba024 doc/rados use min_size=2 as an example
Because `osd pool default min size = 1` is dangerous and may cause
data loss.

Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-09-22 17:10:11 -04:00
Yao Guotao
f22c502553 doc: update default value of option mon_sync_timeout
Signed-off-by: Yao Guotao <yaoguot@gmail.com>
2017-09-19 04:47:00 -04:00
Yao Zongyou
69129b73a5 doc: change boolean option default value from zero to false.
Signed-off-by: Yao Zongyou yaozongyou@vip.qq.com
2017-09-14 21:37:04 +08:00
Sage Weil
25ba984310 Merge pull request #17654 from yuyuyu101/wip-spdk-doc
doc/bluestore: add SPDK usage for bluestore

Reviewed-by: Sage Weil <sage@redhat.com>
2017-09-12 18:56:25 -05:00
yaoguotao
d121f5619b doc: update default value of parameter mon_subscribe_interval
Signed-off-by: yaoguotao <yaoguot@gmail.com>
2017-09-12 05:09:10 -04:00
Haomai Wang
537674b786 doc/bluestore: add SPDK usage for bluestore
Signed-off-by: Haomai Wang <haomai@xsky.com>
2017-09-11 20:11:29 -07:00
Xiaoxi Chen
14ffd9ba8c doc: fix typo on specify db block device
Should use block.db instead of block-db

Signed-off-by: Xiaoxi Chen <xiaoxchen@ebay.com>
2017-09-07 22:53:30 -07:00
Alfredo Deza
b2c861ed62 doc/rados/configuration comment out '...' on ini blocks
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 11:08:59 -04:00
Alfredo Deza
ae88a65880 doc/rados use func reference for rados_set_alloc_hint linking
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:19:58 -04:00
Sage Weil
f7398ddd23 doc/rados/operations/bluestore-migration: document bluestore migration process
Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-10 15:15:03 -04:00
Sage Weil
6a39c5a229 Merge pull request #16614 from neha-ojha/recovery_sleep_hybrid
osd: Check whether journal is rotational or not

Reviewed-by: Sage Weil <sage@redhat.com>
2017-08-04 13:23:38 -05:00
Sage Weil
0291118183 doc/rados/configuration/bluestore-config-ref: fix indentation
Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-03 12:24:33 -04:00
Sage Weil
f2bcd0250b doc/rados/configuration/bluestore-config-ref: devices, checksumming, cache
Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-03 09:21:18 -04:00
Sage Weil
8e166fa1b7 doc/rados/configuration: document bluestore
Initial pass here.  Not yet complete.

Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-02 15:48:41 -04:00
Neha Ojha
1ace6a6a75 doc: add documentation for osd_recovery_sleep_hybrid
Signed-off-by: Neha Ojha <nojha@redhat.com>
2017-08-02 11:58:31 -07:00
Kefu Chai
f273712e1b doc: document bluestore compression settings
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-08-02 16:42:08 +08:00
Kefu Chai
69c6402bbd Merge pull request #16727 from jcsp/wip-doc-config-hel
doc/qa: cover `config help` command

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-08-01 23:38:28 +08:00
John Spray
fbf08b6868 doc: document config help command
Signed-off-by: John Spray <john.spray@redhat.com>
2017-08-01 13:38:27 +01:00
J. Eric Ivancich
81d3def3c2 doc: Describe mClock's use within Ceph in great detail.
It seems many are initially unclear as to how the current
implementations of mclock op queues work, so we need to document it to
avoid confusion.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
2017-07-31 13:20:31 -04:00
Gregory Farnum
ba03ab92a8 Merge pull request #16629 from johnwilkins/wip-doc-remove-contractions
Remove contractions from the documentation.

Reviewed-by: Greg Farnum <gfarnum@redhat.com>
2017-07-27 10:49:38 -07:00
John Wilkins
6640837da3 doc/rados: Removed contractions to improve readabilty for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:46:53 -07:00
Kefu Chai
6ee0de8556 doc: document mClock related options
* rados/configuration/osd-config-ref.rst: document mClock related
  options
* release-notes.rst: fix syntax errors. link QoS to mClock related docs.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-25 12:59:13 +08:00
Kefu Chai
41c59530c1 Merge pull request #16328 from neha-ojha/recovery_sleep_default
osd: Add recovery sleep configuration option for HDDs and SSDs

Reviewed-by: Sage Weil <sage@redhat.com>
2017-07-21 16:55:02 +08:00
Neha Ojha
70f11d2644 doc: update osd recovery sleep description
Signed-off-by: Neha Ojha <nojha@redhat.com>
2017-07-19 14:14:42 -07:00
Neha Ojha
cef6e044e7 doc: add osd recovery sleep for HDDs and SSDs
Signed-off-by: Neha Ojha <nojha@redhat.com>
2017-07-19 11:51:21 -07:00
Bassam Tabbara
c0dc20533b docs: add docs for public_bind_addr
Signed-off-by: Bassam Tabbara <bassam.tabbara@quantum.com>
2017-07-14 10:41:49 -07:00
Sage Weil
5d71220838 Merge pull request #16198 from tchaikov/wip-doc-fixes
doc: kill sphinx warnings
2017-07-07 21:39:19 -05:00
Josh Durgin
5cc892166f Merge pull request #15689 from jdurgin/wip-filestore-rand-split
os/filestore/HashIndex: randomize split threshold by a configurable amount

Reviewed-by: Sage Weil <sage@redhat.com>
2017-07-07 15:18:49 -07:00
Kefu Chai
254e07441c doc: kill sphinx warnings
* doc/release-notes.rst: escape asterisks not used for inline emphasis
    fix bad hyper links
* doc/rados/troubleshooting/troubleshooting-osd.rst: escape asterisks
    not used for inline emphasis
* doc/radosgw/index.rst: add orphan docs to toc
* doc/dev/perf_histograms.rst: indent block quote
* doc/install/manual-freebsd-deployment.rst: fix block quotes
* doc/mgr/administrator.rst: escape asterisks not used for inline emphasis
* doc/start/quick-rbd.rst: add missing hyper link target

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-07 11:50:33 +08:00
Kefu Chai
4fd72b48c4 Merge pull request #15964 from tchaikov/wip-5249
mon/MonClient: respect the priority in SRV RR

Reviewed-by: Gregory Farnum <gfarnum@redhat.com>
2017-07-05 18:48:29 +08:00
Sage Weil
0346998b5a doc: recommend against btrfs
Signed-off-by: Sage Weil <sage@redhat.com>
2017-06-30 13:54:18 -04:00
Kefu Chai
42c822dccf doc: update with "mon priority" related changes
* doc/rados/configuration/mon-lookup-dns.rst
  we now partially support RFC2782: only the targets with the lowest
  value are selected
* doc/rados/configuration/network-config-ref.rst
  update with "mon priority" option in "[mon.$id]" section

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-06-29 13:55:21 +08:00
wujian
75e56c4c5d common/config_opt: remove unused config
Signed-off-by: alex.wu <wujian3659@163.com>
2017-06-23 05:41:28 +08:00
Sage Weil
6743fb203c Merge pull request #15676 from Linbing/wip-mon-delete-unused-config
mon: delete unused config opts of mon_sync_fs_threshold

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-06-19 22:37:58 -05:00