--- wikisrc/amazon_ec2.mdwn 2011/02/18 02:46:16 1.14 +++ wikisrc/amazon_ec2.mdwn 2011/02/28 01:22:57 1.37 @@ -2,7 +2,7 @@ # Introduction -This tutorial aims at showing how you can build, setup, upload and launch NetBSD under the [Amazon EC2](http://aws.amazon.com/ec2/) service. +This tutorial aims at showing how you can build, setup, upload and launch NetBSD under the [Amazon EC2](http://aws.amazon.com/ec2/) service. We will first give some brief explanations on how you can obtain an AWS account, and what you will need to run NetBSD under EC2. Then, at your convenience, you will be able to start with pre-made images, or roll-out your own. # Subscribe to AWS (Amazon Web Services) @@ -15,7 +15,7 @@ Before you can start playing with Amazon 1. you "sign-up" directly on [Amazon Web Services](http://aws.amazon.com/) home-page. This is where you enter your credentials, and confirm your AWS account registration. 1. you sign-up to EC2 through [EC2 AWS home-page](http://aws.amazon.com/ec2/). You will be asked some more information, like a credit card (for billing), and a phone-number, for account validation. -## What do you need to know +## What do you need to know? EC2 uses different types of credentials. In addition to your login and password, you need an access key, a X.509 certificate (with its private key), and a pair of RSA keys, for remote SSH access. @@ -54,7 +54,7 @@ export EC2_SECRET_KEY=MYSECRETACCESSKEY Please note that the rest of the tutorial will assume that these variables are set. -### Installing EC2 API tools +## Installing EC2 API tools NetBSD provides EC2 API tools, to ease EC2 account management a little bit. The package is found inside [pkgsrc](http://www.pkgsrc.org), under [[!template id=pkg category=misc name=ec2-api-tools]]. @@ -65,7 +65,7 @@ make ACCEPTABLE_LICENSES+=amazon-softwar Package depends on Java, so build will take some time to finish. While it builds, just continue reading. -### EC2 vocabulary -- last notes +## EC2 vocabulary -- last notes Before starting to play with EC2, you need to be familiar with the EC2 vocabulary used throughout this tutorial. @@ -77,11 +77,59 @@ These instances are tied to a *region* ( AKI, or *Amazon Kernel Image*, are a specific type of image. It represents the Xen guest para-virtualized kernel, as used by an AMI. Certain AKIs are allowed to boot customized operating systems, e.g. those that are still not officially supported by Amazon. Thanks to [PyGrub](http://wiki.xensource.com/xenwiki/PyGrub), it can boot a kernel that resides inside an AMI's snapshot. -# Building your first AMI (Amazon Image) +# Using pre-made AMIs -## Pre-built AMIs +The following AMIs are publicly available. You can use them to [start a NetBSD instance](#index11h2) quickly, without needing to build your image by hand. -(For the future) Once NetBSD has decent support for Amazon EC2, we will publish the AMI identifiers so you can quickly boot up in a NetBSD environment without going through all the steps given below. + + + + + + + + + + + + + + + + + + + + + + +
NetBSD versionus-west-1us-east-1eu-west-1ap-southeast-1
NetBSD 5.1.0_PATCH + 32 bits:
+ 64 bits: + 		+ 32 bits:
+ 64 bits: + 		+ 32 bits:
+ 64 bits: + 		+ 32 bits:
+ 64 bits: +
NetBSD-HEAD (5.99.45) + 32 bits:
+ 64 bits: + 		+ 32 bits:
+ 64 bits: + 		+ 32 bits:
+ 64 bits: + 		+ 32 bits:
+ 64 bits: +
+ +# Build-up your NetBSD system ## Fetch and build NetBSD @@ -89,11 +137,25 @@ EC2 does not provide direct access to co This tutorial assumes that you will build the system under */mnt/ec2*. -/!\Please note that you will need the [[!template id=man name=makefs section=8]] tool later in the process, so you can build a file system image that can be uploaded to Amazon EC2. You are therefore advised to perform the installation directly under a living NetBSD system, or in case your are not, to [[fetch the source|fetching_src]] to build the toolchain that will contain the **nbmakefs** utility. +/!\Please note that you will need the [[!template id=man name=makefs section=8]] tool later in the process, so you can build a file system image that can be uploaded to Amazon EC2. You are therefore advised to perform the installation directly under a living NetBSD system, or in case your are not, to fetch the *src* tree to build the toolchain, which will contain the **nbmakefs** utility. + +[Details regarding on how you can fetch *src* are given in the NetBSD's guide](http://www.netbsd.org/docs/guide/en/chap-fetch.html). Here are the basic commands you should type to build and install NetBSD under */mnt/ec2*: -XXX build and install /mnt/ec2 +[[!template id=programlisting text=""" +cd /usr/ +# grab a recent src.tgz file (use curl(1), ftp(1), wget(1), ...) +ftp -a 'http://ftp.netbsd.org/pub/NetBSD/NetBSD-current/tar_files/src.tar.gz' +# Decompress +tar -xzpf src.tar.gz +cd src +# build distribution and kernel +./build.sh -O ../obj -T ../tools -D ../dest -R ../release -m amd64 -U distribution +./build.sh -O ../obj -T ../tools -m amd64 kernel=XEN3_DOMU +# install distribution in /mnt/ec2 +su root ./build.sh -O ../obj -T ../tools -D ../dest -R ../release -U -V INSTALLSETS="base etc" install=/mnt/ec2 +"""]] -## Configuration +# Configuration of your NetBSD EC2 tree /!\This part assumes that you have a non-configured NetBSD system extracted under */mnt/ec2*; that is, it should have not been modified through [[!template id=man name=sysinst section=8]], nor by you. @@ -102,7 +164,7 @@ Under */mnt/ec2*, edit the files to add [[!template id=filecontent name=etc/rc.conf text=""" rc_configured=YES -hostname=NetBSD-EC2-$(uname -m) +ec2_init=YES sshd=YES # for remote shell access to instance """]] @@ -111,24 +173,87 @@ sshd=YES # for remote shell access to in PermitRootLogin without-password """]] -Create *etc/fstab* and *etc/ifconfig.xennet0*: +This file is needed if you want to login via the EC2 SSH key pair created previously: + +[[!template id=filecontent name=etc/rc.d/ec2_init text=""" +#!/bin/sh +# +# PROVIDE: ec2_init +# REQUIRE: NETWORKING +# BEFORE: LOGIN + +$_rc_subr_loaded . /etc/rc.subr + +name="ec2_init" +rcvar=${name} +start_cmd="ec2_init" +stop_cmd=":" + +METADATA_URL="http://169.254.169.254/latest/meta-data/" +SSH_KEY_URL="public-keys/0/openssh-key" +HOSTNAME_URL="hostname" + +SSH_KEY_FILE="/root/.ssh/authorized_keys" + +ec2_init() +{ + ( + umask 022 + # fetch the key pair from Amazon Web Services + EC2_SSH_KEY=$(ftp -o - "${METADATA_URL}${SSH_KEY_URL}") + + if [ -n "$EC2_SSH_KEY" ]; then + # A key pair is associated with this instance, add it + # to root 'authorized_keys' file + mkdir -p $(dirname "$SSH_KEY_FILE") + touch "$SSH_KEY_FILE" + cd $(dirname "$SSH_KEY_FILE") + + grep -q "$EC2_SSH_KEY" "$SSH_KEY_FILE" + if [ $? -ne 0 ]; then + echo "Setting EC2 SSH key pair: ${EC2_SSH_KEY##* }" + echo "$EC2_SSH_KEY" >> "$SSH_KEY_FILE" + fi + fi + + # set hostname + HOSTNAME=$(ftp -o - "${METADATA_URL}${HOSTNAME_URL}") + echo "Setting EC2 hostname: ${HOSTNAME}" + echo "$HOSTNAME" > /etc/myname + hostname "$HOSTNAME" + ) +} + +load_rc_config $name +run_rc_command "$1" +"""]] + +Create various files and directories: [[!template id=programlisting text=""" cd /mnt/ec2 -echo "dhcp" > etc/ifconfig.xennet0 # EC2 network configuration +# Add proc and kern directories +mkdir grub kern proc +# EC2 network configuration, via DHCP +echo "dhcp" > etc/ifconfig.xennet0 +# Basic fstab entries cat > etc/fstab << EOF /dev/xbd1a / ffs rw 1 1 -/dev/xbd0a /grub ext2 rw 2 2 +/dev/xbd0a /grub ext2fs rw 2 2 kernfs /kern kernfs rw ptyfs /dev/pts ptyfs rw procfs /proc procfs rw EOF +# EC2 startup script (if you installed it) +if [ -f etc/rc.d/ec2_init ]; then + chmod 555 etc/rc.d/ec2_init +fi """]] -You can then proceed to modifying the system living under */mnt/ec2*, so it can fit your needs (adding custom binaries, packages, etc). When done, build the *NetBSD-AMI.img* ffs image, via [[!template id=man name=makefs section=8]], or **nbmakefs**, from the [toolchain](http://www.netbsd.org/docs/guide/en/chap-build.html#chap-build-tools): +You can then proceed to modifying the system living under */mnt/ec2*, so it can fit your needs (adding custom binaries, packages, etc). When done, build the *NetBSD-AMI.img.gz* ffs image, via [[!template id=man name=makefs section=8]], or **nbmakefs**, from the [toolchain](http://www.netbsd.org/docs/guide/en/chap-build.html#chap-build-tools): [[!template id=programlisting text=""" -$ makefs -t ffs -B le -s 256m -N /mnt/ec2/etc/ -o density=32k NetBSD-AMI.img /mnt/ec2/ +$ makefs -t ffs -B le -s 256m -N /mnt/ec2/etc/ -o density=32k /tmp/NetBSD-AMI.img /mnt/ec2/ Calculated size of `NetBSD-AMI.img': 268435456 bytes, 7345 inodes Extent size set to 8192 NetBSD-AMI.img: 256.0MB (524288 sectors) block size 8192, fragment size 1024 @@ -140,17 +265,17 @@ Image `NetBSD-AMI.img' complete $ gzip -9n NetBSD-AMI.img """]] -## Upload your OS +# Upload NetBSD to EC2 -We must now upload our NetBSD system to EC2. For that, we will have to create a minimalist EC2 instance, to which we will copy our files to construct our snapshots. For that, we will use an Amazon Linux AMI instance. +We must now upload our NetBSD system to EC2. For that, we will have to create a minimalist EC2 instance, to which we will copy our files to construct our snapshots. We will use an Amazon Linux AMI instance. -EC2 being localized in geographical regions, you have to carefully choose the AMI identifier you want to use there. This depends on where you want to execute your instance. Amazon Linux AMI IDs are listed on [the main page](http://aws.amazon.com/amazon-linux-ami/) of the project, by regions. Chose ones backed by EBS. +EC2 being localized in geographical regions, you have to carefully choose the AMI identifier you want to use there. This depends on where you want to execute your instance. Amazon Linux AMI IDs are listed on [the main page](http://aws.amazon.com/amazon-linux-ami/) of the project, by regions. Choose ones backed by EBS. The examples listed here assume that the instances run in **US East**, within the **c** zone (e.g. **us-east-1c**). To have a list of EC2 regions, you can use the command **ec2-describe-regions**, and **ec2-describe-availability-zones** for availability zones. -### Creating the instance +## Create an Amazon Linux instance -Creating an instance straightforward. Amazon provides [different types of instances](http://aws.amazon.com/ec2/pricing/), with varying levels of billing and reliability. We will use a [*micro* instance](http://aws.amazon.com/ec2/faqs/#How_much_compute_power_do_Micro_instances_provide); its pricing is almost free. +Creating an instance is straightforward. Amazon provides [different types of instances](http://aws.amazon.com/ec2/pricing/), with varying levels of billing and reliability. We will use a [*micro* instance](http://aws.amazon.com/ec2/faqs/#How_much_compute_power_do_Micro_instances_provide); its pricing is almost free. [[!template id=programlisting text=""" $ ec2-run-instances ami-74f0061d -t t1.micro -z us-east-1c -k $EC2_SSH_KEYNAME @@ -166,15 +291,13 @@ $ sleep 5 && ec2-describe-instances i-5b INSTANCE i-5babe737 ami-74f0061d ec2-67-202-24-108.compute-1.amazonaws.com ip-10-99-86-193.ec2.internal running <your_ssh_key_pair_name> 0 t1.micro 2011-02-17T23:22:37+0000 us-east-1c aki-427d952b monitoring-disabled 67.202.24.108 10.99.86.193 ebs """]] -### Upload your files +## Create and attach your NetBSD volumes We will have to create and attach two EBS volumes: 1. one to contain the Grub *menu.lst* config file, as well as the NetBSD kernel. 1. the other one will contain the root file-system. -#### Creating and attaching volumes - [[!template id=programlisting text=""" ec2-create-volume -s 1 -z us-east-1c # 1GiB -- will be used for Grub and kernel VOLUME vol-24f88d4c 1 us-east-1c creating 2011-02-18T00:06:21+0000 @@ -197,27 +320,32 @@ VOLUME vol-24f88d4c 1 ATTACHMENT vol-24f88d4c i-5babe737 /dev/sdg attached 2011-02-18T00:14:10+0000 """]] -### Snapshots! +## Snapshots! + +Before we can connect to our brand new instance, we have to allow connections on SSH port (22) through the AWS EC2 firewall: + +[[!template id=programlisting text=""" +$ ec2-authorize default -p 22 --region us-east-1 +GROUP default +PERMISSION default ALLOWS tcp 22 22 FROM CIDR 0.0.0.0/0 +"""]] -We have to upload the kernel and the NetBSD disk image created earlier, *NetBSD-AMI.img*, to our instance host: +We can now upload the kernel and the NetBSD disk image created earlier, *NetBSD-AMI.img.gz*, to our instance host: [[!template id=programlisting text=""" # Upload kernel to Linux AMI -rsync -aPv -e "ssh -i $EC2_SSH_KEY" OBJ/sys/arch/amd64/compile/XEN3_DOMU/netbsd \ +rsync -aPv -e "ssh -i $EC2_SSH_KEY" /usr/obj/sys/arch/amd64/compile/XEN3_DOMU/netbsd \ ec2-user@ec2-67-202-24-108.compute-1.amazonaws.com: # Upload disk image rsync -aPv -e "ssh -i $EC2_SSH_KEY" NetBSD-AMI.img.gz \ ec2-user@ec2-67-202-24-108.compute-1.amazonaws.com: """]] -Before connecting to the instance, we have to allow connection on SSH port (22) through firewall. Then, log in to the instance, through its name. We will format and mount the Grub partition, create the *menu.lst* file, then copy files to their respective partitions. +Then, log in to the instance, via its name. We will format and mount the Grub partition, create the *menu.lst* file, then copy files to their respective partitions. [[!template id=programlisting text=""" $ ec2-describe-instances i-5babe737 INSTANCE i-5babe737 ami-74f0061d ec2-67-202-24-108.compute-1.amazonaws.com ip-10-99-86-193.ec2.internal running <your_ssh_key_pair_name> 0 t1.micro 2011-02-17T23:22:37+0000 us-east-1c aki-427d952b monitoring-disabled 67.202.24.108 10.99.86.193 ebs -$ ec2-authorize default -p 22 -GROUP default -PERMISSION default ALLOWS tcp 22 22 FROM CIDR 0.0.0.0/0 $ ssh -i "$EC2_SSH_KEY" ec2-user@ec2-67-202-24-108.compute-1.amazonaws.com [...] [ec2-user@ip-10-99-86-193 ~]$ sudo su @@ -241,7 +369,7 @@ EOF [root@ip-10-99-86-193 ec2-user]# sync """]] -### Shutdown the Linux instance +## Shutdown the Linux instance We now have to detach volumes, snapshot them, then we shutdown the Linux instance. @@ -258,11 +386,13 @@ SNAPSHOT snap-8aef2be6IMAGE aki-427d952b ec2-public-images/pv-grub-hd0-V1.01-x86_64.gz.manifest.xml amazon available public x86_64 kernel instance-store paravirtual xen IMAGE aki-4c7d9525 ec2-public-images/pv-grub-hd00-V1.01-i386.gz.manifest.xml amazon available public i386 kernel instance-store paravirtual xen -IMAGE aki-4e7d9527 ec2-public-images/pv-grub-hd00-V1.01-x86_64.gz.manifest.xml amazon available public x86_64 kernel instance-store paravirtual xen +IMAGE aki-4e7d9527 ec2-public-images/pv-grub-hd00-V1.01-x86_64.gz.manifest.xml amazon available public x86_64 kernel instance-store paravirtual xen """]] -We pick the one with the correct architecture (x86_64). **hd00** are for EBS backed images, while **hd0** are for S3 backed ones. Chose **hd00** AKIs. In our case, its ID is **aki-4e7d9527**. +Pick the one with the correct architecture (x86_64 here). **hd0** are for AMIs where the snapshot contains no partition (where the volume is itself the whole partition), while **hd00** are for snapshots partitioned in a classical way (via MBR). Choose **hd0** AKIs. In this case, that will be **aki-427d952b**. We can proceed to the creation of our AMI, with: @@ -283,26 +413,62 @@ We can proceed to the creation of our AM 1. */dev/sda2* as root file-system (*/dev/sdf*, snapshot **snap-deef2bb2** of volume **vol-36f88d5e**) [[!template id=programlisting text=""" -$ ec2-register -a x86_64 --kernel aki-4e7d9527 --region us-east-1 \ +$ ec2-register -a x86_64 --kernel aki-427d952b --region us-east-1 \ -b "/dev/sda1=snap-8aef2be6" -b "/dev/sda2=snap-deef2bb2" -n "NetBSD-x86_64-current" \ -d "<add your own description here> IMAGE ami-74d0231d """]] -# Play with your first NetBSD instance +## Launch your first instance You can now start your own NetBSD instance, via: [[!template id=programlisting text=""" -$ ec2-run-instances ami-74d0231d -t t1.micro -z us-east-1c +$ ec2-run-instances ami-74d0231d -t t1.micro -z us-east-1c -k $EC2_SSH_KEYNAME RESERVATION r-08218465 983624114127 default INSTANCE i-953d72f9 ami-74d0231d pending 0 t1.micro 2011-02-18T02:05:46+0000 us-east-1c aki-4e7d9527 monitoring-disabled *** Wait a few minutes, micro instances take time to start *** # Query console output for your new instance $ ec2-get-console-output i-953d72f9 +Copyright (c) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, + 2006, 2007, 2008, 2009, 2010, 2011 + The NetBSD Foundation, Inc. All rights reserved. +Copyright (c) 1982, 1986, 1989, 1991, 1993 + The Regents of the University of California. All rights reserved. + +NetBSD 5.99.45 (XEN3_DOMU) #9: Wed Feb 16 21:14:49 CET 2011 +[...] +NetBSD/amd64 (ip-10-112-58-223.ec2.internal) (console) + +login: +"""]] + +## Connect to your NetBSD instance + +Connection is similar to the one you used for the Amazon Linux instance, except that you login as "root" instead of "ec2-user": + +[[!template id=programlisting text=""" +$ ec2-describe-instances i-953d72f9 +RESERVATION r-da8021b7 983624114127 default +INSTANCE i-953d72f9 ami-74d0231d ec2-50-16-3-55.compute-1.amazonaws.com ip-10-112-58-223.ec2.internal running <your_ssh_key_pair_name> 0 t1.micro 2011-02-19T04:01:03+0000 us-east-1c aki-427d952b monitoring-disabled 50.16.3.55 10.112.58.223 ebs paravirtual xen +BLOCKDEVICE /dev/sda1 vol-ec3c4a84 2011-02-19T04:01:31.000Z +BLOCKDEVICE /dev/sda2 vol-ee3c4a86 2011-02-19T04:01:31.000Z +$ ssh -i "$EC2_SSH_KEY" root@ec2-50-16-3-55.compute-1.amazonaws.com +The authenticity of host 'ec2-50-16-3-55.compute-1.amazonaws.com (50.16.3.55)' can't be established. [...] +Thank you for helping us test and improve NetBSD. + +Terminal type is xterm. +We recommend that you create a non-root account and use su(1) for root access. +ip-10-112-58-223# uname -a +NetBSD ip-10-112-58-223.ec2.internal 5.99.45 NetBSD 5.99.45 (XEN3_DOMU) #9: Wed Feb 16 21:14:49 CET 2011 jym@paris:/home/jym/cvs/obj/sys/arch/amd64/compile/XEN3_DOMU amd64 +ip-10-112-58-223# """]] -## Connect to it +Done! ## And now? + +Well, you got a NetBSD instance that is in almost every part similar to what a NetBSD domU can be. You can use this domU to host Internet services, run a database, extend your build farm, or use it as a sandbox. The AMI being built around snapshots, you can play and break your instance in every way you want; just restart one anew if you need to. Don't forget that Amazon will charge acccordingly :) + +Remember, you can query information regarding your AWS account through [[!template id=pkg category=misc name=ec2-api-tools]] package. It is quite easy to use these tools for scripting; for a more elaborate, graphical interface, use the [Amazon Management Console](https://console.aws.amazon.com/ec2/home).