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_ntp.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_ntp.py')
| -rw-r--r-- | cloudinit/config/cc_ntp.py | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/cloudinit/config/cc_ntp.py b/cloudinit/config/cc_ntp.py index ad69aa34..7cda3172 100644 --- a/cloudinit/config/cc_ntp.py +++ b/cloudinit/config/cc_ntp.py @@ -16,6 +16,38 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +NTP +--- +**Summary:** enable and configure ntp + +Handle ntp configuration. If ntp is not installed on the system and ntp +configuration is specified, ntp will be installed. If there is a default ntp +config file in the image or one is present in the distro's ntp package, it will +be copied to ``/etc/ntp.conf.dist`` before any changes are made. A list of ntp +pools and ntp servers can be provided under the ``ntp`` config key. If no ntp +servers or pools are provided, 4 pools will be used in the format +``{0-3}.{distro}.pool.ntp.org``. + +**Internal name:** ``cc_ntp`` + +**Module frequency:** per instance + +**Supported distros:** centos, debian, fedora, opensuse, ubuntu + +**Config keys**:: + + ntp: + pools: + - 0.company.pool.ntp.org + - 1.company.pool.ntp.org + - ntp.myorg.org + servers: + - my.ntp.server.local + - ntp.ubuntu.com + - 192.168.23.2 +""" + from cloudinit import log as logging from cloudinit.settings import PER_INSTANCE from cloudinit import templater |