From b6dea1e0ec60ad382e4c318624275b7b3f14554d Mon Sep 17 00:00:00 2001 From: Francesco Di Nucci Date: Thu, 5 Dec 2024 12:44:27 +0100 Subject: [PATCH] docs: smart proxy BMC providers additional info Add redfish BMC provider. Make provider dependencies explicit. Verified on 3.12.x and 3.13.x --- _includes/manuals/3.12/4.3.3_smartproxy_bmc.md | 5 +++-- _includes/manuals/3.13/4.3.3_smartproxy_bmc.md | 5 +++-- _includes/manuals/nightly/4.3.3_smartproxy_bmc.md | 5 +++-- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/_includes/manuals/3.12/4.3.3_smartproxy_bmc.md b/_includes/manuals/3.12/4.3.3_smartproxy_bmc.md index 564355dc24..cc58408e0c 100644 --- a/_includes/manuals/3.12/4.3.3_smartproxy_bmc.md +++ b/_includes/manuals/3.12/4.3.3_smartproxy_bmc.md @@ -8,8 +8,9 @@ Activate the BMC management module within the Smart Proxy instance. This allows Available providers are: -* `freeipmi` - for IPMI control using the freeipmi implementation -* `ipmitool` - using the ipmitool implementation +* `freeipmi` - for IPMI control using the freeipmi implementation. Requires [freeipmi](https://www.gnu.org/software/freeipmi) and [rubyipmi](https://rubygems.org/gems/rubyipmi) Ruby gem. +* `ipmitool` - using the ipmitool implementation. Requires [ipmitool](https://github.com/ipmitool/ipmitool) and [rubyipmi](https://rubygems.org/gems/rubyipmi) Ruby gem. +* `redfish` - using [redfish_client](https://rubygems.org/gems/redfish_client) Ruby gem implementation. The gem should be installed by default. * `shell` - specialized provider for controlling the proxy server itself (used for Foreman Discovery) * `ssh` - simple provider via SSH command `shutdown` with limited functionality (poweron does not work) diff --git a/_includes/manuals/3.13/4.3.3_smartproxy_bmc.md b/_includes/manuals/3.13/4.3.3_smartproxy_bmc.md index 564355dc24..cc58408e0c 100644 --- a/_includes/manuals/3.13/4.3.3_smartproxy_bmc.md +++ b/_includes/manuals/3.13/4.3.3_smartproxy_bmc.md @@ -8,8 +8,9 @@ Activate the BMC management module within the Smart Proxy instance. This allows Available providers are: -* `freeipmi` - for IPMI control using the freeipmi implementation -* `ipmitool` - using the ipmitool implementation +* `freeipmi` - for IPMI control using the freeipmi implementation. Requires [freeipmi](https://www.gnu.org/software/freeipmi) and [rubyipmi](https://rubygems.org/gems/rubyipmi) Ruby gem. +* `ipmitool` - using the ipmitool implementation. Requires [ipmitool](https://github.com/ipmitool/ipmitool) and [rubyipmi](https://rubygems.org/gems/rubyipmi) Ruby gem. +* `redfish` - using [redfish_client](https://rubygems.org/gems/redfish_client) Ruby gem implementation. The gem should be installed by default. * `shell` - specialized provider for controlling the proxy server itself (used for Foreman Discovery) * `ssh` - simple provider via SSH command `shutdown` with limited functionality (poweron does not work) diff --git a/_includes/manuals/nightly/4.3.3_smartproxy_bmc.md b/_includes/manuals/nightly/4.3.3_smartproxy_bmc.md index 564355dc24..cc58408e0c 100644 --- a/_includes/manuals/nightly/4.3.3_smartproxy_bmc.md +++ b/_includes/manuals/nightly/4.3.3_smartproxy_bmc.md @@ -8,8 +8,9 @@ Activate the BMC management module within the Smart Proxy instance. This allows Available providers are: -* `freeipmi` - for IPMI control using the freeipmi implementation -* `ipmitool` - using the ipmitool implementation +* `freeipmi` - for IPMI control using the freeipmi implementation. Requires [freeipmi](https://www.gnu.org/software/freeipmi) and [rubyipmi](https://rubygems.org/gems/rubyipmi) Ruby gem. +* `ipmitool` - using the ipmitool implementation. Requires [ipmitool](https://github.com/ipmitool/ipmitool) and [rubyipmi](https://rubygems.org/gems/rubyipmi) Ruby gem. +* `redfish` - using [redfish_client](https://rubygems.org/gems/redfish_client) Ruby gem implementation. The gem should be installed by default. * `shell` - specialized provider for controlling the proxy server itself (used for Foreman Discovery) * `ssh` - simple provider via SSH command `shutdown` with limited functionality (poweron does not work)