From 0e7e036aa7656b005e0ffc1f3d7d11d149b3dda2 Mon Sep 17 00:00:00 2001 From: haoyixing Date: Mon, 23 Nov 2020 20:36:32 +0800 Subject: [PATCH] doc/dev: use http://docs.ceph.com/en/latest/ instead of /docs/master/ 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 --- doc/dev/freebsd.rst | 2 +- doc/man/8/crushtool.rst | 2 +- doc/rados/operations/pools.rst | 7 ++-- doc/rados/troubleshooting/log-and-debug.rst | 2 +- doc/radosgw/multisite.rst | 2 +- doc/radosgw/pools.rst | 2 +- doc/rbd/iscsi-target-cli.rst | 2 +- monitoring/grafana/README.md | 2 +- qa/qa_scripts/openstack/connectceph.sh | 2 +- qa/standalone/scrub/osd-scrub-repair.sh | 2 +- qa/tasks/devstack.py | 2 +- src/mgr/DaemonServer.cc | 2 +- src/mon/PGMap.cc | 2 +- src/osd/OSDMap.cc | 4 +-- .../mgr/dashboard/services/rgw_client.py | 2 +- src/sample.ceph.conf | 32 +++++++++---------- 16 files changed, 34 insertions(+), 35 deletions(-) diff --git a/doc/dev/freebsd.rst b/doc/dev/freebsd.rst index 71568ef388d..b1645b873b3 100644 --- a/doc/dev/freebsd.rst +++ b/doc/dev/freebsd.rst @@ -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 diff --git a/doc/man/8/crushtool.rst b/doc/man/8/crushtool.rst index d48a75ee2e6..82cbfce84b9 100644 --- a/doc/man/8/crushtool.rst +++ b/doc/man/8/crushtool.rst @@ -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 ========================== diff --git a/doc/rados/operations/pools.rst b/doc/rados/operations/pools.rst index 18beffbfc7a..1a12fc16a72 100644 --- a/doc/rados/operations/pools.rst +++ b/doc/rados/operations/pools.rst @@ -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 `_ of ``bluestore compression algorithm``. +:Description: Sets inline compression algorithm to use for underlying BlueStore. This setting overrides the `global setting `__ 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 `_ of ``bluestore compression mode``. +:Description: Sets the policy for the inline compression algorithm for underlying BlueStore. This setting overrides the `global setting `__ 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 `_ of ``bluestore compression min blob *``. +:Description: Chunks smaller than this are never compressed. This setting overrides the `global setting `__ of ``bluestore compression min blob *``. :Type: Unsigned Integer @@ -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 - diff --git a/doc/rados/troubleshooting/log-and-debug.rst b/doc/rados/troubleshooting/log-and-debug.rst index 5cf9e15b350..71170149bca 100644 --- a/doc/rados/troubleshooting/log-and-debug.rst +++ b/doc/rados/troubleshooting/log-and-debug.rst @@ -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 `_ for more details. +- upon requested. Please consult `document on admin socket `_ 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 diff --git a/doc/radosgw/multisite.rst b/doc/radosgw/multisite.rst index d3963234169..fc859594568 100644 --- a/doc/radosgw/multisite.rst +++ b/doc/radosgw/multisite.rst @@ -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 `__ +`Pools `__ for details of configuring pools. To set a zone, create a JSON object consisting of the pools, save the diff --git a/doc/radosgw/pools.rst b/doc/radosgw/pools.rst index a904883b36c..a9b00eac1d6 100644 --- a/doc/radosgw/pools.rst +++ b/doc/radosgw/pools.rst @@ -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 `__ to calculate a suitable number of placement groups for these pools. See -`Pools `__ +`Pools `__ for details on pool creation. .. _radosgw-pool-namespaces: diff --git a/doc/rbd/iscsi-target-cli.rst b/doc/rbd/iscsi-target-cli.rst index 7a668382854..d888a34b09d 100644 --- a/doc/rbd/iscsi-target-cli.rst +++ b/doc/rbd/iscsi-target-cli.rst @@ -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 - `_. + `_. #. As ``root``, on a iSCSI gateway node, create a file named ``iscsi-gateway.cfg`` in the ``/etc/ceph/`` directory: diff --git a/monitoring/grafana/README.md b/monitoring/grafana/README.md index 4054e985384..b4bf4ec3273 100644 --- a/monitoring/grafana/README.md +++ b/monitoring/grafana/README.md @@ -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 diff --git a/qa/qa_scripts/openstack/connectceph.sh b/qa/qa_scripts/openstack/connectceph.sh index 2d70df7ffb3..d975daada0e 100755 --- a/qa/qa_scripts/openstack/connectceph.sh +++ b/qa/qa_scripts/openstack/connectceph.sh @@ -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 diff --git a/qa/standalone/scrub/osd-scrub-repair.sh b/qa/standalone/scrub/osd-scrub-repair.sh index 51439aa3f4e..1461d0d6c61 100755 --- a/qa/standalone/scrub/osd-scrub-repair.sh +++ b/qa/standalone/scrub/osd-scrub-repair.sh @@ -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 diff --git a/qa/tasks/devstack.py b/qa/tasks/devstack.py index 954a6fa885a..2499e9e538d 100644 --- a/qa/tasks/devstack.py +++ b/qa/tasks/devstack.py @@ -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 = {} diff --git a/src/mgr/DaemonServer.cc b/src/mgr/DaemonServer.cc index 91e6c3759b9..2b1878cb78f 100644 --- a/src/mgr/DaemonServer.cc +++ b/src/mgr/DaemonServer.cc @@ -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"; } diff --git a/src/mon/PGMap.cc b/src/mon/PGMap.cc index 176b64e1571..1e95301dae8 100644 --- a/src/mon/PGMap.cc +++ b/src/mon/PGMap.cc @@ -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; diff --git a/src/osd/OSDMap.cc b/src/osd/OSDMap.cc index 194a8b6a415..df33e819ff7 100644 --- a/src/osd/OSDMap.cc +++ b/src/osd/OSDMap.cc @@ -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"); } } @@ -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"); } } diff --git a/src/pybind/mgr/dashboard/services/rgw_client.py b/src/pybind/mgr/dashboard/services/rgw_client.py index 0013d671c74..2355bbbc1ff 100644 --- a/src/pybind/mgr/dashboard/services/rgw_client.py +++ b/src/pybind/mgr/dashboard/services/rgw_client.py @@ -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. diff --git a/src/sample.ceph.conf b/src/sample.ceph.conf index a8f8b9e04af..13394d31f21 100644 --- a/src/sample.ceph.conf +++ b/src/sample.ceph.conf @@ -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 @@ -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. @@ -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. @@ -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 @@ -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.) @@ -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 @@ -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 :) @@ -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 @@ -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. @@ -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. @@ -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) @@ -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 @@ -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 @@ -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.