Commit Graph

1060 Commits

Author SHA1 Message Date
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
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
Zac Dover
c624a2a8ef doc/index.rst: add link to Dev Guide basic workfl.
This PR adds a link to the "Basic Workflow" section of the
Developer Guide on the landing page of docs.ceph.com.

This PR is meant to improve the documentation for developers
new to Ceph and to guide them to instructions that will allow
them to become full-fledged contributors to the Ceph project
as quickly as possible.

The "Basic Workflow" page of the Developer Guide contains
information that answers almost all of the questions that I had
about contributing to the Ceph project when I was new to it,
and I am finally acting on my long-held conviction that the
"Basic Workflow" page of the Developer Guide should have a more
prominent position in the documentation suite than it has had.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-29 22:57:13 +10:00
zdover23
51bfb222f1
Merge pull request #46857 from zdover23/wip-doc-2022-06-27-pdonnelly-to-venky
doc/dev_guide: change CephFS lead to vshankar

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-28 23:58:39 +10:00
Zac Dover
ff3f8e06ae doc/dev_guide: change CephFS lead to vshankar
This makes an overdue change. Venky Shankar is the
CephFS lead, and has been for a while.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-28 22:24:34 +10:00
Laura Flores
d3f55c6047
Merge pull request #46673 from ljflores/wip-mempool-documentation
doc/dev: improve wording and grammar of mempool page
2022-06-27 14:01:58 -05:00
Laura Flores
6d475d3fa8 doc/dev: improve wording and grammar of mempool page
Signed-off-by: Laura Flores <lflores@redhat.com>
2022-06-27 12:10:26 -05:00
Zac Dover
83b77909e5 doc: remove mention of Sage as current leader
This commit removes mention of Sage as the leader of the
Ceph project in the following files:

dev/developer_guide/essentials.rst
dev/developer_guide/merging.rst
foundation.rst
governance.rst

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-24 17:07:09 +10:00
zdover23
945954681b
Merge pull request #46769 from zdover23/wip-doc-2022-06-21-dev-guide-config-local-env-add-context-note
doc/dev: add context note to dev guide config

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-23 00:03:14 +10:00
Laura Flores
462bc054cb doc/dev/developer_guide: fix small typo
Introduced in 682b806efa.

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-06-21 15:52:39 -05:00
Zac Dover
3e6bcd7f0b doc/dev: add context note to dev guide config
This PR adds a note directing first-time cloners of
their Ceph git forks to make sure to cd into the ceph/
directory before trying to run the "git config" commands.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-22 00:09:05 +10:00
Zac Dover
f5fd158bea doc/dev: s/master/main/ in title
This changes "master" to "main" in a title. If we lived in an
ideal world, this would have been a part of PR#46678.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-16 15:57:16 +10:00
zdover23
87e27c89f5
Merge pull request #46705 from zdover23/wip-doc-2022-06-15--master-to-main-dev-guide-merging
doc/dev_guide: s/master/main in merging.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-16 11:50:31 +10:00
zdover23
5122cf02a2
Merge pull request #46678 from zdover23/wip-doc-2022-06-14-dev-guide-basic-workflow-master-to-main
doc/dev: s/master/main/ in basic workflow

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-16 11:13:05 +10:00
Zac Dover
52da71f0ab doc/dev_guide: s/master/main in merging.rst
This changes the branch name "master" to the branch name
"main" in merging.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-16 07:54:31 +10:00
Matan Breizman
682b806efa doc/dev: Debuggging with gdb
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2022-06-15 17:46:37 +00:00
Zac Dover
f5cfc22445 doc/dev: s/master/main/ in basic workflow
This PR changes "master" to "main" in the
basic_workflow.rst file. I have even changed
"master" to "main" in some terminal output from
several years ago. This isn't historically ac-
curate, of course, but my hope is that this change
will prevent someone in the future from being con-
fused about why an antiquated branch name is ref-
erred to.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-15 08:15:33 +10:00
Zac Dover
728b8f2674 doc/dev: s/master/main/ essentials.rst dev guide
This PR changes all reference to the "master" branch
to references to the "main" branch (because we renamed
"master" to main", and the docs now need to reflect that).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-14 07:48:46 +10:00
Patrick Donnelly
d0b69a3cdf
Merge PR #46421 into main
* refs/pull/46421/head:
	doc/dev: move option -R to a different section of doc

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
2022-06-09 20:12:49 -04:00
Rishabh Dave
bbe71266de doc/dev: move option -R to a different section of doc
It's incorrect to pass option "-R fail" to the teuthology-suite command
meant for triggering tests for first time. teuthology-suite command will
fail if "-R" is passed without "-r". Therefore, move this option and its
description from the section meant for triggering tests for first time
to the section dedicated to re-running of tests.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2022-06-09 00:55:51 +05:30
Adam King
7c6c715aa5 mgr/cephadm: some master -> main cleanup
Signed-off-by: Adam King <adking@redhat.com>
2022-06-06 15:18:08 -04:00
Patrick Donnelly
9e5ff96560
doc/dev/developer_guide/testing_integration_tests: document how to test custom kernels
Fixes: https://tracker.ceph.com/issues/55530
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-06-03 13:52:31 -04:00
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