xref: /freebsd/release/tools/ec2.conf (revision e40817302ebdf89df2f3bcd679fb7f2a18c244dc)
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.  In
26	# unprivileged builds this is unnecessary as pkg will not be
27	# installed to begin with.
28	if [ -z "${NO_ROOT}" ]; then
29		echo "ERROR: NO_ROOT not set" >&2
30		exit 1
31	fi
32
33	# Turn off IPv6 Duplicate Address Detection; the EC2 networking
34	# configuration makes it unnecessary.
35	echo 'net.inet6.ip6.dad_count=0' >> ${DESTDIR}/etc/sysctl.conf
36	metalog_add_data ./etc/sysctl.conf
37
38	# Tell gptboot not to wait 3 seconds for a keypress which will
39	# never arrive.
40	printf -- "-n\n" > ${DESTDIR}/boot.config
41	metalog_add_data ./boot.config
42
43	# Booting quickly is more important than giving users a chance to
44	# access the boot loader via the serial port.
45	echo 'autoboot_delay="-1"' >> ${DESTDIR}/boot/loader.conf
46	echo 'beastie_disable="YES"' >> ${DESTDIR}/boot/loader.conf
47
48	# The EFI RNG on Graviton 2 is particularly slow if we ask for the
49	# default 2048 bytes of entropy; ask for 64 bytes instead.
50	echo 'entropy_efi_seed_size="64"' >> ${DESTDIR}/boot/loader.conf
51
52	# The emulated keyboard attached to EC2 instances is inaccessible to
53	# users, and there is no mouse attached at all; disable to keyboard
54	# and the keyboard controller (to which the mouse would attach, if
55	# one existed) in order to save time in device probing.
56	echo 'hint.atkbd.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
57	echo 'hint.atkbdc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
58
59	# There is no floppy drive on EC2 instances so disable the driver.
60	echo 'hint.fd.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
61	echo 'hint.fdc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
62
63	# There is no parallel port on EC2 instances so disable driver.
64	echo 'hint.ppc.0.disabled=1' >> ${DESTDIR}/boot/loader.conf
65
66	# EC2 has two consoles: An emulated serial port ("system log"),
67	# which has been present since 2006; and a VGA console ("instance
68	# screenshot") which was introduced in 2016.
69	echo 'boot_multicons="YES"' >> ${DESTDIR}/boot/loader.conf
70
71	# Graviton 1 through Graviton 4 have a bug in their ACPI where they
72	# mark the PL061's pins as needing to be configured in PullUp mode
73	# (in fact the PL061 has no pullup/pulldown resistors).  Graviton 1
74	# through Graviton 3 have non-functional PCI _EJ0 and need a value
75	# written to the PCI power status register in order to eject a
76	# device.  EC2 instances with PCI (not PCIe) buses need a short
77	# delay before rescanning upon device detach.
78	echo 'debug.acpi.quirks="56"' >> ${DESTDIR}/boot/loader.conf
79
80	# The default behaviour of re-routing INTx interrupts causes a
81	# resource leak on INTRng (aka on Graviton systems).  Repeated
82	# hotplug/unplug on PCI (not PCIe) Graviton systems ends up with
83	# a kernel panic unless we disable this.
84	echo 'hw.pci.intx_reroute=0' >> ${DESTDIR}/boot/loader.conf
85
86	# Load the kernel module for the Amazon "Elastic Network Adapter"
87	echo 'if_ena_load="YES"' >> ${DESTDIR}/boot/loader.conf
88
89	# Use the "nda" driver for accessing NVMe disks rather than the
90	# historical "nvd" driver.
91	echo 'hw.nvme.use_nvd="0"' >> ${DESTDIR}/boot/loader.conf
92
93	# Reduce the timeout for PCIe Eject ("hotunplug") requests.  PCIe
94	# mandates a 5 second timeout to allow someone to cancel the eject
95	# by pressing the "Attention button" a second time, but in the EC2
96	# environment this delay serves no purpose.
97	echo 'hw.pci.pcie_hp_detach_timeout="0"' >> ${DESTDIR}/boot/loader.conf
98	metalog_add_data ./boot/loader.conf
99
100	# Disable KbdInteractiveAuthentication according to EC2 requirements.
101	sed -i '' -e \
102		's/^#KbdInteractiveAuthentication yes/KbdInteractiveAuthentication no/' \
103		${DESTDIR}/etc/ssh/sshd_config
104
105	# RSA host keys are obsolete and also very slow to generate
106	echo 'sshd_rsa_enable="NO"' >> ${DESTDIR}/etc/rc.conf
107
108	# Use FreeBSD Update mirrors hosted in AWS
109	sed -i '' -e 's/update.FreeBSD.org/aws.update.FreeBSD.org/' \
110		${DESTDIR}/etc/freebsd-update.conf
111
112	# Use the NTP service provided by Amazon
113	sed -i '' -e 's/^pool/#pool/' \
114		-e '1,/^#server/s/^#server.*/server 169.254.169.123 iburst/' \
115		${DESTDIR}/etc/ntp.conf
116
117	# Provide a map for accessing Elastic File System mounts
118	cat > ${DESTDIR}/etc/autofs/special_efs <<'EOF'
119#!/bin/sh
120
121if [ $# -eq 0 ]; then
122        # No way to know which EFS filesystems exist and are
123        # accessible to this EC2 instance.
124        exit 0
125fi
126
127# Provide instructions on how to mount the requested filesystem.
128FS=$1
129REGION=`fetch -qo- http://169.254.169.254/latest/meta-data/placement/availability-zone | sed -e 's/[a-z]$//'`
130echo "-nfsv4,minorversion=1,oneopenown ${FS}.efs.${REGION}.amazonaws.com:/"
131EOF
132	chmod 755 ${DESTDIR}/etc/autofs/special_efs
133	metalog_add_data ./etc/autofs/special_efs 0755
134
135	return 0
136}
137
138ec2_base_networking () {
139	# EC2 instances use DHCP to get their network configuration.  IPv6
140	# requires accept_rtadv.
141	echo 'ifconfig_DEFAULT="SYNCDHCP accept_rtadv"' >> ${DESTDIR}/etc/rc.conf
142
143	# The EC2 DHCP server can be trusted to know whether an IP address is
144	# assigned to us; we don't need to ARP to check if anyone else is using
145	# the address before we start using it.
146	echo 'dhclient_arpwait="NO"' >> ${DESTDIR}/etc/rc.conf
147
148	# Enable IPv6 on all interfaces, and spawn DHCPv6 via rtsold
149	echo 'ipv6_activate_all_interfaces="YES"' >> ${DESTDIR}/etc/rc.conf
150	echo 'rtsold_enable="YES"' >> ${DESTDIR}/etc/rc.conf
151	echo 'rtsold_flags="-M /usr/local/libexec/rtsold-M -a"' >> ${DESTDIR}/etc/rc.conf
152
153	# Provide a script which rtsold can use to launch DHCPv6
154	mkdir -p ${DESTDIR}/usr/local/libexec
155	cat > ${DESTDIR}/usr/local/libexec/rtsold-M <<'EOF'
156#!/bin/sh
157
158/usr/local/sbin/dhclient -6 -nw -N -cf /dev/null $1
159EOF
160	chmod 755 ${DESTDIR}/usr/local/libexec/rtsold-M
161	metalog_add_data ./usr/local/libexec/rtsold-M 0755
162
163	return 0
164}
165