Commit Graph

921 Commits

Author SHA1 Message Date
Kefu Chai
ec5b56c98f doc/dev/crimson: add a missing not
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-14 00:00:22 +08:00
Sebastian Wagner
507ee67848
Merge pull request #42209 from sebastian-philipp/doc-dev-cephadm-define-vars
doc/dev/cephadm: Define variables

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-07-13 16:06:01 +02:00
Zac Dover
1443d486b9 doc/dev: add IRC information to dev guide
In days of yore, the Developer Guide linked to the
IRC page at ceph.io. After the 2021 rewriting of
ceph.io, a new era began, and that page was no
longer easily accessible (it could still be found
at old.ceph.com, but this was deprecated).

Anyway, that IRC information should be included in
the docs. This PR makes sure that the IRC
information is included in the docs.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-07-10 07:32:45 +10:00
Sebastian Wagner
9d30b96f04
doc/dev/cephadm: Define variables
Fixes: https://tracker.ceph.com/issues/47142
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-07-07 11:47:59 +02:00
Kefu Chai
c820aeafbc doc/dev/crimson: add a section for metrics
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-07 15:44:35 +08:00
Lorenz Bausch
238c2bc52d
doc/dev/crimson/osd: fix typo
Signed-off-by: Lorenz Bausch <info@lorenzbausch.de>
2021-07-05 17:13:49 +02:00
Alfonso Martínez
5c03b49c4d mgr/dashboard: run cephadm-backend e2e tests with KCLI
Fixes: https://tracker.ceph.com/issues/51300
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
2021-07-02 10:08:49 +02:00
Sage Weil
4537b14b34 Merge PR #41574 into master
* refs/pull/41574/head:
	qa/tasks/vstart_runner: add LocalCluster.run
	qa/tasks/cephfs/test_nfs: fiddle with sudo
	mgr/nfs/export: some cleanup, minor refactoring
	mgr/nfs/cluster: remove unused @cluster_setter
	nfs/mgr: fix help message case
	doc/cephfs/fs-nfs-export: add note about export update behavior
	mgr/nfs: move user create/delete into helper
	mgr/nfs: refactor _delete_user helper
	mgr/nfs: refactor create_export_from_dict() helper
	mgr/nfs: keep 'nfs export get' around for backward-compat
	mgr/nfs: rename method
	qa/tasks/cephfs/test_nfs: test new export via apply
	doc/cephfs/fs-nfs-export: be consistent with cluster_id and _ vs -
	mgr/nfs: addr -> client_addr for 'nfs export create ...'
	mgr/nfs: fix tests
	mgr/nfs: 'nfs export get' -> 'nfs export info'
	mgr/nfs: binding -> pseudo_path
	mgr/nfs: more revisions based on review
	mgr/nfs: adjust NFSExceptoin errno arg
	doc/cephfs: update 'nfs export {get,apply}' docs
	mgr/nfs: merge FSExport back into ExportMgr
	doc/radosgw/nfs: document mgr/nfs way to add/remove rgw exports
	mgr/nfs: merge 'nfs export {update,import}' -> 'nfs export apply'
	mgr/nfs: test export creation and list
	mgr/nfs: test export_update (+ fixes)
	mgr/nfs: test Export.validate(); several fixes
	mgr/nfs: test that export <-> block+dict conversions go both ways
	mgr/nfs: clean up test a bit
	mgr/nfs/export: fix export validation
	mgr/nfs/export: fix tests
	mgr/nfs: handle option addr/client block in create_export()
	mgr/nfs: allow multiple addrs for new exports
	mgr/nfs: fix/finish rgw export
	mgr/nfs/module: clusterid -> cluster_id
	mgr/nfs/export: fix export_update_1 to type check
	mgr/nfs/cluster: fix type error
	mgr/nfs/export: wrap long lines
	mgr/nfs: ExportMgr._delete_export only works for cephfs for now
	mgr/nfs: Remove pool_ns from NFSCluster
	mgr/nfs: Remove ExportMgr.rados_namespace
	mgr/nfs: flake8
	mgr/nfs: Add type checking
	mgr/nfs: Add __eq__ method to Export
	mgr/nfs: Add some compatibility to mgr/dashboard
	mgr/nfs: Fix whitespace handling
	mgr/nfs: Copy unit tests from mgr/dashboard
	mgr/nfs: partially implement rgw export support
	mgr/nfs: abstract FSAL; add RGWFSAL
	mgr/nfs: refactor to merge 'update' and 'import' code
	mgr/nfs: add 'nfs export import' command
	mgr/nfs: refactor 'nfs export update' and export validation
	mgr/nfs: fix _fetch_export to distinguish between clusters
	mgr/nfs: move export ganesha conf translation into caller
	mgr/nfs: name nfs cephfs client key 'nfs.{cluster_id}.{export_id}'
	mgr/nfs: add --addr to 'nfs export create'
	mgr/nfs: add --squash to 'nfs export create'
	mgr/nfs/export_utils: include false but non-None items in config
	vstart.sh: enable nfs module
	mgr/cephadm: nfs: drop attr_expiration_time from top-level config
	mgr/cephadm: remove Dir_Chunk = 0

Reviewed-by: Michael Fritch <mfritch@suse.com>
2021-06-26 10:41:27 -04:00
Kefu Chai
c0239b798a crimson/osd: document fsm of crimson osd
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-06-24 16:07:29 +08:00
Sage Weil
2400937ce2 mgr/nfs: 'nfs export get' -> 'nfs export info'
This is a breaking change, but aligns the CLI verbs with the rest of ceph.

Signed-off-by: Sage Weil <sage@newdream.net>
2021-06-21 14:13:15 -04:00
Kefu Chai
a234acb1d2
Merge pull request #41920 from ljflores/patch-1
doc: fixed a small typo in Perf Counters documentation

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-06-19 16:51:58 +08:00
Laura Flores
2ae0734dba doc: fixed a small typo in Perf Counters documentation
There is a small typo in the Perf Counters documentation. Gauge was spelled incorrectly.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-06-18 18:14:45 +00:00
Sebastian Wagner
848fd9dc83
Merge pull request #41694 from jmolmo/kcli_cephadm_doc
doc: Add kcli utilization for development environments

Reviewed-by: Sebastian Wagner <sewagner@redhat.com>
2021-06-17 11:37:26 +02:00
Laura Flores
13695c1a92
doc/dev: should be ./run-make-check.sh
Updating the initial pull request. The smoke test line should read "./run-make-check.sh" instead of "make && ctest -j12".

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-06-14 11:23:54 -05:00
Laura Flores
5bbed1f6bd
doc/dev: update testing.rst to say ninja
The current version of Ceph uses "ninja" rather than "make," so the testing documentation needs to be updated.

Signed-off-by: Laura Flores <lflores@redhat.com>
2021-06-14 11:01:15 -05:00
Sebastian Wagner
3afc13278e
Merge pull request #41693 from sebastian-philipp/cephadm-devenv-bootstrap-mount
doc/dev/cephadm: cephadm bootstrap --shared_ceph_folder

Reviewed-by: Adam King <adking@redhat.com>
Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-06-10 12:13:40 +02:00
Kefu Chai
13666263ab
Merge pull request #41718 from tchaikov/wip-doc-ci-deps
doc/dev: add continuous-integration

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2021-06-09 16:36:01 +08:00
Kefu Chai
3729788e97 doc/dev: add continuous-integration
for noting down the architecture of our CI. and how we prepare
some of the build dependencies.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-06-09 16:23:44 +08:00
Zac Dover
298b446c35 doc/dev: s/reposotory/repository/ (really)
This corrects the heinous misspelling described in the
substitution expression in the title. This misspelling is
all the more egregious because it appears in a title, and
therefore would be used to create links if it had not been
caught.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-06-09 01:57:13 +10:00
Sebastian Wagner
5f1aa05563 doc/dev/cephadm: cephadm bootstrap --shared_ceph_folder
Signed-off-by: Sebastian Wagner <sewagner@redhat.com>
2021-06-08 12:16:49 +02:00
Juan Miguel Olmo Martínez
3b82624e0c
doc: Add kcli utilization for development environments
How to use kcli to create ceph clusters (cephadm) and made easy code changes in
manager modules.

Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2021-06-04 13:09:24 +02:00
Kefu Chai
c4d5121305
Merge pull request #41686 from t-msn/update-trace-doc
doc/dev: update how to use lttng/blkin trace

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-06-04 12:30:23 +08:00
Misono Tomohiro
53a68e27bb doc/dev: update how to use lttng/blkin trace
Update doc to reflect current status.

Signed-off-by: Misono Tomohiro <misono.tomohiro@jp.fujitsu.com>
2021-06-04 11:41:29 +09:00
Kefu Chai
306a48ce72 doc/dev/crimson: update link to scylladb debugging tips
the old one is not reachable anymore.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-06-02 17:11:10 +08:00
Ernesto Puerta
1b312db505
Merge pull request #41395 from rhcs-dashboard/fix-50855-master
mgr/dashboard: API Version changes do not apply to pre-defined methods (list, create etc.)

Reviewed-by: Aashish Sharma <aasharma@redhat.com>
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>
2021-06-01 16:28:48 +02:00
Aashish Sharma
bb52092cd3 mgr/dashboard: API Version changes doesnt appy to pre-defined methods(list, create etc.)
Methods like list(), create(), get() etc doesn't get applied the version.Also for the endpoints that get the version changed, the docs and the request header has still the version v1.0+ in them. So with the version reduced it gives 415 error when trying to make the request. This PR fixes this issue.

Fixes: https://tracker.ceph.com/issues/50855
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
2021-05-26 10:30:33 +05:30
Kefu Chai
26d7a73564 doc/dev: no more "import absolute_import"
as we've migrated to python3, no need to use

from __future__ import absolute_import

for accessing absolute import

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-24 12:27:40 +08:00
Kefu Chai
29d311a54c doc/dev/msgr2: add state machine diagrams
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-05-18 20:30:05 +08:00
Zac Dover
f904078344 doc/crimson: s/Crismon/Crimson/
This misspelling occurred twice in this
document.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2021-04-28 23:26:09 +10:00
Venky Shankar
8343471a0f
Merge pull request #40933 from vshankar/wip-50266
cephfs-mirror: sanitize `daemons status` JSON

Reviewed-by: Venky Shankar <vshankar@redhat.com>
2021-04-27 12:22:37 +05:30
Kefu Chai
5249e5fe03 doc/dev/osd_internals/mclock_wpq_cmp_study: fix a typo
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-26 21:01:44 +08:00
Kefu Chai
4e27388ba7 doc/rados/configuration: reference options using :confval:
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-04-26 21:01:44 +08:00
Sridhar Seshasayee
f417ebf0ff doc/dev: Add internal documentation for mclock scheduler
The document details the refinements to mclock scheduler and presents the
results of a comparison study performed between the mclock scheduler and
the WPQ scheduler.

Signed-off-by: Sridhar Seshasayee <sseshasa@redhat.com>
2021-04-21 19:04:28 +05:30
Venky Shankar
3c600928c2 doc: adjust daemon status section with changed JSON
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-20 21:18:54 -04:00
Venky Shankar
bfaf5e9929 doc: detail fs snapshot mirror daemon status mgr command
@leseb noticed that this interface did not have any documentation. Thanks!

Fixes: http://tracker.ceph.com/issues/50229
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-08 15:13:58 +05:30
Venky Shankar
9d60ec8ceb doc: s/<fs>/<fs_name>/g
Signed-off-by: Venky Shankar <vshankar@redhat.com>
2021-04-08 15:13:58 +05:30
Patrick Donnelly
551134a935
doc: update some docs still referring to make
We use ninja now.

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2021-04-06 08:11:36 -07:00
Kefu Chai
ba285cbc98 doc/dev/cephadm: quote command with backquotes
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-28 23:29:56 +08:00
Radoslaw Zarzynski
1b1c088dba doc/crimson: improve wording about the pipeline / wait states.
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2021-03-23 16:49:55 +01:00
zdover23
fe76f556cf
Merge pull request #40295 from tchaikov/wip-doc-links
doc: fix broken links

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-03-23 01:43:15 +10:00
Kefu Chai
24d34d7b83
Merge pull request #40282 from rzarzynski/wip-crimson-doc-waitstates
doc/crimson: document wait states

Reviewed-by: Kefu Chai <kchai@redhat.com>
2021-03-22 18:40:16 +08:00
Radoslaw Zarzynski
7110bbed12 doc/crimson: document wait states.
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2021-03-22 11:21:23 +01:00
Kefu Chai
1dbc932195 doc: use :ref: instead relative path for links
path is fragile when we move the file around, but link is more stable.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-22 01:41:53 +08:00
Kefu Chai
f73716402b
Merge pull request #40102 from tchaikov/wip-doc-fixes
doc: theme, cmake and formatting related fixes

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2021-03-21 22:04:02 +08:00
Deepika Upadhyay
6fd0165610 doc/dev/developer_guide: add jaegertracing intial developer documentation
Signed-off-by: Deepika Upadhyay <dupadhya@redhat.com>
2021-03-18 16:59:44 +05:30
Jonas Jelten
76a67d7753 doc: update osd-class-path error messages
the return value is "95 Operation not supported"

Signed-off-by: Jonas Jelten <jj@sft.lol>
2021-03-16 16:16:02 +01:00
Kefu Chai
26b3e73f33 doc/dev: remove triple ":"
`::` would suffice

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00
Kefu Chai
cf816cfdbe doc/dev: specify lexer of pygment
for better rendering result

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00
Kefu Chai
cb32dc8027 doc/dev: start list after an empty line
otherwise sphinx takes it as a definition list

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00
Kefu Chai
8d0080eef6 doc/dev: update to adapt the cmake+ninja transition
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-16 20:22:12 +08:00