diff options
| author | Wesley Wiedenmeier <wesley.wiedenmeier@gmail.com> | 2016-08-28 17:56:17 -0500 |
|---|---|---|
| committer | Scott Moser <smoser@brickies.net> | 2016-09-30 13:21:00 -0400 |
| commit | 1071b9940b4e114cd2eabf290b739f92fbab33de (patch) | |
| tree | a8fbef15c5be9510df93b4544e3bca1f74e2f29a /cloudinit/config/cc_resolv_conf.py | |
| parent | 02f6c4bb8cef17b3fe04ef4dc1ef199e20aeb4d9 (diff) | |
| download | vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.tar.gz vyos-cloud-init-1071b9940b4e114cd2eabf290b739f92fbab33de.zip | |
Improve module documentation and doc cleanup.
This adds lots of config module documentation in a standard format.
It will greatly improve the content at readthedocs.
Additionally:
* Add a 'doc' env to tox.ini
* Changed default highlight language for sphinx conf from python to yaml
most examples in documentation are yaml configs
* Updated datasource examples to highlight sh code properly
Diffstat (limited to 'cloudinit/config/cc_resolv_conf.py')
| -rw-r--r-- | cloudinit/config/cc_resolv_conf.py | 69 |
1 files changed, 39 insertions, 30 deletions
diff --git a/cloudinit/config/cc_resolv_conf.py b/cloudinit/config/cc_resolv_conf.py index 71d9e3a7..feea5653 100644 --- a/cloudinit/config/cc_resolv_conf.py +++ b/cloudinit/config/cc_resolv_conf.py @@ -18,36 +18,45 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. -# Note: -# This module is intended to manage resolv.conf in environments where -# early configuration of resolv.conf is necessary for further -# bootstrapping and/or where configuration management such as puppet or -# chef own dns configuration. As Debian/Ubuntu will, by default, utilize -# resovlconf, and similarly RedHat will use sysconfig, this module is -# likely to be of little use unless those are configured correctly. -# -# For RedHat with sysconfig, be sure to set PEERDNS=no for all DHCP -# enabled NICs. And, in Ubuntu/Debian it is recommended that DNS -# be configured via the standard /etc/network/interfaces configuration -# file. -# -# -# Usage Example: -# -# #cloud-config -# manage_resolv_conf: true -# -# resolv_conf: -# nameservers: ['8.8.4.4', '8.8.8.8'] -# searchdomains: -# - foo.example.com -# - bar.example.com -# domain: example.com -# options: -# rotate: true -# timeout: 1 -# - +""" +Resolv Conf +----------- +**Summary:** configure resolv.conf + +This module is intended to manage resolv.conf in environments where early +configuration of resolv.conf is necessary for further bootstrapping and/or +where configuration management such as puppet or chef own dns configuration. +As Debian/Ubuntu will, by default, utilize resovlconf, and similarly RedHat +will use sysconfig, this module is likely to be of little use unless those +are configured correctly. + +.. note:: + For RedHat with sysconfig, be sure to set PEERDNS=no for all DHCP + enabled NICs. + +.. note:: + And, in Ubuntu/Debian it is recommended that DNS be configured via the + standard /etc/network/interfaces configuration file. + +**Internal name:** ``cc_resolv_conf`` + +**Module frequency:** per instance + +**Supported distros:** fedora, rhel, sles + +**Config keys**:: + + manage_resolv_conf: <true/false> + resolv_conf: + nameservers: ['8.8.4.4', '8.8.8.8'] + searchdomains: + - foo.example.com + - bar.example.com + domain: example.com + options: + rotate: <true/false> + timeout: 1 +""" from cloudinit import log as logging from cloudinit.settings import PER_INSTANCE |