diff options
author | Brett Holman <bholman.devel@gmail.com> | 2022-03-03 16:13:24 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-03-03 16:13:24 +0100 |
commit | ddca5cbafcfbc149c8016ab06ccf47d5ee3bf72e (patch) | |
tree | 9b6d9bf37e1a6598aaaf688ea39bd26b7723fd0a | |
parent | 11ecbed53abfa83ac8415118f87655b23e652ec4 (diff) | |
download | cloud-init-git-ddca5cbafcfbc149c8016ab06ccf47d5ee3bf72e.tar.gz |
Doc cleanups (#1317)
Remove incorrect API documentation and convert documentation todos to
comments
-rw-r--r-- | doc/rtd/topics/datasources.rst | 60 | ||||
-rw-r--r-- | doc/rtd/topics/datasources/maas.rst | 4 | ||||
-rw-r--r-- | doc/rtd/topics/dir_layout.rst | 6 |
3 files changed, 3 insertions, 67 deletions
diff --git a/doc/rtd/topics/datasources.rst b/doc/rtd/topics/datasources.rst index f73a5b2a..fc08bb7d 100644 --- a/doc/rtd/topics/datasources.rst +++ b/doc/rtd/topics/datasources.rst @@ -111,63 +111,3 @@ need to take care of the following items: * **Add documentation for your datasource**: You should add a new file in ``doc/datasources/<cloudplatform>.rst`` - - -API -=== - -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 user data string - # - when filtering only the mime messages targeting - # 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 programmatic - # filtering on this launch index (or other selective actions) - @property - def launch_index(self) - - # 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 related 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) - -.. vi: textwidth=79 diff --git a/doc/rtd/topics/datasources/maas.rst b/doc/rtd/topics/datasources/maas.rst index 427fba24..eb59dab9 100644 --- a/doc/rtd/topics/datasources/maas.rst +++ b/doc/rtd/topics/datasources/maas.rst @@ -3,8 +3,6 @@ MAAS ==== -*TODO* +.. TODO: add content For now see: https://maas.io/docs - - diff --git a/doc/rtd/topics/dir_layout.rst b/doc/rtd/topics/dir_layout.rst index 9d2c9896..d4606ac5 100644 --- a/doc/rtd/topics/dir_layout.rst +++ b/doc/rtd/topics/dir_layout.rst @@ -38,7 +38,7 @@ application:: It is typically located at ``/var/lib`` but there are certain configuration scenarios where this can be altered. - TBD, describe this overriding more. +.. TODO: expand this section ``data/`` @@ -74,7 +74,7 @@ application:: ``seed/`` - TBD + Contains seeded data files: meta-data, network-config, user-data, vendor-data ``sem/`` @@ -83,5 +83,3 @@ application:: is only ran `per-once`, `per-instance`, `per-always`. This folder contains semaphore `files` which are only supposed to run `per-once` (not tied to the instance id). - -.. vi: textwidth=79 |