From 254e07441c945ec7f874a564ca997965e9a68e39 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Fri, 7 Jul 2017 11:41:28 +0800 Subject: [PATCH] doc: kill sphinx warnings * doc/release-notes.rst: escape asterisks not used for inline emphasis fix bad hyper links * doc/rados/troubleshooting/troubleshooting-osd.rst: escape asterisks not used for inline emphasis * doc/radosgw/index.rst: add orphan docs to toc * doc/dev/perf_histograms.rst: indent block quote * doc/install/manual-freebsd-deployment.rst: fix block quotes * doc/mgr/administrator.rst: escape asterisks not used for inline emphasis * doc/start/quick-rbd.rst: add missing hyper link target Signed-off-by: Kefu Chai --- doc/dev/index.rst | 4 +- doc/dev/perf_histograms.rst | 54 +++++++++---------- doc/install/manual-deployment.rst | 2 +- doc/install/manual-freebsd-deployment.rst | 7 ++- doc/mgr/administrator.rst | 3 +- .../configuration/mon-osd-interaction.rst | 1 + doc/rados/operations/user-management.rst | 1 + .../troubleshooting/troubleshooting-osd.rst | 2 +- doc/radosgw/index.rst | 2 + doc/release-notes.rst | 28 +++++----- doc/start/quick-rbd.rst | 1 + 11 files changed, 55 insertions(+), 50 deletions(-) diff --git a/doc/dev/index.rst b/doc/dev/index.rst index 9cc3c03e06c..18f92a406c1 100644 --- a/doc/dev/index.rst +++ b/doc/dev/index.rst @@ -1203,7 +1203,7 @@ Since testing in the cloud is done using the `ceph-workbench ceph-qa-suite`_ tool, you will need to install that first. It is designed to be installed via Docker, so if you don't have Docker running on your development machine, take care of that first. You can follow `the official -tutorial`_ to install if +tutorial `_ to install if you have not installed yet. Once Docker is up and running, install ``ceph-workbench`` by following the @@ -1433,7 +1433,7 @@ The following instructions should work on jewel and above. Step 1 - build Ceph ------------------- -Refer to :doc:`install/build-ceph`. +Refer to :doc:`/install/build-ceph`. You can do step 2 separately while it is building. diff --git a/doc/dev/perf_histograms.rst b/doc/dev/perf_histograms.rst index a1f49644e95..c277ac209dd 100644 --- a/doc/dev/perf_histograms.rst +++ b/doc/dev/perf_histograms.rst @@ -47,35 +47,35 @@ In other words, histogram of type "18" is a histogram of unsigned 64-bit integer Here is an example of the schema output:: -{ - "AsyncMessenger::Worker-0": {}, - "AsyncMessenger::Worker-1": {}, - "AsyncMessenger::Worker-2": {}, - "mutex-WBThrottle::lock": {}, - "objecter": {}, - "osd": { - "op_r_latency_out_bytes_histogram": { - "type": 18, - "description": "Histogram of operation latency (including queue time) + data read", - "nick": "" - }, - "op_w_latency_in_bytes_histogram": { - "type": 18, - "description": "Histogram of operation latency (including queue time) + data written", - "nick": "" - }, - "op_rw_latency_in_bytes_histogram": { - "type": 18, - "description": "Histogram of rw operation latency (including queue time) + data written", - "nick": "" - }, - "op_rw_latency_out_bytes_histogram": { - "type": 18, - "description": "Histogram of rw operation latency (including queue time) + data read", - "nick": "" + { + "AsyncMessenger::Worker-0": {}, + "AsyncMessenger::Worker-1": {}, + "AsyncMessenger::Worker-2": {}, + "mutex-WBThrottle::lock": {}, + "objecter": {}, + "osd": { + "op_r_latency_out_bytes_histogram": { + "type": 18, + "description": "Histogram of operation latency (including queue time) + da ta read", + "nick": "" + }, + "op_w_latency_in_bytes_histogram": { + "type": 18, + "description": "Histogram of operation latency (including queue time) + da ta written", + "nick": "" + }, + "op_rw_latency_in_bytes_histogram": { + "type": 18, + "description": "Histogram of rw operation latency (including queue time) + data written", + "nick": "" + }, + "op_rw_latency_out_bytes_histogram": { + "type": 18, + "description": "Histogram of rw operation latency (including queue time) + data read", + "nick": "" + } } } -} Dump diff --git a/doc/install/manual-deployment.rst b/doc/install/manual-deployment.rst index db06fdf3a49..a7f628caa63 100644 --- a/doc/install/manual-deployment.rst +++ b/doc/install/manual-deployment.rst @@ -295,7 +295,7 @@ Manager daemon configuration On each node where you run a ceph-mon daemon, you should also set up a ceph-mgr daemon. -See `../mgr/administrator`_ +See :doc:`../mgr/administrator` Adding OSDs =========== diff --git a/doc/install/manual-freebsd-deployment.rst b/doc/install/manual-freebsd-deployment.rst index 5be1651e359..007c558fceb 100644 --- a/doc/install/manual-freebsd-deployment.rst +++ b/doc/install/manual-freebsd-deployment.rst @@ -380,11 +380,10 @@ create the first two OSDs with the short form procedure, execute the following on ``node2`` and ``node3``: -#. Prepare the OSD. :: +#. Prepare the OSD. On FreeBSD only existing directories can be use to create OSDs in:: - ssh {node-name} sudo ceph-disk prepare --cluster {cluster-name} --cluster-uuid {uuid} {path-to-ceph-osd-directory} @@ -526,9 +525,9 @@ OSDs with the long form procedure, execute the following on ``node2`` and Once you start your OSD, it is ``up`` and ``in``. - For FreeBSD using rc.d init:: + For FreeBSD using rc.d init. - After adding the OSD to ``ceph.conf`` + After adding the OSD to ``ceph.conf``:: sudo service ceph start osd.{osd-num} diff --git a/doc/mgr/administrator.rst b/doc/mgr/administrator.rst index 5b900c0e8f3..558be5d8df3 100644 --- a/doc/mgr/administrator.rst +++ b/doc/mgr/administrator.rst @@ -27,11 +27,12 @@ of ``ceph status``, which should now include a mgr status line:: Client authentication --------------------- + The manager is a new daemon which requires new CephX capabilities. If you upgrade a cluster from an old version of Ceph, or use the default install/deploy tools, your admin client should get this capability automatically. If you use tooling from elsewhere, you may get EACCES errors when invoking certain ceph cluster commands. -To fix that, add a "mgr allow *" stanza to your client's cephx capabilities by +To fix that, add a "mgr allow \*" stanza to your client's cephx capabilities by `Modifying User Capabilities`_. High availability diff --git a/doc/rados/configuration/mon-osd-interaction.rst b/doc/rados/configuration/mon-osd-interaction.rst index ab57cb069a8..e335ff07058 100644 --- a/doc/rados/configuration/mon-osd-interaction.rst +++ b/doc/rados/configuration/mon-osd-interaction.rst @@ -246,6 +246,7 @@ Monitor Settings ``mon osd laggy max interval`` + :Description: Maximum value of ``laggy_interval`` in laggy estimations (in seconds). Monitor uses an adaptive approach to evaluate the ``laggy_interval`` of a certain OSD. This value will be used to calculate the grace time for diff --git a/doc/rados/operations/user-management.rst b/doc/rados/operations/user-management.rst index 2e47f37ff35..efd92f730a9 100644 --- a/doc/rados/operations/user-management.rst +++ b/doc/rados/operations/user-management.rst @@ -361,6 +361,7 @@ are often restricted to accessing a particular pool. :: .. _modify-user-capabilities: + Modify User Capabilities ------------------------ diff --git a/doc/rados/troubleshooting/troubleshooting-osd.rst b/doc/rados/troubleshooting/troubleshooting-osd.rst index 85e8ced6cb4..81e76eccda8 100644 --- a/doc/rados/troubleshooting/troubleshooting-osd.rst +++ b/doc/rados/troubleshooting/troubleshooting-osd.rst @@ -442,7 +442,7 @@ Events from the OSD as it prepares operations - queued_for_pg: the op has been put into the queue for processing by its PG - reached_pg: the PG has started doing the op -- waiting for *: the op is waiting for some other work to complete before it +- waiting for \*: the op is waiting for some other work to complete before it can proceed (a new OSDMap; for its object target to scrub; for the PG to finish peering; all as specified in the message) - started: the op has been accepted as something the OSD should actually do diff --git a/doc/radosgw/index.rst b/doc/radosgw/index.rst index d64e6dd6b30..657a6f9b92b 100644 --- a/doc/radosgw/index.rst +++ b/doc/radosgw/index.rst @@ -45,10 +45,12 @@ you may write data with one API and retrieve it with the other. Swift API Admin Ops API Python binding + Export over NFS OpenStack Keystone Integration OpenStack Barbican Integration Multi-tenancy Compression + LDAP Authentication Server-Side Encryption Bucket Policy Data Layout in RADOS diff --git a/doc/release-notes.rst b/doc/release-notes.rst index 13aecb0d632..76e8a194349 100644 --- a/doc/release-notes.rst +++ b/doc/release-notes.rst @@ -3,7 +3,7 @@ =============== v12.1.0 Luminous (RC) -==================== +===================== This is the first release candidate for Luminous, the next long term stable release. @@ -295,7 +295,7 @@ Major Changes from Jewel Upgrade from Jewel or Kraken ---------------------------- -.. _Upgrading +.. _Upgrading: #. Ensure that the ``sortbitwise`` flag is enabled:: @@ -594,7 +594,7 @@ Notable Changes since v12.0.3 * cmake: check the existence of gperf before using it (`pr#15164 `_, Kefu Chai) * cmake: do not add dependencies to INTERFACE library on cmake < 3.3 (`pr#15813 `_, Kefu Chai) * cmake: do not link libcommon against some libs (`pr#15340 `_, Willem Jan Withagen) -* cmake: exclude *.css while generating ctags (`pr#15663 `_, Leo Zhang) +* cmake: exclude \*.css while generating ctags (`pr#15663 `_, Leo Zhang) * cmake: fix boost components for WITH_SYSTEM_BOOST (`pr#15160 `_, Bassam Tabbara) * cmake: improved build speed by 5x when using ccache (`pr#15147 `_, Bassam Tabbara) * cmake: link against fcgi only if enabled (`pr#15425 `_, Yao Zongyou) @@ -708,7 +708,7 @@ Notable Changes since v12.0.3 * core: src/ceph.in: Use env(CEPH_DEV) to suppress noise from ceph (`pr#14746 `_, Willem Jan Withagen) * core,tests: ceph-disk: sensible default for block.db (`pr#15576 `_, Loic Dachary) * core,tests: ceph_test_rados_api_*: wait for snap trim on ENOENT during cleanup (`issue#19948 `_, `pr#15638 `_, Sage Weil) -* core,tests: qa/suites/rados/*/at-end: wait for healthy before scrubbing (`pr#15245 `_, Sage Weil) +* core,tests: qa/suites/rados/\*/at-end: wait for healthy before scrubbing (`pr#15245 `_, Sage Weil) * core,tests: qa/suites/rados/singleton-nomsg/health-warnings: behave on ext4 (`issue#20043 `_, `pr#15207 `_, Sage Weil) * core,tests: qa/suites/rados: temporarily remove scrub_test from basic/ until post-luminous (`issue#19935 `_, `pr#15202 `_, Sage Weil) * core,tests: qa/suites/upgrade/kraken-x: enable experimental for bluestore (`pr#15359 `_, Sage Weil) @@ -834,7 +834,7 @@ Notable Changes since v12.0.3 * mon: fix mon_keyvaluedb application (`pr#15059 `_, Sage Weil) * mon: Incorrect expression in PGMap::get_health() (`pr#15648 `_, Jos Collin) * mon: it's no need to get pg action_primary osd twice in pg scrub (`pr#15313 `_, linbing) -* mon: Log errors at startup (`issue#14088 `_, `pr#15723 `_, `pr#15723 `_, Ziye Yang) * mon: mon/MgrMonitor: send digests only if is_active() (`pr#15109 `_, Kefu Chai) * mon: mon/MonClient: cancel pending commands on shutdown (`issue#20051 `_, `pr#15227 `_, Kefu Chai, Sage Weil) * mon: {mon,osd,mds} {versions,count-metadata} (`pr#15436 `_, Sage Weil) @@ -947,7 +947,7 @@ Notable Changes since v12.0.3 * tests: qa/suites/rados/thrash: make sure osds have map before legacy scrub (`pr#15117 `_, Sage Weil) * tests: qa/suites/rados/upgrade: restart mds (`pr#15517 `_, Sage Weil) * tests: qa/tasks/ceph_manager: 'ceph $service tell ...' is obsolete (`pr#15252 `_, Sage Weil) -* tests: qa/tasks/rebuild_mondb: grant "mgr:allow *" to client.admin (`issue#19439 `_, `pr#14284 `_, Kefu Chai) +* tests: qa/tasks/rebuild_mondb: grant "mgr:allow \*" to client.admin (`issue#19439 `_, `pr#14284 `_, Kefu Chai) * tests: qa/tasks/repair_test: unset flags we set (`pr#15296 `_, Sage Weil) * tests: qa/workunits/ceph-helpers.sh: use syntax understood by jq 1.3 (`pr#15530 `_, Kefu Chai) * tests: Rename FileJournal object to distinguish (`pr#15279 `_, Jos Collin) @@ -1241,7 +1241,7 @@ Notable Changes * rbd,tests: qa: krbd write-after-checksum tests (`pr#14836 `_, Ilya Dryomov) * rbd,tests: qa/workunits/rbd: increased trash deferment period (`pr#14846 `_, Jason Dillaman) * rbd,tests: qa/workunits: switch to OpenStack Ocata release for RBD testing (`pr#14465 `_, Jason Dillaman) -* rbd,tests: test/librbd/test_librbd.cc: set *features even if RBD_FEATURES is unset (`issue#19865 `_, `pr#14965 `_, Dan Mick) +* rbd,tests: test/librbd/test_librbd.cc: set \*features even if RBD_FEATURES is unset (`issue#19865 `_, `pr#14965 `_, Dan Mick) * rbd,tests: test/librbd/test_notify.py: don't disable feature in slave (`issue#19716 `_, `pr#14751 `_, Mykola Golub) * rbd,tests: test/rbd_mirror: race in TestMockLeaderWatcher.AcquireError (`issue#19405 `_, `pr#14741 `_, Mykola Golub) * rbd,tests: test: remove hard-coded image name from RBD metadata test (`issue#19798 `_, `pr#14848 `_, Jason Dillaman) @@ -1547,7 +1547,7 @@ Notable Changes * msg/async: Postpone bind if network stack is not ready (`pr#14414 `_, Amir Vadai, Haomai Wang) * msg: src/msg/async: Update fix broken compilation for Posix (`pr#14336 `_, Sarit Zubakov) * NVMEDevice: remove unnessary dpdk header file (`pr#14650 `_, optimistyzy) -* osd: add "heap *" admin command (`issue#15475 `_, `pr#13073 `_, Jesse Williamson) +* osd: add "heap \*" admin command (`issue#15475 `_, `pr#13073 `_, Jesse Williamson) * osd: add override in headers files (`pr#13962 `_, liuchang0812) * osd: Cleanup-Updated OSDMap.cc with C++11 style range-for loops (`pr#14381 `_, Jos Collin) * osd: combine unstable stats with info.stats when publish stats to osd (`pr#14060 `_, Mingxin Liu) @@ -4628,7 +4628,7 @@ Notable Changes * tests: Add test for global static non-POD segfault (`pr#10486 `_, Brad Hubbard) * tests: populate /dev/disk/by-partuuid for scsi_debug (`issue#17100 `_, `pr#10824 `_, Loic Dachary) * tests: use a fixture for memstore clone testing (`pr#11190 `_, Kefu Chai) -* tests: run-*make-check.sh: Make DRY_RUN actually mean a dry run (`pr#11074 `_, Brad Hubbard) +* tests: run-\*make-check.sh: Make DRY_RUN actually mean a dry run (`pr#11074 `_, Brad Hubbard) * tests: run-cmake-check.sh: Actually run the tests (`pr#11075 `_, Brad Hubbard) * tests: run-cmake-check.sh: Init submodules (`pr#11091 `_, Brad Hubbard) * tests: run-make-check.sh: Make DRY_RUN actually do a dry run (`pr#11092 `_, Brad Hubbard) @@ -5009,7 +5009,7 @@ For more detailed information, see :download:`the complete changelog `_, `pr#10860 `_, Kefu Chai) * osd: condition OSDMap encoding on features (`issue#18015 `_, `pr#12167 `_, Sage Weil) * osd: PG::_update_calc_stats wrong for CRUSH_ITEM_NONE up set items (`issue#16998 `_, `pr#10883 `_, Samuel Just) -* osd: PG::choose_acting valgrind error or ./common/hobject.h: 182: FAILED assert(!max || (*this == hobject_t(hobject_t::get_max()))) (`issue#13967 `_, `pr#10885 `_, Tao Chang) +* osd: PG::choose_acting valgrind error or ./common/hobject.h: 182: FAILED assert(!max || (\*this == hobject_t(hobject_t::get_max()))) (`issue#13967 `_, `pr#10885 `_, Tao Chang) * osd: Potential crash during journal::Replay shut down (`issue#16433 `_, `pr#10645 `_, Jason Dillaman) * osd: add peer_addr in heartbeat_check log message (`issue#15762 `_, `pr#9739 `_, Vikhyat Umrao, Sage Weil) * osd: adjust scrub boundary to object without SnapSet (`issue#17470 `_, `pr#11311 `_, Samuel Just) @@ -7052,7 +7052,7 @@ Notable Changes since Infernalis * tests: unittest_bufferlist: fix hexdump test (`pr#7152 `_, Sage Weil) * tests: unittest_ipaddr: fix segv (`pr#7154 `_, Sage Weil) * test/system/rados_list_parallel: print oid if rados_write fails (`issue#15240 `_, `pr#8309 `_, Kefu Chai) -* test/system/*: use dynamically generated pool name (`issue#15240 `_, `pr#8318 `_, Kefu Chai) +* test/system/\*: use dynamically generated pool name (`issue#15240 `_, `pr#8318 `_, Kefu Chai) * test/test-erasure-code.sh: disable pg_temp priming (`issue#15211 `_, `pr#8260 `_, Sage Weil) * test: TestMirroringWatcher test cases were not closing images (`pr#8435 `_, Jason Dillaman) * test/TestPGLog: fix the FTBFS (`issue#14930 `_, `pr#7855 `_, Kefu Chai) @@ -7766,7 +7766,7 @@ Notable Changes since v10.1.0 * script: subscription-manager support (`issue#14972 `_, `pr#7907 `_, Loic Dachary) * set 128MB tcmalloc cache size by bytes (`pr#8427 `_, Star Guo) * systemd: set up environment in rbdmap unit file (`issue#14984 `_, `pr#8222 `_, Nathan Cutler) -* test/system/*: use dynamically generated pool name (`issue#15240 `_, `pr#8318 `_, Kefu Chai) +* test/system/\*: use dynamically generated pool name (`issue#15240 `_, `pr#8318 `_, Kefu Chai) * test/system/rados_list_parallel: print oid if rados_write fails (`issue#15240 `_, `pr#8309 `_, Kefu Chai) * test/test-erasure-code.sh: disable pg_temp priming (`issue#15211 `_, `pr#8260 `_, Sage Weil) * test/test_pool_create.sh: fix port (`pr#8361 `_, Sage Weil) @@ -10609,7 +10609,7 @@ Other Notable Changes * msgr: OpTracker needs to release the message throttle in _unregistered (`issue#14248 `_, `pr#11938 `_, Samuel Just) * msgr: simple/Pipe: error decoding addr (`issue#18072 `_, `pr#12266 `_, Sage Weil) * osd: PG::_update_calc_stats wrong for CRUSH_ITEM_NONE up set items (`issue#16998 `_, `pr#11933 `_, Samuel Just) -* osd: PG::choose_acting valgrind error or ./common/hobject.h: 182: FAILED assert(!max || (*this == hobject_t(hobject_t::get_max()))) (`issue#13967 `_, `pr#11932 `_, Tao Chang) +* osd: PG::choose_acting valgrind error or ./common/hobject.h: 182: FAILED assert(!max || (\*this == hobject_t(hobject_t::get_max()))) (`issue#13967 `_, `pr#11932 `_, Tao Chang) * osd: ReplicatedBackend::build_push_op: add a second config to limit omap entries/chunk independently of object data (`issue#16128 `_, `pr#12417 `_, Wanlong Gao) * osd: crash on EIO during deep-scrubbing (`issue#16034 `_, `pr#11935 `_, Nathan Cutler) * osd: filestore: FALLOC_FL_PUNCH_HOLE must be used with FALLOC_FL_KEEP_SIZE (`issue#18446 `_, `pr#13041 `_, xinxin shu) @@ -10677,7 +10677,7 @@ For more detailed information, see :download:`the complete changelog `_, Sage Weil, Kefu Chai) +* build/ops: rocksdb do not link against tcmalloc if it's disabled (`issue#14799 `_, `pr#10750 `_, Sage Weil, Kefu Chai) * build/ops: Add -D_LARGEFILE64_SOURCE to Linux build. (`issue#16611 `_, `pr#10182 `_, Ira Cooper) * build/ops: boost uuid makes valgrind complain (`issue#12736 `_, `pr#9741 `_, Sage Weil, Rohan Mars) * build/ops: ceph-disk s/by-parttype-uuid/by-parttypeuuid/ (`issue#15867 `_, `pr#9107 `_, Nathan Cutler) diff --git a/doc/start/quick-rbd.rst b/doc/start/quick-rbd.rst index eb489e76b8b..11d85262f4d 100644 --- a/doc/start/quick-rbd.rst +++ b/doc/start/quick-rbd.rst @@ -82,6 +82,7 @@ Configure a Block Device See `block devices`_ for additional details. +.. _Create a Pool: ../../rados/operations/pools#createpool .. _Storage Cluster Quick Start: ../quick-ceph-deploy .. _block devices: ../../rbd/rbd .. _FAQ: http://wiki.ceph.com/How_Can_I_Give_Ceph_a_Try -- 2.39.5