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_final_message.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_final_message.py')
-rw-r--r-- | cloudinit/config/cc_final_message.py | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/cloudinit/config/cc_final_message.py b/cloudinit/config/cc_final_message.py index c9021eb1..5e144fde 100644 --- a/cloudinit/config/cc_final_message.py +++ b/cloudinit/config/cc_final_message.py @@ -18,6 +18,31 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +Final Message +------------- +**Summary:** output final message when cloud-init has finished + +This module configures the final message that cloud-init writes. The message is +specified as a jinja template with the following variables set: + + - ``version``: cloud-init version + - ``timestamp``: time at cloud-init finish + - ``datasource``: cloud-init data source + - ``uptime``: system uptime + +**Internal name:** ``cc_final_message`` + +**Module frequency:** per always + +**Supported distros:** all + +**Config keys**:: + + final_message: <message> + +""" + from cloudinit import templater from cloudinit import util from cloudinit import version |