Commit Graph

1090 Commits

Author SHA1 Message Date
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
Aaryan Porwal
1639885a9a
doc/dev: mgr/dashboard: Replace broken link
The link to Applitools Eyes's Cypress SDK documentation was pointing to a broken link, replaced that with the officially recognized documentation link

Signed-off-by: Aaryan Porwal <aaryanporwal2233@gmail.com>
2022-07-16 11:26:41 -04:00
Nizamudeen A
990069d31f
Merge pull request #45981 from rhcs-dashboard/box-no-more-ultron
cephadm/box: Rootless podman box implementation

Reviewed-by: Pegonzal <NOT@FOUND>
Reviewed-by: anthonyeleven <NOT@FOUND>
Reviewed-by: melissa-kun-li <NOT@FOUND>
2022-07-14 16:43:49 +05:30
Pere Diaz Bou
6f5ac1274b cephadm/box: Choose between docker or podman with --engine
With ./box.py --engine docker you can specify you want to use docker
instead of podman. With docker box.py command should be run with sudo.

Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-07-13 16:43:00 +02:00
zdover23
edd4e553ef
Merge pull request #47045 from zdover23/wip-doc-2022-07-12-dev-guide-dependabot-GitHub-typo
doc/dev: s/github/GitHub/ in essentials.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-07-12 04:24:38 +10:00
zdover23
24252cb6dd
Merge pull request #47031 from zdover23/wip-doc-2022-07-10-internals-cephfs-delayed-deletion-edit
doc/dev: edit delayed-delete.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-07-12 04:17:44 +10:00
Zac Dover
f7581e05b0 doc/dev: s/github/GitHub/ in essentials.rst
This addresses a typo that Anthony D'Atri pointed out in
PR#47032. It didn't get addressed there, so it's being
addressed here.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-07-12 02:58:18 +10:00
Zac Dover
2711e8de80 doc/dev: add Dependabot section to essentials.rst
This PR adds a section to the Developer Guide chapter
"Essentials" that explains what Dependabot is. This
section is adapted from an email from Ernesto Puerta
to the CLT that was sent on 08 Jul 2022.

Co-authored-by: Ernesto Puerta <epuertat@redhat.com>>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-07-12 01:29:00 +10:00
Zac Dover
c186c5ec6c doc/dev: edit delayed-delete.rst
This PR improves the English in the "CephFS Delayed
Deletion" chapter of the Ceph Internals Guide (which
is stored in the doc/dev/ directory).

There was no pressing need to rewrite this. I just saw
that it could be tightened up, and I had the fifteen
minutes I needed to do it.

Co-author: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-07-11 01:33:51 +10:00
Kefu Chai
cc33ff6fef
Merge pull request #47023 from tchaikov/wip-doc-crimson
doc/dev/crimson: Correct the link to Scylla

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-07-09 08:42:00 +08:00
Kefu Chai
f877a4f3eb doc/dev/crimson: Correct the link to Scylla
the old one brings us to 404.

Signed-off-by: Kefu Chai <tchaikov@gmail.com>
2022-07-09 00:03:16 +08:00
Pere Diaz Bou
d4e6763a19 cephadm/box: Rootless podman box implementation
Even though box is a rootless podman container, there are some
capabilities that are need like SYS_ADMIN, NET_ADMIN and SYS_TIME.

In rootless podman chronyd is not capabable of using adjtimex syscall
so we had to add -x flag to chronyd entrypoint which states it will
not try to call that function.

To test run `./box.py -v cluster start`.

To fix: There are some problems with /dev permissions so osds cannot be
deployed still. `./box.py cluster start --expanded` won't fully work.

Details:
- Dockerfile:
  - Fedora image instead of centos.
  - Tons of basic packages aren't installed, therefore, those are
  explicitly installed.
  - Some container folders are created. It isn't clear/tested whether
  those are needed.
  - .box_container is an empty file to identify if a command is ran on
  containers (see box.py for usage).
- box.py
  - podman-compose is missing some features but it compensates with args
  as --podman-run-args so you can add some extra commands whenever
  podman-compose calls podman run.
  - sudo ./box.py cluster start will exit since it can be dangerous.
  - Added some sed trickeroo to modify chronyd options. (I don't know
  how can I pass OPTIONS to it :P)
 - host.py
   - setup_ssh now is need on every box container.
- util.py
  - rice command printing :3.
  - run multiple commands with a multiline string.

Signed-off-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-07-08 10:02:53 +02:00
Anthony D'Atri
cac497b6eb
Merge pull request #37831 from ybwang0211/put-obj-doc
doc:Add a description of the put obj API
2022-07-07 13:34:55 -07:00
Sridhar Seshasayee
e0b5316171 osd: Set initial mClock QoS params at CONF_DEFAULT level
Create the initial mClock QoS params at CONF_DEFAULT level using
set_val_default(). This allows switching to a custom profile on a
running OSD and to make necessary changes to the desired QoS params.
Note that Switching to ‘custom’ profile and then subsequently changing
the QoS params using “config set osd.n …” will be at a higher level i.e.
at CONF_MON.

But When switching back to a built-in profile, the new values won’t take
effect since CONF_DEFAULT < CONF_MON. For the values to take effect, the
config keys created as part of the ‘custom’ profile must be removed from
the ConfigMonitor store after switching back to a built-in profile.

- Added a couple of standalone tests to exercise the scenario.
- Updated the mClock configuration document and the mClock internal
  documentation with a couple of typos relating to the best effort weights.
- Added new sections to the mClock configuration document outlining the
  steps to switch between the built-in and custom profile and vice-versa.

Fixes: https://tracker.ceph.com/issues/55153
Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2022-07-06 16:15:58 +05:30
Anthony D'Atri
cf1415a2b2
Merge pull request #46919 from jsoref/spelling-docs
doc: Fix many spelling errors
2022-07-03 19:54:55 -07:00
Josh Soref
8abce157f1 doc: Fix many spelling errors
* administrators
* allocated
* allowed
* approximate
* authenticate
* availability
* average
* behavior
* binaries
* bootstrap
* bootstrapping
* capacity
* cephadm
* clients
* combining
* command
* committed
* comparison
* compiled
* consequences
* continues
* convenience
* cookie
* crypto
* dashboard
* deduplication
* defaults
* delivered
* deployment
* describe
* directory
* documentation
* dynamic
* elimination
* entries
* expectancy
* explicit
* explicitly
* exporter
* github
* hard
* healthcheck
* heartbeat
* heavily
* http
* indices
* infrastructure
* inherit
* layout
* lexically
* likelihood
* logarithmic
* manually
* metadata
* minimization
* minimize
* object
* of
* operation
* opportunities
* overwrite
* prioritized
* recipe
* records
* requirements
* restructured
* running
* scalability
* second
* select
* significant
* specify
* subscription
* supported
* synonym
* throttle
* unpinning
* upgraded
* value
* version
* which
* with

Plus some line wrapping and additional edits...

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2022-07-02 23:38:18 -04:00
Zac Dover
893e68a8f5 doc/dev: add IRC registration instructions
This PR adds to the Developer Guide a link to the OFTC's IRC nick
registration instructions.
2022-07-03 01:50:44 +10:00
Zac Dover
326034807d doc/dev: s/the the/the/ in basic-workflow.rst
This PR does exactly what it says: it changes a "the the"
to a "the".

I'd like to thank Josh Soref for bringing this
to my attention.
2022-06-30 21:08:51 +10:00