From 0a2a0c075c32f541c8746530690788adaf048b78 Mon Sep 17 00:00:00 2001 From: John Wilkins Date: Wed, 14 Nov 2012 14:57:51 -0800 Subject: [PATCH] doc: config-cluser move to new IA. Signed-off-by: John Wilkins --- doc/cephfs/index.rst | 5 + .../mds-config-ref.rst | 0 doc/dev/documenting.rst | 2 +- doc/dev/release-process2.rst | 154 ++++++++++++++++++ doc/index.rst | 7 +- doc/install/index.rst | 8 +- doc/rados/api/index.rst | 20 +++ doc/rados/api/librados.rst | 4 +- .../configuration}/ceph-conf.rst | 0 .../configuration}/demo-ceph.conf | 0 .../configuration}/filestore-config-ref.rst | 0 .../filesystem-recommendations.rst} | 0 .../configuration}/general-config-ref.rst | 0 .../configuration}/index.rst | 34 +--- .../configuration}/journal-ref.rst | 0 .../configuration}/log-and-debug-ref.rst | 0 .../configuration}/mon-config-ref.rst | 0 .../configuration}/ms-ref.rst | 0 .../configuration}/osd-config-ref.rst | 0 doc/rados/deployment/ceph-deploy.rst | 5 + .../deployment}/chef.rst | 20 +-- doc/rados/deployment/index.rst | 35 ++++ .../deployment/install-chef.rst} | 2 - .../deployment}/mkcephfs.rst | 0 doc/rados/index.rst | 66 ++++++++ doc/rados/man/index.rst | 22 +++ doc/rados/operations/auth-intro.rst | 2 +- doc/rados/operations/authentication.rst | 6 +- doc/rados/operations/debug.rst | 6 +- doc/radosgw/index.rst | 2 + doc/rbd/disk.conf | 8 + doc/rbd/qemu-rbd.rst | 4 +- .../rbd-config-ref.rst | 0 doc/rbd/rbd.rst | 5 +- 34 files changed, 352 insertions(+), 65 deletions(-) rename doc/{config-cluster => cephfs}/mds-config-ref.rst (100%) create mode 100644 doc/dev/release-process2.rst create mode 100644 doc/rados/api/index.rst rename doc/{config-cluster => rados/configuration}/ceph-conf.rst (100%) rename doc/{config-cluster => rados/configuration}/demo-ceph.conf (100%) rename doc/{config-cluster => rados/configuration}/filestore-config-ref.rst (100%) rename doc/{config-cluster/file-system-recommendations.rst => rados/configuration/filesystem-recommendations.rst} (100%) rename doc/{config-cluster => rados/configuration}/general-config-ref.rst (100%) rename doc/{config-cluster => rados/configuration}/index.rst (65%) rename doc/{config-cluster => rados/configuration}/journal-ref.rst (100%) rename doc/{config-cluster => rados/configuration}/log-and-debug-ref.rst (100%) rename doc/{config-cluster => rados/configuration}/mon-config-ref.rst (100%) rename doc/{config-cluster => rados/configuration}/ms-ref.rst (100%) rename doc/{config-cluster => rados/configuration}/osd-config-ref.rst (100%) create mode 100644 doc/rados/deployment/ceph-deploy.rst rename doc/{config-cluster => rados/deployment}/chef.rst (96%) create mode 100644 doc/rados/deployment/index.rst rename doc/{install/chef.rst => rados/deployment/install-chef.rst} (99%) rename doc/{config-cluster => rados/deployment}/mkcephfs.rst (100%) create mode 100644 doc/rados/index.rst create mode 100644 doc/rados/man/index.rst create mode 100644 doc/rbd/disk.conf rename doc/{config-cluster => rbd}/rbd-config-ref.rst (100%) diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst index d419045d274a8..bbcf5833308cd 100644 --- a/doc/cephfs/index.rst +++ b/doc/cephfs/index.rst @@ -9,8 +9,13 @@ with its S3 and Swift APIs, or native bindings. Using Ceph FS requires at least one metadata server in your ``ceph.conf`` configuration file. .. toctree:: + :maxdepth: 1 Mount Ceph FS Mount Ceph FS as FUSE Mount Ceph FS in ``fstab`` Using Ceph with Hadoop + MDS Configuration + Manpage cephfs <../../man/8/cephfs> + Manpage ceph-fuse <../../man/8/ceph-fuse> + Manpage mount.ceph <../../man/8/mount.ceph> diff --git a/doc/config-cluster/mds-config-ref.rst b/doc/cephfs/mds-config-ref.rst similarity index 100% rename from doc/config-cluster/mds-config-ref.rst rename to doc/cephfs/mds-config-ref.rst diff --git a/doc/dev/documenting.rst b/doc/dev/documenting.rst index 2c67273f97357..cc091705f8661 100644 --- a/doc/dev/documenting.rst +++ b/doc/dev/documenting.rst @@ -27,7 +27,7 @@ The general format for function documentation is:: This should be in the header where the function is declared, and functions should be grouped into logical categories. The `librados C API`_ provides a complete example. It is pulled into Sphinx by -`librados.rst`_, which is rendered at :doc:`/api/librados`. +`librados.rst`_, which is rendered at :doc:`/rados/api/librados`. .. _`librados C API`: https://github.com/ceph/ceph/blob/master/src/include/rados/librados.h .. _`librados.rst`: https://raw.github.com/ceph/ceph/master/doc/api/librados.rst diff --git a/doc/dev/release-process2.rst b/doc/dev/release-process2.rst new file mode 100644 index 0000000000000..f7c3b6db8dec1 --- /dev/null +++ b/doc/dev/release-process2.rst @@ -0,0 +1,154 @@ +================= + Release Process +================= + +Build environment +================= + +Ceph maintains multiple build environments. + +Debian +------ + +We build Debian-based packages via ``pbuilder`` for multiple distributions, which identifies the build hosts in the ``deb_hosts`` file and the list of distributions in the ``deb_dist`` file. Each build host will build all distributions. Currently Ceph maintains 1 64-bit build host and 1 32-bit build host. + +RPM +--- + +We build RPM-based packages natively. Therefore, we maintain one build host per distribution. We build RPM-based packages via ``pbuilder``, which identifies the build hosts in the ``rpm_hosts`` file. + +Prior to building, it's necessary to update the ``pbuilder`` seed tarballs:: + + ./update_all_pbuilders.sh + +2. Setup keyring for signing packages +===================================== + +:: + + export GNUPGHOME= + + # verify it's accessible + gpg --list-keys + +The release key should be present:: + + pub 4096R/17ED316D 2012-05-20 + uid Ceph Release Key + + +3. Set up build area +==================== + +Checkout ceph and ceph-build:: + + git clone http://github.com/ceph/ceph.git + git clone http://github.com/ceph/ceph-build.git + +Checkout next branch:: + + git checkout next + +Checkout the submodules (only needed to prevent errors in recursive make):: + + git submodule update --init + +4. Update Build version numbers +================================ + +Edit configure.ac and change version number:: + + DEBEMAIL user@host dch -v 0.xx-1 + +Commit the changes:: + + git commit -a + +Tag the release:: + + ../ceph-build/tag-release v0.xx + +5. Create Makefiles +=================== + +The actual configure options used to build packages are in the +``ceph.spec.in`` and ``debian/rules`` files. At this point we just +need to create a Makefile.:: + + ./do_autogen.sh + + +6. Run the release scripts +========================== + +This creates tarballs and copies them, with other needed files to +the build hosts listed in deb_hosts and rpm_hosts, runs a local build +script, then rsyncs the results back tot the specified release directory.:: + + ../ceph-build/do_release.sh /tmp/release + +7. Create RPM Repo +================== + +Copy the rpms to the destination repo, creates the yum repository +rpm and indexes.:: + + ../ceph-build/push_to_rpm_repo.sh /tmp/release /tmp/repo 0.xx + +8. Create debian repo +===================== + +:: + + mkdir /tmp/debian-repo + ../ceph-build/gen_reprepro_conf.sh debian-testing + ../ceph-build/push_to_deb_repo.sh /tmp/release /tmp/debian-repo 0.xx main + +9. Push repos to ceph.org +========================== + +For a development release:: + + rcp ceph-0.xx.tar.bz2 ceph-0.xx.tar.gz \ + ceph_site@ceph.com:ceph.com/downloads/. + rsync -av /tmp/repo/0.52/ ceph_site@ceph.com:ceph.com/rpm-testing + rsync -av /tmp/debian-repo/ ceph_site@ceph.com:ceph.com/debian-testing + +For a stable release, replace {CODENAME} with the release codename (e.g., ``argonaut`` or ``bobtail``):: + + rcp ceph-0.xx.tar.bz2 \ + ceph_site@ceph.com:ceph.com/downloads/ceph-0.xx{CODENAME}.tar.bz2 + rcp ceph-0.xx.tar.gz \ + ceph_site@ceph.com:ceph.com/downloads/ceph-0.xx{CODENAME}.tar.gz + rsync -av /tmp/repo/0.52/ ceph_site@ceph.com:ceph.com/rpm-{CODENAME} + rsync -auv /tmp/debian-repo/ ceph_site@ceph.com:ceph.com/debian-{CODENAME} + +10. Update Git +============== + +Development release +------------------- + +For a development release, update tags for ``ceph.git``:: + + git push origin v0.xx + git push origin HEAD:testing + git checkout master + git merge next + git push origin master + git push origin HEAD:next + +Similarly, for a development release, for both ``teuthology.git`` and ``ceph-qa-suite.git``:: + + git checkout master + git reset --hard origin/master + git branch -f testing origin/next + git push -f origin testing + git push -f master:next + +Stable release +-------------- + +For ``ceph.git``: + + git push origin stable diff --git a/doc/index.rst b/doc/index.rst index 61aff6a190464..60a613ba14275 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -38,14 +38,11 @@ cluster to ensure that the storage hosts are running smoothly. start/index install/index - config-cluster/index - cluster-ops/index + rados/index cephfs/index rbd/rbd radosgw/index api/index - Internals - man/index architecture - faq + Development release-notes diff --git a/doc/install/index.rst b/doc/install/index.rst index 9c17f9849b182..3503c7939a6aa 100644 --- a/doc/install/index.rst +++ b/doc/install/index.rst @@ -31,18 +31,12 @@ questions and how to install Ceph on various distributions. If you are deploying a Ceph cluster (that is, not developing Ceph), install Ceph using our stable release packages. For testing, you -may install development release and testing packages. If you intend -to deploy Ceph using OpsCode Chef, review the instructions for -Chef below. - -.. tip:: If you are using Dell Crowbar, or Ceph-Deploy you do not - need to install OpsCode Chef. +may install development release and testing packages. .. toctree:: Installing Debian/Ubuntu Packages Installing RPM Packages - Installing OpsCode Chef .. raw:: html diff --git a/doc/rados/api/index.rst b/doc/rados/api/index.rst new file mode 100644 index 0000000000000..8cd63e9774e09 --- /dev/null +++ b/doc/rados/api/index.rst @@ -0,0 +1,20 @@ +========================= + RADOS Object Store APIs +========================= + +Ceph's RADOS Object Store has a messaging layer protocol that enables clients +to interact with Ceph monitors and OSDs. ``librados`` provides this +functionality to object store clients in the form of a library. All Ceph +clients either use ``librados`` or the same functionality encapsulated in +``librados`` to interact with the object store. For example, ``librbd`` and +``libcephfs`` leverage this functionality. You may use ``librados`` to interact +with Ceph directly (e.g., an application that talks to Ceph, your own interface +to Ceph, etc.). + +For an overview of where ``librados`` appears in the technology stack, +see :doc:`../../architecture`. + +.. toctree:: + + librados (C) + librados (C++) \ No newline at end of file diff --git a/doc/rados/api/librados.rst b/doc/rados/api/librados.rst index f433b5c412347..c81a09be3f3a0 100644 --- a/doc/rados/api/librados.rst +++ b/doc/rados/api/librados.rst @@ -4,8 +4,8 @@ .. highlight:: c -`Librados` provides low-level access to the RADOS service. For an -overview of RADOS, see :doc:`/architecture`. +`librados` provides low-level access to the RADOS service. For an +overview of RADOS, see :doc:`../../architecture`. Example: connecting and writing an object diff --git a/doc/config-cluster/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst similarity index 100% rename from doc/config-cluster/ceph-conf.rst rename to doc/rados/configuration/ceph-conf.rst diff --git a/doc/config-cluster/demo-ceph.conf b/doc/rados/configuration/demo-ceph.conf similarity index 100% rename from doc/config-cluster/demo-ceph.conf rename to doc/rados/configuration/demo-ceph.conf diff --git a/doc/config-cluster/filestore-config-ref.rst b/doc/rados/configuration/filestore-config-ref.rst similarity index 100% rename from doc/config-cluster/filestore-config-ref.rst rename to doc/rados/configuration/filestore-config-ref.rst diff --git a/doc/config-cluster/file-system-recommendations.rst b/doc/rados/configuration/filesystem-recommendations.rst similarity index 100% rename from doc/config-cluster/file-system-recommendations.rst rename to doc/rados/configuration/filesystem-recommendations.rst diff --git a/doc/config-cluster/general-config-ref.rst b/doc/rados/configuration/general-config-ref.rst similarity index 100% rename from doc/config-cluster/general-config-ref.rst rename to doc/rados/configuration/general-config-ref.rst diff --git a/doc/config-cluster/index.rst b/doc/rados/configuration/index.rst similarity index 65% rename from doc/config-cluster/index.rst rename to doc/rados/configuration/index.rst index 36ca45786f536..8fa30136c7190 100644 --- a/doc/config-cluster/index.rst +++ b/doc/rados/configuration/index.rst @@ -25,19 +25,19 @@ instance (a single context). .. raw:: html -

Cluster Configuration

+

Configuring the Object Store

-For general cluster configuration, refer to the following: +For general object store configuration, refer to the following: .. toctree:: - Disks and Filesystems + Disks and Filesystems ceph-conf .. raw:: html -

Configuration Reference

+

Reference

To optimize the performance of your cluster, refer to the following: @@ -48,31 +48,9 @@ To optimize the performance of your cluster, refer to the following: OSD Settings Filestore Settings Journal Settings - Metadata Server Settings - librbd Cache Settings - Log / Debug Settings + Log / Debug Settings + Messaging Settings - -.. raw:: html - -

Manual Deployment

- -To deploy a cluster manually (this is recommended for testing and development only), refer to the following: - -.. toctree:: - - Deploy with mkcephfs - - -.. raw:: html - -

Chef Deployment

- -To deploy a cluster with chef, refer to the following: - -.. toctree:: - - Deploy with Chef .. raw:: html diff --git a/doc/config-cluster/journal-ref.rst b/doc/rados/configuration/journal-ref.rst similarity index 100% rename from doc/config-cluster/journal-ref.rst rename to doc/rados/configuration/journal-ref.rst diff --git a/doc/config-cluster/log-and-debug-ref.rst b/doc/rados/configuration/log-and-debug-ref.rst similarity index 100% rename from doc/config-cluster/log-and-debug-ref.rst rename to doc/rados/configuration/log-and-debug-ref.rst diff --git a/doc/config-cluster/mon-config-ref.rst b/doc/rados/configuration/mon-config-ref.rst similarity index 100% rename from doc/config-cluster/mon-config-ref.rst rename to doc/rados/configuration/mon-config-ref.rst diff --git a/doc/config-cluster/ms-ref.rst b/doc/rados/configuration/ms-ref.rst similarity index 100% rename from doc/config-cluster/ms-ref.rst rename to doc/rados/configuration/ms-ref.rst diff --git a/doc/config-cluster/osd-config-ref.rst b/doc/rados/configuration/osd-config-ref.rst similarity index 100% rename from doc/config-cluster/osd-config-ref.rst rename to doc/rados/configuration/osd-config-ref.rst diff --git a/doc/rados/deployment/ceph-deploy.rst b/doc/rados/deployment/ceph-deploy.rst new file mode 100644 index 0000000000000..989f086e4b327 --- /dev/null +++ b/doc/rados/deployment/ceph-deploy.rst @@ -0,0 +1,5 @@ +============= + Ceph Deploy +============= + +Coming soon. \ No newline at end of file diff --git a/doc/config-cluster/chef.rst b/doc/rados/deployment/chef.rst similarity index 96% rename from doc/config-cluster/chef.rst rename to doc/rados/deployment/chef.rst index 2840391931574..c13ecc89fb73d 100644 --- a/doc/config-cluster/chef.rst +++ b/doc/rados/deployment/chef.rst @@ -8,7 +8,7 @@ on using ``knife``. For Chef installation instructions, see `Installing Chef`_. .. _clonecbs: Clone the Required Cookbooks ----------------------------- +============================ To get the cookbooks for Ceph, clone them from git.:: @@ -19,7 +19,7 @@ To get the cookbooks for Ceph, clone them from git.:: .. _addcbpaths: Add the Required Cookbook Paths -------------------------------- +=============================== If you added a default cookbook path when you installed Chef, ``knife`` may be able to upload the cookbook you've cloned to your cookbook path @@ -42,7 +42,7 @@ Becomes:: .. _installcbs: Install the Cookbooks ---------------------- +===================== To install Ceph, you must upload the Ceph cookbooks and the Apache cookbooks (for use with RADOSGW) to your Chef server. :: @@ -52,7 +52,7 @@ To install Ceph, you must upload the Ceph cookbooks and the Apache cookbooks .. _configcephenv: Configure your Ceph Environment -------------------------------- +=============================== The Chef server can support installation of software for multiple environments. The environment you create for Ceph requires an ``fsid``, the secret for @@ -121,7 +121,7 @@ wish to use (e.g., ``master``). .. configroles: Configure the Roles -------------------- +=================== Navigate to the Ceph cookbooks directory. :: @@ -138,7 +138,7 @@ their respective role files. :: .. _confignodes: Configure Nodes ---------------- +=============== You must configure each node you intend to include in your Ceph cluster. Identify nodes for your Ceph cluster. :: @@ -189,7 +189,7 @@ key to the host name for the node. :: .. _prepdisks: Prepare OSD Disks ------------------ +================= Configuring a node with an OSD role tells Chef that the node will run at least one OSD. However, you may run many OSDs on one host. For example, @@ -230,7 +230,7 @@ Finally, simulate a hotplug event. :: .. _runchefclient: Run ``chef-client`` on each Node --------------------------------- +================================ Once you have completed the preceding steps, you must run ``chef-client`` on each node. For example:: @@ -240,7 +240,7 @@ on each node. For example:: .. _proceedtoops: Proceed to Operating the Cluster --------------------------------- +================================ Once you complete the deployment, you may begin operating your cluster. See `Operating a Cluster`_ for details. @@ -248,4 +248,4 @@ 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/ \ No newline at end of file +.. _Operating a Cluster: ../../init/ diff --git a/doc/rados/deployment/index.rst b/doc/rados/deployment/index.rst new file mode 100644 index 0000000000000..997dc2f9a0a96 --- /dev/null +++ b/doc/rados/deployment/index.rst @@ -0,0 +1,35 @@ +================= + Ceph Deployment +================= + +You can deploy Chef 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. + + +.. raw:: html + +

Ceph Deployment Scripts

+ +We provide light-weight deployment scripts to help you evaluate Ceph. For +professional deployment, you should consider professional deployment systems +such as Juju, Puppet, Chef or Crowbar. + +.. toctree:: + + mkcephfs (Deprecated) + Ceph Deploy + +.. raw:: html + +

OpsCode Chef

+ +.. toctree:: + + Installing Chef + Deploying with Chef + +.. raw:: html + +
diff --git a/doc/install/chef.rst b/doc/rados/deployment/install-chef.rst similarity index 99% rename from doc/install/chef.rst rename to doc/rados/deployment/install-chef.rst index 524fc31b37cc3..5989c56c4ff66 100644 --- a/doc/install/chef.rst +++ b/doc/rados/deployment/install-chef.rst @@ -8,8 +8,6 @@ Chef defines three types of entities: #. **Chef Server:** Interacts with ``chef-client`` on Chef nodes. #. **Chef Workstation:** Manages the Chef server. -.. image:: ../images/chef.png - See `Chef Architecture Introduction`_ for details. .. _createuser: diff --git a/doc/config-cluster/mkcephfs.rst b/doc/rados/deployment/mkcephfs.rst similarity index 100% rename from doc/config-cluster/mkcephfs.rst rename to doc/rados/deployment/mkcephfs.rst diff --git a/doc/rados/index.rst b/doc/rados/index.rst new file mode 100644 index 0000000000000..8e858b1caf4bd --- /dev/null +++ b/doc/rados/index.rst @@ -0,0 +1,66 @@ +==================== + RADOS Object Store +==================== + +Ceph's :abbr:`RADOS (Reliable Autonomic Distributed Object Store)` Object Store +is the foundation for all Ceph clusters. When you use object store clients such +as the CephFS filesystem, the RESTful Gateway or Ceph block devices, Ceph reads +data from and writes data to the object store. Ceph's RADOS Object Stores +consist of two types of daemons: Object Storage Daemons (OSDs) store data as +objects on storage nodes; and Monitors maintain a master copy of the cluster +map. A Ceph cluster may contain thousands of storage nodes. A minimal system +will have at least two OSDs for data replication. + +.. ditaa:: +---------------+ +---------------+ + | OSDs | | Monitor | + +---------------+ +---------------+ + +.. raw:: html + +

Config and Deploy

+ +Once you have installed Ceph packages, you must configure. There are a a few +required settings, but most configuration settings have default values. +Following the initial configuration, you must deploy Ceph. Deployment consists +of creating and initializing data directories, keys, etc. + +.. toctree:: + :maxdepth: 2 + + Configuration + Deployment + +.. raw:: html + +

Operations

+ +Once you have a deployed Ceph cluster, you may begin operating your cluster. + +.. toctree:: + :maxdepth: 2 + + + Operations + Manual Pages + + +.. raw:: html + +

APIs

+ +Most Ceph deployments use Ceph `block devices`_, the `gateway`_ and/or the +`CephFS filesystem`_. You may also develop applications that talk directly to +the Ceph object store. + +.. toctree:: + :maxdepth: 2 + + APIs + +.. raw:: html + +
+ +.. _block devices: ../rbd/rbd +.. _CephFS filesystem: ../cephfs/ +.. _gateway: ../radosgw/ diff --git a/doc/rados/man/index.rst b/doc/rados/man/index.rst new file mode 100644 index 0000000000000..82645287f51c0 --- /dev/null +++ b/doc/rados/man/index.rst @@ -0,0 +1,22 @@ +======================= + Object Store Manpages +======================= + +.. toctree:: + :maxdepth: 1 + + ../../man/8/ceph.rst + ../../man/8/ceph-authtool.rst + ../../man/8/ceph-clsinfo.rst + ../../man/8/ceph-conf.rst + ../../man/8/ceph-debugpack.rst + ../../man/8/ceph-dencoder.rst + ../../man/8/ceph-mon.rst + ../../man/8/ceph-osd.rst + ../../man/8/ceph-run.rst + ../../man/8/ceph-syn.rst + ../../man/8/crushtool.rst + ../../man/8/librados-config.rst + ../../man/8/monmaptool.rst + ../../man/8/osdmaptool.rst + ../../man/8/rados.rst \ No newline at end of file diff --git a/doc/rados/operations/auth-intro.rst b/doc/rados/operations/auth-intro.rst index ca8277e69d8a7..30e015de6c597 100644 --- a/doc/rados/operations/auth-intro.rst +++ b/doc/rados/operations/auth-intro.rst @@ -39,7 +39,7 @@ use Ceph clients to interact with Ceph server daemons. For additional information, see our `Cephx Guide`_ and `ceph-authtool manpage`_. .. _Cephx Guide: ../authentication -.. _ceph-authtool manpage: ../../man/8/ceph-authtool/ +.. _ceph-authtool manpage: ../../../man/8/ceph-authtool Ceph Authentication (cephx) =========================== diff --git a/doc/rados/operations/authentication.rst b/doc/rados/operations/authentication.rst index 02fae3f323363..74330aed1a6d6 100644 --- a/doc/rados/operations/authentication.rst +++ b/doc/rados/operations/authentication.rst @@ -17,7 +17,7 @@ do not need to generate the keys again. For additional information, see our `Cephx Intro`_ and `ceph-authtool manpage`_. .. _Cephx Intro: ../auth-intro -.. _ceph-authtool manpage: ../../man/8/ceph-authtool/ +.. _ceph-authtool manpage: ../../../man/8/ceph-authtool Configuring Cephx @@ -70,7 +70,7 @@ following directory:: See `Enabling Cephx`_ step 2 and 3 for stepwise details to enable ``cephx``. -.. _ceph-authtool: ../../man/8/ceph-authtool/ +.. _ceph-authtool: ../../man/ceph-authtool/ .. _enable-cephx: @@ -382,4 +382,4 @@ for authentication:: foregoing flag** at the nearest practical time so that you may avail yourself of the enhanced authentication. -.. _Ceph configuration: ../../config-cluster/ceph-conf +.. _Ceph configuration: ../../configuration/ceph-conf diff --git a/doc/rados/operations/debug.rst b/doc/rados/operations/debug.rst index 66ecbd011e25b..caa0e0f664db9 100644 --- a/doc/rados/operations/debug.rst +++ b/doc/rados/operations/debug.rst @@ -9,8 +9,8 @@ using Ceph's debugging and logging. To activate and configure Ceph's debug logging, refer to `Ceph Logging and Debugging`_. For additional logging settings, refer to the `Logging and Debugging Config Reference`_. -.. _Ceph Logging and Debugging: ../../config-cluster/ceph-conf#ceph-logging-and-debugging -.. _Logging and Debugging Config Reference: ../../config-cluster/log-and-debug-ref +.. _Ceph Logging and Debugging: ../../configuration/ceph-conf#ceph-logging-and-debugging +.. _Logging and Debugging Config Reference: ../../configuration/log-and-debug-ref You can change the logging settings at runtime so that you don't have to stop and restart the cluster. Refer to `Ceph Configuration - Runtime Changes`_ @@ -22,4 +22,4 @@ Valgrind. You should only use Valgrind when developing or debugging Ceph. Valgrind is computationally expensive, and will slow down your system otherwise. Valgrind messages are logged to ``stderr``. -.. _Ceph Configuration - Runtime Changes: ../../config-cluster/ceph-conf#ceph-runtime-config +.. _Ceph Configuration - Runtime Changes: ../../configuration/ceph-conf#ceph-runtime-config diff --git a/doc/radosgw/index.rst b/doc/radosgw/index.rst index dd28676b9a989..d9c2e3579bd37 100644 --- a/doc/radosgw/index.rst +++ b/doc/radosgw/index.rst @@ -43,4 +43,6 @@ one API and retrieve it with the other. Swift API Admin API troubleshooting + Manpage radosgw <../../man/8/radosgw> + Manpage radosgw-admin <../../man/8/radosgw-admin> diff --git a/doc/rbd/disk.conf b/doc/rbd/disk.conf new file mode 100644 index 0000000000000..5dba7b64460fb --- /dev/null +++ b/doc/rbd/disk.conf @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/doc/rbd/qemu-rbd.rst b/doc/rbd/qemu-rbd.rst index 74d412277b2f9..d111b39d3edb6 100644 --- a/doc/rbd/qemu-rbd.rst +++ b/doc/rbd/qemu-rbd.rst @@ -98,7 +98,7 @@ configuration (like any Ceph configuration option) as part of the qemu -m 1024 -drive format=raw,file=rbd:data/squeeze:rbd_cache=true -.. _RBD caching: ../../config-cluster/rbd-config-ref/#rbd-cache-config-settings +.. _RBD caching: ../rbd-config-ref/#rbd-cache-config-settings Enabling Discard/TRIM @@ -147,4 +147,4 @@ QEMU command line settings override the Ceph configuration file settings. .. _QEMU Open Source Processor Emulator: http://wiki.qemu.org/Main_Page .. _QEMU Manual: http://wiki.qemu.org/Manual -.. _RBD Cache: ../../config-cluster/rbd-config-ref/ \ No newline at end of file +.. _RBD Cache: ../rbd-config-ref/ \ No newline at end of file diff --git a/doc/config-cluster/rbd-config-ref.rst b/doc/rbd/rbd-config-ref.rst similarity index 100% rename from doc/config-cluster/rbd-config-ref.rst rename to doc/rbd/rbd-config-ref.rst diff --git a/doc/rbd/rbd.rst b/doc/rbd/rbd.rst index 59c7bde7f0307..b9cb49e071fb2 100644 --- a/doc/rbd/rbd.rst +++ b/doc/rbd/rbd.rst @@ -43,9 +43,12 @@ devices simultaneously. Snapshots QEMU libvirt - Cache Settings <../../config-cluster/rbd-config-ref/> + Cache Settings OpenStack CloudStack + Manpage rbd <../../man/8/rbd> + Manpage ceph-rbdnamer <../../man/8/ceph-rbdnamer> + .. _RBD Caching: ../../config-cluster/rbd-config-ref/ .. _kernel modules: ../rbd-ko/ -- 2.39.5