[pve-devel] [PATCH docs] vzdump: document the new cluster-wide config file

[Thomas Lamprecht]

On 09/02/2023 10:27, Leo Nunner wrote:
> + change the wording from "Global configuration" to "Node-wide
> configuration"
> 
> Signed-off-by: Leo Nunner <l.nunner at proxmox.com>
> ---
> The wording was previously already changed by Fiona but hasn't been
> merged yet:
> 
> https://lists.proxmox.com/pipermail/pve-devel/2022-December/055123.html
> 
>  vzdump.adoc | 12 ++++++++----
>  1 file changed, 8 insertions(+), 4 deletions(-)
> 
> diff --git a/vzdump.adoc b/vzdump.adoc
> index ce46529..253f264 100644
> --- a/vzdump.adoc
> +++ b/vzdump.adoc
> @@ -473,13 +473,17 @@ entire process happens transparently from a user's point of view.
>  Configuration
>  -------------
>  
> -Global configuration is stored in `/etc/vzdump.conf`. The file uses a
> -simple colon separated key/value format. Each line has the following
> -format:
> +Node-wide configuration is stored in `/etc/vzdump.conf`. A cluster-wide
> +configuration can be found at `/etc/pve/vzdump.conf`. Note that this is merely
> +a fallback, and that the node-wide configuration always has higher precedence.

but node-specific configs do not take precedence over CLI? This is worded a bit
confusing, maybe go for something more explicit as, i.e., something along the
lines of:

For each option the order of precendence is, Job or CLI option, if not defined then
local node-specific config, if not defined there then datacenter wide config and
if not defined there the default documented in the API schema.

> +Options that are not set in the node-wide configuration will be taken from
> +the cluster configuration, and, if not set there either, will take the default
> +value. The files use a simple colon separated key/value format. Each line
> +has the following format:
>  
>   OPTION: value
>  
> -Blank lines in the file are ignored, and lines starting with a `#`
> +Blank lines in the files are ignored, and lines starting with a `#`
>  character are treated as comments and are also ignored. Values from
>  this file are used as default, and can be overwritten on the command
>  line.