From 3a4beadce9d52f283550cb47741778992ca60d37 Mon Sep 17 00:00:00 2001 From: Alexon Oliveira <45946599+AlexonOliveiraRH@users.noreply.github.com> Date: Fri, 1 Nov 2024 12:46:45 -0300 Subject: [PATCH 1/2] doc/cephadm/services: [v1] Update monitoring.rst to add additional templates The current documentation lacks a lot of other available templates as the source code here: https://github.com/ceph/ceph/tree/main/src/pybind/mgr/cephadm/templates/services Signed-off-by: Alexon Oliveira --- doc/cephadm/services/monitoring.rst | 40 ++++++++++++++++++++++------- 1 file changed, 31 insertions(+), 9 deletions(-) diff --git a/doc/cephadm/services/monitoring.rst b/doc/cephadm/services/monitoring.rst index a0187363b5e..82b1dbee28a 100644 --- a/doc/cephadm/services/monitoring.rst +++ b/doc/cephadm/services/monitoring.rst @@ -304,24 +304,46 @@ Option names """""""""""" 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``: +overridden. These are the names to be used when storing with ``ceph config-key set``: -- ``services/alertmanager/alertmanager.yml`` -- ``services/grafana/ceph-dashboard.yml`` -- ``services/grafana/grafana.ini`` -- ``services/prometheus/prometheus.yml`` -- ``services/prometheus/alerting/custom_alerts.yml`` -- ``services/loki.yml`` -- ``services/promtail.yml`` +- ``services/alertmanager/alertmanager.yml.j2`` +- ``services/alertmanager/web.yml.j2`` +- ``services/grafana/ceph-dashboard.yml.j2`` +- ``services/grafana/grafana.ini.j2`` +- ``services/ingress/haproxy.cfg.j2`` +- ``services/ingress/keepalived.conf.j2`` +- ``services/iscsi/iscsi-gateway.cfg.j2`` +- ``services/mgmt-gateway/external_server.conf.j2`` +- ``services/mgmt-gateway/internal_server.conf.j2`` +- ``services/mgmt-gateway/nginx.conf.j2`` +- ``services/nfs/ganesha.conf.j2`` +- ``services/node-exporter/web.yml.j2`` +- ``services/nvmeof/ceph-nvmeof.conf.j2`` +- ``services/oauth2-proxy/oauth2-proxy.conf.j2`` +- ``services/prometheus/prometheus.yml.j2`` +- ``services/prometheus/web.yml.j2`` +- ``services/loki.yml.j2`` +- ``services/promtail.yml.j2`` You can look up the file templates that are currently used by cephadm in ``src/pybind/mgr/cephadm/templates``: - ``services/alertmanager/alertmanager.yml.j2`` +- ``services/alertmanager/web.yml.j2`` - ``services/grafana/ceph-dashboard.yml.j2`` - ``services/grafana/grafana.ini.j2`` +- ``services/ingress/haproxy.cfg.j2`` +- ``services/ingress/keepalived.conf.j2`` +- ``services/iscsi/iscsi-gateway.cfg.j2`` +- ``services/mgmt-gateway/external_server.conf.j2`` +- ``services/mgmt-gateway/internal_server.conf.j2`` +- ``services/mgmt-gateway/nginx.conf.j2`` +- ``services/nfs/ganesha.conf.j2`` +- ``services/node-exporter/web.yml.j2`` +- ``services/nvmeof/ceph-nvmeof.conf.j2`` +- ``services/oauth2-proxy/oauth2-proxy.conf.j2`` - ``services/prometheus/prometheus.yml.j2`` +- ``services/prometheus/web.yml.j2`` - ``services/loki.yml.j2`` - ``services/promtail.yml.j2`` From aee484425f7bcff0f18188032f99e14caed227cb Mon Sep 17 00:00:00 2001 From: Alexon Oliveira <45946599+AlexonOliveiraRH@users.noreply.github.com> Date: Fri, 1 Nov 2024 12:56:27 -0300 Subject: [PATCH 2/2] doc/cephadm/services: Update monitoring.rst to add additional templates The current documentation lacks a lot of other available templates as the source code here: https://github.com/ceph/ceph/tree/main/src/pybind/mgr/cephadm/templates/services v2 - This updated commit fixes the j2 extensions I left in the previous one wrongly. v3 - This updated commit changes the title as per PR's comment orientation Signed-off-by: Alexon Oliveira --- doc/cephadm/services/monitoring.rst | 36 ++++++++++++++--------------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/cephadm/services/monitoring.rst b/doc/cephadm/services/monitoring.rst index 82b1dbee28a..0e2c62105fa 100644 --- a/doc/cephadm/services/monitoring.rst +++ b/doc/cephadm/services/monitoring.rst @@ -306,24 +306,24 @@ Option names 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``: -- ``services/alertmanager/alertmanager.yml.j2`` -- ``services/alertmanager/web.yml.j2`` -- ``services/grafana/ceph-dashboard.yml.j2`` -- ``services/grafana/grafana.ini.j2`` -- ``services/ingress/haproxy.cfg.j2`` -- ``services/ingress/keepalived.conf.j2`` -- ``services/iscsi/iscsi-gateway.cfg.j2`` -- ``services/mgmt-gateway/external_server.conf.j2`` -- ``services/mgmt-gateway/internal_server.conf.j2`` -- ``services/mgmt-gateway/nginx.conf.j2`` -- ``services/nfs/ganesha.conf.j2`` -- ``services/node-exporter/web.yml.j2`` -- ``services/nvmeof/ceph-nvmeof.conf.j2`` -- ``services/oauth2-proxy/oauth2-proxy.conf.j2`` -- ``services/prometheus/prometheus.yml.j2`` -- ``services/prometheus/web.yml.j2`` -- ``services/loki.yml.j2`` -- ``services/promtail.yml.j2`` +- ``services/alertmanager/alertmanager.yml`` +- ``services/alertmanager/web.yml`` +- ``services/grafana/ceph-dashboard.yml`` +- ``services/grafana/grafana.ini`` +- ``services/ingress/haproxy.cfg`` +- ``services/ingress/keepalived.conf`` +- ``services/iscsi/iscsi-gateway.cfg`` +- ``services/mgmt-gateway/external_server.conf`` +- ``services/mgmt-gateway/internal_server.conf`` +- ``services/mgmt-gateway/nginx.conf`` +- ``services/nfs/ganesha.conf`` +- ``services/node-exporter/web.yml`` +- ``services/nvmeof/ceph-nvmeof.conf`` +- ``services/oauth2-proxy/oauth2-proxy.conf`` +- ``services/prometheus/prometheus.yml`` +- ``services/prometheus/web.yml`` +- ``services/loki.yml`` +- ``services/promtail.yml`` You can look up the file templates that are currently used by cephadm in ``src/pybind/mgr/cephadm/templates``: