Skip to content

Commit 3fbfd18

Browse files
authored
Merge pull request ceph#51872 from zdover23/wip-doc-2023-06-01-cephadm-48180-cleanup-3-of-x
doc: update the cephadm download instructions Reviewed-by: Anthony D'Atri <[email protected]>
2 parents f76c446 + 7c6a2ca commit 3fbfd18

File tree

1 file changed

+18
-37
lines changed

1 file changed

+18
-37
lines changed

doc/cephadm/install.rst

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,9 @@ up-to-date cephadm. There are two ways to get the initial ``cephadm``:
4343
#. :ref:`distribution-specific installation methods<cephadm_install_distros>`
4444
#. a :ref:`curl-based installation<cephadm_install_curl>` method
4545

46-
Once you have an initial copy of cephadm avaiable, follow the steps to
47-
:ref:`update to an active release of cephadm<cephadm_update>` to ensure
48-
that you have the latest fixes for the version of Ceph you'll be managing.
49-
50-
.. important:: The two methods of initially installing ``cephadm`` are mutually
51-
exclusive. Choose either the distribution-specific method or the curl-based
52-
method. Do not attempt to use both these methods on one system.
46+
.. important:: These methods of installing ``cephadm`` are mutually exclusive.
47+
Choose either the distribution-specific method or the curl-based method. Do
48+
not attempt to use both these methods on one system.
5349

5450
.. note:: Recent versions of cephadm are based on a compilation of source files.
5551
Unlike for earlier versions of Ceph it is no longer sufficient to copy a
@@ -58,13 +54,12 @@ that you have the latest fixes for the version of Ceph you'll be managing.
5854
cephadm. See :ref:`compiling-cephadm` for details on how to create your own
5955
standalone cephadm executable.
6056

61-
6257
.. _cephadm_install_distros:
6358

6459
distribution-specific installations
6560
-----------------------------------
6661

67-
Some Linux distributions may already include Ceph packages. In
62+
Some Linux distributions may already include up-to-date Ceph packages. In
6863
that case, you can install cephadm directly. For example:
6964

7065
In Ubuntu:
@@ -135,42 +130,28 @@ curl-based installation
135130

136131
python3.8 ./cephadm <arguments...>
137132

138-
.. _cephadm_update:
139-
140-
update cephadm
141-
--------------
133+
* Although the standalone cephadm is sufficient to get a cluster started, it is
134+
convenient to have the ``cephadm`` command installed on the host. To install
135+
the packages that provide the ``cephadm`` command, run the following
136+
commands:
142137

143-
The cephadm binary can be used to bootstrap a cluster and for a variety
144-
of other management and debugging tasks. The Ceph team strongly recommends
145-
using an actively supported version of cephadm. Additionally, although
146-
the standalone cephadm is sufficient to get a cluster started, it is
147-
convenient to have the ``cephadm`` command installed on the host. Older or LTS
148-
distros may also have ``cephadm`` packages that are out-of-date and
149-
running the commands below can help install a more recent version
150-
from the Ceph project's repositories.
151-
152-
To install the packages provided by the Ceph project that provide the
153-
``cephadm`` command, run the following commands:
154-
155-
.. prompt:: bash #
156-
:substitutions:
138+
.. prompt:: bash #
139+
:substitutions:
157140

158-
./cephadm add-repo --release |stable-release|
159-
./cephadm install
141+
./cephadm add-repo --release |stable-release|
142+
./cephadm install
160143

161-
Confirm that ``cephadm`` is now in your PATH by running ``which`` or
162-
``command -v``:
144+
Confirm that ``cephadm`` is now in your PATH by running ``which``:
163145

164-
.. prompt:: bash #
165-
166-
which cephadm
146+
.. prompt:: bash #
167147

168-
A successful ``which cephadm`` command will return this:
148+
which cephadm
169149

170-
.. code-block:: bash
150+
A successful ``which cephadm`` command will return this:
171151

172-
/usr/sbin/cephadm
152+
.. code-block:: bash
173153
154+
/usr/sbin/cephadm
174155
175156
Bootstrap a new cluster
176157
=======================

0 commit comments

Comments
 (0)