release/tools/ec2.conf

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