Skip to content

Commit

Permalink
doc: intersphinx to cloud-init
Browse files Browse the repository at this point in the history
  • Loading branch information
dbungert committed Jul 7, 2023
1 parent 3a89519 commit 2e22aac
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
7 changes: 7 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,17 @@

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.

Expand Down
11 changes: 9 additions & 2 deletions doc/tutorial/intro-to-autoinstall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,15 @@ 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
Expand Down

0 comments on commit 2e22aac

Please sign in to comment.