RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-12 06:00:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
116,301 Commits 214 Branches 394 Tags 1.3 GiB
df7adbf387
Commit Graph

748 Commits

Author SHA1 Message Date
Alfonso Martínez
79321d4461 mgr/dashboard: set 'vendor/variables' SASS module as the single source of truth 
Fixes: https://tracker.ceph.com/issues/46869
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
 2020-10-14 13:29:35 +02:00
Yuval Lifshitz
426e6f526c
Merge pull request #37599 from yuvalif/remove_doxyfile 
cmake: remove Doxyfile as doxygen run via make
 2020-10-13 08:03:39 +03:00
zdover23
0f3bce753a
Merge pull request #37541 from anthonyeleven/osd-internals-tweaks 
doc/dev: doc/dev/osd_internals capitalization, formatting, clarity

Reviewed-by: Zac Dover <zac.dover@gmail.com>
 2020-10-13 06:01:05 +10:00
Yuval Lifshitz
fe0bddb7ab build/doc: remove Doxyfile as doxygen run via make 
also update document doxygen behavior
this is to complete: https://github.com/ceph/ceph/pull/35027

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
 2020-10-08 17:00:59 +03:00
Venky Shankar
b0d540e82f doc: cephfs mirroring design document 
Signed-off-by: Venky Shankar <vshankar@redhat.com>
 2020-10-08 05:31:35 -04:00
Kefu Chai
c7da693961 doc/crimson/poseidonstore: reformat 
to render it as expected

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-07 12:54:42 +08:00
Kefu Chai
2263511c93 doc: move dev/crimson.rst into dev/crimson/ 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-07 12:54:42 +08:00
Samuel Just
699c2740fe
Merge pull request #36343 from myoungwon/wip-doc-poseidon-store 
doc: introduce PoseidonStore

Reviewed-by: Samuel Just <sjust@redhat.com>
 2020-10-06 17:28:43 -07:00
Anthony D'Atri
33931a8330 doc/dev: doc/dev/osd_internals caps, formatting, clarity 
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
 2020-10-06 14:06:46 -07:00
Kefu Chai
a9ed9b15c2 doc/dev/crimson: add links to seastar documents 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-06 17:59:11 +08:00
Kefu Chai
3c3c2f6ea0 doc/dev/crimson: add instruction on running install-deps.sh for building crimson 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-06 17:06:35 +08:00
myoungwon oh
9261c747f0 doc: introduce Poseidon store 
Signed-off-by: Myoungwon Oh <myoungwon.oh@samsung.com>
Signed-off-by: Jiwoong Park <jw12.park@samsung.com>
Signed-off-by: Kyuho Son <kyuho.son@samsung.com>
Signed-off-by: Sungkyu Park <sk921.park@samsung.com>
 2020-10-06 16:22:53 +09:00
Courtney Caldwell
ca2261781e
mgr/dashboard/api: generate offline API docs 
Generate Sphinx documentation from OpenAPI YAML spec:
- Fixed Docs controller doc generation
- Now dashboard Python doesn't fails if dashboard/frontend/dist doesn't exist
- OpenAPI added to @ceph/api CODEOWNERS
- Renamed Ceph-Dashboard API to Ceph REST or RESTful API.
- OpenAPI Docs: fixed decorators and docstrings.
- Sphinx Docs: updated dashboard and dev ones.

Co-authored-by: Ernesto Puerta <epuertat@redhat.com>
Fixes: https://tracker.ceph.com/issues/45863
Signed-off-by: Courtney Caldwell <ccaldwel@redhat.com>
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
 2020-09-28 12:03:03 +02:00
Kefu Chai
5bb5f5a79e
Merge pull request #37384 from tchaikov/wip-crimson-doc 
doc/dev/crimson: add instructions on how to build crimson

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
 2020-09-24 22:30:12 +08:00
Kefu Chai
17d35b367d doc/dev/crimson: add instructions on how to build crimson 
and add a link to Scylla's document on debugging with GDB

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-24 15:32:09 +08:00
Zac Dover
5985eb9413 doc/dev: added the other four tests 
This PR adds a list of tests that are performed
when a PR hits Github.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-09-24 09:49:36 +10:00
Zac Dover
f0d1ba50ce doc/dev: updated date from 2016 
This updates a date from 2016 to 2020,
so that readers can be confident that the
procedure that they're reading has been recently
tested.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-09-22 19:10:15 +10:00
Kefu Chai
47e7cd0f65
Merge pull request #37207 from tchaikov/wip-doc-dev-osx 
doc/dev/macos.rst: disable features not supported on osx

Reviewed-by: Kamoltat Sirivadhna <ksirivad@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
 2020-09-19 12:08:35 +08:00
Kefu Chai
266aa66aa9
Merge pull request #37252 from pponnuvel/spellcheck-docs 
doc: Fixed a number of typos in documentation

Reviewed-by: Kefu Chai <kchai@redhat.com>
 2020-09-19 11:07:52 +08:00
Neha Ojha
8ba0a61a51
Merge pull request #35906 from gregsfortytwo/wip-stretch-mode 
Add a new stretch mode for 2-site Ceph clusters

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
 2020-09-18 14:31:45 -07:00
Ponnuvel Palaniyappan
d99d520493 doc: Fixed a number of typos in documentation 
Signed-off-by: Ponnuvel Palaniyappan <pponnuvel@gmail.com>
 2020-09-18 18:17:15 +01:00
Kefu Chai
4278e6b59e doc/dev/macos.rst: disable features not supported on osx 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-17 12:19:47 +08:00
Kamoltat Sirivadhna
825df66bb8 doc/dev/macos: remove nonexistence flag --with-toolchain 
` --with-toolchain` is an old option from llvm 6

Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>
 2020-09-16 22:39:57 +07:00
Greg Farnum
9506d09e3b Merge remote-tracking branch 'origin/master' into wip-stretch-mode 
Conflicts:
	src/include/ceph_features.h

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
 2020-09-15 02:25:07 +00:00
Greg Farnum
d02625331c Merge remote-tracking branch 'origin/master' into wip-stretch-mode 2020-09-14 02:32:19 +00:00
zdover23
b22cf6da57
Merge pull request #37070 from zdover23/wip-doc-3-hacking-into-docs 
doc/dev: add HACKING.rst to Dev Guide

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
 2020-09-11 08:04:24 +10:00
Neha Ojha
9e81f39733
Merge pull request #36747 from varshar16/wip-doc-update-about-priority-check 
doc/developer_guide: Update about '--force-priority' flag

Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Kyr Shatskyy <kyrylo.shatskyy@suse.de>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
 2020-09-10 10:29:29 -07:00
Zac Dover
5760cff6e3 doc/dev: add HACKING.rst to Dev Guide 
This commit exposes HACKING.rst through the
docs website. Formerly, HACKING.rst was just
a file that existed at /src/pybind/mgr/dashboard/
HACKING.rst. This commit also updates README.rst
to point to the new location of HACKING.rst.

Fixes: https://tracker.ceph.com/issues/47230
Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-09-11 01:00:48 +10:00
Kefu Chai
c80d5d47b3 doc/dev: reformat the sample for tree structure of a test suite 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-10 15:13:02 +08:00
Kefu Chai
3569244a50 doc/dev: use appropriate directive for code blocks 
* use "code-block:: yaml" for qa suite samples
* use "prompt:: bash $" for shell commands using a non-root user

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-10 15:13:02 +08:00
Kefu Chai
c77382ac0e doc/dev: update supported distros of ceph 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-10 15:13:02 +08:00
Kefu Chai
549952edef doc/dev: drop unused label 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-10 15:13:02 +08:00
Kefu Chai
b17dcc1fc7 doc/dev: fix broken link 
otherwise "make check" would be a link pointing to
https://wiki.sepia.ceph.com/doku.php

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-10 15:13:02 +08:00
Kefu Chai
e21bcb5e85 doc/dev: drop unused label 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-05 09:55:57 +08:00
Kefu Chai
e3abd2e7c8 doc/dev/developer_guide/tests-unit-tests: use literal "make check" 
the ``make check`` is better than a hyper link here.

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-05 09:46:57 +08:00
Kefu Chai
51b7b05026 doc/dev: fix broken "make check" link 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-05 09:46:57 +08:00
Kefu Chai
40f9e1cee0 doc/dev: link to label not file 
it's less error prone, and can help us avoid broken links if we move a
file around

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-05 09:46:57 +08:00
Kefu Chai
0f2489406a doc/dev: use prompt directive when appropriate 
for 2 reasons:

* sphinx renders codeblock using python syntax highlighting by default,
  so it's not surprising that it highlight keywords like "export" in
  command line samples. so to render command line code blocks, we'd
  better specify the syntax explicitly for better rendering result.
* with the help of "prompt" directive, user is able to copy and paste
  the command without the prompt. for instance, with the default
  "::" directive, user will copy "$ ceph df", which is not very
  convenient, but with "prompt" directive, user only copies
  "ceph df".

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-05 00:03:52 +08:00
zdover23
018161417b
Merge pull request #36489 from zdover23/wip-doc-dev-merge-request-2020-aug 
doc/dev: add proper merge commit format
 2020-09-04 11:15:54 +10:00
Zac Dover
a62847404c doc/dev: add proper Merge PR format 
This commit adds an example of proper Merge PR format
to the Developer Guide. Though this might not be of
great use to most people, Zac Dover will find it most
helpful.

Fixes: https://tracker.ceph.com/issues/46843
Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-09-04 08:29:51 +10:00
Robert Sander
1b42759e19 doc: remove references to ceph-deploy 
The documentation still has many traces of ceph-deploy. This tool has
been deprecated with the Octopus release. This commit tries to remove
most of ceph-deploy occurences.

Signed-off-by: Robert Sander <r.sander@heinlein-support.de>
 2020-09-02 21:14:36 +02:00
Venky Shankar
8bf65fab45 doc: document cephfs mirroring developement status 
Signed-off-by: Venky Shankar <vshankar@redhat.com>
 2020-09-01 06:58:11 -04:00
Sage Weil
c7244e7aad misc language changes: whitelist -> ignore etc 
Signed-off-by: Sage Weil <sage@newdream.net>
 2020-08-24 19:53:08 +00:00
Varsha Rao
d1651ba1d0 doc/developer_guide: Update about '--force-priority' flag 
The '--force-priority' flag is introduced in PR
https://github.com/ceph/teuthology/pull/1550.

Signed-off-by: Varsha Rao <varao@redhat.com>
 2020-08-24 15:33:56 +05:30
Patrick Donnelly
3fb857cd04
Merge PR #36131 into master 
* refs/pull/36131/head:
	doc: document cephfs mirroring dev work
	test: add tests for `ceph fs mirror` family of commands
	mds: track filesystem mirror peers in fsmap

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
 2020-08-21 18:40:42 -07:00
Kefu Chai
3034b22227 doc/dev/crimson: fix a typo 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-08-19 00:13:04 +08:00
Kefu Chai
2a760c596d doc/dev/crimson: note about script/ceph-debug-docker.sh 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-08-16 23:14:21 +08:00
Venky Shankar
bab0b1287d doc: document cephfs mirroring dev work 
Signed-off-by: Venky Shankar <vshankar@redhat.com>
 2020-08-12 09:28:12 -04:00
Kefu Chai
a49651cd42 doc/dev/crimson: add more examples for seastar-addr2line 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-07-23 16:53:41 +08:00
Kefu Chai
1defed5aad doc/dev/crimson: remove redundant options 
`--smp` and `--cpuset` have been passed to crimson-osd by vstart.sh, so
no need to pass them when launching vstart.sh

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-07-23 09:39:32 +08:00