From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Tue, 31 Mar 2026 08:43:37 +0000 (+0700) Subject: doc/hardware-monitoring: improve index.rst X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=893d1be0277facc93894817df7236520259cf7ef;p=ceph.git doc/hardware-monitoring: improve index.rst Try to improve language. Fix a typo. Fix CLI example commands rendered as comments. Fix capitalization and hyphenation. Try to follow the usual style. Signed-off-by: Ville Ojamo --- diff --git a/doc/hardware-monitoring/index.rst b/doc/hardware-monitoring/index.rst index dcafa82303f5..de94f6ee6aa9 100644 --- a/doc/hardware-monitoring/index.rst +++ b/doc/hardware-monitoring/index.rst @@ -1,10 +1,15 @@ .. _hardware-monitoring: -Hardware monitoring +=================== +Hardware Monitoring =================== -`node-proxy` is the internal name to designate the running agent which inventories a machine's hardware, provides the different statuses and enable the operator to perform some actions. -It gathers details from the RedFish API, processes and pushes data to agent endpoint in the Ceph manager daemon. +``node-proxy`` is the internal name of the agent which inventories a machine's +hardware, provides different statuses, and enables the operator to perform +some actions. +It gathers details from the Redfish API that is often provided by an +out-of-band management interface present on server systems. The data is then +processed and pushed to an agent endpoint in the Ceph Manager. .. graphviz:: @@ -17,31 +22,33 @@ It gathers details from the RedFish API, processes and pushes data to agent endp agent -> redfish [label=" 1." color=green]; agent -> mgr [label=" 2." color=orange]; - dashboard:dashboard -> mgr [label=" 3."color=lightgreen]; + dashboard:dashboard -> mgr [label=" 3." color=lightgreen]; node [shape=plaintext]; legend [label=< - - - + + +
Legend
1. Collects data from redfish API
2. Pushes data to ceph mgr
3. Query ceph mgr
1. Collects data from Redfish API
2. Pushes data to Ceph Manager
3. Queries Ceph Manager
>]; } Limitations ------------ +=========== -For the time being, the `node-proxy` agent relies on the RedFish API. -It implies both `node-proxy` agent and `ceph-mgr` daemon need to be able to access the Out-Of-Band network to work. +For the time being, the ``node-proxy`` agent relies on the Redfish API. +This implies that both ``node-proxy`` agent and the Ceph Manager need to be +able to access the out-of-band network. -Deploying the agent -------------------- +Deploying the Agent +=================== -| The first step is to provide the out of band management tool credentials. -| This can be done when adding the host with a service spec file: +The first step is to provide the out-of-band management tool IP address and +credentials. This can be done when adding the host with a :ref:`service +spec ` file: -.. code-block:: bash +.. prompt:: bash # auto # cat host.yml --- @@ -55,23 +62,24 @@ Deploying the agent Apply the spec: -.. code-block:: bash +.. prompt:: bash # auto # ceph orch apply -i host.yml Added host 'node-10' with addr '10.10.10.10' Deploy the agent: -.. code-block:: bash +.. prompt:: bash # auto # ceph config set mgr mgr/cephadm/hw_monitoring true + CLI ---- +=== | **orch** **hardware** **status** [hostname] [--category CATEGORY] [--format plain | json] -supported categories are: +Supported categories are: * summary (default) * memory @@ -83,14 +91,15 @@ supported categories are: * firmwares * criticals + Examples -******** +-------- -hardware health statuses summary -++++++++++++++++++++++++++++++++ +Hardware Health Status Summary +______________________________ -.. code-block:: bash +.. prompt:: bash # auto # ceph orch hardware status +------------+---------+-----+-----+--------+-------+------+ @@ -100,10 +109,10 @@ hardware health statuses summary +------------+---------+-----+-----+--------+-------+------+ -storage devices report -++++++++++++++++++++++ +Storage Devices Report +______________________ -.. code-block:: bash +.. prompt:: bash # auto # ceph orch hardware status IBM-Ceph-1 --category storage +------------+--------------------------------------------------------+------------------+----------------+----------+----------------+--------+---------+ @@ -129,10 +138,10 @@ storage devices report -firmwares details -+++++++++++++++++ +Firmware Details +________________ -.. code-block:: bash +.. prompt:: bash # auto # ceph orch hardware status node-10 --category firmwares +------------+----------------------------------------------------------------------------+--------------------------------------------------------------+----------------------+-------------+--------+ @@ -148,10 +157,10 @@ firmwares details +------------+----------------------------------------------------------------------------+--------------------------------------------------------------+----------------------+-------------+--------+ -hardware critical warnings report -+++++++++++++++++++++++++++++++++ +Hardware Critical Warnings Report +_________________________________ -.. code-block:: bash +.. prompt:: bash # auto # ceph orch hardware status --category criticals +------------+-----------+------------+----------+-----------------+ @@ -161,8 +170,8 @@ hardware critical warnings report +------------+-----------+------------+----------+-----------------+ -Developpers ------------ +For Developers +============== .. py:currentmodule:: cephadm.agent .. autoclass:: NodeProxyEndpoint