doc: intersphinx to cloud-init

This commit is contained in:
Dan Bungert 2023-07-06 16:40:35 -06:00
parent 34333f536f
commit 02efd6ae7d
2 changed files with 15 additions and 2 deletions

View File

@ -35,10 +35,17 @@ needs_sphinx = '5.1.1'
extensions = [ extensions = [
'm2r2', 'm2r2',
'sphinx.ext.intersphinx',
'sphinx_copybutton', 'sphinx_copybutton',
'sphinx_design', 'sphinx_design',
] ]
intersphinx_mapping = {
'cloud-init': (
'https://canonical-cloud-init.readthedocs-hosted.com/en/latest',
None
)
}
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

View File

@ -46,8 +46,14 @@ The suggested method of providing autoinstall to the Ubuntu installer is by way
of cloud-init. This allows the configuration to be applied to the installer of cloud-init. This allows the configuration to be applied to the installer
without having to modify the install media. without having to modify the install media.
When providing autoinstall via cloud-init, the autoinstall config is wrapped in The autoinstall config is provided via cloud-init configuration, which is
a cloud-config header and an autoinstall top-level key, like so: almost endlessly flexible. In most scenarios the easiest way will be to provide
user-data via the :external+cloud-init:ref:`datasource_nocloud` data source.
When providing autoinstall via cloud-init, the autoinstall config is provided
as :external+cloud-init:ref:`user_data_formats-cloud_config`. This
means we need a :code:`#cloud-config` header. The autoinstall directives are
placed under a top level :code:`autoinstall` key, like so:
.. code-block:: yaml .. code-block:: yaml