[pve-devel] [PATCH pve-docs] pvenode: add WOL section to doc

[Thomas Lamprecht]

On 1/18/19 2:55 PM, Christian Ebner wrote:
> Adds a section containing information about the wake on LAN feature to the
> pvenode documentation.

thanks, some nits inside, I may've went a bit over board, so maybe pick the for
you reasonable sounding parts up.

> 
> Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
> ---
>  pvenode.adoc | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/pvenode.adoc b/pvenode.adoc
> index a41085f..df17f93 100644
> --- a/pvenode.adoc
> +++ b/pvenode.adoc
> @@ -50,6 +50,17 @@ systemctl restart pveproxy
>  
>  Setup ACME account and order a certificate for local node.
>  
> +Wake-on-LAN
> +-----------
> +`pvenode` allows to wake sleeping nodes in a cluster via a Wake-on-LAN (WOL)
> +packet. For this to work, the network interface of the node to wake must support
> +WOL as well as have it enabled.

I'd start off with what WOL is in a short sentence:
> Wake-on-LAN (WoL) is a feature to switch on a computer via the network.

Then mention what it needs to work/enable

> At least one NIC must support this feature. Further, the computers firmware
> (BIOS/UEFI) configuration needs to have the respective option enabled. The option
> name van vary from 'Enable Wake-on-Lan' to 'Power On By PCIE Device', check
> your motherboards vendor manual, if unsure.

maybe even mention ethtool to check if it's available/on:
# ethtool enp1s0f0 | grep Wake-on

not sure though

> +
> +`pvenode wakeonlan <node>` is used to wake the sleeping `<node>`.
> +It sends the WOL magic packet via an UDP broadcast to `255.255.255.255` on
> +port 9. The MAC address of `<node>` is obtained from the `wakeonlan` property
> +specified in the per node configuration `/etc/pve/nodes/{node}/config`.
> +

Broadcast and 255.255... is a bit redundant, I'd maybe shorten this to something like:
> WOL broadcasts a UDP magic package using port 9.

Also, for command examples we often do not inline them, but use

----
command args
----

I'm not sure if I'd mention the full path here at all, maybe just show people how
to set it with the pvenode tool?

> With {pve} one can configure the desired wake on Lan MAC address in the node
> configuration file, for example:
> 
> ----
> pvenode config set -wakeonlan DE:AD:BE:EF:AB:CD
> ----


>  // TODO: extend and improve chapter!
>  
>  ifdef::manvolnum[]
>