From 51e01236c844acd38a621ecf4d1cff439d4d5615 Mon Sep 17 00:00:00 2001 From: Dan Bungert Date: Thu, 25 Jul 2024 13:31:55 -0600 Subject: [PATCH 1/5] reference: example for shutdown --- doc/reference/autoinstall-reference.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/reference/autoinstall-reference.rst b/doc/reference/autoinstall-reference.rst index b18f2b6bf..dc4534893 100644 --- a/doc/reference/autoinstall-reference.rst +++ b/doc/reference/autoinstall-reference.rst @@ -892,6 +892,18 @@ Request the system to power off or reboot automatically after the installation h * ``reboot`` * ``poweroff`` +shutdown examples: + +.. code-block:: yaml + + autoinstall: + # default behavior + shutdown: reboot + + autoinstall: + # shutdown instead of reboot + shutdown: poweroff + .. _ai-late-commands: late-commands From cda41b7654bbc0ae0a39311971fee68c872efa8f Mon Sep 17 00:00:00 2001 From: Dan Bungert Date: Thu, 25 Jul 2024 13:40:42 -0600 Subject: [PATCH 2/5] reference: clarify ssh behavior on non-server ISOs Also add openssh as a permitted word. --- doc/.custom_wordlist.txt | 1 + doc/reference/autoinstall-reference.rst | 4 +++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/.custom_wordlist.txt b/doc/.custom_wordlist.txt index e5b9e8de2..15a2a37b5 100644 --- a/doc/.custom_wordlist.txt +++ b/doc/.custom_wordlist.txt @@ -62,6 +62,7 @@ iSCSI init md oem +openssh passwd ppc pre diff --git a/doc/reference/autoinstall-reference.rst b/doc/reference/autoinstall-reference.rst index dc4534893..2fcde9587 100644 --- a/doc/reference/autoinstall-reference.rst +++ b/doc/reference/autoinstall-reference.rst @@ -718,7 +718,9 @@ install-server * **type:** boolean * **default:** ``false`` -Whether to install the OpenSSH server in the target system. +Whether to install the OpenSSH server in the target system. Note that Desktop +install ISOs do not include openssh-server on the ISO, so installs of +Desktop require Ubuntu archive access for install-server to be successful. authorized-keys ^^^^^^^^^^^^^^^ From 949e285dda01eb7d62b4129112746d1f586e19a5 Mon Sep 17 00:00:00 2001 From: Dan Bungert Date: Thu, 25 Jul 2024 13:41:21 -0600 Subject: [PATCH 3/5] reference: examples for ssh --- doc/reference/autoinstall-reference.rst | 27 +++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/doc/reference/autoinstall-reference.rst b/doc/reference/autoinstall-reference.rst index 2fcde9587..f87ff6539 100644 --- a/doc/reference/autoinstall-reference.rst +++ b/doc/reference/autoinstall-reference.rst @@ -736,6 +736,33 @@ allow-pw * **type:** boolean * **default:** ``true`` if ``authorized_keys`` is empty, ``false`` otherwise +ssh examples: + +.. code-block:: yaml + + autoinstall: + # default behavior + ssh: + install-server: false + authorized-keys: [] + allow-pw: true + + autoinstall: + # recommended configuration when openssh-server is desired + ssh: + install-server: true + authorized-keys: + # replace with the contents of the public key(s) as generated by + # ssh-keygen or similar tools + - ssh-ed25519 AAAAC3NzaC..6O8tvZobj user@host + allow-pw: false + + autoinstall: + # configuration for password access + ssh: + install-server: true + allow-pw: true + .. _ai-codecs: codecs From d00e2220556e3f229b179d013c07502eb51cb16d Mon Sep 17 00:00:00 2001 From: Dan Bungert Date: Thu, 25 Jul 2024 17:46:53 -0600 Subject: [PATCH 4/5] reference: document IDs for source --- doc/.custom_wordlist.txt | 2 ++ doc/reference/autoinstall-reference.rst | 41 +++++++++++++++++++++++-- 2 files changed, 40 insertions(+), 3 deletions(-) diff --git a/doc/.custom_wordlist.txt b/doc/.custom_wordlist.txt index 15a2a37b5..b70848750 100644 --- a/doc/.custom_wordlist.txt +++ b/doc/.custom_wordlist.txt @@ -11,6 +11,7 @@ GPT GUID GiB GiB +Kylin Libera LPAR LTS @@ -36,6 +37,7 @@ Seagate Subiquity UEFI URI +Xubuntu Zdev amd authorized diff --git a/doc/reference/autoinstall-reference.rst b/doc/reference/autoinstall-reference.rst index f87ff6539..52d0ceee1 100644 --- a/doc/reference/autoinstall-reference.rst +++ b/doc/reference/autoinstall-reference.rst @@ -218,9 +218,44 @@ id ^^ * **type:** string -* **default:** identifier of the first available source. - -Identifier of the source to install (e.g., ``ubuntu-server-minimal``). +* **default:** the default value as listed in install-sources + +Identifier of the source to install (e.g., ``ubuntu-server-minimal``). The +correct ID to use is specific to a given install ISO. As this ID may change +over time, the canonical place to look for this information is the install ISO +itself, in the file ``casper/install-sources.yaml``, where the value to use is +the ``id``. + +Current values: +* ubuntu-server: + * minimal: ``ubuntu-server-minimal`` + * standard (default): ``ubuntu-server`` +* Ubuntu desktop: + * minimal (default): ``ubuntu-desktop-minimal`` + * standard: ``ubuntu-desktop`` +* Ubuntu Budgie: + * minimal: ``ubuntu-budgie-desktop-minimal`` + * standard (default): ``ubuntu-budgie-desktop`` +* Ubuntu Cinnamon: + * minimal: ``ubuntucinnamon-desktop-minimal`` + * standard (default): ``ubuntucinnamon-desktop`` +* Edubuntu: + * minimal: ``edubuntu-desktop-minimal`` + * standard (default): ``edubuntu-desktop`` +* Ubuntu Kylin: + * minimal: ``ubuntukylin-desktop-minimal`` + * standard (default): ``ubuntukylin-desktop`` +* Ubuntu MATE: + * minimal: ``ubuntu-mate-desktop-minimal`` + * standard (default): ``ubuntu-mate-desktop`` +* Ubuntu Studio: + * standard (default): ``ubuntustudio-desktop`` +* Xubuntu: + * full ISO: + * minimal: ``xubuntu-desktop-minimal`` + * standard (default): ``xubuntu-desktop`` + * minimal ISO: + * minimal (default): ``xubuntu-desktop-minimal`` .. _ai-network: From a1d6e792aa2650c22c9fbb151d7289d407241f1e Mon Sep 17 00:00:00 2001 From: Dan Bungert Date: Thu, 25 Jul 2024 17:49:49 -0600 Subject: [PATCH 5/5] reference: examples for source --- doc/reference/autoinstall-reference.rst | 41 +++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/doc/reference/autoinstall-reference.rst b/doc/reference/autoinstall-reference.rst index 52d0ceee1..78ccb3835 100644 --- a/doc/reference/autoinstall-reference.rst +++ b/doc/reference/autoinstall-reference.rst @@ -227,36 +227,77 @@ itself, in the file ``casper/install-sources.yaml``, where the value to use is the ``id``. Current values: + * ubuntu-server: + * minimal: ``ubuntu-server-minimal`` * standard (default): ``ubuntu-server`` + * Ubuntu desktop: + * minimal (default): ``ubuntu-desktop-minimal`` * standard: ``ubuntu-desktop`` + * Ubuntu Budgie: + * minimal: ``ubuntu-budgie-desktop-minimal`` * standard (default): ``ubuntu-budgie-desktop`` + * Ubuntu Cinnamon: + * minimal: ``ubuntucinnamon-desktop-minimal`` * standard (default): ``ubuntucinnamon-desktop`` + * Edubuntu: + * minimal: ``edubuntu-desktop-minimal`` * standard (default): ``edubuntu-desktop`` + * Ubuntu Kylin: + * minimal: ``ubuntukylin-desktop-minimal`` * standard (default): ``ubuntukylin-desktop`` + * Ubuntu MATE: + * minimal: ``ubuntu-mate-desktop-minimal`` * standard (default): ``ubuntu-mate-desktop`` + * Ubuntu Studio: + * standard (default): ``ubuntustudio-desktop`` + * Xubuntu: + * full ISO: + * minimal: ``xubuntu-desktop-minimal`` * standard (default): ``xubuntu-desktop`` + * minimal ISO: + * minimal (default): ``xubuntu-desktop-minimal`` +source examples: + +.. code-block:: yaml + + autoinstall: + # default behavior + source: + search_drivers: true + id: + + autoinstall: + # on the ubuntu-server ISO, install with the minimal source + source: + id: ubuntu-server-minimal + + autoinstall: + # on the Ubuntu desktop ISO, install with the standard source + source: + id: ubuntu-desktop + .. _ai-network: network