Skip to content

Commit 4d72308

Browse files
authored
Merge pull request ceph#65406 from rkachach/fix_grafana_docs
doc: update Grafana certificate configuration to use certmgr Reviewed-by: Adam King <[email protected]>
2 parents 098432f + 2b5efb7 commit 4d72308

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

doc/cephadm/services/monitoring.rst

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -515,28 +515,43 @@ services have been deployed, you should see something like this when you issue t
515515
Configuring SSL/TLS for Grafana
516516
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
517517

518-
``cephadm`` deploys Grafana using the certificate defined in the ceph
519-
key/value store. If no certificate is specified, ``cephadm`` generates a
520-
self-signed certificate during the deployment of the Grafana service. Each
521-
certificate is specific for the host it was generated on.
518+
``cephadm`` deploys Grafana using a certificate managed by the cephadm
519+
Certificate Manager (certmgr). Certificates for Grafana are **per host**:
522520

523-
A custom certificate can be configured using the following commands:
521+
- **Default (cephadm-signed):** If no certificate is specified,
522+
cephadm generates and signs a certificate for each host where Grafana runs.
523+
- **User-provided (as reference):** You can add your own certificate
524+
and private key with certmgr and reference them in the Grafana spec.
524525

525-
.. prompt:: bash #
526+
A Grafana service spec with a user-provided certificate looks like:
527+
528+
.. code-block:: yaml
526529
527-
ceph config-key set mgr/cephadm/{hostname}/grafana_key -i $PWD/key.pem
528-
ceph config-key set mgr/cephadm/{hostname}/grafana_crt -i $PWD/certificate.pem
530+
service_type: grafana
531+
placement:
532+
hosts:
533+
- <ceph-node-hostname>
534+
spec:
535+
ssl: true
536+
certificate_source: reference
537+
538+
To register a custom certificate and key with certmgr for host ``<ceph-node-hostname>``:
539+
540+
.. prompt:: bash #
529541

530-
Where `hostname` is the hostname for the host where grafana service is deployed.
542+
ceph orch certmgr cert set --cert-name grafana_ssl_cert --hostname <ceph-node-hostname> -i $PWD/certificate.pem
543+
ceph orch certmgr key set --key-name grafana_ssl_key --hostname <ceph-node-hostname> -i $PWD/key.pem
531544

532-
If you have already deployed Grafana, run ``reconfig`` on the service to
533-
update its configuration:
545+
If Grafana is already deployed, run ``reconfig`` on the service to
546+
apply the updated certificate:
534547

535548
.. prompt:: bash #
536549

537-
ceph orch reconfig grafana
550+
ceph orch reconfig grafana
538551

539-
The ``reconfig`` command also sets the proper URL for Ceph Dashboard.
552+
The ``reconfig`` command also ensures that the Ceph Dashboard URL
553+
is updated to use the correct certificate. The ``reconfig`` command
554+
also sets the proper URL for the Ceph Dashboard.
540555

541556
Setting the initial admin password
542557
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)