doc: add stub reference, and sample links to it

doc/reference/autoinstall-reference.rst

@@ -0,0 +1,186 @@
+.. _ai:
+
+Autoinstall Configuration Reference Manual
+******************************************
+
+.. _ai-active-directory:
+
+active-directory
+================
+
+stub
+
+.. _ai-apt:
+
+apt
+=======
+
+stub
+
+.. _ai-codecs:
+
+codecs
+======
+
+stub
+
+.. _ai-debconf-selections:
+
+debconf-selections
+==================
+
+stub
+
+.. _ai-early-commands:
+
+early-commands
+==============
+
+stub
+
+.. _ai-error-commands:
+
+error-commands
+==============
+
+stub
+
+.. _ai-identity:
+
+identity
+========
+
+stub
+
+.. _ai-interactive-sections:
+
+interactive-sections
+====================
+
+stub
+
+.. _ai-kernel:
+
+kernel
+======
+
+stub
+
+.. _ai-keyboard:
+
+keyboard
+========
+
+stub
+
+.. _ai-late-commands:
+
+late-commands
+=============
+
+stub
+
+.. _ai-locale:
+
+locale
+======
+
+stub
+
+.. _ai-network:
+
+network
+=======
+
+stub
+
+.. _ai-oem:
+
+oem
+===
+
+stub
+
+.. _ai-packages:
+
+packages
+========
+
+stub
+
+.. _ai-proxy:
+
+proxy
+=====
+
+stub
+
+.. _ai-refresh-installer:
+
+refresh-installer
+=================
+
+stub
+
+.. _ai-reporting:
+
+reporting
+=========
+
+stub
+
+.. _ai-shutdown:
+
+shutdown
+========
+
+stub
+
+.. _ai-snaps:
+
+snaps
+=====
+
+stub
+
+.. _ai-ssh:
+
+ssh
+===
+
+stub
+
+.. _ai-storage:
+
+storage
+=======
+
+stub
+
+.. _ai-ubuntu-pro:
+
+ubuntu-pro
+==========
+
+stub
+
+.. _ai-updates:
+
+updates
+=======
+
+stub
+
+.. _ai-user-data:
+
+user-data
+=========
+
+stub
+
+.. _ai-version:
+
+version
+=======
+
+stub

doc/reference/index.rst

@@ -5,6 +5,15 @@ Our reference section contains support information for Subiquity.
 This includes details on the network requirements, API definitions, support
 matrices and so on.
 
+Autoinstall Reference Manual
+============================
+
+
+.. toctree::
+   :maxdepth: 1
+
+   autoinstall-reference.rst
+
 -----
 
 .. toctree::

doc/tutorial/intro-to-autoinstall.rst

@@ -138,6 +138,91 @@ for repeating the install is created at
 :code:`/var/log/installer/autoinstall-user-data`.
 
 
+The structure of an autoinstall configuration
+=============================================
+
+See the :ref:`ai` for full details on the supported autoinstall directives.
+
+A minimal autoinstall configuration is:
+
+.. code-block:: yaml
+
+    version: 1
+    identity:
+        hostname: hostname
+        username: username
+        password: $crypted_pass
+
+Here is an example file that shows off most features:
+
+.. parsed-literal::
+
+    :ref:`ai-version`: 1
+    :ref:`ai-reporting`:
+        hook:
+            type: webhook
+            endpoint: http\://example.com/endpoint/path
+    :ref:`ai-early-commands`:
+        - ping -c1 198.162.1.1
+    :ref:`ai-locale`: en_US
+    :ref:`ai-keyboard`:
+        layout: gb
+        variant: dvorak
+    :ref:`ai-network`:
+        network:
+            version: 2
+            ethernets:
+                enp0s25:
+                   dhcp4: yes
+                enp3s0: {}
+                enp4s0: {}
+            bonds:
+                bond0:
+                    dhcp4: yes
+                    interfaces:
+                        - enp3s0
+                        - enp4s0
+                    parameters:
+                        mode: active-backup
+                        primary: enp3s0
+    :ref:`ai-proxy`: http\://squid.internal:3128/
+    :ref:`ai-apt`:
+        primary:
+            - arches: [default]
+              uri: http\://repo.internal/
+        sources:
+            my-ppa.list:
+                source: "deb http\://ppa.launchpad.net/curtin-dev/test-archive/ubuntu $RELEASE main"
+                keyid: B59D 5F15 97A5 04B7 E230  6DCA 0620 BBCF 0368 3F77
+    :ref:`ai-storage`:
+        layout:
+            name: lvm
+    :ref:`ai-identity`:
+        hostname: hostname
+        username: username
+        password: $crypted_pass
+    :ref:`ai-ssh`:
+        install-server: yes
+        authorized-keys:
+          - $key
+        allow-pw: no
+    :ref:`ai-snaps`:
+        - name: go
+          channel: 1.20/stable
+          classic: true
+    :ref:`ai-debconf-selections`: |
+        bind9      bind9/run-resolvconf    boolean false
+    :ref:`ai-packages`:
+        - libreoffice
+        - dns-server^
+    :ref:`ai-user-data`:
+        disable_root: false
+    :ref:`ai-late-commands`:
+        - sed -ie 's/GRUB_TIMEOUT=.\*/GRUB_TIMEOUT=30/' /target/etc/default/grub
+    :ref:`ai-error-commands`:
+        - tar c /var/log/installer | nc 192.168.0.1 1000
+
+
 Error handling
 ==============