RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-04-10 11:42:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #18480 from tchaikov/wip-doc-cleanup

Browse Source 
doc: various cleanups

Reviewed-by: Alfredo Deza <adeza@redhat.com>
This commit is contained in:
Alfredo Deza 2017-10-24 07:03:29 -04:00 committed by GitHub
commit 72dba6c716
23 changed files with 36 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ceph.spec.in
View File

@ -77,7 +77,7 @@ License: LGPL-2.1 and CC-BY-SA-1.0 and GPL-2.0 and BSL-1.0 and BSD-3-Clause and
Group: System/Filesystems Group: System/Filesystems
%endif %endif
URL: http://ceph.com/ URL: http://ceph.com/
Source0: http://ceph.com/download/@TARBALL_BASENAME@.tar.bz2 Source0: https://download.ceph.com/tarballs/@TARBALL_BASENAME@.tar.bz2
%if 0%{?suse_version} %if 0%{?suse_version}
%if 0%{?is_opensuse} %if 0%{?is_opensuse}
ExclusiveArch: x86_64 aarch64 ppc64 ppc64le ExclusiveArch: x86_64 aarch64 ppc64 ppc64le

2
debian/watch vendored
View File

@ -1,2 +1,2 @@
version=3 version=3
http://ceph.com/download/ceph-(\d.*)\.tar\.gz https://download.ceph.com/tarballs/ceph-(\d.*)\.tar\.gz

12
doc/architecture.rst
View File

@ -1576,7 +1576,7 @@ instance for high availability.
.. _RADOS - A Scalable, Reliable Storage Service for Petabyte-scale Storage Clusters: https://ceph.com/wp-content/uploads/2016/08/weil-rados-pdsw07.pdf .. _RADOS - A Scalable, Reliable Storage Service for Petabyte-scale Storage Clusters: https://ceph.com/wp-content/uploads/2016/08/weil-rados-pdsw07.pdf
.. _Paxos: http://en.wikipedia.org/wiki/Paxos_(computer_science) .. _Paxos: https://en.wikipedia.org/wiki/Paxos_(computer_science)
.. _Monitor Config Reference: ../rados/configuration/mon-config-ref .. _Monitor Config Reference: ../rados/configuration/mon-config-ref
.. _Monitoring OSDs and PGs: ../rados/operations/monitoring-osd-pg .. _Monitoring OSDs and PGs: ../rados/operations/monitoring-osd-pg
.. _Heartbeats: ../rados/configuration/mon-osd-interaction .. _Heartbeats: ../rados/configuration/mon-osd-interaction
@ -1589,14 +1589,14 @@ instance for high availability.
.. _Hardware Recommendations: ../start/hardware-recommendations .. _Hardware Recommendations: ../start/hardware-recommendations
.. _Network Config Reference: ../rados/configuration/network-config-ref .. _Network Config Reference: ../rados/configuration/network-config-ref
.. _Data Scrubbing: ../rados/configuration/osd-config-ref#scrubbing .. _Data Scrubbing: ../rados/configuration/osd-config-ref#scrubbing
.. _striping: http://en.wikipedia.org/wiki/Data_striping .. _striping: https://en.wikipedia.org/wiki/Data_striping
.. _RAID: http://en.wikipedia.org/wiki/RAID .. _RAID: https://en.wikipedia.org/wiki/RAID
.. _RAID 0: http://en.wikipedia.org/wiki/RAID_0#RAID_0 .. _RAID 0: https://en.wikipedia.org/wiki/RAID_0#RAID_0
.. _Ceph Object Storage: ../radosgw/ .. _Ceph Object Storage: ../radosgw/
.. _RESTful: http://en.wikipedia.org/wiki/RESTful .. _RESTful: https://en.wikipedia.org/wiki/RESTful
.. _Erasure Code Notes: https://github.com/ceph/ceph/blob/40059e12af88267d0da67d8fd8d9cd81244d8f93/doc/dev/osd_internals/erasure_coding/developer_notes.rst .. _Erasure Code Notes: https://github.com/ceph/ceph/blob/40059e12af88267d0da67d8fd8d9cd81244d8f93/doc/dev/osd_internals/erasure_coding/developer_notes.rst
.. _Cache Tiering: ../rados/operations/cache-tiering .. _Cache Tiering: ../rados/operations/cache-tiering
.. _Set Pool Values: ../rados/operations/pools#set-pool-values .. _Set Pool Values: ../rados/operations/pools#set-pool-values
.. _Kerberos: http://en.wikipedia.org/wiki/Kerberos_(protocol) .. _Kerberos: https://en.wikipedia.org/wiki/Kerberos_(protocol)
.. _Cephx Config Guide: ../rados/configuration/auth-config-ref .. _Cephx Config Guide: ../rados/configuration/auth-config-ref
.. _User Management: ../rados/operations/user-management .. _User Management: ../rados/operations/user-management

2
doc/cephfs/hadoop.rst
View File

@ -30,7 +30,7 @@ and configure Hadoop to use the Ceph file system.
CephFS Java Packages CephFS Java Packages
-------------------- --------------------
* CephFS Hadoop plugin (`hadoop-cephfs.jar <http://ceph.com/download/hadoop-cephfs.jar>`_) * CephFS Hadoop plugin (`hadoop-cephfs.jar <https://download.ceph.com/tarballs/hadoop-cephfs.jar>`_)
Adding these dependencies to a Hadoop installation will depend on your Adding these dependencies to a Hadoop installation will depend on your
particular deployment. In general the dependencies must be present on each particular deployment. In general the dependencies must be present on each

2
doc/dev/index.rst
View File

@ -1237,7 +1237,7 @@ you have not installed yet.
Once Docker is up and running, install ``ceph-workbench`` by following the Once Docker is up and running, install ``ceph-workbench`` by following the
`Installation instructions in the ceph-workbench documentation `Installation instructions in the ceph-workbench documentation
<http://ceph-workbench.readthedocs.org/en/latest/#installation>`_. <http://ceph-workbench.readthedocs.io/en/latest/#installation>`_.
Linking ceph-workbench with your OpenStack tenant Linking ceph-workbench with your OpenStack tenant
------------------------------------------------- -------------------------------------------------

2
doc/dev/osd-class-path.rst
View File

@ -9,7 +9,7 @@
This usually happens because your OSDs can't find ``cls_rbd.so``. They This usually happens because your OSDs can't find ``cls_rbd.so``. They
search for it in ``osd_class_dir``, which may not be set correctly by search for it in ``osd_class_dir``, which may not be set correctly by
default (http://tracker.newdream.net/issues/1722). default (http://tracker.ceph.com/issues/1722).
Most likely it's looking in ``/usr/lib/rados-classes`` instead of Most likely it's looking in ``/usr/lib/rados-classes`` instead of
``/usr/lib64/rados-classes`` - change ``osd_class_dir`` in your ``/usr/lib64/rados-classes`` - change ``osd_class_dir`` in your

2
doc/dev/osd_internals/erasure_coding/developer_notes.rst
View File

@ -147,7 +147,7 @@ chunks are lost, it is not possible to recover the object.
Reading the original content of object O can be a simple Reading the original content of object O can be a simple
concatenation of O1, O2, ... OM, because the plugins are using concatenation of O1, O2, ... OM, because the plugins are using
`systematic codes `systematic codes
<http://en.wikipedia.org/wiki/Systematic_code>`_. Otherwise the chunks <https://en.wikipedia.org/wiki/Systematic_code>`_. Otherwise the chunks
must be given to the erasure code library *decode* method to retrieve must be given to the erasure code library *decode* method to retrieve
the content of the object. the content of the object.

4
doc/glossary.rst
View File

@ -25,7 +25,7 @@ reflect either technical terms or legacy ways of referring to Ceph systems.
Ceph Ceph
Ceph Platform Ceph Platform
All Ceph software, which includes any piece of code hosted at All Ceph software, which includes any piece of code hosted at
`http://github.com/ceph`_. `https://github.com/ceph`_.
Ceph System Ceph System
Ceph Stack Ceph Stack
@ -183,5 +183,5 @@ reflect either technical terms or legacy ways of referring to Ceph systems.
Ceph-specific information about devices and its relationship with Ceph-specific information about devices and its relationship with
OSDs. OSDs.
.. _http://github.com/ceph: http://github.com/ceph .. _https://github.com/ceph: https://github.com/ceph
.. _Cluster Map: ../architecture#cluster-map .. _Cluster Map: ../architecture#cluster-map

4
doc/install/build-ceph.rst
View File

@ -82,11 +82,11 @@ Once you have installed the tools, setup an RPM compilation environment::
Fetch the source tarball for the RPM compilation environment:: Fetch the source tarball for the RPM compilation environment::
wget -P ~/rpmbuild/SOURCES/ http://ceph.com/download/ceph-<version>.tar.bz2 wget -P ~/rpmbuild/SOURCES/ https://download.ceph.com/tarballs/ceph-<version>.tar.bz2
Or from the EU mirror:: Or from the EU mirror::
wget -P ~/rpmbuild/SOURCES/ http://eu.ceph.com/download/ceph-<version>.tar.bz2 wget -P ~/rpmbuild/SOURCES/ http://eu.ceph.com/tarballs/ceph-<version>.tar.bz2
Extract the specfile:: Extract the specfile::

4
doc/install/clone-source.rst
View File

@ -30,8 +30,8 @@ You must also have a ``github`` account. If you do not have a
Follow the directions for setting up git at Follow the directions for setting up git at
`Set Up Git`_. `Set Up Git`_.
.. _github.com: http://github.com .. _github.com: https://github.com
.. _Set Up Git: http://help.github.com/linux-set-up-git .. _Set Up Git: https://help.github.com/linux-set-up-git
Add SSH Keys (Optional) Add SSH Keys (Optional)

20
doc/install/manual-deployment.rst
View File

@ -270,15 +270,6 @@ The procedure is as follows:
sudo /etc/init.d/ceph start mon.node1 sudo /etc/init.d/ceph start mon.node1
#. Verify that Ceph created the default pool. ::
ceph osd lspools
You should see output like this::
0 rbd,
#. Verify that the monitor is running. :: #. Verify that the monitor is running. ::
ceph -s ceph -s
@ -289,9 +280,7 @@ The procedure is as follows:
cluster: cluster:
id: a7f64266-0894-4f1e-a635-d0aeaca0e993 id: a7f64266-0894-4f1e-a635-d0aeaca0e993
health: HEALTH_ERR health: HEALTH_OK
no osds
64 pgs stale
services: services:
mon: 1 daemons, quorum node1 mon: 1 daemons, quorum node1
@ -299,10 +288,10 @@ The procedure is as follows:
osd: 0 osds: 0 up, 0 in osd: 0 osds: 0 up, 0 in
data: data:
pools: 1 pools, 64 pgs pools: 0 pools, 0 pgs
objects: 0 objects, 0 bytes objects: 0 objects, 0 bytes
usage: 0 kB used, 0 kB / 0 kB avail usage: 0 kB used, 0 kB / 0 kB avail
pgs: 64 creating pgs:
**Note:** Once you add OSDs and start them, the placement group health errors **Note:** Once you add OSDs and start them, the placement group health errors
@ -313,7 +302,7 @@ Manager daemon configuration
On each node where you run a ceph-mon daemon, you should also set up a ceph-mgr daemon. On each node where you run a ceph-mon daemon, you should also set up a ceph-mgr daemon.
See `ceph-mgr Administrator Guide`_ See :ref:`mgr-administrator-guide`
Adding OSDs Adding OSDs
=========== ===========
@ -504,4 +493,3 @@ To add (or remove) additional Ceph OSD Daemons, see `Add/Remove OSDs`_.
.. _Network Configuration Reference: ../../rados/configuration/network-config-ref .. _Network Configuration Reference: ../../rados/configuration/network-config-ref
.. _Monitor Config Reference - Data: ../../rados/configuration/mon-config-ref#data .. _Monitor Config Reference - Data: ../../rados/configuration/mon-config-ref#data
.. _create a Ceph filesystem: ../../cephfs/createfs .. _create a Ceph filesystem: ../../cephfs/createfs
.. _ceph-mgr Administrator Guide: :ref:`mgr-administrator-guide`

2
doc/man/8/ceph-deploy.rst
View File

@ -597,7 +597,7 @@ Availability
============ ============
:program:`ceph-deploy` is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to :program:`ceph-deploy` is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to
the documentation at http://ceph.com/ceph-deploy/docs for more information. the documentation at https://ceph.com/ceph-deploy/docs for more information.
See also See also

4
doc/rados/configuration/mon-config-ref.rst
View File

@ -1205,12 +1205,12 @@ Miscellaneous
.. _Paxos: http://en.wikipedia.org/wiki/Paxos_(computer_science) .. _Paxos: https://en.wikipedia.org/wiki/Paxos_(computer_science)
.. _Monitor Keyrings: ../../../dev/mon-bootstrap#secret-keys .. _Monitor Keyrings: ../../../dev/mon-bootstrap#secret-keys
.. _Ceph configuration file: ../ceph-conf/#monitors .. _Ceph configuration file: ../ceph-conf/#monitors
.. _Network Configuration Reference: ../network-config-ref .. _Network Configuration Reference: ../network-config-ref
.. _Monitor lookup through DNS: ../mon-lookup-dns .. _Monitor lookup through DNS: ../mon-lookup-dns
.. _ACID: http://en.wikipedia.org/wiki/ACID .. _ACID: https://en.wikipedia.org/wiki/ACID
.. _Adding/Removing a Monitor: ../../operations/add-or-rm-mons .. _Adding/Removing a Monitor: ../../operations/add-or-rm-mons
.. _Add/Remove a Monitor (ceph-deploy): ../../deployment/ceph-deploy-mon .. _Add/Remove a Monitor (ceph-deploy): ../../deployment/ceph-deploy-mon
.. _Monitoring a Cluster: ../../operations/monitoring .. _Monitoring a Cluster: ../../operations/monitoring

4
doc/rados/configuration/network-config-ref.rst
View File

@ -490,5 +490,5 @@ Ceph disables TCP buffering by default.
.. _hardware recommendations: ../../../start/hardware-recommendations .. _hardware recommendations: ../../../start/hardware-recommendations
.. _Monitor / OSD Interaction: ../mon-osd-interaction .. _Monitor / OSD Interaction: ../mon-osd-interaction
.. _Message Signatures: ../auth-config-ref#signatures .. _Message Signatures: ../auth-config-ref#signatures
.. _CIDR: http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing .. _CIDR: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing
.. _Nagle's Algorithm: http://en.wikipedia.org/wiki/Nagle's_algorithm .. _Nagle's Algorithm: https://en.wikipedia.org/wiki/Nagle's_algorithm

2
doc/rados/operations/add-or-rm-mons.rst
View File

@ -367,4 +367,4 @@ the monitors should operate successfully.
.. _Manual Deployment: ../../../install/manual-deployment .. _Manual Deployment: ../../../install/manual-deployment
.. _Monitor Bootstrap: ../../../dev/mon-bootstrap .. _Monitor Bootstrap: ../../../dev/mon-bootstrap
.. _Paxos: http://en.wikipedia.org/wiki/Paxos_(computer_science) .. _Paxos: https://en.wikipedia.org/wiki/Paxos_(computer_science)

2
doc/rados/operations/cache-tiering.rst
View File

@ -456,6 +456,6 @@ disable and remove it.
.. _Create a Pool: ../pools#create-a-pool .. _Create a Pool: ../pools#create-a-pool
.. _Pools - Set Pool Values: ../pools#set-pool-values .. _Pools - Set Pool Values: ../pools#set-pool-values
.. _Placing Different Pools on Different OSDs: ../crush-map-edits/#placing-different-pools-on-different-osds .. _Placing Different Pools on Different OSDs: ../crush-map-edits/#placing-different-pools-on-different-osds
.. _Bloom Filter: http://en.wikipedia.org/wiki/Bloom_filter .. _Bloom Filter: https://en.wikipedia.org/wiki/Bloom_filter
.. _CRUSH Maps: ../crush-map .. _CRUSH Maps: ../crush-map
.. _Absolute Sizing: #absolute-sizing .. _Absolute Sizing: #absolute-sizing

2
doc/rados/operations/pools.rst
View File

@ -792,7 +792,7 @@ a size of 3).
.. _Pool, PG and CRUSH Config Reference: ../../configuration/pool-pg-config-ref .. _Pool, PG and CRUSH Config Reference: ../../configuration/pool-pg-config-ref
.. _Bloom Filter: http://en.wikipedia.org/wiki/Bloom_filter .. _Bloom Filter: https://en.wikipedia.org/wiki/Bloom_filter
.. _setting the number of placement groups: ../placement-groups#set-the-number-of-placement-groups .. _setting the number of placement groups: ../placement-groups#set-the-number-of-placement-groups
.. _Erasure Coding with Overwrites: ../erasure-code#erasure-coding-with-overwrites .. _Erasure Coding with Overwrites: ../erasure-code#erasure-coding-with-overwrites
.. _Block Device Commands: ../../../rbd/rados-rbd-cmds/#create-a-block-device-pool .. _Block Device Commands: ../../../rbd/rados-rbd-cmds/#create-a-block-device-pool

2
doc/rados/troubleshooting/troubleshooting-osd.rst
View File

@ -521,7 +521,7 @@ from eventually being marked ``out`` (regardless of what the current value for
.. _iostat: http://en.wikipedia.org/wiki/Iostat .. _iostat: https://en.wikipedia.org/wiki/Iostat
.. _Ceph Logging and Debugging: ../../configuration/ceph-conf#ceph-logging-and-debugging .. _Ceph Logging and Debugging: ../../configuration/ceph-conf#ceph-logging-and-debugging
.. _Logging and Debugging: ../log-and-debug .. _Logging and Debugging: ../log-and-debug
.. _Debugging and Logging: ../debug .. _Debugging and Logging: ../debug

2
doc/rados/troubleshooting/troubleshooting-pg.rst
View File

@ -661,7 +661,7 @@ It took 11 tries to map 42 PGs, 12 tries to map 44 PGs etc. The highest number o
.. _here: ../../configuration/pool-pg-config-ref .. _here: ../../configuration/pool-pg-config-ref
.. _Placement Groups: ../../operations/placement-groups .. _Placement Groups: ../../operations/placement-groups
.. _Pool, PG and CRUSH Config Reference: ../../configuration/pool-pg-config-ref .. _Pool, PG and CRUSH Config Reference: ../../configuration/pool-pg-config-ref
.. _NTP: http://en.wikipedia.org/wiki/Network_Time_Protocol .. _NTP: https://en.wikipedia.org/wiki/Network_Time_Protocol
.. _The Network Time Protocol: http://www.ntp.org/ .. _The Network Time Protocol: http://www.ntp.org/
.. _Clock Settings: ../../configuration/mon-config-ref/#clock .. _Clock Settings: ../../configuration/mon-config-ref/#clock

2
doc/radosgw/s3/authentication.rst
View File

@ -72,4 +72,4 @@ an object:
+------------------+--------------------------------------------------------+----------------------------------------------+ +------------------+--------------------------------------------------------+----------------------------------------------+
.. _RFC 2104: http://www.ietf.org/rfc/rfc2104.txt .. _RFC 2104: http://www.ietf.org/rfc/rfc2104.txt
.. _HMAC: http://en.wikipedia.org/wiki/HMAC .. _HMAC: https://en.wikipedia.org/wiki/HMAC

2
doc/radosgw/swift.rst
View File

@ -72,4 +72,4 @@ The following table describes the support status for current Swift functional fe
| **CORS** | Not Supported | | | **CORS** | Not Supported | |
+---------------------------------+-----------------+----------------------------------------+ +---------------------------------+-----------------+----------------------------------------+
.. _Swift API: http://developer.openstack.org/api-ref-objectstorage-v1.html .. _Swift API: https://developer.openstack.org/api-ref/object-store/index.html

2
doc/release-notes.rst
View File

@ -20058,7 +20058,7 @@ v0.56 "bobtail"
=============== ===============
Bobtail is the second stable release of Ceph, named in honor of the Bobtail is the second stable release of Ceph, named in honor of the
`Bobtail Squid`: http://en.wikipedia.org/wiki/Bobtail_squid. `Bobtail Squid`: https://en.wikipedia.org/wiki/Bobtail_squid.
Key features since v0.48 "argonaut" Key features since v0.48 "argonaut"
----------------------------------- -----------------------------------

2
doc/start/get-involved.rst
View File

@ -65,7 +65,7 @@ These are exciting times in the Ceph community! Get involved!
+----------------------+-------------------------------------------------+-----------------------------------------------+ +----------------------+-------------------------------------------------+-----------------------------------------------+
| **Source Code** | If you would like to participate in | | | **Source Code** | If you would like to participate in | |
| | development, bug fixing, or if you just want | - http://github.com/ceph/ceph | | | development, bug fixing, or if you just want | - http://github.com/ceph/ceph |
| | the very latest code for Ceph, you can get it | - http://ceph.com/download | | | the very latest code for Ceph, you can get it | - http://download.ceph.com/tarballs/ |
| | at http://github.com. See `Ceph Source Code`_ | | | | at http://github.com. See `Ceph Source Code`_ | |
| | for details on cloning from github. | | | | for details on cloning from github. | |
+----------------------+-------------------------------------------------+-----------------------------------------------+ +----------------------+-------------------------------------------------+-----------------------------------------------+