Language and formatting review of the Reference section.
This commit is contained in:
parent
968ba4e6b4
commit
0dd4ee7bae
|
@ -17,6 +17,7 @@ LUKS
|
||||||
LV
|
LV
|
||||||
LVM
|
LVM
|
||||||
LinuxONE
|
LinuxONE
|
||||||
|
Mantic
|
||||||
MiB
|
MiB
|
||||||
NIC
|
NIC
|
||||||
Netplan
|
Netplan
|
||||||
|
@ -36,7 +37,7 @@ UEFI
|
||||||
URI
|
URI
|
||||||
Zdev
|
Zdev
|
||||||
amd
|
amd
|
||||||
authorized-keys
|
authorized
|
||||||
autoinstall
|
autoinstall
|
||||||
autoinstaller
|
autoinstaller
|
||||||
autoinstalls
|
autoinstalls
|
||||||
|
@ -51,6 +52,7 @@ debian-installer
|
||||||
el
|
el
|
||||||
flavor
|
flavor
|
||||||
geoip
|
geoip
|
||||||
|
geolocation
|
||||||
globbing
|
globbing
|
||||||
hostname
|
hostname
|
||||||
iSCSI
|
iSCSI
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -1,35 +1,31 @@
|
||||||
.. _autoinstall_schema:
|
.. _autoinstall_schema:
|
||||||
|
|
||||||
Autoinstall schema
|
Autoinstall schema
|
||||||
******************
|
==================
|
||||||
|
|
||||||
The server installer validates the provided autoinstall configuration against a
|
The server installer validates the provided autoinstall configuration against a :ref:`JSON schema<autoinstall_JSON_schema>`.
|
||||||
:ref:`JSON schema<autoinstall_JSON_schema>`.
|
|
||||||
|
|
||||||
How the configuration is validated
|
How the configuration is validated
|
||||||
==================================
|
----------------------------------
|
||||||
|
|
||||||
Although the schema is presented below as a single document, and if you want
|
This reference manual presents the schema as a single document. Use it pre-validate your configuration.
|
||||||
to pre-validate your configuration you should validate it against this document, the
|
|
||||||
configuration is not actually validated against this document at run time. What
|
At run time, the configuration is not validated against this document. Instead, configuration sections are loaded and validated in this order:
|
||||||
happens instead is that some sections are loaded, validated, and applied
|
|
||||||
first, before all other sections are validated. In detail:
|
|
||||||
|
|
||||||
1. The reporting section is loaded, validated and applied.
|
1. The reporting section is loaded, validated and applied.
|
||||||
2. The error commands are loaded and validated.
|
2. The error commands are loaded and validated.
|
||||||
3. The early commands are loaded and validated.
|
3. The early commands are loaded and validated.
|
||||||
4. The early commands, if any, are run.
|
4. The early commands, if any, are run.
|
||||||
5. The configuration is reloaded, and now all sections are loaded and validated.
|
5. The configuration is reloaded, and all sections are loaded and validated.
|
||||||
|
|
||||||
This is so that validation errors in most sections can be reported via the
|
This is to ensure that potential validation errors in most sections can be reported using the reporting and error-commands configuration the same way as other errors.
|
||||||
reporting and error-commands configuration, as all other errors are.
|
|
||||||
|
|
||||||
.. _autoinstall_JSON_schema:
|
.. _autoinstall_JSON_schema:
|
||||||
|
|
||||||
Schema
|
Schema
|
||||||
======
|
------
|
||||||
|
|
||||||
The `JSON schema`_ for autoinstall data is as follows:
|
The `JSON schema`_ for autoinstall data:
|
||||||
|
|
||||||
.. code-block:: JSON
|
.. code-block:: JSON
|
||||||
|
|
||||||
|
@ -579,11 +575,11 @@ The `JSON schema`_ for autoinstall data is as follows:
|
||||||
}
|
}
|
||||||
|
|
||||||
Regeneration
|
Regeneration
|
||||||
============
|
------------
|
||||||
|
|
||||||
The schema above can be regenerated by running ``make schema`` in a Subiquity
|
To regenerate the schema, run ``make schema`` in the root directory of the `Subiquity source repository`_.
|
||||||
source checkout.
|
|
||||||
|
|
||||||
.. LINKS
|
.. LINKS
|
||||||
|
|
||||||
.. _JSON schema: https://json-schema.org/
|
.. _JSON schema: https://json-schema.org/
|
||||||
|
.. _Subiquity source repository: https://github.com/canonical/subiquity
|
||||||
|
|
|
@ -1,14 +1,12 @@
|
||||||
Reference
|
Reference
|
||||||
*********
|
=========
|
||||||
|
|
||||||
Our reference section contains support information for Subiquity.
|
The reference section contains support information for Subiquity. This includes details on the network requirements, API definitions, support matrices, and other.
|
||||||
This includes details on the network requirements, API definitions, support
|
|
||||||
matrices and so on.
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
Autoinstall reference manual
|
Autoinstall reference manual
|
||||||
============================
|
----------------------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
|
@ -1,3 +1,3 @@
|
||||||
.. |ubuntu-latest-version| replace:: 23.04
|
.. |ubuntu-latest-version| replace:: 23.10
|
||||||
.. |ubuntu-latest-codename| replace:: Lunar Lobster
|
.. |ubuntu-latest-codename| replace:: Mantic Minotaur
|
||||||
.. role:: command(literal)
|
.. role:: command(literal)
|
||||||
|
|
Loading…
Reference in New Issue