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_disable_ec2_metadata.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_disable_ec2_metadata.py')
| -rw-r--r-- | cloudinit/config/cc_disable_ec2_metadata.py | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/cloudinit/config/cc_disable_ec2_metadata.py b/cloudinit/config/cc_disable_ec2_metadata.py index 3fd2c20f..5c54e6f4 100644 --- a/cloudinit/config/cc_disable_ec2_metadata.py +++ b/cloudinit/config/cc_disable_ec2_metadata.py @@ -18,6 +18,26 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +Disable EC2 Metadata +-------------------- +**Summary:** disable aws ec2 metadata + +This module can disable the ec2 datasource by rejecting the route to +``169.254.169.254``, the usual route to the datasource. This module is disabled +by default. + +**Internal name:** ``cc_disable_ec2_metadata`` + +**Module frequency:** per always + +**Supported distros:** all + +**Config keys**:: + + disable_ec2_metadata: <true/false> +""" + from cloudinit import util from cloudinit.settings import PER_ALWAYS |