ConfigReference

Differences between revisions 5 and 60 (spanning 55 versions)
Revision 5 as of 2019-07-16 22:48:04
Size: 3487
Editor: mwhudson
Comment:
Revision 60 as of 2020-06-11 04:20:26
Size: 71
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 Config File Reference =

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

<<TableOfContents()>>

= Overall format =

The autoinstall file is YAML. At top level it must be a mapping containing the keys described in this document. Unrecognized keys are ignored.

= Schema =

A schema for the config file should be written down at some point.

= Top-level keys =

== version ==

'''type:''' integer
<<BR>>
'''default:''' no default

A future-proofing config file version field. Currently this must be "1".

== early_commands ==

'''type:''' list
<<BR>>
'''default:''' no commands

A list of shell commands to invoke as soon as the installer starts, in particular before probing for block and network devices.

== locale ==

'''type:''' string
<<BR>>
'''default:''' en_US.UTF-8

The locale to configure for the installer.

== keyboard ==

'''type:''' mapping, see below
<<BR>>
'''default:''' US English keyboard

The layout of any attached keyboard. Often systems being automatically installed will not have a keyboard at all in which case the value used here does not matter.

== network ==

'''type:''' netplan-format mapping, see below
<<BR>>
'''default:''' DHCP on interfaces named eth* or en*

[[https://netplan.io/reference|netplan]] formatted network configuration. This will be applied during installation as well as in the installed system. The default is to interpret the config for the install media, which runs DHCPv4 on any interface with a name matching "eth*" or "en*" but then disables any interface that does not receive an address.

== proxy ==

'''type:''' URL
<<BR>>
'''default:''' no proxy

The proxy to configure both during installation and for apt and for snapd in the target system.

== mirror ==

'''type:''' URL
<<BR>>
'''default:''' http://archive.ubuntu.com/ubuntu or http://ports.ubuntu.com/ubuntu-ports depending on architecture

The archive mirror to use.

== filesystem ==

'''type:''' mapping, see below
<<BR>>
'''default:''' use "lvm" layout in a single disk system, no default in a multiple disk system

TBD.

== identity ==

'''type:''' mapping, see below
<<BR>>
'''default:''' no default

Configure the initial user for the system. A mapping that can contain keys:

=== realname ===
=== username ===
=== hostname ===
=== password ===

== ssh ==

'''type:''' mapping, see below
<<BR>>
'''default:''' do not install openssh-server

Configure ssh for the installed system. A mapping that can contain keys:

=== install_server ===
=== authorized_keys ===
=== allow_pw ===

== snaps ==

'''type:''' list
<<BR>>
'''default:''' install no extra snaps

Snaps to install, in the format "$snap_name/$channel".

== debconf_selections ==

'''type:''' string
<<BR>>
'''default:''' no config

The installer will update the target with debconf set-selection values. Users will need to be familiar with the package debconf options.

== packages ==

'''type:''' list
<<BR>>
'''default:''' no packages

A list of packages to install into the target system.

== late_commands ==

'''type:''' list
<<BR>>
'''default:''' no commands

Shell commands to run after the install has completed and any updates and packages installed, just before the system reboots
moved to https://ubuntu.com/server/docs/install/autoinstall-reference

FoundationsTeam/AutomatedServerInstalls/ConfigReference (last edited 2020-06-11 04:20:26 by mwhudson)