Commit Graph

390 Commits

Author SHA1 Message Date
Drunkard Zhang
bcb89fbe0d doc: hyperlink typo fix in dev/index
The doc compiler complains about this.

Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-03-02 11:04:35 +08:00
Dongsheng Yang
aa913ced12 rbd: add docs for new format of rbd export.
Signed-off-by: Dongsheng Yang <dongsheng.yang@easystack.cn>
2017-02-19 20:42:03 +08:00
Nathan Cutler
6394d2fd6c Merge pull request #13368 from smithfarm/wip-doc-dev
doc: instructions for provisioning OpenStack VMs ad hoc

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2017-02-13 12:39:59 +01:00
Nathan Cutler
63100b4f9b doc: instructions for provisioning OpenStack VMs ad hoc
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-02-11 18:57:33 +01:00
Sage Weil
46ade145a8 doc/dev/rados-client-protocol: describe some of rados protocol, including backoffs
Signed-off-by: Sage Weil <sage@redhat.com>
2017-02-10 18:55:59 -05:00
Samuel Just
6da3f9a5d2 Merge pull request #13344 from gregsfortytwo/wip-osd-discussion-docs
Wip osd discussion docs

Reviewed-by: Samuel Just <sjust@redhat.com>
2017-02-10 11:20:02 -08:00
Jan Fajerski
cc97e9d090 doc: minor change to a cloud testing paragraph
Use terminate for the instances to match the terminology used by the
horizon interface.

Signed-off-by: Jan Fajerski <jfajerski@suse.com>
2017-02-06 16:48:54 +01:00
Greg Farnum
bde8222932 doc: update osd snap trimming with a little more detail
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2017-01-25 16:09:41 -08:00
Ronak Jain
8c79959557 Doc: Fixes Python Swift client commands
Fixes: http://tracker.ceph.com/issues/17746
Signed-off-by: Ronak Jain <ronakjain@outlook.in>
2017-01-13 16:57:45 +05:30
liuchang0812
5fa0a015fc doc/dev: update log_based_pg.rst, fix some display problem
Signed-off-by: liuchang0812 <liuchang0812@gmail.com>
2017-01-03 13:11:27 +08:00
LiuYang
273251197a doc: typo fix in s3_compliance
Signed-off-by: LiuYang <yippeetry@gmail.com>
2016-12-21 14:54:40 +08:00
Samuel Just
e2b3095554 Merge pull request #12500 from badone/wip-doc-PGPool
doc/dev/osd_internals: add pgpool.rst

Reviewed-by: Samuel Just <sjust@redhat.com>
2016-12-15 14:00:22 -08:00
Brad Hubbard
0f6be4c98c doc/dev/osd_internals: add pgpool.rst
Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2016-12-16 05:35:09 +10:00
Samuel Just
6f8e4b3810 src: rename ReplicatedPG to PrimaryLogPG
It's been confusing for a long time that EC pools are implemented by
ReplicatedPG.  What PG/ReplicatedPG really implement is the concept
of a PG where consistency is managed by the primary via a log.

Signed-off-by: Samuel Just <sjust@redhat.com>
2016-12-14 10:18:27 -08:00
Casey Bodley
2f3e75e8b8 Merge pull request #12329 from ktdreyer/wip-doc-spelling
doc: fix grammar/spelling in RGW sections

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
2016-12-06 10:52:01 -05:00
Kefu Chai
71ef0cbd8e Merge pull request #9837 from zhjwpku/typos
doc: network-protocol typos

Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-12-06 09:04:59 +08:00
Ken Dreyer
7db4def824 doc: fix spelling in RGW s3 compliance
mentionned -> mentioned

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-12-05 11:59:13 -07:00
xie xingguo
d9b8ebc84a doc/dev/perf: fix dittography
Signed-off-by: xie xingguo <xie.xingguo@zte.com.cn>
2016-12-05 19:10:08 +08:00
Sage Weil
f5a15f0474 doc/dev/perf: a few notes on perf and flame graphs
Signed-off-by: Sage Weil <sage@redhat.com>
2016-11-23 17:05:37 -05:00
John Spray
b1171f8c7e src/doc: move exports.txt into doc/
Signed-off-by: John Spray <john.spray@redhat.com>
2016-11-22 23:14:15 +00:00
Samuel Just
4740fe46ec doc/dev/osd_internals: add some docs for ECBackend
Also, clean up some old ones.

Signed-off-by: Samuel Just <sjust@redhat.com>
2016-11-17 10:41:34 -08:00
Kefu Chai
4f40fca56a Merge pull request #11233 from zealoussnow/wip-0927
doc: fix start development cluster operation in index.rst

Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-10-11 23:48:21 +08:00
Jiaying Ren
ed65930270 doc: cleanup outdated radosgw description
radosgw support is on by default, as built-in Civetweb, set up Apache
is no necessary any more.

Signed-off-by: Jiaying Ren <jiaying.ren@umcloud.com>
2016-09-28 16:52:08 +08:00
Leo Zhang
5582407721 doc: drop start development cluster area in index.rst, quick_start.rst also documents this area
Signed-off-by: Leo Zhang <nguzcf@gmail.com>
2016-09-27 17:15:04 +08:00
Leo Zhang
ee1de7dc14 doc: fix start development cluster operation in index.rst
Signed-off-by: Leo Zhang <nguzcf@gmail.com>
2016-09-27 15:43:07 +08:00
Leo Zhang
9996b49265 doc: missing "make vstart" in quick_guide.rst
Signed-off-by: Leo Zhang <nguzcf@gmail.com>
2016-09-26 23:25:29 +08:00
John Spray
18ccaeaa89 doc: update vstart guide for cmake-ish paths
Signed-off-by: John Spray <john.spray@redhat.com>
2016-09-21 10:04:33 +01:00
Nathan Cutler
75e5a5d09c doc: fix singleton example in Developer Guide
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-08-23 20:53:36 +02:00
Kefu Chai
b3d9b8d975 doc: silence sphinx warnings
Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-08-09 16:39:30 +08:00
Loic Dachary
98602ae6c6 Merge pull request #10457 from SUSE/wip-15497
doc: add Backporting section to Essentials chapter

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2016-07-27 23:15:39 +02:00
Nathan Cutler
f2dc74e05a doc: add Backporting section to Essentials chapter
... and fix some broken links.

Fixes: http://tracker.ceph.com/issues/15497
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-07-27 21:41:17 +02:00
Loic Dachary
aed7de2919 Merge pull request #10414 from SUSE/wip-doc-dev
doc: add Upload logs to archive server section...

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2016-07-27 21:21:51 +02:00
Nathan Cutler
2f80519958 doc: add Upload logs to archive server section...
...to Testing in the cloud testing chapter

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-07-27 20:20:49 +02:00
John Spray
d9a0222197 Merge pull request #10436 from gregsfortytwo/wip-snapshot-doc
Add documentation about snapshots

Reviewed-by: John Spray <john.spray@redhat.com>
2016-07-27 12:44:25 +01:00
Greg Farnum
9884cd25b6 doc: describe snapshots for developers, and warn about multi-fs
Signed-off-by: Greg Farnum <gfarnum@redhat.com>
2016-07-26 06:25:55 -07:00
Nathan Cutler
e6f2d4e8fc doc: add "Prepare tenant" section to "Testing in the cloud" chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-07-23 19:24:18 +02:00
Kefu Chai
e0b94ff38d Merge pull request #10131 from badone/wip-peering-doc-fixes
doc: peering.rst, fix typo

Reviewed-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-07-15 12:15:55 +08:00
Brad Hubbard
73084b3371 doc: peering.rst, fix typo
Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2016-07-14 18:34:06 +10:00
Brad Hubbard
10de0b0d0c doc: perf_counters.rst fix trivial typo
Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2016-07-14 18:33:16 +10:00
Kefu Chai
7dedce8a6e Merge pull request #9083 from badone/wip-doc-last_epoch_started
doc/dev: Fix missing code section due to no lexer for "none"

Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-07-07 14:23:56 +08:00
Kefu Chai
8b433e13c2 Merge pull request #9394 from xiexingguo/xxg-wip-batchpgstates
mon/PGMonitor: batch filter pg states; add sanity check

Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-07-04 20:19:20 +08:00
Zhao Junwang
94d6851dbb doc: network-protocol typos
Signed-off-by: Zhao Junwang <zhjwpku@gmail.com>
2016-06-20 22:03:24 -04:00
Zhao Junwang
b302eaf451 doc:cephx_protocol
The goal of phase II is to provide C with a session key and ticekt
allowing it to communicate with S

Signed-off-by: Zhao Junwang <zhjwpku@gmail.com>
2016-06-19 18:03:43 -04:00
Sage Weil
c4d6359dbd Merge pull request #9461 from liewegas/wip-msgr2
doc: msgr2 protocol spec
2016-06-17 10:26:56 -04:00
Sage Weil
84c2aa4710 doc/dev/msgr2: TAG_COSE
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-10 17:14:46 -04:00
Sage Weil
c846f06548 doc/dev/msgr2: fix english; drop TAG_START
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-10 17:11:04 -04:00
Sage Weil
bd47272b93 doc/dev/msgr2: include stream ids
- Add stream ids to the protocol.  This will allow us to
  multiplex multiple entities over the same TCP
  connection.

- Add a frame length.  This lets us pull entire frames
  off the wire without any introspection.  This is
  helpful on the implementation side because each stream
  may have a different cipher and for performance reasons
  because we want to pull large chunks from the network
  at a time.

- Simplify to a single frame format description, with
  only one optional variation (signature or no
  signature).

Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-10 06:57:29 -04:00
Sage Weil
45766fed18 doc/dev/msgr2: drop confounder on *every* message
I don't think this is necessary.  Our signature and cipher state
includes prior messages, so as long as we have a confounded
start (a confounder in MSG_AUTH_DONE, in this case) then we are
in good shape.

Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-03 09:03:48 -04:00
xie xingguo
fbfd38c475 osd: rename "wait_backfill" to "backfill_wait"
We use "backfill_wait" everywhere except this one.

Signed-off-by: xie xingguo <xie.xingguo@zte.com.cn>
2016-06-03 17:52:52 +08:00
Sage Weil
e4d5d2d1b3 doc/dev/msgr2: document msgr2 protocol
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-02 14:02:05 -04:00
Sage Weil
f6151f7697 doc/dev/bluestore: update based on Igor's feedback
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-01 11:38:50 -04:00
Sage Weil
c71975aa4d doc/dev/bluestore: write path notes
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-01 11:38:48 -04:00
Ken Dreyer
b7b1ecb4d8 doc: John Spray is now CephFS lead
Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-05-23 15:18:10 -06:00
lafont
54ec7556bc doc: update the "building doc" part
* In the doc, the explicit and outdated list of required
  dependencies is removed. Now, launching `./admin/build-doc`
  is suggested because the script gives the missing dependencies.
* Little refactoring of the "Debian checking dependencies" part
  in the script `./admin/build-doc`.
* In the suggested "apt-get" command to install dependencies, the
  option `-o APT::Install-Recommends=true` is added just in case.

Signed-off-by: François Lafont <francois.lafont@ac-versailles.fr>
2016-05-18 16:23:08 +02:00
Brad Hubbard
ef8025d0de doc/dev: Fix missing code section due to no lexer for "none"
Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2016-05-12 10:13:06 +10:00
Ken Dreyer
5904d89247 doc: remove references to old EOL releases
There were several references to old releases like "dumpling",
"emperor", and "firefly", throughout the docs. Remove these and update
the examples to use jewel instead.

Remove references to CentOS 6 and RHEL 6, since we only support CentOS 7
now.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-05-02 13:54:24 -06:00
Ken Dreyer
fbfb5c12bf doc: Jason Dillaman is now RBD lead
Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-05-02 10:57:53 -06:00
luokexue
4ebd6b84a8 doc: Fixes "branch -b" to "checkout -b"
Signed-off-by: luokexue <luo.kexue@zte.com.cn>
2016-04-16 11:45:41 +08:00
Sage Weil
61c4c1c99b doc: list ext4 last
Signed-off-by: Sage Weil <sage@redhat.com>
2016-04-12 08:48:25 -04:00
Sage Weil
ae97840fa1 doc/dev: remove ancient filestore-filesystem-compat doc
This describes a problem we fixed years ago.

Signed-off-by: Sage Weil <sage@redhat.com>
2016-04-12 08:39:00 -04:00
Loic Dachary
919ff4ff29 releases: what is merged where and when ?
Signed-off-by: Loic Dachary <loic@dachary.org>
2016-03-31 15:10:40 +02:00
Loic Dachary
43d63ee456 Merge pull request #8228 from SUSE/wip-15218
doc/dev: add "Deploy a cluster for manual testing" section

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2016-03-29 13:01:23 +02:00
Sage Weil
a09da43201 Merge pull request #8207 from theanalyst/doc/mstart
doc: very basic doc on mstart
2016-03-23 12:17:53 -04:00
Nathan Cutler
57c57548aa doc/dev: add "Deploy a cluster for manual testing" section
http://tracker.ceph.com/issues/15218 Fixes: #15218

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-20 14:23:37 +01:00
Abhishek Lekshmanan
39317e8d7d doc: very basic doc on mstart
A very basic explanation of getting started with using mstart to deploy
multiple clusters on a machine

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-03-18 14:01:20 +01:00
Nathan Cutler
917e06b8e2 doc/dev: add section on interrupting a running suite
This commit adds a new section, entitled "Interrupt a running suite", to
the "Testing in the cloud" chapter.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-15 14:14:09 +01:00
Nathan Cutler
323c267971 doc/dev: Continue writing Testing in the cloud chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-09 09:23:39 +01:00
Nathan Cutler
4a5875a184 doc/dev: start Testing in the cloud chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-07 16:00:01 +01:00
Nathan Cutler
37afe5c53b doc/dev: various refinements
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-07 10:27:42 +01:00
Nathan Cutler
5b570653f5 doc/dev: integrate testing into the narrative
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-06 20:41:35 +01:00
Nathan Cutler
a0572bc55c doc: detailed description of bugfixing workflow
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-05 15:54:09 +01:00
Samuel Just
c9861a0f79 doc/.../throttles*: update the docs to reflect the throttle changes
Signed-off-by: Samuel Just <sjust@redhat.com>
2016-02-25 11:11:46 -08:00
Abhishek Lekshmanan
dd3c87d78c doc: update PG doc with the backfill change
Since the state reported is `backfilling` and `backfill_wait`

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-02-02 17:03:46 +01:00
Abhishek Lekshmanan
5793df4cdf doc: vstart update a few commandline switches
Add a few more available commandline switches to vstart quickstart
documentation

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-01-21 13:53:50 +01:00
Loic Dachary
279e9fb1e7 doc: dev: document ceph-qa-suite
Signed-off-by: Loic Dachary <loic@dachary.org>
2016-01-07 14:20:54 +01:00
Nathan Cutler
fec545839c doc: fix typo in developer guide
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-15 15:25:45 +01:00
Loic Dachary
736532cac9 Merge pull request #6934 from smithfarm/wip-14070
doc: Update list of admin/build-doc dependencies

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-12-15 13:24:47 +01:00
Nathan Cutler
eadc771d27 doc: Update list of admin/build-doc dependencies
http://tracker.ceph.com/issues/14070 Fixes: #14070

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-15 12:41:29 +01:00
Loic Dachary
9c34d0c4e4 Merge pull request #6910 from dachary/wip-dev-guide-ceph-qa-suite
doc: dev: introduction to tests

Reviewed-by: Nathan Cutler <ncutler@suse.com>
2015-12-15 11:21:51 +01:00
Sage Weil
d5cee59b02 doc/cephfs/posix: update
Signed-off-by: Sage Weil <sage@redhat.com>
2015-12-14 10:45:30 -05:00
Loic Dachary
5440334dec doc: dev: introduction to tests
Signed-off-by: Loic Dachary <loic@dachary.org>
2015-12-13 22:02:27 +01:00
Nathan Cutler
c1daf4e6f8 doc/dev/index.rst: wholesale refactor
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-04 23:58:11 +01:00
Nathan Cutler
6807b35a21 doc/dev/index.rst: fix links
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 18:11:37 +01:00
Nathan Cutler
f3366401eb doc/dev/index.rst: Flesh out the IRC section
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 18:11:25 +01:00
Nathan Cutler
8d281bc5f0 doc/dev/index.rst: Make Issue tracker a separate chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 18:11:09 +01:00
Nathan Cutler
6e7f9c8ed3 doc/dev/index.rst: start writing Bugfixing chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 13:31:28 +01:00
Nathan Cutler
002d26b097 doc/dev/index.rst: rewrite introductory material
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 09:53:35 +01:00
Nathan Cutler
bc21a23555 doc/dev/index.rst: fix headings
This commit fixes the headings so they render properly on http://ceph.com

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 00:30:24 +01:00
Nathan Cutler
b6f9a9b2b1 doc/dev/index.rst: begin writing Contributing to Ceph
Replace existing index.rst with the beginnings of a comprehensive
developer guide.

Move the old index.rst to index-old.rst.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-02 23:37:06 +01:00
Javier M. Mellid
71909b64b8 doc: rgw: update x-amz-request-id status
Signed-off-by: Javier M. Mellid <jmunhoz@igalia.com>
2015-09-10 11:25:17 +02:00
Kefu Chai
351d957992 doc: fix the typo in command example
always indent using tab, the rendered html looks good, but it helps with
editor to highlight the codeblock properly.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-09-06 19:30:02 +08:00
Sage Weil
7d781f7a09 doc: 'ceph --admin-daemon ...' -> 'ceph daemon ...'
Signed-off-by: Sage Weil <sage@redhat.com>
2015-09-04 15:59:34 -04:00
Zhiqiang Wang
89aacaf699 doc: add the doc for min_write_recency_for_promote
Signed-off-by: Zhiqiang Wang <zhiqiang.wang@intel.com>
2015-09-02 14:00:40 +08:00
Kefu Chai
6dc9ed5814 Merge pull request #5603 from wonzhq/doc-read-recency
doc: add the description for min_read_recency_for_promote

Reviewed-by: Kefu Chai <kchai@redhat.com>
2015-08-31 18:12:43 +08:00
Sage Weil
dfb9fea3a9 Merge pull request #5660 from badone/doc_snaps_typo
doc: Fix typo and redundant word in snaps section
2015-08-25 11:54:29 -04:00
Kefu Chai
665de0a91f Merge pull request #5657 from badone/master
doc: Fix typo in recovery reservation section

Reviewed-by: Kefu Chai <kchai@redhat.com>
2015-08-25 19:35:53 +08:00
Brad Hubbard
699fca8089 doc: Fix typo and redundant word in snaps section
Fix typo and remove identifying from "filtering identifying" in
doc/dev/osd_internals/snaps.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-25 21:31:43 +10:00
Brad Hubbard
6ee7068c4c doc: Fix typo in writeback throttle section
Fix typo in doc/dev/osd_internals/wbthrottle.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-25 21:04:55 +10:00
Brad Hubbard
07a28d6ce2 doc: Fix typo in recovery reservation section
Fix typo in doc/dev/osd_internals/recovery_reservation.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-25 20:51:09 +10:00
Zhiqiang Wang
d5a56c497a doc: update some of the outdated cache tiering doc
Signed-off-by: Zhiqiang Wang <zhiqiang.wang@intel.com>
2015-08-20 10:58:45 +08:00