Merge branch 'main' into mgr-prom

Signed-off-by: Zac Dover <[email protected]>

Author: zdover23

PendingReleaseNotes

@@ -107,6 +107,10 @@
   `PutBucketPolicy`. Additionally, the root user will always have access to modify
   the bucket policy, even if the current policy explicitly denies access.
 
+* CephFS: The ``ceph fs subvolume snapshot getpath`` command now allows users
+  to get the path of a snapshot of a subvolume. If the snapshot is not present
+  ``ENOENT`` is returned.
+
 * CephFS: The ``ceph fs volume create`` command now allows users to pass
   metadata and data pool names to be used for creating the volume. If either
   is not passed or if either is a non-empty pool, the command will abort.

cmake/modules/BuildBoost.cmake

@@ -93,13 +93,15 @@ function(do_build_boost root_dir version)
     message(SEND_ERROR "unknown compiler: ${CMAKE_CXX_COMPILER_ID}")
   endif()
 
-  # build b2 and prepare the project-config.jam for boost
+  # prepare the project-config.jam for boost
+  set(bjam <SOURCE_DIR>/b2)
   set(configure_command
     ./bootstrap.sh --prefix=<INSTALL_DIR>
     --with-libraries=${boost_with_libs}
-    --with-toolset=${toolset})
+    --with-toolset=${toolset}
+    --with-bjam=${bjam})
 
-  set(b2 ./b2)
+  set(b2 ${bjam})
   if(BOOST_J)
     message(STATUS "BUILDING Boost Libraries at j ${BOOST_J}")
     list(APPEND b2 -j${BOOST_J})
@@ -183,6 +185,13 @@ function(do_build_boost root_dir version)
     BUILD_BYPRODUCTS ${Boost_LIBRARIES}
     INSTALL_COMMAND ${install_command}
     PREFIX "${root_dir}")
+  ExternalProject_Add_Step(Boost build-bjam
+    COMMAND ./tools/build/src/engine/build.sh --cxx=${CMAKE_CXX_COMPILER} ${toolset}
+    COMMAND ${CMAKE_COMMAND} -E copy ./tools/build/src/engine/b2 ${bjam}
+    DEPENDEES download
+    DEPENDERS configure
+    COMMENT "Building B2 engine.."
+    WORKING_DIRECTORY <SOURCE_DIR>)
 endfunction()
 
 set(Boost_context_DEPENDENCIES thread chrono system date_time)

doc/cephfs/fs-volumes.rst

@@ -635,6 +635,15 @@ otherwise fail (if the snapshot did not exist).
 
 .. note:: if the last snapshot within a snapshot retained subvolume is removed, the subvolume is also removed
 
+Fetching Path of a Snapshot of a Subvolume
+------------------------------------------
+Use a command of the following form to fetch the absolute path of a snapshot of
+a subvolume:
+
+.. prompt:: base #
+
+    ceph fs subvolume snapshot getpath <volname> <subvol_name> <snap_name> [<group_name>]
+
 Listing the Snapshots of a Subvolume
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

doc/mgr/administrator.rst

@@ -10,27 +10,21 @@ Usually, you would set up a ceph-mgr daemon using a tool such
 as ceph-ansible.  These instructions describe how to set up
 a ceph-mgr daemon manually.
 
-First, create an authentication key for your daemon:
+First, create an authentication key for your daemon::
 
-.. prompt:: bash #
-
-   ceph auth get-or-create mgr.$name mon 'allow profile mgr' osd 'allow *' mds 'allow *'
+    ceph auth get-or-create mgr.$name mon 'allow profile mgr' osd 'allow *' mds 'allow *'
 
 Place that key as file named ``keyring`` into ``mgr data`` path, which for a cluster "ceph"
 and mgr $name "foo" would be ``/var/lib/ceph/mgr/ceph-foo`` respective ``/var/lib/ceph/mgr/ceph-foo/keyring``.
 
-Start the ceph-mgr daemon:
-
-.. prompt:: bash #
+Start the ceph-mgr daemon::
 
-   ceph-mgr -i $name
+    ceph-mgr -i $name
 
 Check that the mgr has come up by looking at the output
-of ``ceph status``, which should now include a mgr status line:
-
-.. prompt:: bash #
+of ``ceph status``, which should now include a mgr status line::
 
-   mgr active: $name
+    mgr active: $name
 
 Client authentication
 ---------------------
@@ -39,7 +33,7 @@ The manager is a new daemon which requires new CephX capabilities. If you upgrad
 a cluster from an old version of Ceph, or use the default install/deploy tools,
 your admin client should get this capability automatically. If you use tooling from
 elsewhere, you may get EACCES errors when invoking certain ceph cluster commands.
-To fix that, add a ``mgr allow \*`` stanza to your client's cephx capabilities by
+To fix that, add a "mgr allow \*" stanza to your client's cephx capabilities by
 `Modifying User Capabilities`_.
 
 High availability
@@ -101,12 +95,9 @@ information about what functionality each module provides.
 
 Here is an example of enabling the :term:`Dashboard` module:
 
-.. prompt:: bash #
-
-   ceph mgr module ls
-
-::
+.. code-block:: console
 
+	$ ceph mgr module ls
 	{
 		"enabled_modules": [
 			"status"
@@ -116,13 +107,8 @@ Here is an example of enabling the :term:`Dashboard` module:
 		]
 	}
 
-.. prompt:: bash #
-
-   ceph mgr module enable dashboard
-   ceph mgr module ls
-
-::
-
+	$ ceph mgr module enable dashboard
+	$ ceph mgr module ls
 	{
 		"enabled_modules": [
 			"status",
@@ -132,12 +118,7 @@ Here is an example of enabling the :term:`Dashboard` module:
 		]
 	}
 
-.. prompt:: bash #
-
-   ceph mgr services
-
-::
-
+	$ ceph mgr services
 	{
 		"dashboard": "http://myserver.com:7789/"
 	}
@@ -176,11 +157,9 @@ Calling module commands
 Where a module implements command line hooks, the commands will
 be accessible as ordinary Ceph commands.  Ceph will automatically incorporate
 module commands into the standard CLI interface and route them appropriately to
-the module.
-
-.. prompt:: bash #
+the module.::
 
-   ceph <command | help>
+    ceph <command | help>
 
 Configuration
 -------------

doc/mgr/alerts.rst

@@ -16,58 +16,44 @@ as well.
 Enabling
 --------
 
-The *alerts* module is enabled with:
+The *alerts* module is enabled with::
 
-.. prompt:: bash #
-
-   ceph mgr module enable alerts
+  ceph mgr module enable alerts
 
 Configuration
 -------------
 
 To configure SMTP, all of the following config options must be set
-(When setting ``mgr/alerts/smtp_destination``, you can use commas to separate multiple):
-
-.. prompt:: bash #
-
-   ceph config set mgr mgr/alerts/smtp_host *<smtp-server>*
-   ceph config set mgr mgr/alerts/smtp_destination *<email-address-to-send-to>*
-   ceph config set mgr mgr/alerts/smtp_sender *<from-email-address>*
-
-By default, the module will use SSL and port 465.  To change that:
+(When setting ``mgr/alerts/smtp_destination``, you can use commas to separate multiple)::
 
-.. prompt:: bash #
+  ceph config set mgr mgr/alerts/smtp_host *<smtp-server>*
+  ceph config set mgr mgr/alerts/smtp_destination *<email-address-to-send-to>*
+  ceph config set mgr mgr/alerts/smtp_sender *<from-email-address>*
 
-   ceph config set mgr mgr/alerts/smtp_ssl false   # if not SSL
-   ceph config set mgr mgr/alerts/smtp_port *<port-number>*  # if not 465
+By default, the module will use SSL and port 465.  To change that,::
 
-To authenticate to the SMTP server, you must set the user and password:
+  ceph config set mgr mgr/alerts/smtp_ssl false   # if not SSL
+  ceph config set mgr mgr/alerts/smtp_port *<port-number>*  # if not 465
 
-.. prompt:: bash #
+To authenticate to the SMTP server, you must set the user and password::
 
-   ceph config set mgr mgr/alerts/smtp_user *<username>*
-   ceph config set mgr mgr/alerts/smtp_password *<password>*
+  ceph config set mgr mgr/alerts/smtp_user *<username>*
+  ceph config set mgr mgr/alerts/smtp_password *<password>*
 
 By default, the name in the ``From:`` line is simply ``Ceph``.  To
-change that (e.g., to identify which cluster this is):
+change that (e.g., to identify which cluster this is),::
 
-.. prompt:: bash #
-
-   ceph config set mgr mgr/alerts/smtp_from_name 'Ceph Cluster Foo'
+  ceph config set mgr mgr/alerts/smtp_from_name 'Ceph Cluster Foo'
 
 By default, the module will check the cluster health once per minute
 and, if there is a change, send a message.  To change that
-frequency:
-
-.. prompt:: bash #
+frequency,::
 
-   ceph config set mgr mgr/alerts/interval *<interval>*   # e.g., "5m" for 5 minutes
+  ceph config set mgr mgr/alerts/interval *<interval>*   # e.g., "5m" for 5 minutes
 
 Commands
 --------
 
-To force an alert to be send immediately:
-
-.. prompt:: bash #
+To force an alert to be send immediately,::
 
-   ceph alerts send
+  ceph alerts send

doc/mgr/ceph_api/index.rst

@@ -53,11 +53,9 @@ be obtained, and it may then be reused for subsequent requests. The
     { "token": "<redacted_token>", ...}
 
 The token obtained must be passed together with every API request in the
-``Authorization`` HTTP header:
+``Authorization`` HTTP header::
 
-.. prompt:: bash $
-
-   curl -H "Authorization: Bearer <token>" ...
+  curl -H "Authorization: Bearer <token>" ...
 
 Authentication and authorization can be further configured from the
 Ceph CLI, the Ceph-Dashboard UI and the Ceph API itself (please refer to

doc/mgr/cli_api.rst

@@ -7,47 +7,33 @@ benchmarked for further testing.
 Enabling
 --------
 
-The *cli api commands* module is enabled with:
+The *cli api commands* module is enabled with::
 
-.. prompt:: bash #
+  ceph mgr module enable cli_api
 
-   ceph mgr module enable cli_api
+To check that it is enabled, run::
 
-To check that it is enabled, run:
-
-.. prompt:: bash #
-
-   ceph mgr module ls | grep cli_api
+  ceph mgr module ls | grep cli_api
 
 Usage
 --------
 
-To run a mgr module command, run:
-
-.. prompt:: bash #
-
-   ceph mgr cli <command> <param>
-
-For example, use the following command to print the list of servers:
-
-.. prompt:: bash #
-
-   ceph mgr cli list_servers
+To run a mgr module command, run::
 
-List all available mgr module commands with:
+  ceph mgr cli <command> <param>
 
-.. prompt:: bash #
+For example, use the following command to print the list of servers::
 
-   ceph mgr cli --help
+  ceph mgr cli list_servers
 
-To benchmark a command, run:
+List all available mgr module commands with::
 
-.. prompt:: bash #
+  ceph mgr cli --help
 
-   ceph mgr cli_benchmark <number of calls> <number of threads> <command> <param>
+To benchmark a command, run::
 
-For example, use the following command to benchmark the command to get osd_map:
+  ceph mgr cli_benchmark <number of calls> <number of threads> <command> <param>
 
-.. prompt:: bash #
+For example, use the following command to benchmark the command to get osd_map::
 
-   ceph mgr cli_benchmark 100 10 get osd_map
+  ceph mgr cli_benchmark 100 10 get osd_map