Commit Graph

852 Commits

Author SHA1 Message Date
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
Zac Dover
745934320d doc/dev: removing workbench docs (part 2)
This removes a paragraph in the section "How
Integration Tests Are Run" that described
ceph-workbench. ceph-workbench is deprecated,
so that paragraph is now gone.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-17 03:45:49 +10:00
Zac Dover
07a9bf4d55 doc/dev: Teuthology guide PR#37949 grammar edit
This PR improves the wording of the technical
information added to the documentation in PR#37949.
This is the second is a series of two PRs, which series
is dedicated to testing a workflow wherein developers
add technical information to the documentation and then
technical writers improve its presentation.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-17 00:55:39 +10:00
Zac Dover
f16402a962 doc/dev: cephfs-shell typo repair
This corrects the formatting for a mention of
cephfs-shell. Previously, it was not properly
formatted. This commit adds two backticks before
the string "cephfs-shell", and adds to backticks
after it.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-16 18:37:13 +10:00
Zac Dover
81976b4f13 doc/dev: teuthology: improve triggering tests
- This PR cleans up the language in the "Triggering
  Tests" section of the "Workflow" chapter of the
  "Tests: Integration Tests" (Teuthology) guide.
- Added bash prompts.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-16 00:43:14 +10:00
Zac Dover
ef198d8af5 doc/dev: rewrite 'testing qa changes'
This PR rewrites the "Testing QA Changes (Without
Re-Building Binaries)" section of the Developer
Guide. I also tried to unbury the lede.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-15 23:27:34 +10:00
Zac Dover
3eaf27f01d doc/dev: rewrite "about suites and filters"
This improves the English in the section
"About Suites and Filters" in the new
Teuthology Guide in the Developer Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-12 09:28:06 +10:00
Sebastian Wagner
ca41e2a559
Merge pull request #38505 from sebastian-philipp/doc-dev-cephadm-scalability-notes
doc/dev/cephadm: scalability notes

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Michael Fritch <mfritch@suse.com>
2021-02-10 13:17:00 +01:00
zdover23
718af4faaf
Merge pull request #39351 from zdover23/wip-doc-dev-getting-binaries-rewrite-08-Feb-2021
doc/dev: rewrite "getting binaries" section

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-10 12:00:15 +10:00
Zac Dover
cce1fc800d doc/dev: rewrite "getting binaries" section
This rewrites the "Getting Binaries" section
of the "Workflow" section of the "Tests:
Integration Tests" section of the Developer Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-10 06:46:48 +10:00
Sebastian Wagner
f82e374341 doc/dev/cephadm: scalability notes
Add a few notes about possible future scalability improvements

Co-authored-by: Joshua Schmid <jschmid@suse.de>
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-02-09 12:14:26 +01:00
zdover23
d372880580
Merge pull request #39262 from zdover23/wip-doc-removing-workbench-from-docs-2021-Feb-first
doc/dev: Remove workbench mentions

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-02-05 03:05:07 +10:00
Zac Dover
1dbeeef2dd doc/dev: Remove workbench mentions
This PR removes the "running-tests-in-cloud.rst"
file, which explains how to use ceph-workbench.
ceph-workbench is now deprecated, and the new
Teuthology documentation supplants the information
in the ceph-workbench-related documentation.

This PR also alters the "index.rst" file to remove
a link to "running-tests-in-cloud.rst".

Fixes: https://tracker.ceph.com/issues/49109 (partially)
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-04 00:06:13 +10:00
Venky Shankar
bf19651d6a doc: cleanup cephfs-mirroring document
Remove references to in-progress feature, remove internal interfaces
section and minor cleanups.

Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-02-03 08:56:29 -05:00
Zac Dover
ebea923ffc doc:dev remove workbench sections
This PR removes the following two sections:

1. Getting Ceph Workbench
2. Linking Ceph Workbench With Your OpenStack Tenant

Fixes: https://tracker.ceph.com/issues/48942
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-02-02 01:01:25 +10:00
Sage Weil
713f79fdf4 Merge PR #39039 into master
* refs/pull/39039/head:
	src/test/cli/monmaptool: adjust for new monmap features
	qa/tasks/cephadm: allow custom git_url for cephadm_branch pull
	qa/suites/rados/upgrade: include pacific-x
	qa/suites/upgrade/pacific-x/parallel
	qa/suites: some clean up for quincy
	mon: updates for quincy
	mon: update for quincy ondisk features
	script: add pacific
	doc/dev/release-checklist: we tagged v17.0.0
	ceph-volume: change to quincy
	include/ceph_features: retire MON_SINGLE_PAXOS
	include/ceph_features: define FEATURE_SERVER_QUINCY
	mon/MgrMonitor: add always_on_modules for quincy
	add feature/release name quincy
	kickoff v17 quincy
	doc/dev/release-checklists: uncheck everything!

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-01-29 14:01:26 -06:00
Sebastian Wagner
9c4df44fc5
Merge pull request #37144 from jmolmo/storage_devices_mgmt
doc: High level workflow for storage devices

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Jan Fajerski <jfajerski@suse.com>
Reviewed-by: Kiefer Chang <kiefer.chang@suse.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-01-29 19:16:54 +01:00
Sage Weil
a9c4d1f1e7 qa/suites: some clean up for quincy
- remove upgrades from nautilus
- stubs for completing upgrade to quincy

Still missing the pacific-x upgrade tests.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
7bbc92eda3 mon: updates for quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
d777adb89e mon: update for quincy ondisk features
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
8a0cd401a8 script: add pacific
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
fbd4356f0d doc/dev/release-checklist: we tagged v17.0.0
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
1c039854cb ceph-volume: change to quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
f1ecf99a86 include/ceph_features: retire MON_SINGLE_PAXOS
X-3 = Q-3 = Nautilus

Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
f954c7e985 include/ceph_features: define FEATURE_SERVER_QUINCY
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:28 -06:00
Sage Weil
348ed248f4 mon/MgrMonitor: add always_on_modules for quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Sage Weil
beb62c029a add feature/release name quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Sage Weil
d730a522e3 kickoff v17 quincy
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Sage Weil
0a13114341 doc/dev/release-checklists: uncheck everything!
Signed-off-by: Sage Weil <sage@newdream.net>
2021-01-28 13:29:27 -06:00
Neha Ojha
a3d74ad052
Merge pull request #39108 from zdover23/wip-doc-leads-update-epuertat-28-Jan-2021
doc/dev: add Ernesto Puerta as dashboard lead

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2021-01-27 17:10:59 -08:00
Neha Ojha
36bf44e150
Merge pull request #37949 from ideepika/wip-docs-update
doc/dev/developer_guide:  teuthology update developer guide

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-01-27 16:35:23 -08:00
Zac Dover
d318b60cc1 doc/dev: add Ernesto Puerta as dashboard lead
This commit removes Lenz Grimmer's name and github
handle from the list of component leads and replaces
it with Ernesto Puerta's name and github handle.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-01-28 02:26:23 +10:00
Deepika Upadhyay
e179e14115 doc/dev/developer_guide/basic-workflow: fix integration tests link
Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:53:34 +05:30
Zac Dover
9ce222fee2 doc/dev: improving teuthology docs
This commit is a proof of concept and a repair of
links to the "Integration Tests" section of the
Developer Guide.

This fixes the "reading a standalone test" link
from the "Running Tests in the Cloud" page
to the "Reading a Standalone Test" section in
the "Tests: Integration Tests" page.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-01-26 16:53:34 +05:30
Deepika Upadhyay
4159d946d7 doc/dev/developer_guide/testing_integration_tests: fix broken links and
update teuthology guide

Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:53:06 +05:30
Deepika Upadhyay
c77d0817d5 doc/dev/developer_guide: rearrange and improve docs
* move running-tests-using-teuth.rst to
doc/dev/developer_guide/tests-integration-testing-teuthology-workflow.rst

* introduce developer's guide for Sentry and improve teuthology docs

* add teuthology debugging guide * create testing_integration_tests
subfolder for teuthology

Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-01-26 16:49:36 +05:30
Juan Miguel Olmo Martínez
bddb596011
doc: High level workflow for storage devices
A first document where to discuss how to improve and make more easy and effective for final users the storage devices and OSD management.

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-01-20 13:17:53 +01:00
Venky Shankar
439c18c490 doc: document mirror daemon internals
... fix some typos and reorganize sections to be reader
friendly. Also include a requirements section.

Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-01-12 05:56:52 -05:00
Sebastian Wagner
3aeda544a1 doc/cephadm: Rm doc/dev/cephadm from user docs
We should not link the dev guide form the user documentation. The user docs are already convoluted and hard to follow. Adding the dev guide is not helpful.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-07 12:52:12 +01:00
Sebastian Wagner
6b3c46f508 doc/dev: resurrect hidden dev/cephadm.rst
some time ago, a cephadm folder was added that did hide the
old dev documentation page.

Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2021-01-06 14:13:11 +01:00
Zac Dover
702cedf327 doc/dev: restructure basic-workflow.rst
- Rewrote a sentence about forking.
- s/exactly how to proceed/how to proceed/
- Changed titles to present participles
- Rewrote "Fixing the Bug Locally" to improve its elegance.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-31 15:18:34 +10:00
zdover23
d8675ecf80
Merge pull request #38187 from zdover23/wip-doc-dev-unit-tests-5-of-7
doc/dev: update unit-tests tox section

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2020-12-23 02:07:59 +10:00