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 /doc/rtd/topics/datasources.rst | |
| 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 'doc/rtd/topics/datasources.rst')
| -rw-r--r-- | doc/rtd/topics/datasources.rst | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/doc/rtd/topics/datasources.rst b/doc/rtd/topics/datasources.rst index 0d7d4aca..3a9c808c 100644 --- a/doc/rtd/topics/datasources.rst +++ b/doc/rtd/topics/datasources.rst @@ -1,11 +1,11 @@ .. _datasources: -========= +=========== Datasources -========= ----------- +=========== +---------------------- What is a datasource? ----------- +---------------------- Datasources are sources of configuration data for cloud-init that typically come from the user (aka userdata) or come from the stack that created the configuration @@ -70,9 +70,9 @@ The current interface that a datasource object must provide is the following: def get_package_mirror_info(self) ---------------------------- +--- EC2 ---------------------------- +--- The EC2 datasource is the oldest and most widely used datasource that cloud-init supports. This datasource interacts with a *magic* ip that is provided to the @@ -130,61 +130,61 @@ To see which versions are supported from your cloud provider use the following U ... latest ---------------------------- +------------ Config Drive ---------------------------- +------------ .. include:: ../../sources/configdrive/README.rst ---------------------------- +---------- OpenNebula ---------------------------- +---------- .. include:: ../../sources/opennebula/README.rst ---------------------------- +--------- Alt cloud ---------------------------- +--------- .. include:: ../../sources/altcloud/README.rst ---------------------------- +-------- No cloud ---------------------------- +-------- .. include:: ../../sources/nocloud/README.rst ---------------------------- +---- MAAS ---------------------------- +---- *TODO* For now see: http://maas.ubuntu.com/ ---------------------------- +---------- CloudStack ---------------------------- +---------- .. include:: ../../sources/cloudstack/README.rst ---------------------------- +--- OVF ---------------------------- +--- *TODO* For now see: https://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/files/head:/doc/sources/ovf/ ---------------------------- +--------- OpenStack ---------------------------- +--------- .. include:: ../../sources/openstack/README.rst ---------------------------- +------------- Fallback/None ---------------------------- +------------- This is the fallback datasource when no other datasource can be selected. It is the equivalent of a *empty* datasource in that it provides a empty string as userdata |