Commit Graph

1260 Commits

Author SHA1 Message Date
Zac Dover
b81d6af1b4 doc/dev: improve basic-workflow.rst
Make various improvements to doc/dev/developer_guide/basic-workflow.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-31 05:24:25 +10:00
Zac Dover
86385b1daf
Merge pull request #58705 from gitkenan/crimsonDocChanges
doc/dev/crimson: making it more user-friendly, re-arranging chapters and fixing typos

Reviewed-by: Matan Breizman <mbreizma@redhat.com>
2024-07-23 04:58:39 +10:00
Zac Dover
f836a76cb7
Merge pull request #58600 from zdover23/wip-doc-2024-07-16-dev-guide-basic-workflow
doc/dev: add formatting to basic workflow

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-07-23 04:00:49 +10:00
Zac Dover
02d5a6a337 doc/dev_guide: add needs-upgrade-testing label info
Add an explanation of the "needs-upgrade-testing" label and explain when
to use it.

Laura is the true author of this text.

Co-authored-by: Laura Flores <lflores@ibm.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-23 01:38:11 +10:00
gitkenan
92fea64c1f doc/dev/crimson: clarify and rearrange for userability
Signed-off-by: gitkenan <kenan.mth@gmail.com>
2024-07-22 15:29:11 +01:00
Paulo E. Castro
3b0360bc2e
doc: Amend dev mailing list subscribe instructions.
Signed-off-by: Paulo E. Castro <pecastro@wormholenet.com>
2024-07-20 17:34:48 +01:00
Radoslaw Zarzynski
58b3ae4982
Merge pull request #57591 from aclamk/wip-aclamk-denc-compat-check
common, os/bluestore: Fix lack of checking for compat on DENC_START

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2024-07-18 01:52:42 +02:00
Adam Kupczyk
6143b80ef7 include/denc.h: Review fixes
- Added note to release-checklist
- Created specialized DENC_START_OSD_REQID
- Use CEPH_RELEASE_SQUID (19) value

Signed-off-by: Adam Kupczyk <akupczyk@ibm.com>
2024-07-16 13:15:38 +00:00
Zac Dover
4c4063a097 doc/dev: add formatting to basic workflow
Add some formatting to a few sections near the end of
doc/dev/developer_guide_basic-workflow.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-16 02:03:37 +10:00
Zac Dover
570797e558 doc/dev: edit "Principles for format change"
Improve "Principles for format change" in doc/dev/encoding.rst. This
commit started as a response to Anthony D'Atri's suggestion here: https://github.com/ceph/ceph/pull/58299/files#r1656985564

Review of this section suggested to me that certain minor English usage
improvements would be of benefit. The numbered lists in this section
could still be made a bit clearer.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-07-14 17:25:23 +10:00
Yuri Weinstein
8761bbe16c docs: removed centos 8 and added squid to the build matrix
Signed-off-by: Yuri Weinstein <yweinste@redhat.com>
2024-07-12 06:42:02 -07:00
N Balachandran
9f43c67a63 doc/dev: Fix typos in encoding.rst
Signed-off-by: N Balachandran <nibalach@redhat.com>
2024-06-27 12:52:09 +05:30
Matan Breizman
35d257bfaa doc/dev/crimson: CPU cores allocation
CPU cores allocation and
add crimson-smp vstart flag

Signed-off-by: Matan Breizman <mbreizma@redhat.com>

Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2024-06-18 17:12:14 +10:00
Zac Dover
5134aeb78b doc/dev: link to ceph.io leads list
Remove the docs.ceph.com list of team leads, and link to the list of
leads on ceph.io.

Fixes: https://tracker.ceph.com/issues/66392

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-18 00:39:10 +10:00
Ivo Almeida
e082a4d72d
Merge pull request #57746 from ceph/nodejs-lts-update
mgr/dashboard: update node js version  

Reviewed-by: Nizamudeen A <nia@redhat.com>
2024-06-07 10:23:29 +01:00
Zac Dover
36e09fb689 doc/dev: origin of Labeled Perf Counters
Note that Labeled Perf Counters were introduced in Reef.

Fixes: https://github.com/ceph/ceph/pull/57753#discussion_r1626483732

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-06-05 11:18:46 +10:00
Ivo Almeida
45183620dd mgr/dashboard: update node js version
Fixes: https://tracker.ceph.com/issues/66249

Signed-off-by: Ivo Almeida <ialmeida@redhat.com>
2024-05-29 09:25:19 +01:00
Zac Dover
55e41bc679 doc/dev: add note about intro of perf counters
Add a note to the "perf counter" section of doc/dev/perf_counters.rst
that explains that this feature was introduced in the Reef release of
Ceph. This note will prevent us from accidentally backporting
perf-counter-related PRs to Quincy.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-29 02:27:53 +10:00
Rishabh Dave
899c481d40 doc/developer_guide: update doc about installing teuthology
There are 2 more ways to install teuthology. Approach with boostrap
script is easier and more convenient while other approach is more
elaborate but manual, document both of them. Don't delete the currently
documented approach because it lets users install teuthology
conveniently in a custom virtual environment. So, keep all three.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2024-05-28 19:02:57 +05:30
Dan Mick
7e64c6386e doc/dev/release-process.rst: note new 'project' arguments
Support added to the release scripts (from ceph-build.git) to
work for ceph-iscsi, so 'project' must be passed to these scripts,
and will appear in the prerelease pathnames.  See also
https://github.com/ceph/ceph-build/pull/2243 and
https://github.com/ceph/ceph-container/pull/2210

Signed-off-by: Dan Mick <dan.mick@redhat.com>
2024-05-22 16:14:16 -07:00
Zac Dover
832358b072 doc/dev: s/to asses/to assess/
s/to asses/to assess/ in doc/deve/developer_guide/dash-devel.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-05-12 12:27:23 +10:00
Zac Dover
5ff768dc73 doc/dev: repair broken image
Replace the ".. graphviz" directive with an ".. image" directive that
correctly displays an image where previously an unusably zoomed-in image
appeared.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-19 13:28:54 +10:00
Zac Dover
221d734760 doc/dev: refine "Concepts" 4 of 3
s/PG's PG logs/PG's logs/

re https://github.com/ceph/ceph/pull/56727#discussion_r1553541922

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-06 14:43:16 +10:00
Zac Dover
512e2dc9d5 doc/dev: refine "Concepts" 3 of 3
Refine the third third of the entries in the section "Concepts" in
doc/dev/peering.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-05 16:43:47 +10:00
Zac Dover
7bb35282da doc/dev: refine "Concepts" 2 of 3
Refine the second third of the entries in the section "Concepts" in
doc/dev/peering.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-04 22:53:43 +10:00
Zac Dover
530b11be24 doc/dev: refine "Concepts"
Refine the text in the first third of the entries in the section
"Concepts" in doc/dev/peering.rst.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-03 12:16:11 +10:00
Zac Dover
158b0403bd doc/dev: update leads list
Remove Joao Luis from the list of component leads.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-04-01 11:17:39 +10:00
Yuri Weinstein
9ad0cefd3d
Merge pull request #56572 from ceph/wip-yuriw-release-process-main
doc: added jammy to the supported distro list for quincy

Reviewed-by: Laura Flores <lflores@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2024-03-30 07:57:37 -07:00
Yuri Weinstein
e06dcdee0c doc: added jammy to the supported distro list for quincy
Signed-off-by: Yuri Weinstein <yweinste@redhat.com>
2024-03-29 08:30:17 -07:00
Zac Dover
57e9427eac doc/dev: update leads list
Update the list of component leads in
doc/dev/developer_guide/essentials.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-29 22:28:35 +10:00
Patrick Donnelly
cddb41a8b4
doc: reconcile release checklist
Updating the releases documentation existed already but that section should be
moved to after dev freeze when the branch is forked.

Fixes: 7b5017913a
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-03-28 18:50:02 -04:00
Patrick Donnelly
7b5017913a
doc: update release checklist
To include note that release notes must be removed after forking the release
branch.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-03-28 17:14:13 -04:00
Matan Breizman
f19765ec08
Merge pull request #56173 from Matan-B/wip-matanb-clone-overlap-doc
doc/dev: osd_internals/snaps.rst: add clone_overlap doc

Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
Reviewed-by: Radosław Zarzyński <rzarzyns@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
Reviewed-by: Greg Farnum <gfarnum@redhat.com>
Reviewed-by: Zac Dover <zac.dover@proton.me>
2024-03-25 12:15:22 +02:00
Matan Breizman
6a7f2b0fda doc/dev: osd_internals/snaps.rst: add clone_overlap doc
snapdir concept was removed in: https://github.com/ceph/ceph/pull/17579

Co-authored-by: Zac Dover <zac.dover@proton.me>
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2024-03-24 12:10:05 +00:00
Patrick Donnelly
719d30d277
doc/dev: update quiesce developer document
To include changes relating to it now being a local lock that prevents mutable
caps.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-03-20 10:56:58 -04:00
Patrick Donnelly
51c9b86bf1
doc: add dev docs for quiesce protocol
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-03-20 10:56:55 -04:00
Patrick Donnelly
a3e541f999
mds: add new inode quiescelock
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-03-20 10:56:54 -04:00
Patrick Donnelly
7060146d6a
doc/dev: update teuthology priority guidance
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2024-03-14 14:59:23 -04:00
Zac Dover
b31e061cc0 doc/glossary: add "Crimson" entry
Add a "Crimson" entry to the glossary.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-09 14:34:06 +10:00
Matan Breizman
3a6d793ef3
Merge pull request #56027 from Matan-B/wip-matanb-crimson-docs-walkthrough
doc/dev/crimson: add Code Walkthroughs

Reviewed-by: Rongqi Sun <sunrongqi@huawei.com>
Reviewed-by: Nitzan Mordechai <nmordech@redhat.com>
2024-03-07 15:29:29 +02:00
Matan Breizman
13a771931b doc/dev/crimson: add Code Walkthroughs
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2024-03-07 09:15:49 +00:00
Zac Dover
51796e80f3 doc/dev: edit teuthology workflow
Improve a couple of sentences in
doc/dev/developer_guide_testing_integration_tests/tests-integration-testing-teutology-workflow.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-03-06 17:15:20 +10:00
Zac Dover
e16ab1df72 doc/dev: edit internals.rst
Edit doc/dev/internals.rst. Make a few sentences pithier.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-29 17:40:57 +10:00
Dan Mick
83fc4eba3e doc/dev/release-process.rst: modify for prerelease mechanism
Signed-off-by: Dan Mick <dmick@redhat.com>
2024-02-28 13:55:11 -08:00
Zac Dover
dfdb5e124a doc/dev: fix spelling in crimson.rst
Repair a confusing sentence in doc/dev/crimson.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2024-02-24 02:21:54 +10:00
Rongqi Sun
8d766c5717 doc/crimson: cleanup duplicate seastore description
Signed-off-by: Rongqi Sun <sunrongqi@huawei.com>
2024-02-22 10:41:43 +08:00
Casey Bodley
2d61900c60
Merge pull request #55499 from cbodley/wip-squid-deprecate-blkin
doc: deprecate blkin tracing

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Samuel Just <sjust@redhat.com>
Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2024-02-08 22:14:54 +00:00
Radoslaw Zarzynski
72be1f4a8a
Merge pull request #55332 from athanatos/sjust/wip-crush-multi-choose
crush: add multistep retry rules

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
Reviewed-by: Greg Farnum <gfarnum@redhat.com>
2024-02-08 22:56:55 +01:00
Casey Bodley
de57824519 doc: deprecate blkin tracing
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2024-02-08 10:56:03 -05:00
Samuel Just
8eb6835396 doc/dev/crush-msr.rst: add developer summary of crush msr
Signed-off-by: Samuel Just <sjust@redhat.com>
2024-02-03 21:00:11 -08:00