Skip to content

Commit 5790400

Browse files
authored
Merge pull request ceph#60805 from zdover23/wip-doc-2024-11-23-cephadm-install-curl-based-installation
doc/cephadm: Improve "Curl-based Installation" :Reviewd-by: Anthony D'Atri <[email protected]>
2 parents a723aaa + 6e27367 commit 5790400

File tree

1 file changed

+50
-37
lines changed

1 file changed

+50
-37
lines changed

doc/cephadm/install.rst

Lines changed: 50 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -95,67 +95,80 @@ that case, you can install cephadm directly. For example:
9595

9696
.. _cephadm_install_curl:
9797

98-
curl-based installation
99-
-----------------------
98+
Using curl to install cephadm
99+
-----------------------------
100100

101-
* First, determine what version of Ceph you wish to install. You can use the releases
102-
page to find the `latest active releases <https://docs.ceph.com/en/latest/releases/#active-releases>`_.
103-
For example, we might find that ``18.2.1`` is the latest
104-
active release.
101+
#. Determine which version of Ceph you will install. Use the releases page to
102+
find the `latest active releases
103+
<https://docs.ceph.com/en/latest/releases/#active-releases>`_. For example,
104+
you might find that ``18.2.1`` is the latest active release.
105105

106-
* Use ``curl`` to fetch a build of cephadm for that release.
106+
#. Use ``curl`` to fetch a build of cephadm for that release.
107107

108-
.. prompt:: bash #
109-
:substitutions:
108+
.. prompt:: bash #
109+
:substitutions:
110110

111-
CEPH_RELEASE=18.2.0 # replace this with the active release
112-
curl --silent --remote-name --location https://download.ceph.com/rpm-${CEPH_RELEASE}/el9/noarch/cephadm
111+
CEPH_RELEASE=18.2.0 # replace this with the active release
112+
curl --silent --remote-name --location https://download.ceph.com/rpm-${CEPH_RELEASE}/el9/noarch/cephadm
113113

114-
Ensure the ``cephadm`` file is executable:
114+
#. Use ``chmod`` to make the ``cephadm`` file executable:
115115

116-
.. prompt:: bash #
116+
.. prompt:: bash #
117117

118-
chmod +x cephadm
118+
chmod +x cephadm
119119

120-
This file can be run directly from the current directory:
120+
After ``chmod`` has been run on cephadm, it can be run from the current
121+
directory:
121122

122-
.. prompt:: bash #
123+
.. prompt:: bash #
124+
125+
./cephadm <arguments...>
123126

124-
./cephadm <arguments...>
127+
cephadm Requires Python 3.6 or Later
128+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
125129

126-
* If you encounter any issues with running cephadm due to errors including
127-
the message ``bad interpreter``, then you may not have Python or
128-
the correct version of Python installed. The cephadm tool requires Python 3.6
129-
or later. You can manually run cephadm with a particular version of Python by
130-
prefixing the command with your installed Python version. For example:
130+
* ``cephadm`` requires Python 3.6 or later. If you encounter difficulties
131+
running ``cephadm``, then you may not have Python or the correct version of
132+
Python installed. This includes any errors that include the message ``bad
133+
interpreter``.
134+
135+
You can manually run cephadm with a particular version of Python by prefixing
136+
the command with your installed Python version. For example:
131137

132138
.. prompt:: bash #
133-
:substitutions:
134139

135140
python3.8 ./cephadm <arguments...>
136141

137-
* Although the standalone cephadm is sufficient to bootstrap a cluster, it is
138-
best to have the ``cephadm`` command installed on the host. To install
139-
the packages that provide the ``cephadm`` command, run the following
140-
commands:
142+
Installing cephadm on the Host
143+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
141144

142-
.. prompt:: bash #
143-
:substitutions:
145+
Although the standalone ``cephadm`` is sufficient to bootstrap a cluster, it is
146+
best to have the ``cephadm`` command installed on the host. To install the
147+
packages that provide the ``cephadm`` command, run the following commands:
144148

145-
./cephadm add-repo --release |stable-release|
146-
./cephadm install
149+
#. Add the repository:
147150

148-
Confirm that ``cephadm`` is now in your PATH by running ``which``:
151+
.. prompt:: bash #
149152

150-
.. prompt:: bash #
153+
./cephadm add-repo --release |stable-release|
154+
155+
#. Run ``cephadm install``:
156+
157+
.. prompt:: bash #
158+
159+
./cephadm install
160+
161+
#. Confirm that ``cephadm`` is now in your PATH by running ``which``:
162+
163+
.. prompt:: bash #
151164

152-
which cephadm
165+
which cephadm
153166

154-
A successful ``which cephadm`` command will return this:
167+
A successful ``which cephadm`` command will return this:
155168

156-
.. code-block:: bash
169+
.. code-block:: bash
157170
158-
/usr/sbin/cephadm
171+
/usr/sbin/cephadm
159172
160173
Bootstrap a new cluster
161174
=======================

0 commit comments

Comments
 (0)