Commit Graph

893 Commits

Author SHA1 Message Date
Zac Dover
f904078344 doc/crimson: s/Crismon/Crimson/
This misspelling occurred twice in this
document.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-04-28 23:26:09 +10:00
Venky Shankar
8343471a0f
Merge pull request #40933 from vshankar/wip-50266
cephfs-mirror: sanitize `daemons status` JSON

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2021-04-27 12:22:37 +05:30
Kefu Chai
5249e5fe03 doc/dev/osd_internals/mclock_wpq_cmp_study: fix a typo
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-26 21:01:44 +08:00
Kefu Chai
4e27388ba7 doc/rados/configuration: reference options using :confval:
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-26 21:01:44 +08:00
Sridhar Seshasayee
f417ebf0ff doc/dev: Add internal documentation for mclock scheduler
The document details the refinements to mclock scheduler and presents the
results of a comparison study performed between the mclock scheduler and
the WPQ scheduler.

Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2021-04-21 19:04:28 +05:30
Venky Shankar
3c600928c2 doc: adjust daemon status section with changed JSON
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-20 21:18:54 -04:00
Venky Shankar
bfaf5e9929 doc: detail fs snapshot mirror daemon status mgr command
@leseb noticed that this interface did not have any documentation. Thanks!

Fixes: http://tracker.ceph.com/issues/50229
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-08 15:13:58 +05:30
Venky Shankar
9d60ec8ceb doc: s/<fs>/<fs_name>/g
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-08 15:13:58 +05:30
Patrick Donnelly
551134a935
doc: update some docs still referring to make
We use ninja now.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-04-06 08:11:36 -07:00
Kefu Chai
ba285cbc98 doc/dev/cephadm: quote command with backquotes
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-28 23:29:56 +08:00
Radoslaw Zarzynski
1b1c088dba doc/crimson: improve wording about the pipeline / wait states.
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2021-03-23 16:49:55 +01:00
zdover23
fe76f556cf
Merge pull request #40295 from tchaikov/wip-doc-links
doc: fix broken links

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-03-23 01:43:15 +10:00
Kefu Chai
24d34d7b83
Merge pull request #40282 from rzarzynski/wip-crimson-doc-waitstates
doc/crimson: document wait states

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-03-22 18:40:16 +08:00
Radoslaw Zarzynski
7110bbed12 doc/crimson: document wait states.
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2021-03-22 11:21:23 +01:00
Kefu Chai
1dbc932195 doc: use :ref: instead relative path for links
path is fragile when we move the file around, but link is more stable.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-22 01:41:53 +08:00
Kefu Chai
f73716402b
Merge pull request #40102 from tchaikov/wip-doc-fixes
doc: theme, cmake and formatting related fixes

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-03-21 22:04:02 +08:00
Deepika Upadhyay
6fd0165610 doc/dev/developer_guide: add jaegertracing intial developer documentation
Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-03-18 16:59:44 +05:30
Jonas Jelten
76a67d7753 doc: update osd-class-path error messages
the return value is "95 Operation not supported"

Signed-off-by: Jonas Jelten <jj@sft.lol>
2021-03-16 16:16:02 +01:00
Kefu Chai
26b3e73f33 doc/dev: remove triple ":"
`::` would suffice

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00
Kefu Chai
cf816cfdbe doc/dev: specify lexer of pygment
for better rendering result

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00
Kefu Chai
cb32dc8027 doc/dev: start list after an empty line
otherwise sphinx takes it as a definition list

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00
Kefu Chai
8d0080eef6 doc/dev: update to adapt the cmake+ninja transition
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00
Kefu Chai
b9f2101afd doc/dev: use ditaa to render diagram
for better reading experience.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-14 20:19:02 +08:00
Kefu Chai
752cbbe936 doc/dev: drop unnecessary ::
`.. prompt::` is enough, no need to add '::'

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-14 20:19:02 +08:00
Venky Shankar
943ea38678 doc: clarify mirror daemon user capability requirements
Fixes: http://tracker.ceph.com/issues/49619
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-03-11 03:41:52 -05:00
Venky Shankar
f766e8297c doc: doc changes for additional mirroring interfaces
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-03-11 03:41:52 -05:00
Zac Dover
f2f17fbb86 doc/dev: t8y interactive-on-error rewrite
This PR rewrites the section of the Teuthology
documentation that is about the --interactive-
on-error flag.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-03-05 12:42:31 +10:00
Zac Dover
85b117fc57 doc/dev: add t8y label to index.rst
I added "(Teuthology)" to the "Tests: Integration
Tests" link, because that section is all about Teuthology,
but you wouldn't have known it from the text in the link
up to now.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-26 23:06:41 +10:00
Zac Dover
34254d5222 doc/dev: t8y - rewrite "a. & d. a t8y job"
This PR rewrites the "Analyzing and Debugging a
Teuthology Job" section of the "Debugging Tips"
page of the Teuthology User Guide in the Developer
Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-26 20:32:49 +10:00
Neha Ojha
731c20fe49
Merge pull request #39666 from zdover23/wip-doc-dev-t8y-rerunning-tests-rewrite-2021-Feb-24
doc/dev: rewrite t8y "re-running tests"

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-25 17:14:59 -08:00
Neha Ojha
85fcd117e9
Merge pull request #39694 from zdover23/wip-doc-dev-t8y-debugging-triaging-rewrite-2021-Feb-25
doc/dev: rewrite t8y "triaging" section

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-25 17:09:56 -08:00
Neha Ojha
deb7d811e0
Merge pull request #39695 from zdover23/wip-doc-dev-t8y-debugging-adding-sections-2021-Feb-26
doc/dev: add t8y debug section names

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-25 17:08:30 -08:00
Zac Dover
25a914229a doc/dev: rewrite t8y "reporting the issue"
This commit rewrites the "Reporting the Issue"
section, reflecting my better understanding of the
various tools and parties in play. I also added a
TL;DR-style summary (or argument) paragraph at the
top of the section.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-26 00:38:11 +10:00
Zac Dover
dc87477a1a doc/dev: add t8y debug section names
This commit adds two section headings to the
Debugging section of the Teuthology Guide:

  1. Viewing Test Results
  2. Identifying Failed Jobs

The text as it stood before seemed to call out for
this explicit sectioning of material, so I've answered
that call.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-26 00:15:56 +10:00
Zac Dover
5c4a1a317d doc/dev: rewrite t8y "triaging" section
This commit simplifes and clarifies the "Triaging
the Cause of Failure" section in the Teuthology
Guide in the Developer Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-26 00:05:38 +10:00
Zac Dover
04fbd85e42 doc/dev: rewrite t8y "re-running tests"
This PR rewrites the "re-running tests" section
so that its elegance and readability are improved.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-25 22:45:15 +10:00
Zac Dover
ecb333f101 doc/dev: t8y-naming-ceph-ci-branch rewrite
This PR rewrites the "Naming the Ceph Branch"
section of the Teuthology docs, improving its
elegance and unburying the ledes.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-25 01:36:48 +10:00
Zac Dover
53e809b456 doc/dev: s/getting tests r.../getting test r...
s/getting tests results/getting test results/

This commit changes a title so that it is grammatically
correct. The adjective "test" now properly modifies the
noun "results". Another way of thinking of this is that
the complex noun "test results" has had a typo in it
corrected.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-24 13:41:50 +10:00
Neha Ojha
6b3a8bccbb
Merge pull request #39615 from zdover23/wip-doc-dev-basic-workflow-intro-adding-ceph-ceph-2021-Feb-22
doc/dev: adding upstream repo name

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-23 08:49:26 -08:00
Zac Dover
1bdd4fdae7 doc/dev: adding upstream repo name
This commit makes one sentence slightly less
ambiguous by designating the location from
which the "ceph fetch" command fetches objects.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-24 01:48:13 +10:00
Jos Collin
efb23dd034
doc: fix broken links multimds and kcephfs
Fixes: https://tracker.ceph.com/issues/49372
Signed-off-by: Jos Collin <jcollin@redhat.com>
2021-02-22 20:38:22 +05:30
Zac Dover
e6596e10b1 doc/dev: intro: removing ceph-deploy mention
This removes a mention of the ceph-deploy manpage.
We also no longer direct people to use horses as
a primary form of transportation.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-20 00:36:03 +10:00
zdover23
d6cf88fcea
Merge pull request #39546 from zdover23/wip-doc-dev-teuthology-intro-suites-inventory-rewrite-18-Feb-2021
doc/dev: t5logy: rewrite "suites inventory"

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-19 21:13:11 +10:00
Josh Durgin
0c2164c2ab
Merge pull request #39556 from zdover23/wip-doc-dev-t8y-intro-how-integration-tests-are-run-rewrite-2021-Feb-19
doc/dev: t8y intro: edit "how to run int. tests"

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-02-18 12:27:29 -08:00
Zac Dover
ec199b916f doc/dev: t8y intro: edit "how to run int. tests"
This PR gives a bit more form to the section called
"how integration tests are run".

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-19 03:19:25 +10:00
Zac Dover
cc362c2fd6 doc/dev: t7gy s/Priority/N/
"N" just looks better in this table than does
"Priority". I've been thinking about this all
day, and I just decided to make this change.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-19 02:46:57 +10:00
Zac Dover
36287f21ce doc/dev: t5logy: rewrite "suites inventory"
This really just re-organizes this information into
a table. I think tables are easier to read than what
was here before.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-18 21:08:27 +10:00
Zac Dover
e25c54c188 doc/dev: intro: rewrite "testing priority"
This PR improves the English in the "Testing
Priority" section and makes a few structural
changes to make the intent clearer.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-18 01:31:55 +10:00
zdover23
f3312bbdb3
Merge pull request #39497 from zdover23/wip-doc-dev-teuthology-intro-workbench-removal-16-Feb-2021
doc/dev: removing workbench docs (part 2)

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-17 12:16:47 +10:00
Zac Dover
67298e2492 doc/dev: correct "teuthology-describe-tests"
This tiny commit does this:

s/teuthology-describe-tests/teuthology-describe/

The name of this feature was changed from "teuthology-
describe-tests" to "teuthology-describe", and this
commit brings up to date the title of the section
detailing it.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-17 04:14:30 +10:00