saltstack / salt

Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here:
https://repo.saltproject.io/
Apache License 2.0
14.13k stars 5.47k forks source link

DDNS Module configuration structure. #52650

Open DeForce opened 5 years ago

DeForce commented 5 years ago

Description of Issue/Question

Currently, DDNS Module configuration documentation is not really understandable to what you need to configure in the minion configuration to run this execution module with TSIG authentication.

Documentation: https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.ddns.html looks like documentation specifies how you configure it using CLI, not minion configuration:

keyfile: keyring file (default=None)
keyname: key name in file (default=None)
...

You can configure module using minion configuration which is not documented and looks like:

ddns.keyfile: ...
ddns.keyname: ...

Browsing Source code I have found that it is using module config.option which doesn't know how to traverse a dict.

I think that current way of configuring is oldschool and we can leverage YAML and nested structure to be like that:

ddns:
  keyfile: something
  keyname: something
...
DeForce commented 5 years ago

PR for the change #52651