Skip to content

Commit

Permalink
doc: apt reference curtin usage examples
Browse files Browse the repository at this point in the history
Remove the example for adding a PPA since introducing it in curtin's
common snippet's section in [1]. Guide users to the official curtin
documentation for examples of curtin specific behavior.

[1] https://code.launchpad.net/~cpete/curtin/+git/curtin/+merge/471552
  • Loading branch information
Chris-Peterson444 committed Aug 20, 2024
1 parent 2f25577 commit 068b803
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions doc/reference/autoinstall-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -392,15 +392,18 @@ apt

APT configuration, used both during the installation and once booted into the target system.

This section historically used the same format as curtin, which is documented in the `APT Source <https://curtin.readthedocs.io/en/latest/topics/apt_source.html>`_ section of the curtin documentation. Nonetheless, some key differences with the format supported by curtin have been introduced:
This section has historically used the same format as curtin, which is documented in the `APT Source <https://curtin.readthedocs.io/en/latest/topics/apt_source.html>`_ section of the curtin documentation. Nonetheless, some key differences with the format supported by curtin have been introduced:

- Subiquity supports an alternative format for the ``primary`` section, allowing configuration of a list of candidate primary mirrors. During installation, Subiquity automatically tests the specified mirrors and selects the first one that appears usable. This new behaviour is only activated when the ``primary`` section is wrapped in the ``mirror-selection`` section.

- The ``fallback`` key controls what Subiquity does when no primary mirror is usable.

- The ``geoip`` key controls whether to perform IP-based geolocation to determine the correct country mirror.

The default apt configuration is equivalent to:

All other sections behave as defined in curtin. See the curtin `documentation <https://curtin.readthedocs.io/en/latest/topics/apt_source.html#common-snippets>`_ and its `example apt configurations <https://git.launchpad.net/curtin/tree/examples/apt-source.yaml>`_ for usage examples of these sections.

The default apt configuration in Subiquity is equivalent to:

.. code-block:: yaml
Expand Down Expand Up @@ -529,16 +532,6 @@ Examples:
geoip: false
To add a PPA:

.. code-block:: yaml
autoinstall:
apt:
sources:
curtin-ppa:
source: ppa:curtin-dev/test-archive
.. _ai-storage:

storage
Expand Down

0 comments on commit 068b803

Please sign in to comment.