Commit Graph

417 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
Kefu Chai
6fb9540bd6 doc: update docs to remove references of ubuntu 14.04
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-12-04 15:42:56 +08:00
rune
93f9007da3 doc: add pre-requisite to enable CephFS snapshot
Signed-off-by: Jian Su <sujian@umcloud.com>
2017-11-28 16:25:17 +08:00
Gregory Farnum
ed5f565baa
Merge pull request #18710 from com6056/wip-doc-fix-cephfs-snap-dir
doc: Fixes the name of the CephFS snapshot directory.

Reviewed-by: Greg Farnum <gfarnum@redhat.com>
2017-11-20 16:46:44 -08: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
Jordan Rodgers
e2ae48dcde doc: Fixes the name of the CephFS snapshot directory.
Signed-off-by: Jordan Rodgers <com6056@gmail.com>
2017-11-03 13:09:30 -04: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
Jason Dillaman
ecec3217b6 Merge pull request #17134 from PCzhangPC/metaexin
rbd: export/import image-meta when we export/import an image

Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2017-10-16 21:00:08 -04:00
Jos Collin
ded96388da doc: Fix URL in Licensing
Fixed the unnecessary URL format in the text. Modify the URL formatting to highlight only the file name seems better.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2017-09-30 07:40:01 +05:30
Jos Collin
41c4b3dbbe doc: Fix typo and URL in Submitting patches
Dropped the repeated 'the' in the paragraph and Fixed the unnecessary URL format in the text.

Signed-off-by: Jos Collin <jcollin@redhat.com>
2017-09-29 20:20:33 +05:30
PCzhangPC
2f0b233a31 rbd:export/import image-meta when we export/import an image
when we do exporting/importing an image, we should export or import the image-meta of this image at the same time

Signed-off-by: PCzhangPC <pengcheng.zhang@easystack.cn>
2017-09-29 13:30:01 +08:00
Kefu Chai
b35bf318af doc: update ceph-disk with a state transition diagram
also, quote the variabls in source code with double quote.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-09-11 20:44:35 +08:00
Sage Weil
b5c2782615 src/script/build-integration-branch
Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-30 22:53:10 -04:00
Kefu Chai
4f4af6262a doc/dev/perf: add doc on disabling -fomit-frame-pointer
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-08-30 12:14:37 +08:00
Kefu Chai
4fba9c0ee2 Merge pull request #17019 from dachary/wip-doc-ceph-disk
doc: document ceph-disk prepare class hierarchy

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-08-28 19:17:33 +08:00
Loic Dachary
ed89f8cb0e doc: document ceph-disk prepare class hierarchy
Signed-off-by: Loic Dachary <loic@dachary.org>
2017-08-25 15:48:59 +03:00
Alfredo Deza
87f7ff4783 doc/dev include ceph-volume devel docs
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:44:54 -04:00
Alfredo Deza
b8811fc06d doc/ceph-volume create the systemd lvm reference
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:44:53 -04:00
Alfredo Deza
801725b924 doc/dev/ceph-volume add a toctree for the dev docs
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:08:08 -04:00
Alfredo Deza
ba811d2d90 doc/dev/ceph-volume add systemd reference
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:08:08 -04:00
Alfredo Deza
e0b7bd8f82 doc/dev/ceph-volume add plugin interface
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:08:07 -04:00
Alfredo Deza
b6d3983177 doc/dev/ceph-volume add the internal lvm api
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:08:07 -04:00
Alfredo Deza
a7fed6c213 doc: update repo-access to point to ceph-ci.git
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 10:54:32 -04:00
Alfredo Deza
640e080f22 doc/logging fix unexpected indent in paragraph
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:19:59 -04:00
Sage Weil
dab64cb7c5 Merge pull request #16910 from liewegas/wip-iana
doc/dev/iana: document our official IANA numbers
2017-08-08 12:46:21 -05:00
Sage Weil
f19214687f doc/dev/index: update rados lead
Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-08 13:37:42 -04:00
Sage Weil
dd84361c1e doc/dev/iana: document our official IANA numbers
PEN 50495
port 3300

Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-08 13:36:39 -04:00
Patrick Donnelly
66756c4f65
Merge PR #16292 into master
* refs/remotes/upstream/pull/16292/head:
	qa: use new hex rep of inode
	qa: fix whitelist error message
	mds: refine "Scrub error" cluster log message
	mds: polish clog messages
	doc: developer logging guidance

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2017-08-03 13:55:21 -07:00
John Spray
ea37145131 doc: developer logging guidance
Signed-off-by: John Spray <john.spray@redhat.com>
2017-08-01 15:06:41 +01:00
Kefu Chai
4cac1e40b1 Merge pull request #16652 from shangzhong/wip-update-quick-guide
doc: update the pool names created by vstart.sh by default

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-08-01 21:50:52 +08:00
Zhu Shangzhong
c91bb519e8 doc: change the default filesystem/pool names
- s/cephfs_data/cephfs_data_a
- s/cephfs_metadata/cephfs_metadata_a
- s#./rados df#bin/rados df
- update the 'bin/rados df' output
- remove the rbd pool, it isn't created by default anymore.

Signed-off-by: Zhu Shangzhong <zhu.shangzhong@zte.com.cn>
2017-08-01 20:40:58 +08:00
Jos Collin
eb1f53782a doc: fix typo in config.rst
Fixed the typo introduced by PR#16681

Signed-off-by: Jos Collin <jcollin@redhat.com>
2017-08-01 14:16:14 +05:30
Song Shun
2556605b79 doc: fix sevral typos
fix sevral typos

Signed-off-by: Song Shun <song.shun3@zte.com.cn>
2017-07-31 22:10:51 +08:00
Sage Weil
625859b42b doc/dev/config: some guidance around defining config options
Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-27 22:30:12 -04:00
Kefu Chai
be7d9d92ad Merge pull request #16394 from jcsp/wip-pr-docs
doc: add doc requirements on PR submitters

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Greg Farnum <gfarnum@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-07-25 15:28:26 +08:00
Kefu Chai
60d0c67886 Merge pull request #16362 from tchaikov/wip-ceph-disk
ceph-disk: use '-' for feeding ceph cli with stdin

Reviewed-by: Loic Dachary <ldachary@redhat.com>
Reviewed-by: Alfredo Deza <adeza@redhat.com>
2017-07-25 08:00:56 +08:00
Sage Weil
26051db716 Merge pull request #16399 from batrick/cephfs-ptl-change
AUTHORS: update CephFS PTL

Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: John Spray <john.spray@redhat.com>
2017-07-24 12:48:02 -05:00
Patrick Donnelly
f5bd6f09b5
doc: update CephFS PTL
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2017-07-24 10:43:45 -07:00
Kefu Chai
05da6d34be doc/dev/ceph-disk: add docs for ceph-disk
we might want to move part of it to user-facing docs.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-25 00:21:05 +08:00
Dan Mick
47726f8b66 doc/mgr: add Prometheus plugin docs
Signed-off-by: Dan Mick <dan.mick@redhat.com>
2017-07-20 20:25:08 -07:00
John Spray
b0b931858d doc: add doc requirements on PR submitters
Signed-off-by: John Spray <john.spray@redhat.com>
2017-07-19 20:00:10 -04:00
Nathan Cutler
b08b485ce8 Merge pull request #16079 from smithfarm/wip-doc-make-check
doc: dev: add notes on PR make check validation test

Reviewed-by: Loic Dachary <ldachary@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-07-09 13:14:42 +02:00
Sage Weil
8b21c6b6fd Merge pull request #16027 from liewegas/wip-crush-rule-class
mon,crush: create crush rules using device classes for replicated and ec pools via cli

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2017-07-08 21:34:13 -05: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
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
Nathan Cutler
5ec6c7c2c3 doc: dev: unit tests are not linked against tcmalloc
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-07-04 12:25:33 +02:00
Nathan Cutler
94d6012cb7 doc: dev: change "make check" into an internal Xref
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-07-03 15:44:30 +02:00
Nathan Cutler
7f14c6a238 doc: dev: add notes on PR make check test
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-07-03 15:44:27 +02:00
Sage Weil
0346998b5a doc: recommend against btrfs
Signed-off-by: Sage Weil <sage@redhat.com>
2017-06-30 13:54:18 -04:00
Sage Weil
b6a5b946f8 Merge pull request #15180 from theanalyst/doc/rgw-dev-s3tests
doc: dev improve the s3tests doc to reflect current scripts
2017-06-09 08:32:10 -05:00