AutomatedServerInstalls

Differences between revisions 33 and 60 (spanning 27 versions)
Revision 33 as of 2019-07-22 20:41:55
Size: 6290
Editor: mwhudson
Comment:
Revision 60 as of 2020-06-11 04:19:11
Size: 61
Editor: mwhudson
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
||<#FF5555> '''This document is entirely a description of something that does not yet exist''' ||

= Automated Server Installs for 20.04 (and maybe 18.04.4?) =

||<#FF5555> '''This document is entirely a description of something that does not yet exist''' ||

Please direct feedback on this proposal to [[https://community.ubuntu.com/t/please-review-design-for-automated-server-installs/11923|community.ubuntu.com]] or [[https://lists.ubuntu.com/mailman/listinfo/ubuntu-server|the ubuntu-server mailing list]].

<<TableOfContents()>>

= Introduction =

The server installer for 20.04 supports a new mode of operation: automated installation, autoinstallation for short. You might also know this feature as unattended or handsoff or preseeded installation.

Autoinstallation lets you answer all those configuration questions ahead of time in an ''autoinstall file'' and lets the installation process run without any interaction.

= Differences from debian-installer preseeding =

''preseeds'' are the way to automate an installer based on debian-installer (aka d-i).

autoinstalls for the new server installer differ from preseeds in the following main ways:

 * the file format is completely different (yaml vs debconf-set-selections format)
 * when the answer to a question is not present in a preseed, d-i stops and asks the user for input. autoinstalls are not like this: if there is any autoinstall config at all, the installer takes the default for any unanswered question (and fails if there is no default).

= Providing the autoinstall file =

The autoinstall file can be provided in the following ways:

 * As `/autoinstall.yaml` in the initrd
 * As `/autoinstall.yaml` on the install media
 * As `/autoinstall.yaml` on a filesystem with label "autoinstall"
 * Via a http or https (or maybe tftp) URL on the kernel command line

= Creating an autoinstall file =

When any system is installed using the server installer, an autoinstall file for repeating the install is created at {{{/var/log/installer/autoinstall.yaml}}}.

Alternatively there is a snap, ``autoinstall-editor``, that can be used to either edit or create from scratch an autoinstall file (it is actually mostly the same code as that that runs the installation in interactive mode).

{{{
# start editing new config file
$ autoinstall-editor
# dump out to stdout a complete autoinstall config file with default answers everywhere
$ autoinstall-editor --create > my-autoinstall.yaml
# edit existing autoinstall file
$ autoinstall-editor my-autoinstall.yaml
}}}

= The format of an autoinstall file =

The autoinstall file is YAML and has [[/ConfigReference|full documentation]].

A minimal config (for a single disk system) is:

{{{
version: 1
    username: mwhudson
    password: $crypted_pass
}}}

Here is an example file that shows off most features:

[[/ConfigReference#version|version]]`: 1`<<BR>>
[[/ConfigReference#reporting|reporting]]:<<BR>>
` hook:`<<BR>>
` type: webhook`<<BR>>
` endpoint: http://example.com/endpoint/path`<<BR>>
[[/ConfigReference#early_commands|early_commands]]`:`<<BR>>
` - ping -c1 198.162.1.1`<<BR>>
[[/ConfigReference#locale|locale]]`: en_US`<<BR>>
[[/ConfigReference#keyboard|keyboard]]`:`<<BR>>
` layout: en`<<BR>>
` variant: uk`<<BR>>
[[/ConfigReference#network|network]]`:`<<BR>>
` version: 2`<<BR>>
` network:`<<BR>>
` ethernets:`<<BR>>
` enp0s25:`<<BR>>
` dhcp4: yes`<<BR>>
` enp3s0:`<<BR>>
` enp4s0:`<<BR>>
` bonds:`<<BR>>
` bond0:`<<BR>>
` dhcp4: yes`<<BR>>
` interfaces:`<<BR>>
` - enp3s0`<<BR>>
` - enp4s0`<<BR>>
` parameters:`<<BR>>
` mode: active-backup`<<BR>>
` primary: enp3s0`<<BR>>
[[/ConfigReference#proxy|proxy]]`: http://squid.internal:3128/`<<BR>>
[[/ConfigReference#mirror|mirror]]`: http://repo.internal/`<<BR>>
[[/ConfigReference#filesystem|filesystem]]`:`<<BR>>
` layout:`<<BR>>
` name: lvm`<<BR>>
[[/ConfigReference#identity|identity]]`:`<<BR>>
` username: mwhudson`<<BR>>
` password: $crypted_pass`<<BR>>
[[/ConfigReference#ssh|ssh]]`:`<<BR>>
` install_server: yes`<<BR>>
` authorized_keys:`<<BR>>
` - $key`<<BR>>
` allow_pw: no`<<BR>>
[[/ConfigReference#snaps|snaps]]`:`<<BR>>
` - go/stable`<<BR>>
[[/ConfigReference#debconf_selections|debconf_selections]]`: |`<<BR>>
` bind9 bind9/run-resolvconf boolean false`<<BR>>
[[/ConfigReference#packages|packages]]`:`<<BR>>
` - libreoffice`<<BR>>
` - dns-server^`<<BR>>
[[/ConfigReference#error_commands|error_commands]]`:`<<BR>>
` - tar c /var/log/installer | nc 192.168.0.1 1000`

Many keys and values correspond straightforwardly to questions the installer asks (e.g. keyboard selection). See the reference for details of those that do not.

= Possible future directions =

There are other places we could put the autoinstall config:

 * As a b64encoded gzipped blob on the kernel command line
 * Given as a URL via DHCP

Possibly the installer should support reporting progress to some endpoint.

We could add syntax to indicate that the user should still be asked for the answer to some question or other.

We might want to extend the 'match specs' for disks to cover other ways of selecting disks.

We might want to add some way of customizing the apt sources (adding a PPA, etc). Possibly just by accepting more of the curtin syntax for this.

There are other things we could do by default in a system with multiple disks (create an LVM VG incorporating all of them, just install on one disk picked at random, install on the largest disk, etc etc).

We could support kickstart compatibility as in kickseed.

We could allow the config to contain verbatim cloud-init config for the new system. Several of the keys in the current syntax are actually used to produce cloud-init config, but we could document that these are ignored if you supply your own config. (Although some of cloud-init’s default behaviours are a bit unhelpful for a bare metal install so maybe some kind of merging of configs is needed anyway...)
moved to https://ubuntu.com/server/docs/install/autoinstall

FoundationsTeam/AutomatedServerInstalls (last edited 2020-06-11 04:19:11 by mwhudson)