From 1071b9940b4e114cd2eabf290b739f92fbab33de Mon Sep 17 00:00:00 2001 From: Wesley Wiedenmeier Date: Sun, 28 Aug 2016 17:56:17 -0500 Subject: 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 --- .../config/cc_package_update_upgrade_install.py | 35 ++++++++++++++++++++++ 1 file changed, 35 insertions(+) (limited to 'cloudinit/config/cc_package_update_upgrade_install.py') diff --git a/cloudinit/config/cc_package_update_upgrade_install.py b/cloudinit/config/cc_package_update_upgrade_install.py index 73b0e30d..6d717616 100644 --- a/cloudinit/config/cc_package_update_upgrade_install.py +++ b/cloudinit/config/cc_package_update_upgrade_install.py @@ -16,6 +16,41 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Package Update Upgrade Install +------------------------------ +**Summary:** update, upgrade, and install packages + +This module allows packages to be updated, upgraded or installed during boot. +If any packages are to be installed or an upgrade is to be performed then the +package cache will be updated first. If a package installation or upgrade +requires a reboot, then a reboot can be performed if +``package_reboot_if_required`` is specified. A list of packages to install can +be provided. Each entry in the list can be either a package name or a list with +two entries, the first being the package name and the second being the specific +package version to install. + +**Internal name:** ``cc_package_update_upgrade_install`` + +**Module frequency:** per instance + +**Supported distros:** all + +**Config keys**:: + + packages: + - pwgen + - pastebinit + - [libpython2.7, 2.7.3-0ubuntu3.1] + package_update: + package_upgrade: + package_reboot_if_required: + + apt_update: (alias for package_update) + apt_upgrade: (alias for package_upgrade) + apt_reboot_if_required: (alias for package_reboot_if_required) +""" + import os import time -- cgit v1.2.3