]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: do not recommend pulling cephadm from git 52997/head
authorJohn Mulligan <jmulligan@redhat.com>
Mon, 14 Aug 2023 18:10:39 +0000 (14:10 -0400)
committerZac Dover <zac.dover@proton.me>
Tue, 15 Aug 2023 11:11:33 +0000 (21:11 +1000)
First off, these instructions are wrong because the file has been
renamed to cephadm.py, and will not succeed as written. Amusingly, due
to curl's default behavior (and my lack of access to a time machine) the
initial command will seem to have succeeded until the user discovers
that HTML delivered as part of the body of a 404 response is not an
executable script.

Furthermore, in preparation for Reef we updated the documentation in the
cephadm subsection to use the results of a build, rather than source
files, because reef now contains a "compiled" cephadm. Currently, the
contents of the compilation is essentially the same-old cephadm script
but that will no longer be the case in the very near future (see
7c6a2cad96405616719b85c740aabd98558c93ac). We missed this general
section of the Ceph docs that repeats the instructions to copy a raw
python file out of the Ceph tree on GitHub.  Update the section to
contain a simplified version of the instruction found in
doc/cephadm/install.rst.

(cherry picked from commit 336e8022b599782b6b928ccae866dec003a8efa4)

doc: minor improvements of the cephadm section of the packages doc

* Don't call cephadm a script, it could be misleading
* Use the current release in the example for copy-pasters
* Improve grammar (I think)

Signed-off-by: John Mulligan <jmulligan@redhat.com>
(cherry picked from commit c1a47f74ca414236f99ecb8474345e628a775a9a)

doc/install/get-packages.rst

index c3c40b015cda36fce6e0d743d5baa50a01568952..d6edc177b8a67fd8f07ddc2dcce9ae05eb06ce16 100644 (file)
@@ -25,17 +25,17 @@ There are three ways to get packages:
 Install packages with cephadm
 =============================
 
-#. Download the cephadm script
+#. Download cephadm
 
 .. prompt:: bash $
    :substitutions:
 
-   curl --silent --remote-name --location https://github.com/ceph/ceph/raw/|stable-release|/src/cephadm/cephadm
+   curl --silent --remote-name --location https://download.ceph.com/rpm-|stable-release|/el9/noarch/cephadm
    chmod +x cephadm
 
 #. Configure the Ceph repository based on the release name::
 
-     ./cephadm add-repo --release nautilus
+     ./cephadm add-repo --release |stable-release|
 
    For Octopus (15.2.0) and later releases, you can also specify a specific
    version::
@@ -47,8 +47,8 @@ Install packages with cephadm
      ./cephadm add-repo --dev my-branch
 
 #. Install the appropriate packages.  You can install them using your
-   package management tool (e.g., APT, Yum) directly, or you can also
-   use the cephadm wrapper.  For example::
+   package management tool (e.g., APT, Yum) directly, or you can
+   use the cephadm wrapper command.  For example::
 
      ./cephadm install ceph-common