Merge pull request #39932 from mgfritch/custom-monitoring-j2

doc/cephadm: update section on applying custom config (j2) 

Reviewed-by: Juan Miguel Olmo Martínez <jolmomar@redhat.com>
Reviewed-by: Sebastian Wagner <sebastian.wagner@suse.com>
This commit is contained in:
Sebastian Wagner 2021-03-11 11:44:17 +01:00 committed by GitHub
commit 5f7a2ab76f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -119,21 +119,14 @@ A custom certificate can be configured using the following commands.
ceph config-key set mgr/cephadm/grafana_key -i $PWD/key.pem
ceph config-key set mgr/cephadm/grafana_crt -i $PWD/certificate.pem
The ``cephadm`` manager module needs to be restarted to be able to read updates
to these keys.
.. code-block:: bash
ceph orch restart mgr
If you already deployed Grafana, you need to redeploy the service for the
If you already deployed Grafana, you need to ``reconfig`` the service for the
configuration to be updated.
.. code-block:: bash
ceph orch redeploy grafana
ceph orch reconfig grafana
The ``redeploy`` command also takes care of setting the right URL for Ceph
The ``reconfig`` command also takes care of setting the right URL for Ceph
Dashboard.
Using custom images
@ -211,10 +204,10 @@ The following templates for files that will be generated by cephadm can be
overridden. These are the names to be used when storing with ``ceph config-key
set``:
- ``alertmanager_alertmanager.yml``
- ``grafana_ceph-dashboard.yml``
- ``grafana_grafana.ini``
- ``prometheus_prometheus.yml``
- ``services/alertmanager/alertmanager.yml``
- ``services/grafana/ceph-dashboard.yml``
- ``services/grafana/grafana.ini``
- ``services/prometheus/prometheus.yml``
You can look up the file templates that are currently used by cephadm in
``src/pybind/mgr/cephadm/templates``:
@ -244,9 +237,9 @@ To set contents of files as template use the ``-i`` argument:
When using files as input to ``config-key`` an absolute path to the file must
be used.
It is required to restart the cephadm mgr module after a configuration option
has been set. Then the configuration file for the service needs to be recreated.
This is done using `redeploy`. For more details see the following example.
Then the configuration file for the service needs to be recreated.
This is done using `reconfig`. For more details see the following example.
Example
"""""""
@ -254,14 +247,11 @@ Example
.. code-block:: bash
# set the contents of ./prometheus.yml.j2 as template
ceph config-key set mgr/cephadm/services_prometheus_prometheus.yml \
ceph config-key set mgr/cephadm/services/prometheus/prometheus.yml \
-i $PWD/prometheus.yml.j2
# restart cephadm mgr module
ceph orch restart mgr
# redeploy the prometheus service
ceph orch redeploy prometheus
# reconfig the prometheus service
ceph orch reconfig prometheus
Disabling monitoring
--------------------