Commit Graph

68 Commits

Author SHA1 Message Date
CodingSpiderFox
d80f158954 doc: Introduce the concept of a pool before talking about it.
Signed-off-by: CodingSpiderFox <codingspiderfox@gmail.com>
2020-05-21 22:34:31 +02:00
Brad Hubbard
3b6341239f doc/rados/operations: Detail for min_size on EC pools
Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2020-02-26 11:58:21 +10:00
Brad Hubbard
2e5e5db0a1 doc/rados/operations: min_size is applicable to EC
min_size is *not* replicated pool specific.

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2020-02-26 10:33:22 +10:00
Sage Weil
b4e06c5b31 doc/rados/operations: adjust docs a bit
Signed-off-by: Sage Weil <sage@redhat.com>
2020-02-06 07:09:29 -06:00
Sage Weil
7b988e9fe1 doc: remove all pg_num arguments to 'osd pool create'
Also, update the dicussion about pg_num and pool creation, with a reference
to the autoscaler.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-09-22 16:58:33 -05:00
Kefu Chai
3ed3de6c96 doc/rados/operations: crush_rule is a name
like
```
ceph osd pool set <pool-name> crush_rule <rule-name>
```
where `<rule-name>` is a string instead of a number.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2019-07-27 21:35:39 +08:00
David Zafman
444aa9f9fe osd, mon: New pool recovery priority range -10 to 10
Use OSD_POOL_PRIORITY_MAX and OSD_POOL_PRIORITY_MIN constants
Scale legacy priorities if exceeds maximum

Signed-off-by: David Zafman <dzafman@redhat.com>
2019-04-25 13:53:27 -07:00
David Zafman
f7bec341da common, doc: Improve docs osd_recovery_priority, osd_recovery_op_priority and related
Add option desciptions for osd_recovery_priority and osd_recovery_op_priority

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

Signed-off-by: David Zafman <dzafman@redhat.com>
2019-03-01 13:55:35 -08:00
Thore Kruess
3b636ff69f doc: Add mention of ceph osd pool stats
Neither  "Show Pool Statistics" nor the suggested options from `ceph osd pool` mention this command.

Signed-off-by: Thore Kruess <thore@kruess.xyz>
2018-12-19 04:54:44 +01:00
James McClune
321f390010
doc: fixed links in Pools section
Fixed broken links (404 error) in the Pools section of Ceph Storage Cluster.

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-08-05 13:49:03 -04:00
Nathan Cutler
73124c8df8 doc: cleanup: prune Argonaut-specific verbiage
Also drop all release-specific upgrading instructions (they only go up to
Firefly, anyway - none of the current releases are covered).

Note that all of this verbiage I am removing here can still be accessed
on docs.ceph.com via e.g. http://docs.ceph.com/docs/firefly/

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-07-17 12:20:01 +02:00
Mykola Golub
ce561ea204 mon: add 'ceph osd pool get erasure allow_ec_overwrites' command
Fixes: https://tracker.ceph.com/issues/23487
Signed-off-by: Mykola Golub <mgolub@suse.com>
2018-03-28 21:21:04 +03:00
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
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
songweibin
9ccb710aa4 doc,os,osdc: drop and modify some comments
Signed-off-by: songweibin <song.weibin@zte.com.cn>
2017-09-14 21:27:38 +08:00
Alfredo Deza
aa90ea25cf doc/rados/operations add a ref label to pool application
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:20:01 -04:00
Alfredo Deza
e925b9f899 doc/rados/operations add newline after definition
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:19:59 -04: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
Sage Weil
3de9f22ce0 Merge pull request #16423 from liewegas/wip-ls
mon: '* list' -> '* ls'

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-07-20 10:43:34 -05:00
Jason Dillaman
878d0b0c3f doc: document pool tags in rados pool operations doc
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-07-19 13:13:01 -04:00
Sage Weil
572a942f8f mon: 'auth list' -> 'auth ls'
Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-19 12:33:14 -04:00
Sage Weil
dc7a2aaf7a erasure-code: ruleset-* -> crush-*
1) ruleset is an obsolete term, and
2) crush-{rule,failure-domain,...} is more descriptive.

Note that we are changing the names of the erasure code profile keys
from ruleset-* to crush-*.  We will update this on upgrade when the
luminous flag is set, but that means that during mon upgrade you cannot
create EC pools that use these fields.

When the upgrade completes (users sets require_osd_release = luminous)
existing ec profiles are updated automatically.

Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-06 15:01:03 -04:00
Josh Durgin
bad606605a doc: update ec docs for overwrite support
Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2017-04-19 17:45:43 -07:00
Sven Seeberg
804134a2bf renamed hit_set_grade_search_last_n to hit_set_search_last_n
Signed-off-by: Sven Seeberg <sseebergelverfeldt@suse.com>
2017-03-24 10:25:06 +01:00
Sage Weil
63bb2b7d45 doc: remove crash_replay_interval mentions
Signed-off-by: Sage Weil <sage@redhat.com>
2016-12-29 10:30:08 -05:00
Wido den Hollander
95ed04a536
doc: Add documentation about mon_allow_pool_delete before pool remove
Tell users they need to set this to true before Monitors will allow
pools to be removed.

Also update the Pending Release Notes so that users can find this change
there.

This was changed with commit 5d7f4ea

Signed-off-by: Wido den Hollander <wido@42on.com>
2016-11-23 12:18:21 +01:00
Barbora Ančincová
a9c0e7b789 Removed reference about pool ownership based on BZ#1368528
Signed-off-by: Bara Ancincova <bara@redhat.com>

https://bugzilla.redhat.com/show_bug.cgi?id=1368528

From email conversation with Sage and Sam:

I don't think it is used at all, and at a minimum it is
untested and undocumented and the implementation is alomst
certainly incomplete.

I definitely support removing any trace of it from the docs.

sage
2016-09-13 17:38:25 +05:30
Ken Dreyer
3c43185002 doc: more details for pool deletion
Prior to this change, the documention instructed administrators to
delete rulesets and users, but did not go into details regarding how to
do that.

Add example commands that admins may use to search for rulesets and
users that might reference the to-be-deleted pool.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-07-08 07:42:29 -06:00
Etienne Menguy
fa32bd3cb9 adding pg_num to pools documentation
Signed-off-by: Etienne Menguy <etienne.menguy@corp.ovh.com>
2016-04-13 13:25:30 +02:00
xiexingguo
ca50f42359 doc: batch small fixes, including typo, syntax etc.
Signed-off-by: xiexingguo <xie.xingguo@zte.com.cn>
2016-02-26 23:25:02 +08:00
Drunkard Zhang
593c1249d2 doc: rst style fix for pools document
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2015-12-07 10:45:03 +08:00
Mykola Golub
e6dcf1419a osd: store per pool scrub intervals in pool options
ceph osd pool set $POOL scrub_min_interval N
  ceph osd pool set $POOL scrub_max_interval N
  ceph osd pool set $POOL deep_scrub_interval N

If N > 0, this value is used for the pool instead of
the corresponding global parameter from the config
(osd_scrub_min_interval, osd_scrub_max_interval or
osd_deep_scrub_interval).

Fixes: #13077
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-11-27 13:35:51 +02:00
MingXin Liu
738d64c7e4 Doc: add temperature related stuff in documents and test scripts
Signed-off-by: MingXin Liu <mingxinliu@ubuntukylin.com>
Reviewed-by: Li Wang <liwang@ubuntukylin.com>
2015-11-11 15:22:33 +08:00
Guang Yang
6b1e4a69c5 cleanup: make the pool setting GET decription point to SET description
Signed-off-by: Guang Yang yguang@yahoo-inc.com
2015-09-30 00:48:12 +00:00
Guang Yang
ef59f7c737 doc: update doc for with new pool settings
Signed-off-by: Guang Yang yguang@yahoo-inc.com
2015-09-30 00:48:01 +00:00
Sage Weil
216eef53e9 Revert "osd: new pool settings: scrub intervals"
This reverts commit 30810da4b5.

After some discussion we have decided it is better to build a generic
dictionary in pg_pool_t to store infrequently used per-pool properties.

Signed-off-by: Sage Weil <sage@redhat.com>
2015-09-25 14:01:19 -04:00
Mykola Golub
30810da4b5 osd: new pool settings: scrub intervals
ceph osd pool set $POOL scrub_min_interval N
 ceph osd pool set $POOL scrub_max_interval N
 ceph osd pool set $POOL deep_scrub_interval N

If N > 0, this value is used for the pool instead of
the corresponding global parameter from the config
(osd_scrub_min_interval, osd_scrub_max_interval or
osd_deep_scrub_interval).

Fixes: #13077
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-09-21 09:08:16 +03:00
Mykola Golub
48db7b16d4 osd: new pool flags: noscrub, nodeep-scrub
This allows to disable periodic scrub on per pool basis.

Fixes: #13076
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-09-21 09:08:16 +03:00
Mykola Golub
10235e3ff3 osd: refactor setting write_fadvise_dontneed pool flag
Handle together with other flags.

Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-09-21 09:08:16 +03:00
John Spray
865708120f doc: remove references to default data/metadata pools
These haven't existed since 0.84 -- the cephfs documentation
was updated at the time, but there were also references in the
rados documentation.

Signed-off-by: John Spray <john.spray@redhat.com>
2015-09-11 16:46:52 +01:00
Li Wang
c1bd02c978 Merge pull request #4792 from kylinstorage/wip-writeback-throttling-for-cache-tiering
Wip writeback throttling for cache tiering

This patch is to do write back throttling for cache tiering, which is similar to what the Linux kernel does for  page cache write back.  A paramter 'cache_target_dirty_high_ratio'  (default 0.6) is introduced as the high speed flushing threshold, while leave the 'cache_target_dirty_ratio' (default 0.4) to represent the low speed  threshold. The flush speed is controlled by limiting the parallelism of flushing. The maximum parallelism under low speed is half of the parallelism under high speed. If there is at least one PG such that the dirty ratio beyond the high threshold, full speed mode is entered; If there is no PG such that dirty ratio beyond the low threshold, idle mode is entered; In other cases, slow speed mode is entered.

Signed-off-by: Mingxin Liu <mingxinliu@ubuntukylin.com>
Reviewed-by: Li Wang <liwang@ubuntukylin.com>
Suggested-by: Nick Fisk <nick@fisk.me.uk>
Tested-by: Kefu Chai <kchai@redhat.com>
2015-06-23 15:15:47 +08:00
Abhishek Lekshmanan
81eee9bd8c doc: explain about pgp num
Explain the significance of pgp num & how it differs from pg num.

Fixes: #10035
Reported-by: Loic Dachary <loic@dachary.org>
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
2015-06-16 22:59:22 +05:30
liumingxin
7aba9476e6 Doc: add write back throttling stuff in document and test scripts
Signed-off-by: Mingxin Liu <mingxinliu@ubuntukylin.com>
Reviewed-by: Li Wang <liwang@ubuntukylin.com>
Suggested-by: Nick Fisk <nick@fisk.me.uk>
2015-06-03 15:57:14 +08:00
Ilya Dryomov
eb9dbef2fe doc: fix crush-ruleset-name param description
Specified crush-ruleset-name is required to exist, implicit creation is
going to happen only if crush-ruleset-name wasn't specified on the
command line.  While at it, pool-name is very much a required param.

Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2015-05-27 15:06:37 +03:00
Andy Allan
aaabd57205 doc: fix typo
Signed-off-by: Andy Allan <github@gravitystorm.co.uk>
2015-03-09 14:41:18 +00:00
Mykola Golub
8ab3c41db7 osd: new pool safeguard flags: nodelete, nopgchange, nosizechange
* nodelete - pool can't be deleted
* nopgchange - pool's pg and pgp num can't be changed
* nosizechange - pool's size and min size can't be changed

This is intended to help some poor admin to avoid a very bad day.

Fixes: #9792 (but in a different way than it was proposed there)
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-01-19 21:50:28 +02:00
cholcombe973
a198deea5f Modifying the docs to add the Get pool commands to match the CLI.
Signed-off-by: Chris Holcombe <chris.holcombe@nebula.com>
2014-12-08 16:10:38 -08:00
Loic Dachary
c44bdb1dc9 erasure-code: document pool operations
A short introduction to the first time user of an erasure coded pool.
It includes a reminder of how it relates to cache tiering and links to
define new profiles with an example.

There was examples in the developer documentation but the operator
expects to find such a guide in the rados operations chapter.

http://tracker.ceph.com/issues/9970 Fixes: #9970

Signed-off-by: Loic Dachary <ldachary@redhat.com>
2014-11-10 14:47:56 +01:00
Loic Dachary
75f0fb2693 documentation: erasure code profile update
The plugins are made a sub-section of the erasure code profile
section. The k and m parameters are removed from erasure code profile
documentation. They were added for simplicity in the first version
because there was only one plugin. But they should really be in the
plugin documentation.

Signed-off-by: Loic Dachary <loic-201408@dachary.org>
2014-09-14 01:01:21 +02:00
John Wilkins
4ad1106eda doc: Clean up syntax.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-09-08 11:24:28 -07:00