Commit Graph

144 Commits

Author SHA1 Message Date
Kefu Chai
3c40db975c script/run_tox.sh: drop support of python2
since we don't support python2 anymore, there is not need to mention or
support python2 when performing tests

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-31 21:16:56 +08:00
Zac Dover
1443d486b9 doc/dev: add IRC information to dev guide
In days of yore, the Developer Guide linked to the
IRC page at ceph.io. After the 2021 rewriting of
ceph.io, a new era began, and that page was no
longer easily accessible (it could still be found
at old.ceph.com, but this was deprecated).

Anyway, that IRC information should be included in
the docs. This PR makes sure that the IRC
information is included in the docs.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-07-10 07:32:45 +10:00
Alfonso Martínez
5c03b49c4d mgr/dashboard: run cephadm-backend e2e tests with KCLI
Fixes: https://tracker.ceph.com/issues/51300
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-07-02 10:08:49 +02:00
Zac Dover
298b446c35 doc/dev: s/reposotory/repository/ (really)
This corrects the heinous misspelling described in the
substitution expression in the title. This misspelling is
all the more egregious because it appears in a title, and
therefore would be used to create links if it had not been
caught.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-06-09 01:57:13 +10:00
Ernesto Puerta
1b312db505
Merge pull request #41395 from rhcs-dashboard/fix-50855-master
mgr/dashboard: API Version changes do not apply to pre-defined methods (list, create etc.)

Reviewed-by: Aashish Sharma <aasharma@redhat.com>
Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
2021-06-01 16:28:48 +02:00
Aashish Sharma
bb52092cd3 mgr/dashboard: API Version changes doesnt appy to pre-defined methods(list, create etc.)
Methods like list(), create(), get() etc doesn't get applied the version.Also for the endpoints that get the version changed, the docs and the request header has still the version v1.0+ in them. So with the version reduced it gives 415 error when trying to make the request. This PR fixes this issue.

Fixes: https://tracker.ceph.com/issues/50855
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
2021-05-26 10:30:33 +05:30
Kefu Chai
26d7a73564 doc/dev: no more "import absolute_import"
as we've migrated to python3, no need to use

from __future__ import absolute_import

for accessing absolute import

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-24 12:27:40 +08:00
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
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
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
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
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
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
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
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
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
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