From 0980c8318e678131c9b9fef629d1b3670efa3696 Mon Sep 17 00:00:00 2001 From: Adam King Date: Tue, 8 Nov 2022 14:25:13 -0500 Subject: [PATCH] doc/cephadm: docs for extra entrypoint args Signed-off-by: Adam King (cherry picked from commit 8ee799e9cc0800fbedc8d9343aa3207bc9fd429e) --- doc/cephadm/services/index.rst | 35 +++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/doc/cephadm/services/index.rst b/doc/cephadm/services/index.rst index d5b45d20c0810..605a0215239a2 100644 --- a/doc/cephadm/services/index.rst +++ b/doc/cephadm/services/index.rst @@ -496,11 +496,20 @@ candidate hosts. If there are fewer hosts selected by the placement specification than demanded by ``count``, cephadm will deploy only on the selected hosts. +.. _cephadm-extra-container-args: + Extra Container Arguments ========================= .. warning:: - The arguments provided for extra container args are limited to whatever arguments are available for a `run` command from whichever container engine you are using. Providing any arguments the `run` command does not support (or invalid values for arguments) will cause the daemon to fail to start. + The arguments provided for extra container args are limited to whatever arguments are available for + a `run` command from whichever container engine you are using. Providing any arguments the `run` + command does not support (or invalid values for arguments) will cause the daemon to fail to start. + +.. note:: + + For arguments passed to the process running inside the container rather than the for + the container runtime itself, see :ref:`cephadm-extra-entrypoint-args` Cephadm supports providing extra miscellaneous container arguments for @@ -544,6 +553,30 @@ For example: - "-v" - "/opt/ceph_cert/host.cert:/etc/grafana/certs/cert_file:ro" +.. _cephadm-extra-entrypoint-args: + +Extra Entrypoint Arguments +========================== + +.. note:: + + For arguments intended for the container runtime rather than the process inside + it, see :ref:`cephadm-extra-container-args` + +Similar to extra container args for the container runtime, Cephadm supports +appending to args passed to the entrypoint process running +within a container. For example, to set the collector textfile directory for +the node-exporter service , one could apply a service spec like + +.. code-block:: yaml + + service_type: node-exporter + service_name: node-exporter + placement: + host_pattern: '*' + extra_entrypoint_args: + - "--collector.textfile.directory=/var/lib/node_exporter/textfile_collector2" + Custom Config Files =================== -- 2.39.5