Commit Graph

178 Commits

Author SHA1 Message Date
Zack Cerza
6fee777d60
Merge pull request #44967 from batrick/nested-subset-doc
doc/dev: document nested subsets in teuthology
2022-05-24 10:23:48 -06:00
Zac Dover
63c6041068 doc/dev: refine basic-workflow.rst integ. test
This is one in a set of PRs meant to keep the Basic
Workflow in the Developer guide current. It refines
the English in the "Integration Tests AKA ceph-qa-suite"
section of "Basic Workflow".

Several other small updates like this are expected. I
intend to avoid refining half of the page in one commit,
as I did last month when I refined the first half of the
basic workflow.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-05-18 04:08:05 +10:00
Zac Dover
a227e4007a doc/dev: update basic-workflow.rst
This PR updates the basic-workflow.rst file
to serve the needs of people in 2022 who were not
present at jump street.

The text has been refined up to the section called
"Integration Tests" (non-inclusive).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-05-11 01:53:47 +10:00
Rishabh Dave
27eaacd98a qa/vstart_runner: accept multiple commands as str
Convert all command arguments to str from list, update checks and
adjustments performed on command arguments accordingly and update
documentation to include warnings about some critical parts of
vstart_runner.py and update tasks.cephfs.mount.MountCephFS.run_shell().

Fixes: https://tracker.ceph.com/issues/47849
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2022-05-02 20:24:08 +05:30
Rishabh Dave
f5974d3993 doc/developer_guide: split a note point into two
Since both the sentences in the note point aren't strictly related to
each other, it's better to split that note point into two.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2022-04-17 22:53:09 +05:30
Patrick Donnelly
c4d3040b70
doc/dev: document nested subsets in teuthology
See also: https://github.com/ceph/teuthology/pull/1704

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-03-25 09:12:56 -04:00
Ernesto Puerta
749f2f5746
doc: browser extension for merge message
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2022-02-16 17:49:45 +01:00
Ernesto Puerta
63f5fa45fe
Merge pull request #44857 from rhcs-dashboard/test-doc-dash-cephadm
doc: update kcli test env documentation

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-02-04 17:35:54 +01:00
Patrick Donnelly
547b21c0de
doc: document PI .qa symlinks
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-02-03 10:08:30 -05:00
Nizamudeen A
8feb2b8fe0 doc: update dashboard kcli test env documentation
Fixes: https://tracker.ceph.com/issues/54105
Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-02-02 13:50:00 +05:30
Ernesto Puerta
310e8f5571
Merge pull request #43404 from rhcs-dashboard/angular-12-upgradee
mgr/dashboard: Update Angular version to 12 

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>
Reviewed-by: Volker Theile <vtheile@suse.com>
2022-01-11 13:02:07 +01:00
Laura Flores
33ae23a150 doc/.../testing_integration_tests: fix formatting of teuthology-suite option
The `--subset` teuthology-suite option should be formatted.

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-01-05 16:48:53 +00:00
Nizamudeen A
e3d92e4889 mgr/dashboard: Update Angular version to 12
A full changelog can be seen here: https://blog.angular.io/angular-v12-is-now-available-32ed51fbfd49

For us, the most I had to do is to take care of the min-max validation
and a small CSS change regarding the math()

Fixes: https://tracker.ceph.com/issues/53049
Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-01-05 19:37:23 +05:30
Dimitri Papadopoulos
7677651618
doc,man: typos found by codespell
Signed-off-by: Dimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
2021-12-15 12:04:36 +01:00
Neha Ojha
3304a82bfd
Merge pull request #44095 from Matan-B/wip-matanb-local-workunits
doc/dev: Running workunits locally

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-12-07 13:34:15 -08:00
Alfonso Martínez
f08c0db689 mgr/dashboard: fix frontend deps' vulnerabilities
- Remove npm-force-resolutions: no resolution needed anymore and this is modifying package-lock.json every time it is run (striping last empty line).
- Add .npmrc: save exact version by default; do not launch audit report when installing.

Fixes: https://tracker.ceph.com/issues/48005
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-12-02 15:05:23 +01:00
Matan Breizman
7324abbe01 doc/dev: Running workunits locally
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2021-12-01 12:54:25 +00:00
Matan Breizman
19f6263789 doc/dev: adding Teuthology suggested resources
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2021-11-23 11:06:57 +00:00
Yuval Lifshitz
d69f196c0f
Merge pull request #43587 from zenomri/wip-omri-tracer-opentelemetry
common/tracer: Tracer implementation using opentelemetry sdk
2021-11-11 19:40:12 +02:00
Alfonso Martínez
a6aeded514 mgr/dashboard: python unit tests refactoring
* Controller tests: cherrypy config: authentication disabled by default; ability to pass custom config (e.g. enable authentication).
* Auth controller: add tests; test that unauthorized request fails when authentication is enabled.
* DocsTest: clear ENDPOINT_MAP so the test_gen_tags test becomes deterministic.
* pylint: disable=no-name-in-module: fix imports in tests.

Fixes: https://tracker.ceph.com/issues/53083
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-11-03 10:36:47 +01:00
Omri Zeneva
6b4382aac7 common/tracer: tracer implementation was moved to common/
Signed-off-by: Omri Zeneva <ozeneva@redhat.com>
2021-11-03 01:53:14 +02:00
Laura Flores
05bb4e3f02 doc/dev/developer_guide/testing_integration_tests: update "frequently used options"
The `subset` option is important in Teuthology runs for reducing the number of tests that are triggered. This option is outlined in another part of the Teuthology documentation, but I think it's important to place here as well.

Also, -n (for how many times the job will run) is incorrect; it should be -N.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-11-02 00:37:10 +00:00
Mike Perez
a747322524 doc: updating RBD lead
Signed-off-by: Mike Perez thingee@gmail.com
2021-09-16 11:47:34 -07:00
Laura Flores
4985f5c7d2 doc/dev: specify location of e2e-tests script
I was just going through these steps myself, and I found it difficult to locate and run `run-frontend-e2e-tests.sh`. Specifying the location of it might make it clearer to others where the correct script is located.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-09-09 19:10:10 +00:00
Pere Diaz Bou
05b92513c8 doc/dashboard: Fix kcli pool and network requirements documentation
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2021-08-31 16:25:56 +02:00
Aaryan Porwal
d4f0d949af doc/dev: mgr/dashboard: Visual regression tests for ceph dashboard
Fixes: https://tracker.ceph.com/issues/52370

Signed-off-by: Aaryan Porwal <aaryanporwal2233@gmail.com>
2021-08-23 14:18:15 +05:30
Ernesto Puerta
afadfede0d
Merge pull request #42194 from rhcs-dashboard/add-grafonnet-grafana
mgr/dashboard: monitoring: replace Grafana JSON with Grafonnet based code
2021-08-11 18:11:59 +02:00
Aashish Sharma
e9bd94515f mgr/dashboard: monitoring: replace Grafana JSON with Grafonnet based Code
This PR intends to add grafonnet to generate grafana JSON files

Fixes: https://tracker.ceph.com/issues/45184
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
2021-08-11 19:23:54 +05:30
Ernesto Puerta
031fcb65b6
Merge pull request #42697 from rhcs-dashboard/52082-cephadm-e2e-improv
mgr/dashboard: cephadm e2e start script: add --expanded option

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-08-09 18:19:26 +02:00
Alfonso Martínez
973a6f5343 mgr/dashboard: cephadm e2e start script: add --expanded option
- Additional improvements: clean npm cache in jenkins env.; display mgr logs on error.

Fixes: https://tracker.ceph.com/issues/52082
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-08-09 15:14:21 +02:00
Ernesto Puerta
5e654b4c94
Merge pull request #42611 from s0nea/wip-doc-transifex-resource
doc/dev: Dashboard translations release update

Reviewed-by: aaryanporwal <NOT@FOUND>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
2021-08-09 10:59:32 +02:00
Kefu Chai
a17ebc0406
Merge pull request #42575 from tchaikov/wip-venv
*: s/virtualenv/python -m venv/

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2021-08-04 18:37:45 +08:00
Tatjana Dehler
84da5ca55f
doc/dev: Dashboard translations release update
Add a note on how to add a new release resource to transifex.

Signed-off-by: Tatjana Dehler <tdehler@suse.com>
2021-08-03 15:47:22 +02:00
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
Alfonso Martínez
65b75000b7 mgr/dashboard: cephadm-e2e script: improvements
Improvements and some adaptations related to the jenkins job.

Fixes: https://tracker.ceph.com/issues/51612
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-07-27 10:51:18 +02: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