Commit Graph

1018 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
Samuel Just
f6a9ee72d7 bluestore: Revert "os/bluestore: Add CoDel to BlueStore for Bufferbloat mitigation"
Merge caused: https://tracker.ceph.com/issues/55433

Signed-off-by: Samuel Just <sjust@redhat.com>
2022-04-25 12:33:45 -07:00
Samuel Just
78ffeb71a0
Merge pull request #43413 from esmaeil-mirvakili/bluestore-bufferbloat-mitigation
os/bluestore: Add CoDel to BlueStore for Bufferbloat mitigation

Reviewed-by: Samuel Just <sjust@redhat.com>
Reviewed-by: Adam Kupczyk <akupczyk@redhat.com>
2022-04-22 14:37:04 -07:00
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
Anthony D'Atri
e96703fb9d
Merge pull request #45571 from rzarzynski/wip-doc-mempool-acct
doc/dev: Define what mempools we use in BlueStore
2022-04-13 19:18:26 -07:00
Anthony D'Atri
d48f7fe90e doc/dev: define what mempools we use in bluestore
doc/dev: define what mempools we use in bluestore

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-04-13 14:59:34 -07:00
Ernesto Puerta
c160e1e205
Merge pull request #45059 from ceph/wip-merge_message_browser-master
doc: browser extension for merge message

Reviewed-by: Nizamudeen A <nia@redhat.com>
2022-04-13 10:37:30 +02:00
Kefu Chai
352ab9b5f0 doc/dpdk: reword the root access part
the root access to system is not a must have for running a DPDK
application. so reword the "Configuring OSD DPDKStack" section.

also, manually editing /etc/passwd is not encouraged, so use
"usermod" instead. to add a directory after user's command
interpreter in /etc/passwd does not make sense. see PASSWD(5).
so drop the paragraph on editing /etc/passwd.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2022-03-27 01:00:21 +08:00
Kefu Chai
3d2d6ffabb doc/dpdk: improve the formatting
Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2022-03-27 00:46:17 +08:00
Kefu Chai
20b11d81df
Merge pull request #44292 from fengchunsong/dpdk-doc
doc/dev: add dpdkstack doc

Reviewed-by: Haomai Wang <haomai@xsky.com>
Reviewed-by: Kefu Chai <tchaikov@gmail.com>
2022-03-26 23:48:00 +08:00
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
Deepika
d6b0dc3049 doc/dev: define what mempools we use in bluestore
Signed-off-by: Deepika <dupadhya@redhat.com>
2022-03-24 15:30:23 +01:00
Esmaeil Mirvakili
b4268f5e1a os/bluestore: SlowFastCoDel added to the BlueStore
Signed-off-by: Esmaeil Mirvakili <smirvaki@ucsc.edu>
2022-03-22 07:22:12 -07:00
Kefu Chai
f63fa1b1e4 doc/dev: s/tchaikov/ceph/
use the repo under ceph orgnization for the sake of better
consistency

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2022-03-14 23:05:54 +08:00
wangxinyu
b132d6d69b doc/cephfs: fix typos
fix typos

Signed-off-by: wangxinyu <wangxinyu@inspur.com>
2022-03-10 15:44:18 +08:00
Pere Diaz Bou
dd1b5eb38c cephadm/box: default add hosts
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-02-28 09:48:36 +01: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
Venky Shankar
95f326d780 doc: document mds locking operation
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2022-02-11 18:45:33 +05:30
Laura Flores
b544e6986c doc/dev: add section on using the gen_state_diagram.py script
Commands sourced from Jianshen Liu's blog post on the Ceph peering state machine: https://jianshenliu.com/blog/development/ceph-peering-state-machine/

Also fixed the formatting of "PG info".

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-02-10 09:12:05 -06: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
Sebastian Wagner
9e8b2d8282
Merge pull request #44510 from rzarzynski/wip-cephadm-docfix
doc/cephadm: improve the development doc a bit

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2022-01-17 10:21:45 +01:00
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
Radoslaw Zarzynski
4c58d71d2b doc/cephadm: improve the developer's guide a bit
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-01-10 14:18:00 +00:00
Radoslaw Zarzynski
e513869fd3 doc/cephadm: fix a typo in developing-cephadm.rst
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-01-10 14:15:23 +00:00
Neha Ojha
24df4a2e83
Merge pull request #44474 from ljflores/wip-doc-integration-tests
doc/.../testing_integration_tests: fix formatting of teuthology-suite option

Reviewed-by: Neha Ojha <nojha@redhat.com>
2022-01-05 10:33:55 -08: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
Alfonso Martínez
dae1b27022
Merge pull request #43580 from rhcs-dashboard/cephadm_box-docs
cephadm/box: DiD box documentation

Reviewed-by: Aashish Sharma <aasharma@redhat.com>
Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Avan Thakkar <athakkar@redhat.com>
Reviewed-by: sebastian-philipp <sewagner@redhat.com>
2022-01-04 17:24:44 +01:00
Kefu Chai
3b250938bc doc: remove references to SEASTAR_DEFAULT_ALLOCATOR
now that 067681b701
has been merged upstream, and our src/seastar submodule includes
this commit. there is no need to worry that the seastar's lockless
allocator does not work with seastar::alien anymore.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2021-12-26 13:13:56 +08:00
Chunsong Feng
8d4e1e44c7 doc/dev: add dpdkstack doc
Add the description of DPDKStack development, debugging, optimization and plan.

Fixes: https://tracker.ceph.com/issues/53432
Signed-off-by: Chunsong Feng <fengchunsong@huawei.com>
Reviewed-by: luo rixin <luorixin@huawei.com>
Reviewed-by: Han Fengzhe  <hanfengzhe@hisilicon.com>
2021-12-19 03:31:03 +00:00
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
6628f444b3
Merge pull request #44145 from rhcs-dashboard/fix-frontend-vulnerabilities
mgr/dashboard: fix frontend deps' vulnerabilities

Reviewed-by: Waad Alkhoury <walkhour@redhat.com>
Reviewed-by: Pere Diaz Bou <pdiazbou@redhat.com>
2021-12-07 15:02:42 +01: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
Pere Diaz Bou
36f0246f32 doc/cephadm: add DiD box documentation
Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2021-12-02 09:50:04 +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
Josh Durgin
7dee504a41
Merge pull request #43760 from yaarith/release-checklists
doc/dev/release-checklist: add manual review of telemetry reports

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-11-29 18:18:43 -08: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
Neha Ojha
e76a9f4045
Merge pull request #43326 from pdvian/wip-doc-config-correction
doc/dev/config: Replace invalid config debug-pg

Reviewed-by: Neha Ojha <nojha@redhat.com>
2021-11-18 17:03:11 -08: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
Yaarit Hatuka
35f2fe8279 doc/dev/release-checklist: add manual review of telemetry reports
When gathering metrics, the telemetry module automatically detects and
removes sensitive details (e.g. pools and hosts names) from its reports.
We wish to manually double-check here that none of these details are
accidentally included in the reports.

Signed-off-by: Yaarit Hatuka <yaarit@redhat.com>
2021-11-01 15:19:30 +00:00
Maya Gilad
3f5dca4977 doc added msgr on-wire-compression
Signed-off-by: Maya Gilad <ms.maya.gilad@gmail.com>
2021-10-18 10:03:30 +03:00