Skip to content

Commit

Permalink
doc/dev: use http://docs.ceph.com/en/latest/ instead of /docs/master/…
Browse files Browse the repository at this point in the history
… 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 <[email protected]>
  • Loading branch information
Rethan committed Nov 24, 2020
1 parent de870ca commit 0e7e036
Show file tree
Hide file tree
Showing 16 changed files with 34 additions and 35 deletions.
2 changes: 1 addition & 1 deletion doc/dev/freebsd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ MON creation

Monitors are created by following the manual creation steps on::

http://docs.ceph.com/docs/master/install/manual-deployment/
https://docs.ceph.com/en/latest/install/manual-freebsd-deployment/


OSD creation
Expand Down
2 changes: 1 addition & 1 deletion doc/man/8/crushtool.rst
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ Reclassify
The *reclassify* function allows users to transition from older maps that
maintain parallel hierarchies for OSDs of different types to a modern CRUSH
map that makes use of the *device class* feature. For more information,
see http://docs.ceph.com/docs/master/rados/operations/crush-map-edits/#migrating-from-a-legacy-ssd-rule-to-device-classes.
see https://docs.ceph.com/en/latest/rados/operations/crush-map-edits/#migrating-from-a-legacy-ssd-rule-to-device-classes.

Example output from --test
==========================
Expand Down
7 changes: 3 additions & 4 deletions doc/rados/operations/pools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -276,21 +276,21 @@ You may set values for the following keys:

``compression_algorithm``

:Description: Sets inline compression algorithm to use for underlying BlueStore. This setting overrides the `global setting <http://docs.ceph.com/docs/master/rados/configuration/bluestore-config-ref/#inline-compression>`_ of ``bluestore compression algorithm``.
:Description: Sets inline compression algorithm to use for underlying BlueStore. This setting overrides the `global setting <https://docs.ceph.com/en/latest/rados/configuration/bluestore-config-ref/#inline-compression>`__ of ``bluestore compression algorithm``.

:Type: String
:Valid Settings: ``lz4``, ``snappy``, ``zlib``, ``zstd``

``compression_mode``

:Description: Sets the policy for the inline compression algorithm for underlying BlueStore. This setting overrides the `global setting <http://docs.ceph.com/docs/master/rados/configuration/bluestore-config-ref/#inline-compression>`_ of ``bluestore compression mode``.
:Description: Sets the policy for the inline compression algorithm for underlying BlueStore. This setting overrides the `global setting <http://docs.ceph.com/en/latest/rados/configuration/bluestore-config-ref/#inline-compression>`__ of ``bluestore compression mode``.

:Type: String
:Valid Settings: ``none``, ``passive``, ``aggressive``, ``force``

``compression_min_blob_size``

:Description: Chunks smaller than this are never compressed. This setting overrides the `global setting <http://docs.ceph.com/docs/master/rados/configuration/bluestore-config-ref/#inline-compression>`_ of ``bluestore compression min blob *``.
:Description: Chunks smaller than this are never compressed. This setting overrides the `global setting <http://docs.ceph.com/en/latest/rados/configuration/bluestore-config-ref/#inline-compression>`__ of ``bluestore compression min blob *``.

:Type: Unsigned Integer

Expand Down Expand Up @@ -837,4 +837,3 @@ a size of 3).
.. _setting the number of placement groups: ../placement-groups#set-the-number-of-placement-groups
.. _Erasure Coding with Overwrites: ../erasure-code#erasure-coding-with-overwrites
.. _Block Device Commands: ../../../rbd/rados-rbd-cmds/#create-a-block-device-pool

2 changes: 1 addition & 1 deletion doc/rados/troubleshooting/log-and-debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ verbose [#]_ . In general, the logs in-memory are not sent to the output log unl

- a fatal signal is raised or
- an ``assert`` in source code is triggered or
- upon requested. Please consult `document on admin socket <http://docs.ceph.com/docs/master/man/8/ceph/#daemon>`_ for more details.
- upon requested. Please consult `document on admin socket <http://docs.ceph.com/en/latest/man/8/ceph/#daemon>`_ for more details.

A debug logging setting can take a single value for the log level and the
memory level, which sets them both as the same value. For example, if you
Expand Down
2 changes: 1 addition & 1 deletion doc/radosgw/multisite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1387,7 +1387,7 @@ Set a Zone
Configuring a zone involves specifying a series of Ceph Object Gateway
pools. For consistency, we recommend using a pool prefix that is the
same as the zone name. See
`Pools <http://docs.ceph.com/docs/master/rados/operations/pools/#pools>`__
`Pools <http://docs.ceph.com/en/latest/rados/operations/pools/#pools>`__
for details of configuring pools.

To set a zone, create a JSON object consisting of the pools, save the
Expand Down
2 changes: 1 addition & 1 deletion doc/radosgw/pools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ are sufficient for some pools, but others (especially those listed in
tuning. We recommend using the `Ceph Placement Group’s per Pool
Calculator <http://ceph.com/pgcalc/>`__ to calculate a suitable number of
placement groups for these pools. See
`Pools <http://docs.ceph.com/docs/master/rados/operations/pools/#pools>`__
`Pools <http://docs.ceph.com/en/latest/rados/operations/pools/#pools>`__
for details on pool creation.

.. _radosgw-pool-namespaces:
Expand Down
2 changes: 1 addition & 1 deletion doc/rbd/iscsi-target-cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ For rpm based instructions execute the following commands:

If it does not exist instructions for creating pools can be found on the
`RADOS pool operations page
<http://docs.ceph.com/docs/master/rados/operations/pools/>`_.
<http://docs.ceph.com/en/latest/rados/operations/pools/>`_.

#. As ``root``, on a iSCSI gateway node, create a file named
``iscsi-gateway.cfg`` in the ``/etc/ceph/`` directory:
Expand Down
2 changes: 1 addition & 1 deletion monitoring/grafana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Here you can find a collection of [Grafana](https://grafana.com/grafana)
dashboards for Ceph Monitoring. These dashboards are based on metrics collected
from [prometheus](https://prometheus.io/) scraping the [prometheus mgr
plugin](http://docs.ceph.com/docs/master/mgr/prometheus/) and the
plugin](http://docs.ceph.com/en/latest/mgr/prometheus/) and the
[node_exporter](https://github.com/prometheus/node_exporter).

### Other requirements
Expand Down
2 changes: 1 addition & 1 deletion qa/qa_scripts/openstack/connectceph.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#
# Essentially implements:
#
# http://docs.ceph.com/docs/master/rbd/rbd-openstack/
# http://docs.ceph.com/en/latest/rbd/rbd-openstack/
#
# The directory named files contains templates for the /etc/glance/glance-api.conf,
# /etc/cinder/cinder.conf, /etc/nova/nova.conf Openstack files
Expand Down
2 changes: 1 addition & 1 deletion qa/standalone/scrub/osd-scrub-repair.sh
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ source $CEPH_ROOT/qa/standalone/ceph-helpers.sh
if [ `uname` = FreeBSD ]; then
# erasure coding overwrites are only tested on Bluestore
# erasure coding on filestore is unsafe
# http://docs.ceph.com/docs/master/rados/operations/erasure-code/#erasure-coding-with-overwrites
# http://docs.ceph.com/en/latest/rados/operations/erasure-code/#erasure-coding-with-overwrites
use_ec_overwrite=false
else
use_ec_overwrite=true
Expand Down
2 changes: 1 addition & 1 deletion qa/tasks/devstack.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ def install(ctx, config):
This was created using documentation found here:
https://github.com/openstack-dev/devstack/blob/master/README.md
http://docs.ceph.com/docs/master/rbd/rbd-openstack/
http://docs.ceph.com/en/latest/rbd/rbd-openstack/
"""
if config is None:
config = {}
Expand Down
2 changes: 1 addition & 1 deletion src/mgr/DaemonServer.cc
Original file line number Diff line number Diff line change
Expand Up @@ -863,7 +863,7 @@ void DaemonServer::log_access_denied(
<< "entity='" << session->entity_name << "' "
<< "cmd=" << cmdctx->cmd << ": access denied";
ss << "access denied: does your client key have mgr caps? "
"See http://docs.ceph.com/docs/master/mgr/administrator/"
"See http://docs.ceph.com/en/latest/mgr/administrator/"
"#client-authentication";
}

Expand Down
2 changes: 1 addition & 1 deletion src/mon/PGMap.cc
Original file line number Diff line number Diff line change
Expand Up @@ -3487,7 +3487,7 @@ int process_pg_map_command(
string omap_stats_note =
"\n* NOTE: Omap statistics are gathered during deep scrub and "
"may be inaccurate soon afterwards depending on utilization. See "
"http://docs.ceph.com/docs/master/dev/placement-group/#omap-statistics "
"http://docs.ceph.com/en/latest/dev/placement-group/#omap-statistics "
"for further details.\n";
bool omap_stats_note_required = false;

Expand Down
4 changes: 2 additions & 2 deletions src/osd/OSDMap.cc
Original file line number Diff line number Diff line change
Expand Up @@ -5955,7 +5955,7 @@ void OSDMap::check_health(CephContext *cct,
ss << "crush map has legacy tunables (require " << min
<< ", min is " << cct->_conf->mon_crush_min_required_version << ")";
auto& d = checks->add("OLD_CRUSH_TUNABLES", HEALTH_WARN, ss.str(), 0);
d.detail.push_back("see http://docs.ceph.com/docs/master/rados/operations/crush-map/#tunables");
d.detail.push_back("see http://docs.ceph.com/en/latest/rados/operations/crush-map/#tunables");
}
}

Expand All @@ -5966,7 +5966,7 @@ void OSDMap::check_health(CephContext *cct,
ss << "crush map has straw_calc_version=0";
auto& d = checks->add("OLD_CRUSH_STRAW_CALC_VERSION", HEALTH_WARN, ss.str(), 0);
d.detail.push_back(
"see http://docs.ceph.com/docs/master/rados/operations/crush-map/#tunables");
"see http://docs.ceph.com/en/latest/rados/operations/crush-map/#tunables");
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/pybind/mgr/dashboard/services/rgw_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def _parse_frontend_config(config):
the first found option will be returned.
Get more details about the configuration syntax here:
http://docs.ceph.com/docs/master/radosgw/frontends/
http://docs.ceph.com/en/latest/radosgw/frontends/
https://civetweb.github.io/civetweb/UserManual.html
:param config: The configuration string to parse.
Expand Down
32 changes: 16 additions & 16 deletions src/sample.ceph.conf
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
# ; Example: /var/run/ceph/$cluster-$name.asok

[global]
### http://docs.ceph.com/docs/master/rados/configuration/general-config-ref/
### http://docs.ceph.com/en/latest/rados/configuration/general-config-ref/

;fsid = {UUID} # use `uuidgen` to generate your own UUID
;public network = 192.168.0.0/24
Expand All @@ -51,8 +51,8 @@
;max open files = 131072


### http://docs.ceph.com/docs/master/rados/operations/
### http://docs.ceph.com/docs/master/rados/configuration/auth-config-ref/
### http://docs.ceph.com/en/latest/rados/operations/
### http://docs.ceph.com/en/latest/rados/configuration/auth-config-ref/

# If enabled, the Ceph Storage Cluster daemons (i.e., ceph-mon, ceph-osd,
# and ceph-mds) must authenticate with each other.
Expand Down Expand Up @@ -90,7 +90,7 @@
;keyring = /etc/ceph/$cluster.$name.keyring


### http://docs.ceph.com/docs/master/rados/configuration/pool-pg-config-ref/
### http://docs.ceph.com/en/latest/rados/configuration/pool-pg-config-ref/


## Replication level, number of data copies.
Expand Down Expand Up @@ -140,7 +140,7 @@
;osd crush chooseleaf type = 1


### http://docs.ceph.com/docs/master/rados/troubleshooting/log-and-debug/
### http://docs.ceph.com/en/latest/rados/troubleshooting/log-and-debug/

# The location of the logging file for your cluster.
# Type: String
Expand All @@ -155,7 +155,7 @@
;log to syslog = true


### http://docs.ceph.com/docs/master/rados/configuration/ms-ref/
### http://docs.ceph.com/en/latest/rados/configuration/ms-ref/

# Enable if you want your daemons to bind to IPv6 address instead of
# IPv4 ones. (Not required if you specify a daemon or cluster IP.)
Expand All @@ -168,8 +168,8 @@
## You need at least one. You need at least three if you want to
## tolerate any node failures. Always create an odd number.
[mon]
### http://docs.ceph.com/docs/master/rados/configuration/mon-config-ref/
### http://docs.ceph.com/docs/master/rados/configuration/mon-osd-interaction/
### http://docs.ceph.com/en/latest/rados/configuration/mon-config-ref/
### http://docs.ceph.com/en/latest/rados/configuration/mon-osd-interaction/

# The IDs of initial monitors in a cluster during startup.
# If specified, Ceph requires an odd number of monitors to form an
Expand Down Expand Up @@ -217,7 +217,7 @@
# (Default: 900)
;mon osd report timeout = 300

### http://docs.ceph.com/docs/master/rados/troubleshooting/log-and-debug/
### http://docs.ceph.com/en/latest/rados/troubleshooting/log-and-debug/

# logging, for debugging monitor crashes, in order of
# their likelihood of being helpful :)
Expand Down Expand Up @@ -246,7 +246,7 @@
# experimental support for running multiple metadata servers. Do not run
# multiple metadata servers in production.
[mds]
### http://docs.ceph.com/docs/master/cephfs/mds-config-ref/
### http://docs.ceph.com/en/latest/cephfs/mds-config-ref/

# where the mds keeps it's secret encryption keys
;keyring = /var/lib/ceph/mds/$name/keyring
Expand Down Expand Up @@ -277,7 +277,7 @@
# You need at least one. Two or more if you want data to be replicated.
# Define as many as you like.
[osd]
### http://docs.ceph.com/docs/master/rados/configuration/osd-config-ref/
### http://docs.ceph.com/en/latest/rados/configuration/osd-config-ref/

# The path to the OSDs data.
# You must create the directory when deploying Ceph.
Expand Down Expand Up @@ -337,7 +337,7 @@
# (Default: false)
;osd check for log corruption = true

### http://docs.ceph.com/docs/master/rados/configuration/journal-ref/
### http://docs.ceph.com/en/latest/rados/configuration/journal-ref/

# The size of the journal in megabytes. If this is 0,
# and the journal is a block device, the entire block device is used.
Expand All @@ -363,7 +363,7 @@
;debug filestore = 20
;debug journal = 20

### http://docs.ceph.com/docs/master/rados/configuration/filestore-config-ref/
### http://docs.ceph.com/en/latest/rados/configuration/filestore-config-ref/

# The maximum interval in seconds for synchronizing the filestore.
# Type: Double (optional)
Expand Down Expand Up @@ -391,7 +391,7 @@

## Filestore and OSD settings can be tweak to achieve better performance

### http://docs.ceph.com/docs/master/rados/configuration/filestore-config-ref/#misc
### http://docs.ceph.com/en/latest/rados/configuration/filestore-config-ref/#misc

# Min number of files in a subdir before merging into parent NOTE: A negative value means to disable subdir merging
# Type: Integer
Expand Down Expand Up @@ -436,7 +436,7 @@
## client settings
[client]

### http://docs.ceph.com/docs/master/rbd/rbd-config-ref/
### http://docs.ceph.com/en/latest/rbd/rbd-config-ref/

# Enable caching for RADOS Block Device (RBD).
# Type: Boolean
Expand Down Expand Up @@ -492,7 +492,7 @@
## radosgw client settings
[client.radosgw.gateway]

### http://docs.ceph.com/docs/master/radosgw/config-ref/
### http://docs.ceph.com/en/latest/radosgw/config-ref/

# Sets the location of the data files for Ceph Object Gateway.
# You must create the directory when deploying Ceph.
Expand Down

0 comments on commit 0e7e036

Please sign in to comment.