xref: /freebsd/release/tools/ec2.conf (revision cd92dd23241e22dce06ebeb0c8e98eec5afcc896)
1#!/bin/sh
2
3# Package which should be installed onto all EC2 AMIs:
4# * ebsnvme-id, which is very minimal and provides important EBS-specific
5# functionality,
6export VM_EXTRA_PACKAGES="${VM_EXTRA_PACKAGES} ebsnvme-id"
7
8# Services which should be enabled by default in rc.conf(5).
9export VM_RC_LIST="dev_aws_disk ntpd"
10
11# Build with a 7.9 GB partition; the growfs rc.d script will expand
12# the partition to fill the root disk after the EC2 instance is launched.
13# Note that if this is set to <N>G, we will end up with an <N+1> GB disk
14# image since VMSIZE is the size of the filesystem partition, not the disk
15# which it resides within.
16export VMSIZE=8000m
17
18# No swap space; it doesn't make sense to provision any as part of the disk
19# image when we could be launching onto a system with anywhere between 0.5
20# and 4096 GB of RAM.
21export NOSWAP=YES
22
23ec2_common() {
24	# Delete the pkg package and the repo database; they will likely be
25	# long out of date before the EC2 instance is launched.
26	mount -t devfs devfs ${DESTDIR}/dev
27	chroot ${DESTDIR} ${EMULATOR} env ASSUME_ALWAYS_YES=yes \
28		/usr/sbin/pkg delete -f -y pkg
29	umount ${DESTDIR}/dev
30	rm -r ${DESTDIR}/var/db/pkg/repos/FreeBSD
31
32	# Turn off IPv6 Duplicate Address Detection; the EC2 networking
33	# configuration makes it unnecessary.
34	echo 'net.inet6.ip6.dad_count=0' >> ${DESTDIR}/etc/sysctl.conf
35
36	# Booting quickly is more important than giving users a chance to
37	# access the boot loader via the serial port.
38	echo 'autoboot_delay="-1"' >> ${DESTDIR}/boot/loader.conf
39	echo 'beastie_disable="YES"' >> ${DESTDIR}/boot/loader.conf
40
41	# The EFI RNG on Graviton 2 is particularly slow if we ask for the
42	# default 2048 bytes of entropy; ask for 64 bytes instead.
43	echo 'entropy_efi_seed_size="64"' >> ${DESTDIR}/boot/loader.conf
44
45	# Tell gptboot not to wait 3 seconds for a keypress which will
46	# never arrive.
47	printf -- "-n\n" > ${DESTDIR}/boot.config
48
49	# The emulated keyboard attached to EC2 instances is inaccessible to
50	# users, and there is no mouse attached at all; disable to keyboard
51	# and the keyboard controller (to which the mouse would attach, if
52	# one existed) in order to save time in device probing.
53	echo 'hint.atkbd.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
54	echo 'hint.atkbdc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
55
56	# There is no floppy drive on EC2 instances so disable the driver.
57	echo 'hint.fd.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
58	echo 'hint.fdc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
59
60	# There is no parallel port on EC2 instances so disable driver.
61	echo 'hint.ppc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
62
63	# EC2 has two consoles: An emulated serial port ("system log"),
64	# which has been present since 2006; and a VGA console ("instance
65	# screenshot") which was introduced in 2016.
66	echo 'boot_multicons="YES"' >> ${DESTDIR}/boot/loader.conf
67
68	# Some older EC2 hardware used a version of Xen with a bug in its
69	# emulated serial port.  It is not clear if EC2 still has any such
70	# nodes, but apply the workaround just in case.
71	echo 'hw.broken_txfifo="1"' >> ${DESTDIR}/boot/loader.conf
72
73	# Graviton 1 through Graviton 4 have a bug in their ACPI where they
74	# mark the PL061's pins as needing to be configured in PullUp mode
75	# (in fact the PL061 has no pullup/pulldown resistors).  Graviton 1
76	# through Graviton 3 have non-functional PCI _EJ0 and need a value
77	# written to the PCI power status register in order to eject a
78	# device.  EC2 instances with PCI (not PCIe) buses need a short
79	# delay before rescanning upon device detach.
80	echo 'debug.acpi.quirks="56"' >> ${DESTDIR}/boot/loader.conf
81
82	# Load the kernel module for the Amazon "Elastic Network Adapter"
83	echo 'if_ena_load="YES"' >> ${DESTDIR}/boot/loader.conf
84
85	# Use the "nda" driver for accessing NVMe disks rather than the
86	# historical "nvd" driver.
87	echo 'hw.nvme.use_nvd="0"' >> ${DESTDIR}/boot/loader.conf
88
89	# Disable KbdInteractiveAuthentication according to EC2 requirements.
90	sed -i '' -e \
91		's/^#KbdInteractiveAuthentication yes/KbdInteractiveAuthentication no/' \
92		${DESTDIR}/etc/ssh/sshd_config
93
94	# RSA host keys are obsolete and also very slow to generate
95	echo 'sshd_rsa_enable="NO"' >> ${DESTDIR}/etc/rc.conf
96
97	# Use FreeBSD Update mirrors hosted in AWS
98	sed -i '' -e 's/update.FreeBSD.org/aws.update.FreeBSD.org/' \
99		${DESTDIR}/etc/freebsd-update.conf
100
101	# Use the NTP service provided by Amazon
102	sed -i '' -e 's/^pool/#pool/' \
103		-e '1,/^#server/s/^#server.*/server 169.254.169.123 iburst/' \
104		${DESTDIR}/etc/ntp.conf
105
106	# Provide a map for accessing Elastic File System mounts
107	cat > ${DESTDIR}/etc/autofs/special_efs <<'EOF'
108#!/bin/sh
109
110if [ $# -eq 0 ]; then
111        # No way to know which EFS filesystems exist and are
112        # accessible to this EC2 instance.
113        exit 0
114fi
115
116# Provide instructions on how to mount the requested filesystem.
117FS=$1
118REGION=`fetch -qo- http://169.254.169.254/latest/meta-data/placement/availability-zone | sed -e 's/[a-z]$//'`
119echo "-nfsv4,minorversion=1,oneopenown ${FS}.efs.${REGION}.amazonaws.com:/"
120EOF
121	chmod 755 ${DESTDIR}/etc/autofs/special_efs
122
123	# The first time the AMI boots, run "first boot" scripts.
124	touch ${DESTDIR}/firstboot
125
126	return 0
127}
128
129ec2_base_networking () {
130	# EC2 instances use DHCP to get their network configuration.  IPv6
131	# requires accept_rtadv.
132	echo 'ifconfig_DEFAULT="SYNCDHCP accept_rtadv"' >> ${DESTDIR}/etc/rc.conf
133
134	# The EC2 DHCP server can be trusted to know whether an IP address is
135	# assigned to us; we don't need to ARP to check if anyone else is using
136	# the address before we start using it.
137	echo 'dhclient_arpwait="NO"' >> ${DESTDIR}/etc/rc.conf
138
139	# Enable IPv6 on all interfaces, and spawn DHCPv6 via rtsold
140	echo 'ipv6_activate_all_interfaces="YES"' >> ${DESTDIR}/etc/rc.conf
141	echo 'rtsold_enable="YES"' >> ${DESTDIR}/etc/rc.conf
142	echo 'rtsold_flags="-M /usr/local/libexec/rtsold-M -a"' >> ${DESTDIR}/etc/rc.conf
143
144	# Provide a script which rtsold can use to launch DHCPv6
145	mkdir -p ${DESTDIR}/usr/local/libexec
146	cat > ${DESTDIR}/usr/local/libexec/rtsold-M <<'EOF'
147#!/bin/sh
148
149/usr/local/sbin/dhclient -6 -nw -N -cf /dev/null $1
150EOF
151	chmod 755 ${DESTDIR}/usr/local/libexec/rtsold-M
152
153	return 0
154}
155