diff --git a/doc/conf.py b/doc/conf.py index 263437f1..bdd83ec5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -35,10 +35,17 @@ needs_sphinx = '5.1.1' extensions = [ 'm2r2', + 'sphinx.ext.intersphinx', 'sphinx_copybutton', '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. diff --git a/doc/tutorial/intro-to-autoinstall.rst b/doc/tutorial/intro-to-autoinstall.rst index f037547d..4c93ada0 100644 --- a/doc/tutorial/intro-to-autoinstall.rst +++ b/doc/tutorial/intro-to-autoinstall.rst @@ -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 without having to modify the install media. -When providing autoinstall via cloud-init, the autoinstall config is wrapped in -a cloud-config header and an autoinstall top-level key, like so: +The autoinstall config is provided via cloud-init configuration, which is +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