xref: /freebsd/release/tools/ec2.conf (revision 62cfcf62f627e5093fb37026a6d8c98e4d2ef04c)
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-daemon ebsnvme-id"
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 dev_aws_disk"
21
22# Build with a 3.9 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=4000M
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	mount -t devfs devfs ${DESTDIR}/dev
44	chroot ${DESTDIR} ${EMULATOR} env ASSUME_ALWAYS_YES=yes \
45		/usr/sbin/pkg delete -f -y pkg
46	umount ${DESTDIR}/dev
47	rm ${DESTDIR}/var/db/pkg/repo-*.sqlite
48
49	# The size of the EC2 root disk can be configured at instance launch
50	# time; expand our filesystem to fill the disk.
51	echo 'growfs_enable="YES"' >> ${DESTDIR}/etc/rc.conf
52
53	# EC2 instances use DHCP to get their network configuration.  IPv6
54	# requires accept_rtadv.
55	echo 'ifconfig_DEFAULT="SYNCDHCP accept_rtadv"' >> ${DESTDIR}/etc/rc.conf
56
57	# Unless the system has been configured via EC2 user-data, the user
58	# will need to SSH in to do anything.
59	echo 'sshd_enable="YES"' >> ${DESTDIR}/etc/rc.conf
60
61	# The AWS CLI tools are generally useful, and small enough that they
62	# will download quickly; but users will often override this setting
63	# via EC2 user-data.
64	echo 'firstboot_pkgs_list="awscli"' >> ${DESTDIR}/etc/rc.conf
65
66	# Enable IPv6 on all interfaces, and use DHCP on both IPv4 and IPv6.
67	echo 'ipv6_activate_all_interfaces="YES"' >> ${DESTDIR}/etc/rc.conf
68	echo 'dhclient_program="/usr/local/sbin/dual-dhclient"' >> ${DESTDIR}/etc/rc.conf
69
70	# The EC2 console is output-only, so while printing a backtrace can
71	# be useful, there's no point dropping into a debugger or waiting
72	# for a keypress.
73	echo 'debug.trace_on_panic=1' >> ${DESTDIR}/boot/loader.conf
74	echo 'debug.debugger_on_panic=0' >> ${DESTDIR}/boot/loader.conf
75	echo 'kern.panic_reboot_wait_time=0' >> ${DESTDIR}/boot/loader.conf
76
77	# The console is not interactive, so we might as well boot quickly.
78	echo 'autoboot_delay="-1"' >> ${DESTDIR}/boot/loader.conf
79	echo 'beastie_disable="YES"' >> ${DESTDIR}/boot/loader.conf
80
81	# The emulated keyboard attached to EC2 instances is inaccessible to
82	# users, and there is no mouse attached at all; disable to keyboard
83	# and the keyboard controller (to which the mouse would attach, if
84	# one existed) in order to save time in device probing.
85	echo 'hint.atkbd.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
86	echo 'hint.atkbdc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
87
88	# EC2 has two consoles: An emulated serial port ("system log"),
89	# which has been present since 2006; and a VGA console ("instance
90	# screenshot") which was introduced in 2016.
91	echo 'boot_multicons="YES"' >> ${DESTDIR}/boot/loader.conf
92
93	# Some older EC2 hardware used a version of Xen with a bug in its
94	# emulated serial port.  It is not clear if EC2 still has any such
95	# nodes, but apply the workaround just in case.
96	echo 'hw.broken_txfifo="1"' >> ${DESTDIR}/boot/loader.conf
97
98	# Load the kernel module for the Amazon "Elastic Network Adapter"
99	echo 'if_ena_load="YES"' >> ${DESTDIR}/boot/loader.conf
100
101	# Use the "nda" driver for accessing NVMe disks rather than the
102	# historical "nvd" driver.
103	echo 'hw.nvme.use_nvd="0"' >> ${DESTDIR}/boot/loader.conf
104
105	# Disable ChallengeResponseAuthentication according to EC2
106	# requirements.
107	sed -i '' -e \
108		's/^#ChallengeResponseAuthentication yes/ChallengeResponseAuthentication no/' \
109		${DESTDIR}/etc/ssh/sshd_config
110
111	# Use the NTP service provided by Amazon
112	sed -i '' -e 's/^pool/#pool/' \
113		-e '1,/^#server/s/^#server.*/server 169.254.169.123 iburst/' \
114		${DESTDIR}/etc/ntp.conf
115
116	# Provide a map for accessing Elastic File System mounts
117	cat > ${DESTDIR}/etc/autofs/special_efs <<'EOF'
118#!/bin/sh
119
120if [ $# -eq 0 ]; then
121        # No way to know which EFS filesystems exist and are
122        # accessible to this EC2 instance.
123        exit 0
124fi
125
126# Provide instructions on how to mount the requested filesystem.
127FS=$1
128REGION=`fetch -qo- http://169.254.169.254/latest/meta-data/placement/availability-zone | sed -e 's/[a-z]$//'`
129echo "-nfsv4,minorversion=1,oneopenown ${FS}.efs.${REGION}.amazonaws.com:/"
130EOF
131	chmod 755 ${DESTDIR}/etc/autofs/special_efs
132
133	# The first time the AMI boots, the installed "first boot" scripts
134	# should be allowed to run:
135	# * ec2_configinit (download and process EC2 user-data)
136	# * ec2_fetchkey (arrange for SSH using the EC2-provided public key)
137	# * growfs (expand the filesystem to fill the provided disk)
138	# * firstboot_freebsd_update (install critical updates)
139	# * firstboot_pkgs (install packages)
140	touch ${DESTDIR}/firstboot
141
142	if ! [ -z "${QEMUSTATIC}" ]; then
143		rm -f ${DESTDIR}/${EMULATOR}
144	fi
145	rm -f ${DESTDIR}/etc/resolv.conf
146
147	return 0
148}
149