Commit Graph

455 Commits

Author SHA1 Message Date
Mao Zhongyi
c62714b81a doc: vstart update a few options
Add missing several options in vstart and make
these options arranged in alphabetical order.

Signed-off-by: Mao Zhongyi <maozy.fnst@cn.fujitsu.com>
2018-06-11 18:44:45 +08:00
Mao Zhongyi
f7ec92df26 doc: drop the unsupported option -r from vstart
vstart no longer supports -r option after commit 8dcf8d6e,
but it is not cleaned from mstart, so drop it.

Signed-off-by: Mao Zhongyi <maozy.fnst@cn.fujitsu.com>
2018-06-11 13:34:30 +08:00
Mahati Chamarthy
b6588e4c2a doc: cleanup
cleanup format

Signed-off-by: Mahati Chamarthy <mahati.chamarthy@intel.com>
2018-06-04 17:21:18 +05:30
Sage Weil
30aaa74ea2
Merge pull request #22364 from tchaikov/wip-doc
doc: fix the links in releases/schedule.rst

Reviewed-by: Sage Weil <sage@redhat.com>
2018-06-01 08:15:29 -05:00
Kefu Chai
776329abe1 doc: fix some redirected links reported by "build-doc linkcheck"
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-06-01 17:00:06 +08:00
Kefu Chai
a6a0cf1dfc
Merge pull request #22317 from MahatiC/wip-doc-zipkin
doc: update blkin changes

Reviewed-by: Kefu Chai <kchai@redhat.com>
2018-06-01 15:22:23 +08:00
Mahati Chamarthy
08256eb94d doc: update blkin changes
Update blkin and zipkin changes to reflect current state

Signed-off-by: Mahati Chamarthy <mahati.chamarthy@intel.com>
2018-05-31 15:10:08 +05:30
Sage Weil
f866d98ce6
Merge pull request #21381 from liewegas/wip-seastore
doc/dev/seastore.rst: initial draft notes
2018-05-25 13:35:28 -05:00
Dan Mick
39b2626c7a Remove embedded 'cephd' code
Signed-off-by: Dan Mick <dan.mick@redhat.com>
2018-05-11 13:10:26 -07:00
Yan, Zheng
5643909b36 mds: update dev document of cephfs snapshot
Signed-off-by: "Yan, Zheng" <zyan@redhat.com>
Fixes: http://tracker.ceph.com/issues/23583
2018-04-27 19:08:21 +08:00
Alfredo Deza
eeff346354 doc/dev/ceph-volume add VDO tag information
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2018-04-17 14:37:02 -04:00
Sage Weil
50fad75068 doc/dev/seastore.rst: initial draft notes
Signed-off-by: Sage Weil <sage@redhat.com>
2018-04-12 10:58:58 -05:00
Sage Weil
5d2f369b27
Merge pull request #21236 from jecluis/wip-mon-auth-bootstrap
mon/AuthMonitor: create bootstrap keys on create_initial()

Reviewed-by: Sage Weil <sage@redhat.com>
2018-04-11 10:57:20 -05:00
Nathan Cutler
bdb674639d
Merge pull request #19594 from smithfarm/wip-doc-make-check
doc: expand developer documentation of unit tests

Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
2018-04-06 22:19:03 +02:00
Joao Eduardo Luis
940dd941ef
Merge pull request #19331 from jecluis/wip-mon-osdmap-prune
mon: osdmap prune

Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2018-04-06 15:22:28 +01:00
Nathan Cutler
a9ba2011f6 doc: dev: improve headings within Testing chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-04-06 14:18:37 +02:00
Joao Eduardo Luis
efeb79a9a9 doc/dev/mon: info on auth mon disk format
Signed-off-by: Joao Eduardo Luis <joao@suse.de>
2018-04-06 06:51:43 +01:00
Joao Eduardo Luis
06f3ab684f doc: add dev notes for mon's full osdmap pruning
Signed-off-by: Joao Eduardo Luis <joao@suse.de>
2018-04-06 04:18:22 +01:00
Yan, Zheng
5e79179d2b mds: PendingReleaseNotes and dev doc for open file table
Fixes: http://tracker.ceph.com/issues/23532
Signed-off-by: "Yan, Zheng" <zyan@redhat.com>
2018-04-03 17:06:07 +08:00
Kefu Chai
f710466995
Merge pull request #21077 from Ashid6/master
doc: typo fix

Reviewed-by: Alfredo Deza <adeza@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2018-03-28 19:04:29 +08:00
Ashita Dashottar
1e8d753876 doc: typo fix
Signed-off-by: Ashita Dashottar <AshitaDashottar6@gmail.com>
2018-03-28 16:15:00 +05:30
Neha Ojha
5cc9252784 doc: dev description of async recovery
Signed-off-by: Josh Durgin <jdurgin@redhat.com>
Signed-off-by: Neha Ojha <nojha@redhat.com>
2018-03-27 15:01:17 -07:00
Nathan Cutler
820dac980e
Merge pull request #20876 from smithfarm/wip-doc-license
legal: remove doc license ambiguity

Reviewed-by: Sage Weil <sage@redhat.com>
Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
Reviewed-by: Ken Dreyer <kdreyer@redhat.com>
2018-03-19 14:29:54 +01:00
Nathan Cutler
e294dd5910 legal: remove doc license ambiguity
The license applicable to the files under doc/ was originally declared (in the
top-level file COPYING) to be "Creative Commons Attribution-ShareAlike (CC
BY-SA)" by ed0653b493

This license declaration omitted a version number.

Some time later ef7418421b was merged, mentioning
CC-BY-SA-1.0 as one of the Ceph source code licenses. Although the purpose of that
commit was only to summarize the canonical license information from COPYING, it
unintentionally became the only place in the source code where the doc license
version was specified.

In March 2018, the Debian project warned that CC-BY-SA-1.0 does not meet its
criteria for inclusion in the "free" section of the Debian distribution. (For
that, at least version 3.0 must be used.)

This new commit removes the doc license ambiguity by setting it to CC-BY-SA-3.0
in all places where the license is mentioned.

The exact spelling of the license name is taken from https://spdx.org/licenses/

Fixes: http://tracker.ceph.com/issues/23336
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-03-13 18:59:02 +01:00
Abhishek Lekshmanan
e37e49b205 doc: reorganize releases
Making one file per release, and in a separate folder

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2018-03-07 23:36:11 +01:00
Sage Weil
448b346c46 doc/dev/config-key: document how we structure things in config-key
Signed-off-by: Sage Weil <sage@redhat.com>
2018-03-06 14:44:49 -06:00
John Spray
86d7f3f72c
Merge pull request #20131 from jcsp/wip-doc-encoding
doc/dev: add a brief guide to serialization

Reviewed-by: Kefu Chai <kchai@redhat.com>
2018-03-05 22:33:34 +00:00
songweibin
8f43eff6da rbd: import with option --export-format fails to protect snapshot
Fixes: http://tracker.ceph.com/issues/23038

Signed-off-by: songweibin <song.weibin@zte.com.cn>
2018-03-01 20:48:38 +08:00
Kefu Chai
1b3d19a46b
Merge pull request #20031 from tchaikov/wip-doc-macos
doc/dev/macos: add doc for building on MacOS
2018-02-19 15:21:50 +08:00
Jordan Hus
d68e84dadf doc: Fixes a spelling error and a broken hyperlink.
Signed-off-by: Jordan Hus <jordan.hus@dicecorp.com>
2018-02-14 14:23:59 -05:00
Kefu Chai
3a1357450c doc/dev/macos: add doc for building on MacOS
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-02-13 00:05:47 +08:00
John Spray
29b5611d68 doc/dev: add a brief guide to serialization
Contributors encounter this pretty soon when trying
to add any feature to Ceph, so I'd like a central place
to point them to.

Ignoring feature bits etc for this simple example.

Signed-off-by: John Spray <john.spray@redhat.com>
2018-01-26 13:03:07 +00:00
Andrew Schoen
f852f640bf
Merge pull request #20054 from ceph/wip-rm22619
ceph-volume: dmcrypt support for lvm

Reviewed-by: Andrew Schoen <aschoen@redhat.com>
2018-01-24 18:22:56 +01:00
Sage Weil
73934df3b0 doc/dev/msgr2.rst: a few notes on protocol goals
Signed-off-by: Sage Weil <sage@redhat.com>
2018-01-23 17:40:43 -06:00
Alfredo Deza
46babe80b6 doc/dev/ceph-volume update internal LVM metadata information
Includes dmcrypt information, and updated key names to reflect current
code

Signed-off-by: Alfredo Deza <adeza@redhat.com>
2018-01-23 13:32:13 -05:00
Kefu Chai
92c2dd2750 doc/dev/cxx: add C++11 ABI related doc
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-01-19 23:40:43 +08:00
Chang Liu
489ef0f2be doc: fix CFLAGS in doc/dev/cpu-profiler.rst
Signed-off-by: Chang Liu <liuchang0812@gmail.com>
2018-01-03 15:19:06 +08:00
Nathan Cutler
fd8461b021 doc: expand developer documentation of unit tests
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-12-19 22:26:29 +01: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
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