Commit Graph

1108 Commits

Author SHA1 Message Date
Zac Dover 488ca03690 doc/dev: improve Basic Workflow wording
Make several semantic and syntactic improvements to basic-workflow.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-28 09:27:13 +10:00
Anthony D'Atri e228468ab0
Merge pull request #49005 from CHOKYUJIN/main
doc/dev: fix a typo in deduplication.rst
2022-11-23 08:31:58 -05:00
Kyujin Cho 5a4823e0a2 doc/dev: fix a typo in deduplication.rst
Signed-off-by: Kyujin Cho <bori19960@snu.ac.kr>
2022-11-23 07:24:13 +00:00
zdover23 0528e16f89
Merge pull request #48984 from Matan-B/wip-matanb-unit-debug-lvl
doc/dev/developer_guide/tests-unit-tests: Add unit test caveat

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2022-11-23 00:11:45 +10:00
Matan Breizman 032f8cf601 doc/dev/developer_guide/tests-unit-tests: Add unit test caveat
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2022-11-21 14:56:24 +00:00
Zac Dover 249a4794af doc/dev: link to Dot User's Manual
Add a link to the Dot User's Manual for Graphviz diagrams.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-17 15:35:58 +10:00
Zac Dover 52551dd157 doc/dev: fix graphviz diagram
Fix the formatting of the "Object Store Architecture Overview" graphviz
diagram.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-17 14:45:29 +10:00
Zac Dover 3e31ccefe0 doc/dev: expand "HLD" to "high-level design"
Expand "HLD" to "high-level design" in prim-balancer-design.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-17 13:44:29 +10:00
zdover23 ac0f376f1f
Merge pull request #44565 from ljflores/wip-primary-balancer-documentation
[DNM] doc/dev: explain the primary balancer scope and design

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2022-11-17 13:31:50 +10:00
Nizamudeen A 31a0a4f93b mgr/dashboard: tslint to eslint migration
Fixes: https://tracker.ceph.com/issues/48258
Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-11-14 22:56:21 +05:30
Zac Dover b0df28b61a doc/dev: improve lone sentence
Improve a lone sentence to make it less ambiguous, and at the same
time permit the testing of a script.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-05 03:11:04 +10:00
Zac Dover 6d6de42b6f doc/dev: refine erasure_coding.rst
Improve the readability and clarity of
erasure_coding.rst.

Co-author: Cole Mitchell <cole.mitchell@gmail.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-02 15:04:04 +10:00
Zac Dover 5067f575ad doc/dev: alphabetize EC glossary
Alphabetize the glossary in
doc/dev/osd_internals/erasure_coding.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-01 10:47:52 +10:00
Zac Dover 64f10fc14b doc/dev: improve EC glossary
Improve the clarity and syntax of the text in
doc/dev/osd_internals/erasure_coding.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-31 13:32:24 +10:00
zdover23 301776b0ab
Merge pull request #46089 from myoungwon/wip-dedup-doc
doc/dev: add explanation of how to use deduplication

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
Reviewed-by: Samuel Just <sjust@redhat.com>
2022-10-21 01:54:56 +10:00
Nizamudeen A 5f95db33e9 cmake: bump node version to 14
to update the angular to 13, we need a node version of either 12.20.x or
14.15.x or 16.10.x. But inorder to not break the angular 12 run for now
   we  need to choose the node which works for both 12 and 13. which is
14.15.x. So I went with that node version here.

Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-10-19 13:34:58 +05:30
myoungwon oh 72c695780c doc/dev: add explanation of how to use deduplication
Signed-off-by: Myoungwon Oh <myoungwon.oh@samsung.com>
2022-10-18 15:46:14 +09:00
Zac Dover e55c3b114b doc/dev: add submodule-update link to dev guide
This commit links to the procedure in install/clone-source.rst that
explains how to update submodules.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-13 03:30:42 +10:00
Casey Bodley 4b8ce7b0ba
Merge pull request #46772 from cbodley/wip-rgw-doc-bucket-index
doc/dev/radosgw: start describing the bucket index

Reviewed-by: J. Eric Ivancich <ivancich@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-10-10 11:22:46 -04:00
Radoslaw Zarzynski bf46d3736d
Merge pull request #47458 from rzarzynski/wip-all-kickoff-r
kickoff v18 reef

Reviewed-by: Ilya Dryomov <idryomov@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
Reviewed-by: Guillaume Abrioux <gabrioux@redhat.com>
Reviewed-by: Anthony D'Atri <anthonyeleven@users.noreply.github.com>
Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Laura Flores <lflores@redhat.com>
2022-10-04 22:39:19 +02:00
Ilya Dryomov 21543030b7 doc/dev/release-checklists: mention LIBRBD_VER_MINOR and VERSION
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>
2022-10-04 14:19:25 +02:00
Radoslaw Zarzynski 130704e815 doc, qa/standalone/mon/misc: verify that len(monmap.features.persistent) == 10
Also updates the release checklist.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-10-04 00:27:28 +02:00
Radoslaw Zarzynski 895f7aa991 doc/dev/release-checklists.rst: document vX.0.0 tagging and mark it complete.
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-10-04 00:27:28 +02:00
Casey Bodley 8fdbc9f3da doc/dev/radosgw: describe the bucket index
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2022-09-29 15:33:16 -04:00
Ernesto Puerta 7f41f15745
Merge pull request #47131 from aaryanporwal/vrt-doc-update
doc/dev: mgr/dashboard: Replace broken link

Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2022-09-26 13:22:11 +02:00
Zac Dover b8472b98e2 doc/dev: improve presentation of note (git remote)
This commit corrects the formatting of a note that previously
did not make console output and commands as clear as this commit
makes them.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-09-25 13:41:35 +10:00
Radoslaw Zarzynski 67b7bdbade doc/dev/release-checklists.rst: add section for ceph-build
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:29:57 +00:00
Radoslaw Zarzynski c77ef7cba1 cephadm: update DEFAULT_IMAGE_RELEASE to reef
Also updates the release checklist.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:29:57 +00:00
Radoslaw Zarzynski 4210e0a95e tools/monmaptool: "octopus" to "pacific" for default min_mon_release
We introduced it in eae6c11d72.

Also updates the release checklist.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:29:57 +00:00
Radoslaw Zarzynski a1a673866e doc, test/cli/monmaptool: adjust for the reef monmap features
This bases on e19e99a8a7.

Also updates the release checklist.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:29:57 +00:00
Radoslaw Zarzynski bd14233e1e doc, qa: bring qa/suites/upgrade/quincy-x
Bases on pacific-x.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:29:57 +00:00
Radoslaw Zarzynski 98edc76720 doc/dev/release-checklists.rst: drop outdated check
a9c4d1f1e7 has removed
the last `(X-3)-x-singleton` symlink from `rados/upgrade`.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:29:57 +00:00
Radoslaw Zarzynski 4baea08565 doc, qa: stubs and clean up for reef
- remove upgrades from octopus
- stubs for completing upgrade to reef

Still missing the quincy-x upgrade tests.

`c8e1f4c2b547a152e049af2b529bf415f6d76e59` has moved
the `thrash-old-clients` tests back to the rados suite.
This commit fixes the `release-checklists.rst` accordingly.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:29:47 +00:00
Radoslaw Zarzynski 905540db14 doc, common, mon, qa: Mon-related updates for reef
This bases on two commits:
  * 7bbc92eda3 and
  * 6b22d47863 which seems to be
    a fixup to former one.

In contrast to them, in `OSDMonitor::create_initial()` I updated
also `newmap.require_osd_release` to pacific when
`mon_debug_no_require_reef` and `mon_debug_no_require_quincy`.
Please take have an extra look on that during the review.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 4d34d0db95 doc, mon: update for reef ondisk features
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 9add2a0bbe doc/dev/release-checklists.rst: mark ceph-release-notes is done already
Accomplished in 1c37409ede.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 33946d9724 doc/dev/release-checklists.rst: mark backport-resolve-issue is done already
X-1 == R-1 == Quincy

Accomplished in 96fab936f2.

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 626de03be0 doc, ceph-volume: change to reef
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 9e32ba3e67 doc, include/ceph_features: retire RESERVED_BROKEN
X-3 == R-3 == Octopus

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 35d483af54 doc, include/ceph_features: define FEATURE_SERVER_REEF
I'm mimicking the f954c7e985
but shouldn't the incarnation bit set to `2` instead `3`?

Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 3a12f1d16b doc, mon: add always_on_modules for reef
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski ad7ce46c1e common, doc, include, mds, mon: add feature/release name reef
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 084e3ebfb9 doc/dev/release-checklists.rst: mark cmake and ceph_release are done for reef
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
Radoslaw Zarzynski 07a486132c doc/dev/release-checklists: uncheck everything!
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-09-20 14:26:59 +00:00
nsedrickm 567ee3ae85 doc/dashboard: update documentation with accessibility development practices
Update documentation to include  tools and practice used when developing dashboard features

Fixes: https://tracker.ceph.com/issues/56453
Signed-off-by: nsedrickm <nsedrick101@gmail.com>
2022-09-12 16:54:56 +01:00
David Galloway 4829af891c doc: Update release process doc to accurately reflect current process
Signed-off-by: David Galloway <dgallowa@redhat.com>
2022-08-28 06:40:49 +10:00
David Galloway 325f66d849
Merge pull request #47197 from ceph/boost-docs
doc/dev: Elaborate on boost .deb creation
2022-08-01 14:55:14 -04:00
zdover23 f5857acd68
Merge pull request #47082 from rzarzynski/wip-doc-crimson-cephadm
doc/crimson: document installing crimson with cephadm

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-07-27 00:45:09 +10:00
Radosław Zarzyński 60b8348a84 doc, crimson: document installing crimson with cephadm
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2022-07-26 13:32:19 +00:00
David Galloway 3222485d65 doc/dev: Elaborate on boost .deb creation
Signed-off-by: David Galloway <dgallowa@redhat.com>
2022-07-20 17:08:40 -04:00