From f2c7a60c90060c9cac5fd17e0aa85ae9516b54b8 Mon Sep 17 00:00:00 2001 From: John Wilkins Date: Mon, 3 Dec 2012 12:22:37 -0800 Subject: [PATCH] doc: Fixed many hyperlinks, a few typos, and some minor clarifications. fixes: #3564 Signed-off-by: John Wilkins --- doc/architecture.rst | 6 +++--- doc/cephfs/fstab.rst | 2 +- doc/cephfs/kernel.rst | 2 +- doc/install/build-packages.rst | 2 +- doc/man/8/ceph.rst | 2 +- doc/rados/configuration/ceph-conf.rst | 4 ++-- .../configuration/filestore-config-ref.rst | 14 ++++++------- doc/rados/configuration/journal-ref.rst | 2 +- doc/rados/configuration/osd-config-ref.rst | 13 +++++------- doc/rados/deployment/chef.rst | 4 ++-- doc/rados/deployment/index.rst | 2 +- doc/rados/deployment/install-chef.rst | 2 +- doc/rados/operations/add-or-rm-osds.rst | 20 +++++++++---------- doc/rados/operations/index.rst | 4 ++-- doc/rbd/rados-rbd-cmds.rst | 2 +- doc/rbd/rbd-ko.rst | 2 +- doc/rbd/rbd-openstack.rst | 6 +++--- doc/rbd/rbd-snapshot.rst | 2 +- doc/rbd/rbd.rst | 2 +- 19 files changed, 45 insertions(+), 48 deletions(-) diff --git a/doc/architecture.rst b/doc/architecture.rst index eb6e71d59fa..ba5b946ccfe 100644 --- a/doc/architecture.rst +++ b/doc/architecture.rst @@ -247,8 +247,8 @@ bad sectors on a disk that weren't apparent in a light scrub (weekly). .. todo:: explain "classes" -.. _Placement Group States: ../cluster-ops/pg-states -.. _Placement Group Concepts: ../cluster-ops/pg-concepts +.. _Placement Group States: ../rados/operations/pg-states +.. _Placement Group Concepts: ../rados/operations/pg-concepts Monitor Quorums =============== @@ -301,7 +301,7 @@ commands. The Cephx authentication system is similar to Kerberos, but avoids a single point of failure to ensure scalability and high availability. For details on Cephx, see `Ceph Authentication and Authorization`_. -.. _Ceph Authentication and Authorization: ../cluster-ops/auth-intro/ +.. _Ceph Authentication and Authorization: ../rados/operations/auth-intro/ librados -------- diff --git a/doc/cephfs/fstab.rst b/doc/cephfs/fstab.rst index 646eda879b7..96093bf8ec3 100644 --- a/doc/cephfs/fstab.rst +++ b/doc/cephfs/fstab.rst @@ -16,4 +16,4 @@ For example:: mandatory when you have Ceph authentication running. See `Authentication`_ for details. - .. _Authentication: ../../cluster-ops/authentication/ \ No newline at end of file + .. _Authentication: ../../rados/operations/authentication/ \ No newline at end of file diff --git a/doc/cephfs/kernel.rst b/doc/cephfs/kernel.rst index e9f11d313b1..0bf891a8a38 100644 --- a/doc/cephfs/kernel.rst +++ b/doc/cephfs/kernel.rst @@ -31,4 +31,4 @@ To unmount the Ceph file system, you may use the ``umount`` command. For example See `mount.ceph`_ for details. .. _mount.ceph: ../../man/8/mount.ceph/ -.. _Authentication: ../../cluster-ops/authentication/ \ No newline at end of file +.. _Authentication: ../../rados/operations/authentication/ \ No newline at end of file diff --git a/doc/install/build-packages.rst b/doc/install/build-packages.rst index 46a21152a87..c8f405a76b1 100644 --- a/doc/install/build-packages.rst +++ b/doc/install/build-packages.rst @@ -53,4 +53,4 @@ Build the RPM packages:: For multi-processor CPUs use the ``-j`` option to accelerate the build. .. _build prerequisites: ../build-prerequisites -.. _Ceph: ../cloning-the-ceph-source-code-repository +.. _Ceph: ../clone-source diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst index 7f523b76f75..04b51e609f7 100644 --- a/doc/man/8/ceph.rst +++ b/doc/man/8/ceph.rst @@ -81,7 +81,7 @@ Monitor commands A more complete summary of commands understood by the monitor cluster can be found in the wiki, at - http://ceph.com/docs/master/cluster-ops/control + http://ceph.com/docs/master/rados/operations/control Availability diff --git a/doc/rados/configuration/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst index 3ee71bf2473..4926ca8eb8f 100644 --- a/doc/rados/configuration/ceph-conf.rst +++ b/doc/rados/configuration/ceph-conf.rst @@ -203,7 +203,7 @@ minimal settings for each instance of a daemon. For example: **ONLY** for ``mkcephfs`` and manual deployment. It **MUST NOT** be used with ``chef`` or ``ceph-deploy``. -.. _Hardware Recommendations: ../../install/hardware-recommendations +.. _Hardware Recommendations: ../../../install/hardware-recommendations .. _ceph-network-config: @@ -260,7 +260,7 @@ in the daemon instance sections of your ``ceph.conf`` file. public addr {host-public-ip-address} cluster addr {host-cluster-ip-address} -.. _hardware recommendations: ../../install/hardware-recommendations +.. _hardware recommendations: ../../../install/hardware-recommendations .. _ceph-monitor-config: diff --git a/doc/rados/configuration/filestore-config-ref.rst b/doc/rados/configuration/filestore-config-ref.rst index 0babcd85034..e45c0f7a9fc 100644 --- a/doc/rados/configuration/filestore-config-ref.rst +++ b/doc/rados/configuration/filestore-config-ref.rst @@ -49,13 +49,13 @@ by using a method of storing XATTRs that is extrinsic to the underlying filesyst Synchronization Intervals ========================= -Periodically, the filestore needs to quiesce writes and synchronize the filesystem, -which creates a consistent commit point. It can then free journal entries up to -the commit point. Synchronizing more frequently tends to reduce the time required -perform synchronization, and reduces the amount of data that needs to remain in the -journal. Less frequent synchronization allows the backing filesystem to coalesce -small writes and metadata updates more optimally--potentially resulting in more -efficient synchronization. +Periodically, the filestore needs to quiesce writes and synchronize the +filesystem, which creates a consistent commit point. It can then free journal +entries up to the commit point. Synchronizing more frequently tends to reduce +the time required to perform synchronization, and reduces the amount of data +that needs to remain in the journal. Less frequent synchronization allows the +backing filesystem to coalesce small writes and metadata updates more +optimally--potentially resulting in more efficient synchronization. ``filestore max sync interval`` diff --git a/doc/rados/configuration/journal-ref.rst b/doc/rados/configuration/journal-ref.rst index f1906d12a50..3937d036614 100644 --- a/doc/rados/configuration/journal-ref.rst +++ b/doc/rados/configuration/journal-ref.rst @@ -11,7 +11,7 @@ Ceph OSDs use a journal for two reasons: speed and consistency. with short spurts of high-speed writes followed by periods without any write progress as the filesystem catches up to the journal. -- **Consistency:** Ceph OSDs requires a filesystem interface that guarantees +- **Consistency:** Ceph OSDs require a filesystem interface that guarantees atomic compound operations. Ceph OSDs write a description of the operation to the journal and apply the operation to the filesystem. This enables atomic updates to an object (for example, placement group metadata). Every diff --git a/doc/rados/configuration/osd-config-ref.rst b/doc/rados/configuration/osd-config-ref.rst index 05a3369cde1..c4f3bd25213 100644 --- a/doc/rados/configuration/osd-config-ref.rst +++ b/doc/rados/configuration/osd-config-ref.rst @@ -347,18 +347,21 @@ :Type: Float :Default: Once per day. ``60*60*24`` + ``osd deep scrub interval`` -:Description: The interval for "deep" scrubbing (fully reading all data) +:Description: The interval for "deep" scrubbing (fully reading all data). :Type: Float :Default: Once per week. ``60*60*24*7`` + ``osd deep scrub stride`` -:Description: Read siez when doing a deep scrub +:Description: Read size when doing a deep scrub. :Type: 32-bit Int :Default: 512 KB. ``524288`` + ``osd class dir`` :Description: The class path for RADOS class plug-ins. @@ -414,9 +417,3 @@ :Type: Boolean :Default: ``false`` - -``osd kill backfill at`` - -:Description: For debugging only. -:Type: 32-bit Integer -:Default: ``0`` diff --git a/doc/rados/deployment/chef.rst b/doc/rados/deployment/chef.rst index c13ecc89fb7..689761bd428 100644 --- a/doc/rados/deployment/chef.rst +++ b/doc/rados/deployment/chef.rst @@ -247,5 +247,5 @@ See `Operating a Cluster`_ for details. .. _Managing Cookbooks with Knife: http://wiki.opscode.com/display/chef/Managing+Cookbooks+With+Knife -.. _Installing Chef: ../../install/chef -.. _Operating a Cluster: ../../init/ +.. _Installing Chef: ../../deployment/chef +.. _Operating a Cluster: ../../operations/ diff --git a/doc/rados/deployment/index.rst b/doc/rados/deployment/index.rst index cb698d104c4..71debb40afa 100644 --- a/doc/rados/deployment/index.rst +++ b/doc/rados/deployment/index.rst @@ -2,7 +2,7 @@ Ceph Deployment ================= -You can deploy Chef using many different deployment systems including Chef, Juju, +You can deploy Ceph using many different deployment systems including Chef, Juju, Puppet, and Crowbar. If you are just experimenting, Ceph provides some minimal deployment tools that rely only on SSH and DNS to deploy Ceph. You need to set up the SSH and DNS settings manually. diff --git a/doc/rados/deployment/install-chef.rst b/doc/rados/deployment/install-chef.rst index 5989c56c4ff..7fe53af086c 100644 --- a/doc/rados/deployment/install-chef.rst +++ b/doc/rados/deployment/install-chef.rst @@ -276,7 +276,7 @@ Chef nodes. :: A list of the nodes you've configured should appear. -See the `Deploy With Chef <../../config-cluster/chef>`_ section for information +See the `Deploy With Chef <../../deployment/chef>`_ section for information on using Chef to deploy your Ceph cluster. .. _Chef Architecture Introduction: http://wiki.opscode.com/display/chef/Architecture+Introduction diff --git a/doc/rados/operations/add-or-rm-osds.rst b/doc/rados/operations/add-or-rm-osds.rst index 3c712b46b91..fa377b3c58f 100644 --- a/doc/rados/operations/add-or-rm-osds.rst +++ b/doc/rados/operations/add-or-rm-osds.rst @@ -35,8 +35,8 @@ See `Filesystem Recommendations`_ for details. Add your OSD host to a rack in your cluster, connect it to the network and ensure that it has network connectivity. -.. _Hardware Recommendations: ../../install/hardware-recommendations -.. _Filesystem Recommendations: ../../config-cluster/file-system-recommendations +.. _Hardware Recommendations: ../../../install/hardware-recommendations +.. _Filesystem Recommendations: ../../configuration/filesystem-recommendations Install the Required Software ----------------------------- @@ -46,17 +46,17 @@ manually. See `Installing Debian/Ubuntu Packages`_ for details. You should configure SSH to a user with password-less authentication and root permissions. -.. _Installing Debian/Ubuntu Packages: ../../install/debian +.. _Installing Debian/Ubuntu Packages: ../../../install/debian For clusters deployed with Chef, create a `chef user`_, `configure SSH keys`_, `install Ruby`_ and `install the Chef client`_ on your host. See `Installing Chef`_ for details. -.. _chef user: ../../install/chef#createuser -.. _configure SSH keys: ../../install/chef#genkeys -.. _install the Chef client: ../../install/chef#installchef -.. _Installing Chef: ../../install/chef -.. _Install Ruby: ../../install/chef#installruby +.. _chef user: ../../deployment/install-chef#createuser +.. _configure SSH keys: ../../deployment/install-chef#genkeys +.. _install the Chef client: ../../deployment/install-chef#installchef +.. _Installing Chef: ../../deployment/install-chef +.. _Install Ruby: ../../deployment/install-chef#installruby Adding an OSD (Manual) ---------------------- @@ -234,8 +234,8 @@ completes. (Control-c to exit.) .. _Add/Move an OSD: ../crush-map#addosd -.. _Configure Nodes: ../../config-cluster/chef#confignodes -.. _Prepare OSD Disks: ../../config-cluster/chef#prepdisks +.. _Configure Nodes: ../../deployment/chef#confignodes +.. _Prepare OSD Disks: ../../deployment/chef#prepdisks .. _ceph: ../monitoring diff --git a/doc/rados/operations/index.rst b/doc/rados/operations/index.rst index 5829eea257d..032b567bc90 100644 --- a/doc/rados/operations/index.rst +++ b/doc/rados/operations/index.rst @@ -46,8 +46,8 @@ to one or more pools, or the cluster as a whole. .. toctree:: - Cephx Overview - authentication + Authentication Overview + Cephx Authentication diff --git a/doc/rbd/rados-rbd-cmds.rst b/doc/rbd/rados-rbd-cmds.rst index 3ef6e7a9b18..6e28a6ab713 100644 --- a/doc/rbd/rados-rbd-cmds.rst +++ b/doc/rbd/rados-rbd-cmds.rst @@ -102,5 +102,5 @@ For example:: -.. _Storage Pools: ../../cluster-ops/pools +.. _Storage Pools: ../../rados/operations/pools .. _RBD – Manage RADOS Block Device (RBD) Images: ../../man/8/rbd/ \ No newline at end of file diff --git a/doc/rbd/rbd-ko.rst b/doc/rbd/rbd-ko.rst index 393c8559f7b..3358bb9c7ca 100644 --- a/doc/rbd/rbd-ko.rst +++ b/doc/rbd/rbd-ko.rst @@ -60,4 +60,4 @@ For example:: sudo rbd unmap /dev/rbd/rbd/foo -.. _cephx: ../../cluster-ops/authentication/ \ No newline at end of file +.. _cephx: ../../rados/operations/authentication/ \ No newline at end of file diff --git a/doc/rbd/rbd-openstack.rst b/doc/rbd/rbd-openstack.rst index e2e57941b31..8d4c75f356f 100644 --- a/doc/rbd/rbd-openstack.rst +++ b/doc/rbd/rbd-openstack.rst @@ -68,8 +68,8 @@ See `Create a Pool`_ for detail on specifying the number of placement groups for your pools, and `Placement Groups`_ for details on the number of placement groups you should set for your pools. -.. _Create a Pool: ../../cluster-ops/pools#createpool -.. _Placement Groups: ../../cluster-ops/placement-groups +.. _Create a Pool: ../../rados/operations/pools#createpool +.. _Placement Groups: ../../rados/operations/placement-groups Configure OpenStack Ceph Clients @@ -132,7 +132,7 @@ the temporary copy of the key:: Save the uuid of the secret for configuring ``nova-compute`` later. -.. _cephx authentication: ../../cluster-ops/authentication +.. _cephx authentication: ../../rados/operations/authentication Configure OpenStack to use Ceph diff --git a/doc/rbd/rbd-snapshot.rst b/doc/rbd/rbd-snapshot.rst index acd2be497c5..8b36909cc3d 100644 --- a/doc/rbd/rbd-snapshot.rst +++ b/doc/rbd/rbd-snapshot.rst @@ -313,7 +313,7 @@ For example:: a flattened image will take up more storage space than a layered clone. -.. _cephx: ../../cluster-ops/authentication/ +.. _cephx: ../../rados/operations/authentication/ .. _QEMU: ../qemu-rbd/ .. _OpenStack: ../rbd-openstack/ .. _CloudStack: ../rbd-cloudstack/ diff --git a/doc/rbd/rbd.rst b/doc/rbd/rbd.rst index a9ae5f783a0..2238fd0a807 100644 --- a/doc/rbd/rbd.rst +++ b/doc/rbd/rbd.rst @@ -51,7 +51,7 @@ devices simultaneously. librbd -.. _RBD Caching: ../../config-cluster/rbd-config-ref/ +.. _RBD Caching: ../rbd-config-ref/ .. _kernel modules: ../rbd-ko/ .. _Qemu: ../qemu-rbd/ .. _OpenStack: ../rbd-openstack