summaryrefslogtreecommitdiff
path: root/doc/rtd/topics/datasources.rst
diff options
context:
space:
mode:
authorStephan Telling <st@telling.xyz>2017-06-01 22:08:29 +0200
committerScott Moser <smoser@ubuntu.com>2017-06-06 09:43:40 -0600
commitdc0e70d155b4ff7a3c914ae7aaed3a52571e2107 (patch)
treed4512a8e8e883486691bb8208c760341e70ac206 /doc/rtd/topics/datasources.rst
parent27c079bb14667fda52937ee198b72c80823f3a4f (diff)
downloadvyos-cloud-init-dc0e70d155b4ff7a3c914ae7aaed3a52571e2107.tar.gz
vyos-cloud-init-dc0e70d155b4ff7a3c914ae7aaed3a52571e2107.zip
fix typos and remove whitespace in various docs
Diffstat (limited to 'doc/rtd/topics/datasources.rst')
-rw-r--r--doc/rtd/topics/datasources.rst26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/rtd/topics/datasources.rst b/doc/rtd/topics/datasources.rst
index 9acecc53..a60f5eb7 100644
--- a/doc/rtd/topics/datasources.rst
+++ b/doc/rtd/topics/datasources.rst
@@ -20,7 +20,7 @@ through the typical usage of subclasses.
The current interface that a datasource object must provide is the following:
.. sourcecode:: python
-
+
# returns a mime multipart message that contains
# all the various fully-expanded components that
# were found from processing the raw userdata string
@@ -28,47 +28,47 @@ The current interface that a datasource object must provide is the following:
# this instance id will be returned (or messages with
# no instance id)
def get_userdata(self, apply_filter=False)
-
+
# returns the raw userdata string (or none)
def get_userdata_raw(self)
-
+
# returns a integer (or none) which can be used to identify
# this instance in a group of instances which are typically
- # created from a single command, thus allowing programatic
+ # created from a single command, thus allowing programmatic
# filtering on this launch index (or other selective actions)
@property
def launch_index(self)
-
- # the data sources' config_obj is a cloud-config formated
+
+ # the data sources' config_obj is a cloud-config formatted
# object that came to it from ways other than cloud-config
# because cloud-config content would be handled elsewhere
def get_config_obj(self)
-
+
#returns a list of public ssh keys
def get_public_ssh_keys(self)
-
+
# translates a device 'short' name into the actual physical device
# fully qualified name (or none if said physical device is not attached
# or does not exist)
def device_name_to_device(self, name)
-
+
# gets the locale string this instance should be applying
# which typically used to adjust the instances locale settings files
def get_locale(self)
-
+
@property
def availability_zone(self)
-
+
# gets the instance id that was assigned to this instance by the
# cloud provider or when said instance id does not exist in the backing
# metadata this will return 'iid-datasource'
def get_instance_id(self)
-
+
# gets the fully qualified domain name that this host should be using
# when configuring network or hostname releated settings, typically
# assigned either by the cloud provider or the user creating the vm
def get_hostname(self, fqdn=False)
-
+
def get_package_mirror_info(self)