Skip to content

Commit

Permalink
fixup! doc: Set expectations for new datasources (#4670)
Browse files Browse the repository at this point in the history
  • Loading branch information
holmanb committed Dec 8, 2023
1 parent 717cc98 commit ae68599
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions doc/rtd/development/datasource_creation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _datasource_creation:

Adding cloud-init support to your cloud or platform
***************************************************
Supporting your cloud or platform
*********************************

The upstream cloud-init project regularly accepts code contributions for new
platforms that wish to support cloud-init.
Expand All @@ -13,8 +13,8 @@ In order to use cloud-init with a new platform, a couple of approaches
are possible:

1. Provide platform compatibility with one of the existing datasource
definitions, such as DatasourceNoCloud.py. Several platforms, including
`Libvirt`_ and `Proxmox`_ use this approach.
definitions, such as `nocloud`_ via `DatasourceNoCloud.py`_. Several
platforms, including `Libvirt`_ and `Proxmox`_ use this approach.
2. Add a new datasource definition to upstream cloud-init. This provides
tighter integration, a better debugging experience, and more control
and flexibility of cloud-init's interaction with the datasource. This
Expand Down Expand Up @@ -45,9 +45,8 @@ through `DMI`_ data. For example, Oracle's public cloud provides the string
``Cloud-init``-enabled images produce a log file with details about the
platform. Reading through this log in :file:`/run/cloud-init/ds-identify.log`
may provide the information needed to uniquely identify the platform.
If the log is not present, you can generate it by running from source
:file:`./tools/ds-identify` or the installed location
:file:`/usr/lib/cloud-init/ds-identify`.
If the log is not present, one can generate the log by running ``ds-identify``
manually.

The mechanism used to identify the platform will be required for
``ds-identify`` and the datasource module sections below.
Expand All @@ -56,9 +55,8 @@ A mechanism for cloud-init to retrieve configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There are a few different methods by which cloud-init may retrieve
cloud-configuration from its platform to configure the instance. Perhaps
the most common method is a webserver providing configuration over a link-local
network.
cloud-configuration from its platform to configure the instance. The most
common method is a webserver providing configuration over a link-local network.

Logistical Requirements
-----------------------
Expand Down Expand Up @@ -179,3 +177,5 @@ fixes by the upstream development team.
.. _DMI: https://www.dmtf.org/sites/default/files/standards/documents/DSP0005.pdf
.. _Libvirt: https://github.com/virt-manager/virt-manager/blob/main/man/virt-install.rst#--cloud-init
.. _Proxmox: https://pve.proxmox.com/wiki/Cloud-Init_Support
.. _DatasourceNoCloud.py: https://github.com/canonical/cloud-init/blob/main/cloudinit/sources/DataSourceNoCloud.py
.. _nocloud: https://cloudinit.readthedocs.io/en/latest/reference/datasources/nocloud.html

0 comments on commit ae68599

Please sign in to comment.