Commit Graph

7539 Commits

Author SHA1 Message Date
Ernesto Puerta
b383a1fdf3
Merge pull request #38284 from rhcs-dashboard/48355-read-pwd-from-file
mgr/dashboard: CLI commands: read passwords from file

Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Juan Miguel Olmo <jolmomar@redhat.com>
Reviewed-by: knortema <knortema@redhat.com>
2020-12-17 17:36:42 +01:00
Ernesto Puerta
65b11e931e
Merge pull request #38473 from votdev/issue_48474_health_check
mgr/dashboard: Display a warning message in Dashboard when debug mode is enabled

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Tatjana Dehler <tdehler@suse.com>
2020-12-17 17:35:01 +01:00
Kefu Chai
8bcfdad3a0
Merge pull request #38599 from tchaikov/wip-47977
ceph.in: try harder if asok path does not exist

Reviewed-by: Mykola Golub <mgolub@suse.com>
Reviewed-by: Xiubo Li <xiubli@redhat.com>
2020-12-18 00:03:51 +08:00
Alfonso Martínez
5d7ee7c1f0 mgr/dashboard: CLI commands: read passwords from file
Fixes: https://tracker.ceph.com/issues/48355

Signed-off-by: Alfonso Martínez <almartin@redhat.com>
Signed-off-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
2020-12-17 08:36:57 +01:00
zdover23
ac439c7244
Merge pull request #38450 from zdover23/wip-doc-dev-guide-basic-workflow-auto-pr-valid-dec-2020-1
doc/dev: update auto pr validation section

Reviewed-by: Josh Durgin <jdurgin@redat.com>
Reviewed-by: Nathan Cutler <ncutler@suse.com>
2020-12-17 11:28:21 +10:00
Neha Ojha
332f32dcff doc/releases/octopus.rst: add release notes for 15.2.8
Signed-off-by: Neha Ojha <nojha@redhat.com>
2020-12-16 18:31:31 +00:00
Neha Ojha
e4b61aa71e doc/releases/nautilus.rst: add release notes for 14.2.16
Signed-off-by: Neha Ojha <nojha@redhat.com>
2020-12-16 17:33:40 +00:00
zdover23
9838e03b01
Merge pull request #38580 from anthonyeleven/anthonyeleven/48301-underscores
doc: standardize config option names with interstitial underscores

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-17 01:11:53 +10:00
Zac Dover
0eaf991bd8 doc/dev: update auto pr validation section
This commit updates the "Automated PR Validation"
section of the "Basic Workflow" page in the
Developer Guide. This is part of a project that
aims to clean all of the sentences currently extant
in the Dev Guide, prior to a slight reorganization
of that guide for the sake of clarity and simplicity.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-17 00:32:58 +10:00
Volker Theile
a1aa760acf mgr/dashboard: Display a warning message in Dashboard when debug mode is enabled
Set a health check warning if debug mode is enabled.

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

Signed-off-by: Volker Theile <vtheile@suse.com>
2020-12-16 14:13:44 +01:00
Nizamudeen A
3f50b05e25 mgr/dashboard: Updating the docs regarding the user lockout
Fixes: https://tracker.ceph.com/issues/40914
Signed-off-by: Nizamudeen A <nia@redhat.com>
2020-12-16 16:14:47 +05:30
lixiaoy1
89b8e30bc4 doc: rename RBD persistent cache
Rename peristent cache to persistent read-only cache.

Signed-off-by: Li, Xiaoyan <xiaoyan.li@intel.com>
2020-12-16 04:52:21 -05:00
Anthony D'Atri
21d68cf137 doc: standardize config option names to use interstitial underscores
Ceph config option names may use spaces, underscores, or by one reference hyphens
as interstitial separators. Most usage within the doc tree uses underscores,
though example conf files and especially structured lists of options mostly
use spaces. Mostly. Underscores help differentiate the config names from
surrounding text, and moreover facilitate scripting, grep, awk, etc and match
their form in src/common/options.cc.

This PR conforms these occurrences of option names to use interstitial underscores instead of spaces.

Fixes: https://tracker.ceph.com/issues/48301
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-15 13:55:38 -08:00
Ernesto Puerta
ba650bf561
Merge pull request #37937 from p-se/cd-alternative-grafana-fe-url
mgr/dashboard: enable different URL for users of browser to Grafana

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-12-15 19:47:30 +01:00
Kefu Chai
c17c6c66eb ceph-conf: add --pid option
this change partially reverts 1f09b19665,
and add "--pid" option, so user can specify the pid to override the $pid
meta variable when expanding options.

Fixes: https://tracker.ceph.com/issues/47977
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-16 02:01:12 +08:00
Ernesto Puerta
9a71e9e363
Merge pull request #36715 from rhcs-dashboard/fix-39128-master
mgr/dashboard: new generic HTTP error page component

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Nizamudeen A <nia@redhat.com>
Reviewed-by: Volker Theile <vtheile@suse.com>
2020-12-15 18:59:14 +01:00
Patrick Donnelly
0376ce721a
doc: add documentation for new multifs feature
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2020-12-15 06:46:49 -08:00
Kefu Chai
c03415caf1 doc/dev/crimson: quote inline codeblock using "``"
backquote is used for quoting italic typed text.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-15 17:50:43 +08:00
Kefu Chai
370f04fa82 doc/dev/crimson: highlight code blocks using C++ lexer
also remove redundant ":", normally "::" would suffice to start a
codeblock.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-15 17:48:02 +08:00
Yuval Lifshitz
f5dd15e021 rgw/lua: allow for multiple RGWs to install packages in the same host
each RGW will install the luarocks packages in its own directory

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-12-15 10:27:42 +02:00
Radoslaw Zarzynski
d788b6b5ac doc/dev/crimson: exemplify errorator usage in error-handling.rst
Signed-off-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2020-12-14 16:28:01 +01:00
Kefu Chai
219c8d177b doc/dev/crimson: add error-handling.rst
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-14 16:28:01 +01:00
zdover23
851d10ed35
Merge pull request #37047 from sebastian-philipp/doc-cephadm-rm-host
doc/cephadm: Add remove host to operations

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-14 15:54:49 +10:00
Yuval Lifshitz
c2cb7b8a76 rgw/notification: automatically delete topics associated with a bucket
when a bucket is deleted

fixes: https://tracker.ceph.com/issues/46128

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-12-13 14:32:11 +02:00
Sebastian Wagner
cd97c73089
Merge pull request #38547 from varshar16/wip-kubejacker-updates
script/kubejacker: Add python_common library and misc updates

Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-12-12 12:55:50 +01:00
Kefu Chai
db3516d8f8
Merge pull request #38544 from tchaikov/wip-build-doc-auto-build
admin/build-doc: add livehtml target

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
2020-12-12 08:05:24 +08:00
Varsha Rao
c453493280 doc/dev/kubernetes: Add minikube tips and misc updates
Signed-off-by: Varsha Rao <varao@redhat.com>
2020-12-11 23:23:28 +05:30
Kefu Chai
34f74e8a37 admin/build-doc: add livehtml target
it is time-consuming to rebuild the python bindings every time we
rebuild the document, it'd be ideal if we could just build document.

in this change, in addition to "html" and "doc", "livehtml" argument is
now supported by build-doc script, so one can just use

./build-doc livehtml

to build and start a web server. whenever a change in doc/ is detected,
the document is rebuilt. for more details, see
https://pypi.org/project/sphinx-autobuild/

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-11 22:30:56 +08:00
Aashish Sharma
13900cf6ae mgr/dashboard: new generic HTTP error page component
Added a generic Error component for HTTP Errors such as 404,403,501

Fixes:https://tracker.ceph.com/issues/39128
Signed-off-by: Aashish Sharma <aasharma@redhat.com>
2020-12-11 19:19:38 +05:30
Kefu Chai
864d7ffc2a
Merge pull request #38486 from Rjerk/fix-mds-conf-typo
doc: fix a couple of typos

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-12-11 20:46:24 +08:00
胡玮文
4dd26d651f doc: Fixes a typo in mon_dns_srv_name.
Signed-off-by: 胡玮文 <huww98@outlook.com>
2020-12-11 17:16:21 +08:00
Josh Durgin
7f1f5673c7
Merge pull request #35314 from zdover23/wip-doc-elasticsearch-7-warning
doc/radosgw: Note that ElasticSearch 7 doesn't work. Just 6 and lower.

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2020-12-10 18:54:51 -08:00
Kefu Chai
b2d0ea1d5b
Merge pull request #38431 from tchaikov/wip-rtd-doc
pybind,doc: build stub using cython and build API doc with RTD

Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Jason Dillaman <dillaman@hotmail.com>
Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-12-10 12:03:21 +08:00
pcuzner
bb462f2cb8
Merge branch 'master' into cephadm-exporter-docs 2020-12-10 09:39:45 +13:00
Paul Cuzner
ba485f2472 doc/dev/cephadm: update index links
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-10 09:37:13 +13:00
Sebastian Wagner
7d7e6ad30d
Merge pull request #37519 from pcuzner/docs-cephadm-config-drift
doc/dev/cephadm: high level design for a compliance check feature

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-09 13:32:27 +01:00
Sebastian Wagner
453000af19 doc/cephadm: Add remove host to operations
Co-authored-by: Alexandra Settle <asettle@suse.com>
Co-authored-by: Kefu Chai <tchaikov@gmail.com>
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-12-09 12:34:16 +01:00
Kefu Chai
15affa5bca
Merge pull request #38457 from tchaikov/wip-mon-scrub-interval
mon: use TYPE_SEC for mon_scrub_interval

Reviewed-by: Joao Eduardo Luis <joao@suse.com>
Reviewed-by: Brad Hubbard <bhubbard@redhat.com>
2020-12-09 16:45:00 +08:00
Liu Lan
e29a3c7c2d doc: fix a couple of typos
Signed-off-by: Liu Lan <liulan_yewu@cmss.chinamobile.com>
2020-12-09 09:05:27 +08:00
Neha Ojha
55c0f16752
Merge pull request #38418 from anthonyeleven/anthonyeleven/clarify-op-priorities
doc: clarify osd recovery op priority and fix a couple of typos

Reviewed-by: David Zafman <dzafman@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-12-08 13:14:58 -08:00
Anthony D'Atri
bc41ae3a88 doc: clarify osd recovery op priority and fix a couple of typos
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-12-07 21:01:36 -08:00
zdover23
269c555a04
Merge pull request #38356 from icepic/patch-2
doc/radosgw: Fix misspelled word in index.rst

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-07 08:30:28 +10:00
Kefu Chai
fc82b0ae8e mon: use TYPE_SEC for mon_scrub_interval
* common/legacy_config_opts.h: drop mon_scrub_interval from legacy
  settings. as this option is not in critical path. so we can afford
  the overhead of look its value up in the map.
* common/options.cc: change mon_scrub_interval's type from TYPE_INT
  to TYPE_SECS, so we can use human friendly representations like
  "3 days" when specifying its value
* mon/Monitor.cc: adapt to the changes above.
* doc/rados: update the doc for "mon scrub interval" accordingly

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-06 16:30:45 +08:00
Matt Benjamin
9264e6a32f
Merge pull request #37543 from ianwatsonrh/master
docs: With the addition of STS x-amz-security-token is now supported
2020-12-05 09:46:09 -05:00
Kefu Chai
670efdd3c7 doc: build api docs with Read the Docs
since we are able to build the python bindings using the stub
implementation of C binding, let's enable the API docs build.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-05 22:09:22 +08:00
Kefu Chai
4ae8abbe21
Merge pull request #37314 from ifed01/wip-ifed-faster-rm-p1
osd: optimize PG removal (part1)

Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Adam Kupczyk <akupczyk@redhat.com>
2020-12-05 21:50:30 +08:00
Matt Benjamin
3dde92561f
Merge pull request #36384 from linuxbox2/wip-doc-ippolicy
rgw:doc: document support for (Not)IpAddress in S3 policy
2020-12-04 17:37:58 -05:00
Igor Fedotov
ba9b547120 doc/osd-config-ref: adjust default value for osd_delete_sleep_hybrid
Signed-off-by: Igor Fedotov <ifedotov@suse.com>
2020-12-05 00:09:52 +03:00
Patrick Seidensal
676f82923d mgr/dashboard: enable different URL for users of browser to Grafana
Fixes: https://tracker.ceph.com/issues/47386

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-12-04 17:08:29 +01:00
Zac Dover
d7f88e3ce4 doc/governance.rst - updating CLT list
This PR removes the following people from the
CLT. They've left the CLT:
* Lenz Grimmer
* Alfredo Deza
* Zack Cerza

This commit also adds:
* Ernesto Puerta

Fixes: https://tracker.ceph.com/issues/48436
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-12-04 23:31:45 +10:00
Yuval Lifshitz
6ef3e52a3f rgw/lua: support packages via luarocks
Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-12-04 09:55:56 +02:00
Janne Johansson
c35a56e1fc doc/radosgw: fix a typo in index.rst
miniscule spelling nit.

Signed-off-by: Janne Johansson <icepic.dz@gmail.com>
2020-12-04 13:38:00 +08:00
Paul Cuzner
f2791c0e26 doc/dev/cephadm: Add link to the index
Adds a link to the index for the compliance-check doc

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:58:06 +13:00
Paul Cuzner
1facc5e9a7 doc/dev/cephadm: Updates following feedback
Minor grammatical and formatting changes

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:56:20 +13:00
Paul Cuzner
7168cbf052 doc: moved design doc under doc/dev
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-04 13:56:20 +13:00
Paul Cuzner
92fa97347c doc: Update drivegroup spec examples
The examples currently miss the document separator, so a
copy/paste will result in only a single doc being parsed (the
last one!)

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-03 16:23:26 +13:00
Josh Durgin
f535d20949
Merge pull request #38289 from smithfarm/wip-rn-hotfix-octo
doc: add release notes for Octopus 15.2.7

Reviewed-by: J. Eric Ivancich <ivancich@redhat.com>
Reviewed-by: Casey Bodley <cbodley@redhat.com>
Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
2020-12-02 16:51:53 -08:00
Paul Cuzner
875c94fd95 doc/dev/cephadm: minor updates to address PR feedback
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-12-03 12:17:37 +13:00
Jason Dillaman
34c6ea7d4c
Merge pull request #38383 from shellwedance/doc_fix_typos
doc/rbd: fix doc typos

Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Jason Dillaman <dillaman@redhat.com>
2020-12-02 09:34:38 -05:00
Nathan Cutler
8ee33f0ace doc/releases: add recent releases to timeline
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2020-12-02 13:45:39 +01:00
Matt Benjamin
f89d98320e
Merge pull request #38136 from yuvalif/wip-yuval-fix-47904
rgw/notification: trigger notifications on changes from any user
2020-12-02 07:43:12 -05:00
Matt Benjamin
146a8e5543
Merge pull request #38171 from yuvalif/wip-yuval-fix-46296
rgw/notification: support GetTopicAttributes API
2020-12-02 07:42:03 -05:00
Taeuk Kim
5b11688da1 doc/rbd: fix doc typos
fix typos in Ceph iSCSI manual

Signed-off-by: Taeuk Kim <taeuk_kim@tmax.co.kr>
2020-12-02 15:07:34 +09:00
Yuval Lifshitz
658993efc1 rgw/notification: trigger notifications on changes from any user
any user authorized to make changes to a bucket may trigger
notifications defined on that bucket.
manual test procedure of the fix is described here:
https://gist.github.com/yuvalif/39c183aa0f74d286ecef7844268817df

fixes: https://tracker.ceph.com/issues/47904

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-12-01 20:23:43 +02:00
zdover23
c0f1c56cf5
Merge pull request #38311 from anthonyeleven/anthonyeleven/fix-typo
doc/rados/operations: typo in stretch-mode.rst

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-02 04:03:26 +10:00
Kefu Chai
3a2822ed75
Merge pull request #38366 from tchaikov/wip-templated-doc
doc: drop edit-on-github extension and templatize page.html further

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2020-12-02 00:57:26 +08:00
Kefu Chai
7a62303b57 doc: check "release" context variable for #dev-warning
if $release is "dev", then the release being built is not a stable
version.

drop ceph.js, as the web page is generated at build time.

since the last user of "releases.json" is gone, now we can
drop the hooks preparing "releases.json" in conf.py as well.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-02 00:25:16 +08:00
Kefu Chai
448800d300 doc: disable eol-warning based on "is_release_eol"
enable/disable #eol-warning based on "is_release_eol" context variable.
this allows us to generate a more static web page. and pave the road to
a releases.json-free doc build process.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-02 00:25:16 +08:00
Kefu Chai
7edd8dd0d0 doc: add docubetter link back
check if the release being built is EOL when building the document, so
no need to use javascript to read releases.json anymore.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-02 00:25:16 +08:00
Patrick Donnelly
96bc10822b
Merge PR #38365 into master
* refs/pull/38365/head:
	doc/mds: fix the default value for mds_dir_max_commit_size

Reviewed-by: Rishabh Dave <ridave@redhat.com>
Reviewed-by: Jos Collin <jcollin@redhat.com>
2020-12-01 06:56:38 -08:00
Kefu Chai
a6eb62e107
Merge pull request #38218 from aaugustinas/patch-1
doc: Remove duplicate sentence in sync module documentation

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-12-01 22:38:43 +08:00
Kefu Chai
94488f911a doc/conf: find the latest stable release in releases.yml
instead of hardwiring the "|stable-release|" to "octopus" use the latest
release name found in 'doc/releases/releases.yml'

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-01 15:41:45 +08:00
Kefu Chai
beb218c41d doc/conf: read version and release from src/ceph_release
instead of hardwiring them to 'dev' and 'dev', use the src/ceph_release
as the source of truth.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-01 15:41:45 +08:00
Kefu Chai
be26c566e5 doc: remove edit_on_github sphinx extension
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-12-01 15:41:45 +08:00
Xiubo Li
51e4c7caf2 doc/mds: fix the default value for mds_dir_max_commit_size
The default value has changed to 10MB.

Signed-off-by: Xiubo Li <xiubli@redhat.com>
2020-12-01 14:42:43 +08:00
Anthony D'Atri
f7ead5e83a doc/rados/operations: typo in stretch-mode.rst 2020-11-30 15:31:15 -08:00
Kefu Chai
c722452c4d
Merge pull request #38203 from tchaikov/wip-doc-build-releases.yaml
doc/conf: generate releases.json in conf.py and cleanups

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
2020-12-01 07:13:34 +08:00
Patrick Donnelly
71a0c64000
Merge PR #38248 into master
* refs/pull/38248/head:
	doc: Adding missing Ceph Foundation board members

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-11-30 14:02:36 -08:00
Paul Cuzner
fef0e12bf3 doc/dev/cephadm: document the cephadm exporter design
Development document defining the goals, requirements,
design and implementation details for the exporter mode
of the cephadm 'binary'

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
2020-11-30 19:30:32 +13:00
Kefu Chai
592920070b
Merge pull request #38078 from zdover23/wip-doc-docs-style-guide-prompts-nov-2020
doc/start: update prompts in documenting-ceph.rst

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-27 14:47:06 +08:00
Kefu Chai
09f1e7ffff
Merge pull request #38241 from Rethan/update_url_from_master_to_lastest
doc/dev: use http://docs.ceph.com/en/latest/ instead of /docs/master/ for docs

Reviewed-by: Laura Paduano <lpaduano@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
Reviewed-by: Willem Jan Withagen <wjw@digiware.nl>
2020-11-27 14:00:12 +08:00
Kefu Chai
48515e9b8d
Merge pull request #38265 from Rethan/doc-prometheus-config-key
doc/mgr/prometheus: update 'config-key set' to 'config set' for consistency

Reviewed-by: Mykola Golub <mgolub@suse.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-26 19:52:10 +08:00
haoyixing
f5fd172559 doc/mgr/prometheus: update 'config-key set' to 'config set' for consistency
Elsewere in mgr/prometheus use the 'config set' way, so update the only 'config-key set'
to make it consistent.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2020-11-26 14:23:56 +08:00
Nathan Cutler
f637a4f99d doc: add release notes for Octopus 15.2.7
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2020-11-25 19:45:42 +01:00
zdover23
6497da98d7
Merge pull request #38195 from anthonyeleven/anthonyeleven/docs-14730
doc/rados/troubleshooting: description of upgrade procedure - stopping/starting OSDs

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-26 01:27:06 +10:00
zdover23
2d25182893
Merge pull request #38091 from anthonyeleven/anthonyeleven/docs-46367
doc/dev/developer_guide: verb disagreement on "Testing: Unit Tests" page

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-26 00:19:38 +10:00
zdover23
ea57d5d7ee
Merge pull request #38143 from anthonyeleven/anthonyeleven/docs-46364
doc/dev/developer_guide: What Is Merged and When?" could be less colloquial

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-26 00:16:51 +10:00
zdover23
3cea1e5a2a
Merge pull request #38079 from anthonyeleven/anthonyeleven/docs-24143
doc/rados/configuration/common.rst:  enhance the running multiple clusters section

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-26 00:14:51 +10:00
Augustinas
0d73909779 doc: Remove duplicate sentence in sync module documentation
Signed-off-by: Augustinas Šimelionis <augustinas.simelionis@gmail.com>
2020-11-25 15:39:01 +02:00
zdover23
eefa5e33ff
Merge pull request #38088 from anthonyeleven/anthonyeleven/docs-47627
doc/mgr: document dashboard configuration unsetting

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-25 22:10:41 +10:00
Yuval Lifshitz
3906884aa6 rgw/notification: support GetTopicAttributes API
fixes: https://tracker.ceph.com/issues/46296

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
2020-11-25 11:23:52 +02:00
Anthony D'Atri
00d1948491
Merge branch 'master' into anthonyeleven/docs-46367 2020-11-24 12:27:31 -08:00
Yuri Weinstein
a01f710a90
Merge pull request #38254 from neha-ojha/wip-48299
doc/releases/nautilus.rst: add release notes for 14.2.15

Reviewed-by: David Galloway <dgallowa@redhat.com>
Reviewed-by: David Galloway <dgallowa@redhat.com>
Reviewed-by: Yuri Weinstein <yweinste@redhat.com>
2020-11-24 10:51:40 -08:00
zdover23
11311241c7
Merge pull request #38144 from anthonyeleven/anthonyeleven/docs-46365
doc/dev/developer_guide: prefer Latinate verbs to English phrasal verbs

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-25 04:51:13 +10:00
Anthony D'Atri
3ea3975ad0 doc/mgr: document dashboard configuration unsetting
Fixes: https://tracker.ceph.com/issues/47627
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-24 10:03:34 -08:00
Neha Ojha
2d63f47878 doc/releases/nautilus.rst: add release notes for 14.2.15
Signed-off-by: Neha Ojha <nojha@redhat.com>
2020-11-24 16:40:45 +00:00
Ilya Dryomov
b4129a3e2f
Merge pull request #38142 from theanalyst/doc/releases/v14.2.14
doc: release notes for octopus & nautilus backports

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Yuri Weinstein <yweinste@redhat.com>
Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2020-11-24 17:23:00 +01:00
Mike Perez
1571d838a0 doc: Adding missing Ceph Foundation board members
These companies have been members since the beginning.
Signed-off-by: Mike Perez <thingee@gmail.com>
2020-11-24 08:09:40 -08:00
Abhishek Lekshmanan
b04b1ba566 doc: releases: v15.2.6 Octopus release notes
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
Co-authored-by: Ilya Dryomov <idryomov@gmail.com>
2020-11-24 15:43:37 +01:00
Abhishek Lekshmanan
cf1a3d7a39 doc: releases: v14.2.14 Nautilus release notes
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
Co-authored-by: Ilya Dryomov <idryomov@gmail.com>
2020-11-24 15:43:33 +01:00
haoyixing
0e7e036aa7 doc/dev: use http://docs.ceph.com/en/latest/ instead of /docs/master/ for docs
Several links under http://docs.ceph.com/docs/master/ were unable to access.
Change them to http://docs.ceph.com/en/lastest so we can access them directly.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2020-11-24 12:49:47 +08:00
Anthony D'Atri
d4b0215a84 doc/dev/developer_guide: prefer Latinate verbs to English phrasal verbs
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
Fixes: https://tracker.ceph.com/issues/46365
2020-11-23 13:07:19 -08:00
Anthony D'Atri
8a47edfced
Merge branch 'master' into anthonyeleven/docs-14730 2020-11-23 09:31:29 -08:00
zdover23
8c6b533ee8
Merge pull request #38089 from anthonyeleven/anthonyeleven/docs-47976
doc/mgr: Fix msgr2 TCP port in a couple of examples

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-24 00:32:22 +10:00
zdover23
f6c3592916
Merge pull request #38180 from anthonyeleven/anthonyeleven/docs-23442
doc/rados/operations: Add description of new auth profiles

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-24 00:05:00 +10:00
zdover23
de870cac81
Merge pull request #38092 from anthonyeleven/anthonyeleven/docs-mixed-device-trick
doc/rados/operations: enhance primary affinity section

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-23 22:20:13 +10:00
zdover23
2f0fe914be
Merge pull request #38181 from anthonyeleven/anthonyeleven/docs-23443
doc: object -> file -> disk is wrong for bluestore

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-23 16:13:24 +10:00
zdover23
acf80f111c
Merge pull request #34506 from ktdreyer/doc-rm-sysv-init
doc: remove SysV init reference in manual deployment walkthrough

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2020-11-23 16:10:30 +10:00
Kefu Chai
b7e8d11d09
Merge pull request #38231 from anthonyeleven/anthonyeleven/docs-40579
doc/rados/operations: POOL_NEAR_FULL on OSD_NEAR_FULL

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-22 21:24:56 +08:00
Anthony D'Atri
7fde53bbb1 doc/rados/operations: POOL_NEAR_FULL on OSD_NEAR_FULL
Fixes: https://tracker.ceph.com/issues/40579
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-22 00:02:54 -08:00
Anthony D'Atri
61a7eb8647 doc/rados/operations: enhance primary affinity section
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-21 23:57:31 -08:00
Kefu Chai
d3cf17da15
Merge pull request #38090 from anthonyeleven/anthonyeleven/docs-47339
doc/releases: correct spelling

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-22 14:03:09 +08:00
Anthony D'Atri
b3cede6dbc doc/releases: correct spelling
Fixes: https://tracker.ceph.com/issues/47339
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-21 18:32:40 -08:00
Sebastian Wagner
d9879eb001
Merge pull request #37576 from p-se/doc-cephadm-custom-monitoring-templates
mgr/cephadm: document setting custom monitoring templates for configuration files

Reviewed-by: Kiefer Chang <kiefer.chang@suse.com>
Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Michael Fritch <mfritch@suse.com>
2020-11-20 16:15:39 +01:00
Sebastian Wagner
66f647b00b
Merge pull request #37696 from p-se/cephadm-monitoring-grafana-tls
doc/cepham: instructions for custom Grafana TLS certs

Reviewed-by: Alexandra Settle <asettle@suse.com>
Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
Reviewed-by: Michael Fritch <mfritch@suse.com>
2020-11-20 15:42:28 +01:00
Anthony D'Atri
84757fc202 doc/rados/troubleshooting: description of upgrade procedure - stopping/starting OSDs
Fixes: https://tracker.ceph.com/issues/14730
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-19 23:39:42 -08:00
Anthony D'Atri
3e2e3e3735 doc/rados/operations: Add description of new auth profiles 2020-11-19 23:34:32 -08:00
Anthony D'Atri
4aa98df043 doc/dev/developer_guide: "What Is Merged and When?" could be less colloquial
Fixes: https://tracker.ceph.com/issues/46364
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-19 23:12:02 -08:00
Anthony D'Atri
73435185a3 doc/dev/developer_guide: verb disagreement on "Testing: Unit Tests" page
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
Fixes: https://tracker.ceph.com/issues/46367
2020-11-19 23:08:23 -08:00
Anthony D'Atri
9c67b80495 doc/mgr: Fix msgr2 TCP port in a couple of examples
Fixes: https://tracker.ceph.com/issues/47976
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-19 22:58:10 -08:00
Anthony D'Atri
154d05fe11 doc: object -> file -> disk is wrong for bluestore
Address tracker 23443

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>

doc: object -> file -> disk is wrong for bluestore

Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-11-19 22:43:59 -08:00
Kefu Chai
b1c4a821b6 doc/conf: generate releases.json in conf.py
pave the road to build all the ingredients of the document using RTD
facility.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
0980cde334 doc/_static: match with branch encoded in pathname in URL
since we've migrated to RTD, a typical URL of ceph document looks like

https://docs.ceph.com/en/octopus/rados/

so instead of match "/docs.ceph.com/docs/<branch-name>/", we should
better match "/en/<branch-name>". in this change,

* do not include the domain name in the pattern to be matched,
  it's not necessary.
* match with "/en/<branch-name>/"

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
e5c949dbe9 doc/conf: re-group configurations
for better readability.

see also https://www.sphinx-doc.org/en/master/usage/configuration.html

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
c2151a3843 doc/conf: wrap lines over 79 chars
to be compliant with PEP8, see
https://www.python.org/dev/peps/pep-0008/#id19

also silences flake8 warning of

E501 line too long

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
23626401e9 doc: write releases.json to _static
this follows the convention of sphinx, so we can also customise this
path in future using "html_static_path". see also
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_static_path

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
06d0bbc94a doc/conf: add blank lines before class/func definitions
this change silences flake8 warnings like:

expected 2 blank lines after class or function definition, found 1
[E305]

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
664547a665 doc/conf: disable "undefined name" warning from flake8
"tags" is exposed by sphinx, so we will have access to this variable
when sphinx imports this file. this silences the warning from flake8:

undefined name 'tags' [F821]

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
f3f0b3027e doc/conf: drop "u" prefix from string literals
since we've migrated to python3, there is no need to add "u" prefix
anymore.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-20 12:59:22 +08:00
Kefu Chai
4d4983dc0a doc/script/gen_state_diagram: wrap lines which is over 80 chars
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 21:05:14 +08:00
Kefu Chai
ac1f3fa4b3 doc/script/gen_state_diagram: use itertools.cycle() for cycling in colors
for better readability

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 21:05:14 +08:00
Kefu Chai
3c0bc49875 doc: pass graphviz options in conf.py
easier to maintain the options of sphinx extensions in a single place.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
cc5864234e doc: generate peering graph in conf.py
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
a14b2b42be doc/script/gen_state_diagram: add "output" parameter to emit_dot()
this allows us to reuse this python script as a module.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
e9af59a50e doc/script/gen_state_diagram: only run if called as a script
Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-11-19 17:00:29 +08:00
Kefu Chai
ba99f56f52
Merge pull request #38146 from ljishen/peering_state_model
doc: increase visibility of the peering state diagram

Reviewed-by: Kefu Chai <kchai@redhat.com>
2020-11-19 16:09:14 +08:00
Jianshen Liu
909bfa34e6 doc: increase visibility of the peering state diagram
Signed-off-by: Jianshen Liu <jliu120@ucsc.edu>
2020-11-18 21:26:54 -07:00
Neha Ojha
a24f40bb8d
Merge pull request #38172 from zdover23/wip-doc-dev-unit-test-list-update
doc/dev: update list in unit test section

Reviewed-By: Nathan Cutler <ncutler@suse.com>
2020-11-18 15:50:01 -08:00
Neha Ojha
becb9b6db2
Merge pull request #38133 from zdover23/wip-doc-dev-unit-tests-1-of-7
doc/dev: update unit test 1 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-18 12:19:42 -08:00
Neha Ojha
42c599bd1f
Merge pull request #38134 from zdover23/wip-doc-dev-unit-tests-2-of-7
doc/dev: update unit tests 2 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
2020-11-18 12:18:55 -08:00
Patrick Donnelly
50a2c7ead0
Merge PR #38126 into master
* refs/pull/38126/head:
	doc/cephfs/health-messages: add dot between mds identifier and it's name

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2020-11-18 12:15:22 -08:00
pcuzner
9ba45ee661
Merge pull request #37607 from pcuzner/docs-cephadm-host-maintenance
doc/dev/cephadm: Doc defining the design for host maintenance
2020-11-19 09:03:19 +13:00
Zac Dover
491a2fa8dc doc/dev: update list in unit test section
This commit removes an unwanted extra
nested list layer from a list.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-19 03:35:19 +10:00
Zac Dover
0dd7b26fb3 doc/dev: update unit test declaration
This commit updates the text in the "How
Unit Tests Are Declared" section of
tests-unit-tests.rst. This commit breaks
long sentences into shorter sentences and
breaks a sentence into a bulleted list that
might reduce the reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-19 01:13:37 +10:00
Zac Dover
19d34666a8 doc/dev: update unit test 1 of 7
This commit updates the language at the beginning
of the Unit Test section of the developer guide.
The language in this edit is more grammatical than
it used to be, and should now reduce the reader's
cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-18 18:25:05 +10:00
Zac Dover
7425e96c86 doc/dev: update unit tests 2 of 7
This commit updates the "What does 'make
check' mean" section of the "Unit Tests" chapter
of the Developer Guide. It makes the wording a
bit less editorial and attempts to reduce the
reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-11-18 18:13:35 +10:00
haoyixing
fb0a650ba2 doc/cephfs/health-messages: add dot between mds identifier and it's name
After pr #37608, ceph health detail output message
have changed when mds has slow requests. So update
doc according to output.

Signed-off-by: haoyixing <haoyixing@kuaishou.com>
2020-11-18 09:42:48 +08:00
Michael Fritch
35d6fde51f
Merge pull request #37901 from votdev/issue_48041_device_light
mgr/cephadm: Allow customizing mgr/cephadm/lsmcli_blink_lights_cmd per host

Reviewed-by: Michael Fritch <mfritch@suse.com>
Reviewed-by: Sebastian Wagner <swagner@suse.com>
2020-11-16 19:21:06 -07:00
Zac Dover
2b90e77802 doc/start: update prompts in documenting-ceph.rst
This commit adds the ".. prompt:: bash $" directive
to the commands in "documenting-ceph.rst" so that
the permissions level of each command is evident
(through the presentation of the $ or the #), and
so that when the reader cuts and pastes the commands
from the documentation, they don't have to delete
the prompt (because that's how this directive
renders).

This commit also instructs the reader to add the
directory containing "build-doc" and
"serve-doc" to the PATH environment variable
in order to run the commands.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
Co-authored-by: Kefu Chai <tchaikov@gmail.com>
2020-11-17 00:13:05 +10:00
Patrick Seidensal
7f5b1d8bfe doc/cephadm: document setting custom monitoring templates
Fixes: https://tracker.ceph.com/issues/47651

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
2020-11-16 11:31:24 +01:00