[pve-devel] [PATCH v2 docs] ha-manager: simulator: add note for xauth when installing

[Thomas Lamprecht]

On 09.02.21 16:45, Aaron Lauterer wrote:
> Installing the ha-simulator on a PVE node directly to start it via ssh
> and x11 forwarding will need the 'xauth' package installed on the PVE
> node as well.
> 
> Otherwise one is likely to encounter the following error when starting
> the simulator: `Unable to init server: Could not connect: Connection
> refused`
> 
> Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
> ---
> I added this patch as I think it might be good to have a hint in the
> docs as well and not just a suggested package.
> 

yeah, good idea. IMO that's even the better place to fix this than the
package control file.

> 
>  ha-manager.adoc | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/ha-manager.adoc b/ha-manager.adoc
> index 2162d25..f0a029a 100644
> --- a/ha-manager.adoc
> +++ b/ha-manager.adoc
> @@ -505,6 +505,10 @@ pve-ha-simulator working/
>  You can then start, stop, migrate the simulated HA services, or even check out
>  what happens on a node failure.
>  
> +NOTE: Should you install the simulator on a {pve} node, it is possible that
> +starting the simulator will fail at first. If that happens, consider installing
> +the 'xauth' package on the {pve} node.

IMO this is a bit weird wording. General failure can be much different things.
E.g., this sounds like it would help to install xauth for any error even if no
ssh X forwarding is involved at all.

Rather state the exact use case and requirements. Something short along the lines
of:

HINT: If you want to forward the simulator window over SSH, you need to install
the `xauth` package on the {pve} node.