xref: /freebsd/release/tools/ec2.conf (revision f9856d08139ac5aea7c1258fc85958d6786b416f)
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# Include the amazon-ssm-agent package in amd64 images, since some users want
12# to be able to use it on systems which are not connected to the Internet.
13# (It is not enabled by default, however.)  This package does not exist for
14# aarch64, so we have to be selective about when we install it.
15if [ "${TARGET_ARCH}" = "amd64" ]; then
16	export VM_EXTRA_PACKAGES="${VM_EXTRA_PACKAGES} amazon-ssm-agent"
17fi
18
19# Set to a list of third-party software to enable in rc.conf(5).
20export VM_RC_LIST="ec2_configinit ec2_fetchkey ec2_loghostkey firstboot_freebsd_update firstboot_pkgs ntpd"
21
22# Build with a 3 GB UFS partition; the growfs rc.d script will expand
23# the partition to fill the root disk after the EC2 instance is launched.
24# Note that if this is set to <N>G, we will end up with an <N+1> GB disk
25# image since VMSIZE is the size of the UFS partition, not the disk which
26# it resides within.
27export VMSIZE=3072M
28
29# No swap space; the ec2_ephemeralswap rc.d script will allocate swap
30# space on EC2 ephemeral disks.  (If they exist -- the T2 low-cost instances
31# and the C4 compute-optimized instances don't have ephemeral disks.  But
32# it would be silly to bloat the image and increase costs for every instance
33# just for those two families, especially since instances ranging in size
34# from 1 GB of RAM to 60 GB of RAM would need different sizes of swap space
35# anyway.)
36export NOSWAP=YES
37
38vm_extra_pre_umount() {
39	# The firstboot_pkgs rc.d script will download the repository
40	# catalogue and install or update pkg when the instance first
41	# launches, so these files would just be replaced anyway; removing
42	# them from the image allows it to boot faster.
43	chroot ${DESTDIR} env ASSUME_ALWAYS_YES=yes \
44		/usr/sbin/pkg delete -f -y pkg
45	rm ${DESTDIR}/var/db/pkg/repo-*.sqlite
46
47	# The size of the EC2 root disk can be configured at instance launch
48	# time; expand our filesystem to fill the disk.
49	echo 'growfs_enable="YES"' >> ${DESTDIR}/etc/rc.conf
50
51	# EC2 instances use DHCP to get their network configuration.  IPv6
52	# requires accept_rtadv.
53	echo 'ifconfig_DEFAULT="SYNCDHCP accept_rtadv"' >> ${DESTDIR}/etc/rc.conf
54
55	# Unless the system has been configured via EC2 user-data, the user
56	# will need to SSH in to do anything.
57	echo 'sshd_enable="YES"' >> ${DESTDIR}/etc/rc.conf
58
59	# The AWS CLI tools are generally useful, and small enough that they
60	# will download quickly; but users will often override this setting
61	# via EC2 user-data.
62	echo 'firstboot_pkgs_list="awscli"' >> ${DESTDIR}/etc/rc.conf
63
64	# Enable IPv6 on all interfaces, and use DHCP on both IPv4 and IPv6.
65	echo 'ipv6_activate_all_interfaces="YES"' >> ${DESTDIR}/etc/rc.conf
66	echo 'dhclient_program="/usr/local/sbin/dual-dhclient"' >> ${DESTDIR}/etc/rc.conf
67
68	# The EC2 console is output-only, so while printing a backtrace can
69	# be useful, there's no point dropping into a debugger or waiting
70	# for a keypress.
71	echo 'debug.trace_on_panic=1' >> ${DESTDIR}/boot/loader.conf
72	echo 'debug.debugger_on_panic=0' >> ${DESTDIR}/boot/loader.conf
73	echo 'kern.panic_reboot_wait_time=0' >> ${DESTDIR}/boot/loader.conf
74
75	# The console is not interactive, so we might as well boot quickly.
76	echo 'autoboot_delay="-1"' >> ${DESTDIR}/boot/loader.conf
77	echo 'beastie_disable="YES"' >> ${DESTDIR}/boot/loader.conf
78
79	# The emulated keyboard attached to EC2 instances is inaccessible to
80	# users, and there is no mouse attached at all; disable to keyboard
81	# and the keyboard controller (to which the mouse would attach, if
82	# one existed) in order to save time in device probing.
83	echo 'hint.atkbd.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
84	echo 'hint.atkbdc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
85
86	# EC2 has two consoles: An emulated serial port ("system log"),
87	# which has been present since 2006; and a VGA console ("instance
88	# screenshot") which was introduced in 2016.
89	echo 'boot_multicons="YES"' >> ${DESTDIR}/boot/loader.conf
90
91	# Some older EC2 hardware used a version of Xen with a bug in its
92	# emulated serial port.  It is not clear if EC2 still has any such
93	# nodes, but apply the workaround just in case.
94	echo 'hw.broken_txfifo="1"' >> ${DESTDIR}/boot/loader.conf
95
96	# Load the kernel module for the Amazon "Elastic Network Adapter"
97	echo 'if_ena_load="YES"' >> ${DESTDIR}/boot/loader.conf
98
99	# Disable ChallengeResponseAuthentication according to EC2
100	# requirements.
101	sed -i '' -e \
102		's/^#ChallengeResponseAuthentication yes/ChallengeResponseAuthentication no/' \
103		${DESTDIR}/etc/ssh/sshd_config
104
105	# Use the NTP service provided by Amazon
106	sed -i '' -e 's/^pool/#pool/' \
107		-e '1,/^#server/s/^#server.*/server 169.254.169.123 iburst/' \
108		${DESTDIR}/etc/ntp.conf
109
110	# The first time the AMI boots, the installed "first boot" scripts
111	# should be allowed to run:
112	# * ec2_configinit (download and process EC2 user-data)
113	# * ec2_fetchkey (arrange for SSH using the EC2-provided public key)
114	# * growfs (expand the filesystem to fill the provided disk)
115	# * firstboot_freebsd_update (install critical updates)
116	# * firstboot_pkgs (install packages)
117	touch ${DESTDIR}/firstboot
118
119	rm -f ${DESTDIR}/etc/resolv.conf
120
121	return 0
122}
123