xref: /freebsd/release/tools/ec2.conf (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1#!/bin/sh
2#
3# $FreeBSD$
4#
5
6# Packages to install into the image we're creating.  This is a deliberately
7# minimalist set, providing only the packages necessary to bootstrap further
8# package installation as specified via EC2 user-data.
9export VM_EXTRA_PACKAGES="ec2-scripts firstboot-freebsd-update firstboot-pkgs dual-dhclient"
10
11# Set to a list of third-party software to enable in rc.conf(5).
12export VM_RC_LIST="ec2_configinit ec2_fetchkey ec2_ephemeralswap ec2_loghostkey firstboot_freebsd_update firstboot_pkgs"
13
14# Build with a 2 GB UFS partition; the growfs rc.d script will expand
15# the partition to fill the root disk after the EC2 instance is launched.
16# Note that if this is set to <N>G, we will end up with an <N+1> GB disk
17# image since VMSIZE is the size of the UFS partition, not the disk which
18# it resides within.
19export VMSIZE=2048M
20
21# No swap space; the ec2_ephemeralswap rc.d script will allocate swap
22# space on EC2 ephemeral disks.  (If they exist -- the T2 low-cost instances
23# and the C4 compute-optimized instances don't have ephemeral disks.  But
24# it would be silly to bloat the image and increase costs for every instance
25# just for those two families, especially since instances ranging in size
26# from 1 GB of RAM to 60 GB of RAM would need different sizes of swap space
27# anyway.)
28export NOSWAP=YES
29
30vm_extra_pre_umount() {
31	# The firstboot_pkgs rc.d script will download the repository
32	# catalogue and install or update pkg when the instance first
33	# launches, so these files would just be replaced anyway; removing
34	# them from the image allows it to boot faster.
35	env ASSUME_ALWAYS_YES=yes pkg -c ${DESTDIR} delete -f -y pkg
36	rm ${DESTDIR}/var/db/pkg/repo-*.sqlite
37
38	# The size of the EC2 root disk can be configured at instance launch
39	# time; expand our filesystem to fill the disk.
40	echo 'growfs_enable="YES"' >> ${DESTDIR}/etc/rc.conf
41
42	# EC2 instances use DHCP to get their network configuration.  IPv6
43	# requires accept_rtadv.
44	echo 'ifconfig_DEFAULT="SYNCDHCP accept_rtadv"' >> ${DESTDIR}/etc/rc.conf
45
46	# Unless the system has been configured via EC2 user-data, the user
47	# will need to SSH in to do anything.
48	echo 'sshd_enable="YES"' >> ${DESTDIR}/etc/rc.conf
49
50	# The AWS CLI tools are generally useful, and small enough that they
51	# will download quickly; but users will often override this setting
52	# via EC2 user-data.
53	echo 'firstboot_pkgs_list="awscli"' >> ${DESTDIR}/etc/rc.conf
54
55	# Enable IPv6 on all interfaces, and use DHCP on both IPv4 and IPv6.
56	echo 'ipv6_activate_all_interfaces="YES"' >> ${DESTDIR}/etc/rc.conf
57	echo 'dhclient_program="/usr/local/sbin/dual-dhclient"' >> ${DESTDIR}/etc/rc.conf
58
59	# The EC2 console is output-only, so while printing a backtrace can
60	# be useful, there's no point dropping into a debugger or waiting
61	# for a keypress.
62	echo 'debug.trace_on_panic=1' >> ${DESTDIR}/etc/sysctl.conf
63	echo 'debug.debugger_on_panic=0' >> ${DESTDIR}/etc/sysctl.conf
64	echo 'kern.panic_reboot_wait_time=0' >> ${DESTDIR}/etc/sysctl.conf
65
66	# The console is not interactive, so we might as well boot quickly.
67	echo 'autoboot_delay="-1"' >> ${DESTDIR}/boot/loader.conf
68	echo 'beastie_disable="YES"' >> ${DESTDIR}/boot/loader.conf
69
70	# EC2 has two consoles: An emulated serial port ("system log"),
71	# which has been present since 2006; and a VGA console ("instance
72	# screenshot") which was introduced in 2016.
73	echo 'boot_multicons="YES"' >> ${DESTDIR}/boot/loader.conf
74
75	# Some older EC2 hardware used a version of Xen with a bug in its
76	# emulated serial port.  It is not clear if EC2 still has any such
77	# nodes, but apply the workaround just in case.
78	echo 'hw.broken_txfifo="1"' >> ${DESTDIR}/boot/loader.conf
79
80	# The first time the AMI boots, the installed "first boot" scripts
81	# should be allowed to run:
82	# * ec2_configinit (download and process EC2 user-data)
83	# * ec2_fetchkey (arrange for SSH using the EC2-provided public key)
84	# * growfs (expand the filesystem to fill the provided disk)
85	# * firstboot_freebsd_update (install critical updates)
86	# * firstboot_pkgs (install packages)
87	touch ${DESTDIR}/firstboot
88
89	return 0
90}
91