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 --- cloudinit/config/cc_rightscale_userdata.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'cloudinit/config/cc_rightscale_userdata.py') diff --git a/cloudinit/config/cc_rightscale_userdata.py b/cloudinit/config/cc_rightscale_userdata.py index 8118fac4..6cf8c948 100644 --- a/cloudinit/config/cc_rightscale_userdata.py +++ b/cloudinit/config/cc_rightscale_userdata.py @@ -18,6 +18,32 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +""" +Rightscale Userdata +------------------- +**Summary:** support rightscale configuration hooks + +This module adds support for RightScale configuration hooks to cloud-init. +RightScale adds a entry in the format ``CLOUD_INIT_REMOTE_HOOK=http://...`` to +ec2 user-data. This module checks for this line in the raw userdata and +retrieves any scripts linked by the RightScale user data and places them in the +user scripts configuration directory, to be run later by ``cc_scripts_user``. + +.. note:: + the ``CLOUD_INIT_REMOTE_HOOK`` config variable is present in the raw ec2 + user data only, not in any cloud-config parts + +**Internal name:** ``cc_rightscale_userdata`` + +**Module frequency:** per instance + +**Supported distros:** all + +**Config keys**:: + + CLOUD_INIT_REMOTE_HOOK= +""" + # # The purpose of this script is to allow cloud-init to consume # rightscale style userdata. rightscale user data is key-value pairs -- cgit v1.2.3