From: John Mulligan <jmulligan@redhat.com>
Date: Mon, 22 May 2023 18:20:19 +0000 (-0400)
Subject: doc: add instructions for compiling cephadm
X-Git-Tag: v19.0.0~1105^2~2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=9ad38033cc5c7f177cb8fe3bae696682687e0346;p=ceph-ci.git

doc: add instructions for compiling cephadm

Now that cephadm is based on zipapp, add a short section to the
developer docs explaining how to build cephadm yourself.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
---

diff --git a/doc/dev/cephadm/developing-cephadm.rst b/doc/dev/cephadm/developing-cephadm.rst
index 8df292330ec..d71c87b6a37 100644
--- a/doc/dev/cephadm/developing-cephadm.rst
+++ b/doc/dev/cephadm/developing-cephadm.rst
@@ -388,3 +388,15 @@ Note regarding different variables used in the code
 * a ``daemon_id`` is typically ``<service_id>.<hostname>.<random-string>``.
   (Not the case for e.g. OSDs. OSDs are always called OSD.N)
 * a ``daemon_name`` is ``<daemon_type>.<daemon_id>``
+
+
+Compiling cephadm
+=================
+
+Recent versions of cephadm are based on `Python Zip Application`_ support, and
+is "compiled" from Python source code files in the ceph tree. To create your
+own copy of the cephadm "binary" use the script located at
+``src/cephadm/build.py`` in the Ceph tree.  The command should take the form
+``./src/cephadm/build.py [output]``.
+
+.. _Python Zip Application: https://peps.python.org/pep-0441/