3: # Introduction
5: This tutorial aims at showing how you can build, setup, upload and launch NetBSD under the [Amazon EC2](http://aws.amazon.com/ec2/) service.
7: # Subscribe to AWS (Amazon Web Services)
9: If you already have an account for [Amazon Web Services](http://aws.amazon.com/), and you are a registered user for EC2 service, you can directly jump to section [What do you need to know](#index2h2). If not, keep reading.
11: ## Quick overview
13: Before you can start playing with Amazon EC2, you have to create an account on Amazon Web Services, of which EC2, the Elastic Compute Cloud, is part. This is fairly straightforward, and done in two steps:
15: 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.
16: 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.
18: ## What do you need to know
20: 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.
22: These can be created through the [Security Credentials](https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8&action=access-key) page (also accessible from the [Account](http://aws.amazon.com/account/) page):
24: 1. create the access key. Keep a secured copy of the ID and its associated secret value. These will be used by various scripts later on to perform certain EC2 actions.
25: 1. note down your account number (different from your access key ID!). This identifier can usually be obtained in the right top part of the page; it is a serie of numbers, separated with dashes: XXXX-XXXX-XXXX.
26: 1. create, or upload, a X.509 certificate, in PEM format. Keep the private key in a safe place.
27: 1. lastly, generate Amazon EC2 key pairs that will be used for SSH access. This step will be performed through the [Amazon Management Console](https://console.aws.amazon.com/ec2/home). Note down the SSH Key Pair Name you chose.
29: ### Keep your credentials!
31: The different credentials created above will be used in various places of EC2, and by a myriad of commands. You are advised to keep them easily accessible, while still reasonably secure regarding their access. Most EC2 tools expect them to be find through a set of environment variables.
33: For convenience, you could store them under a *.ec2* directory inside your *$HOME*:
35: [[!template id=programlisting text="""
36: $ ls .ec2/
37: cert-SOMERANDOMKEY.pem # the X.509 certificate
38: id_rsa.ec2 # private RSA SSH key
39: id_rsa.ec2.pub # public RSA SSH key
40: pk-SOMERANDOMKEY.pem # the private key associated to the certificate
43: then set the environment accordingly:
45: [[!template id=programlisting text="""
46: export EC2_PRIVATE_KEY=$HOME/.ec2/pk-SOMERANDOMKEY.pem
47: export EC2_CERT=$HOME/.ec2/cert-SOMERANDOMKEY.pem
48: export EC2_SSH_KEY=$HOME/.ec2/id_rsa.ec2
49: export EC2_SSH_KEYNAME=<your_ssh_key_pair_name>
50: export EC2_ACCOUNT_NUM=XXXX-XXXX-XXXX
51: export EC2_ACCESS_KEY=MYACCESSKEYID
52: export EC2_SECRET_KEY=MYSECRETACCESSKEY
55: Please note that the rest of the tutorial will assume that these variables are set.
57: ### Installing EC2 API tools
59: 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]].
61: [[!template id=programlisting text="""
62: cd /usr/pkgsrc/misc/ec2-api-tools
63: make ACCEPTABLE_LICENSES+=amazon-software-license install
66: Package depends on Java, so build will take some time to finish. While it builds, just continue reading.
68: ### EC2 vocabulary -- last notes
70: Before starting to play with EC2, you need to be familiar with the EC2 vocabulary used throughout this tutorial.
72: Briefly said, EC2 uses [Xen](http://www.xen.org) as virtualization solution. So, in essence, all operating systems that support Xen para-virtualization can theoretically run inside EC2, as a domU. This is the case for NetBSD; however, please note that only amd64 is currently supported. Work is on-going to support 32 bits for EC2.
74: All operating systems are run as *instances*, which are, as their name implies, the instantiation of a specific AMI, or *Amazon Machine Image*. An AMI is an image built from specific *snapshots* of *volumes*. The volumes are part of [Elastic Block Storage](http://aws.amazon.com/ebs/) (or EBS for short), which is another service offered by AWS, distinct from EC2.
76: These instances are tied to a *region* (a geographical location; typically US East, US West, Europe West, etc.). Each region has *availability zones*, which can be compared to a sub-region, each one being physically distinct from another. Regions are identified by a name, like *us-east-1*, *eu-west-1*. Same goes for availability zones, usually with the region's name as prefix: *us-east-1a*, *us-east-1b*, and so forth. Note that resources are **not** shared between zones, so if you transfer data from one zone to another, you will be charged for it.
78: 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.
80: # Building your first AMI (Amazon Image)
82: ## Pre-built AMIs
84: (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.
86: ## Fetch and build NetBSD
88: EC2 does not provide direct access to console. As a consequence, we cannot rely on it for installation, especially via [[!template id=man name=sysinst section=8]]. We must therefore build and install NetBSD in a separate directory, and configure it manually, before upload.
90: This tutorial assumes that you will build the system under */mnt/ec2*.
92: /!\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.
94: XXX build and install /mnt/ec2
96: ## Configuration
98: /!\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.
100: Under */mnt/ec2*, edit the files to add (or modify) these lines:
102: [[!template id=filecontent name=etc/rc.conf text="""
105: hostname=NetBSD-EC2-$(uname -m)
106: sshd=YES # for remote shell access to instance
109: [[!template id=filecontent name=etc/ssh/sshd_config text="""
110: # Allows root to login via authentication keys
111: PermitRootLogin without-password
114: Create *etc/fstab* and *etc/ifconfig.xennet0*:
116: [[!template id=programlisting text="""
117: cd /mnt/ec2
118: echo "dhcp" > etc/ifconfig.xennet0 # EC2 network configuration
119: cat > etc/fstab << EOF
120: /dev/xbd1a / ffs rw 1 1
121: /dev/xbd0a /grub ext2 rw 2 2
122: kernfs /kern kernfs rw
123: ptyfs /dev/pts ptyfs rw
124: procfs /proc procfs rw
128: 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):
130: [[!template id=programlisting text="""
131: $ makefs -t ffs -B le -s 256m -N /mnt/ec2/etc/ -o density=32k NetBSD-AMI.img /mnt/ec2/
132: Calculated size of `NetBSD-AMI.img': 268435456 bytes, 7345 inodes
133: Extent size set to 8192
134: NetBSD-AMI.img: 256.0MB (524288 sectors) block size 8192, fragment size 1024
135: using 5 cylinder groups of 53.88MB, 6896 blks, 1728 inodes.
136: super-block backups (for fsck -b #) at:
137: 32, 110368, 220704, 331040, 441376,
138: Populating `NetBSD-AMI.img'
139: Image `NetBSD-AMI.img' complete
140: $ gzip -9n NetBSD-AMI.img
143: ## Upload your OS
145: 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.
147: 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.
149: 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.
151: ### Creating the instance
153: 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.
155: [[!template id=programlisting text="""
156: $ ec2-run-instances ami-74f0061d -t t1.micro -z us-east-1c -k $EC2_SSH_KEYNAME
157: RESERVATION r-1ab61377 983624114127 default
158: INSTANCE <strong>i-5babe737</strong> ami-74f0061d pending <your_ssh_key_pair_name> 0 t1.micro 2011-02-17T23:15:04+0000 us-east-1c aki-427d952b monitoring-disabled ebs paravirtual xen
161: Use the instance identifier **i-XXXXXXX** to query the instance state via **ec2-describe-instances**. It will take some time to launch:
163: [[!template id=programlisting text="""
164: $ sleep 5 && ec2-describe-instances i-5babe737 | grep running
165: $ sleep 5 && ec2-describe-instances i-5babe737 | grep running
166: INSTANCE i-5babe737 ami-74f0061d <strong>ec2-67-202-24-108.compute-1.amazonaws.com</strong> 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 18.104.22.168 10.99.86.193 ebs
169: ### Upload your files
171: We will have to create and attach two EBS volumes:
173: 1. one to contain the Grub *menu.lst* config file, as well as the NetBSD kernel.
174: 1. the other one will contain the root file-system.
176: #### Creating and attaching volumes
178: [[!template id=programlisting text="""
179: <strong>ec2-create-volume -s 1 -z us-east-1c</strong> # 1GiB -- will be used for Grub and kernel
180: VOLUME vol-24f88d4c 1 us-east-1c creating 2011-02-18T00:06:21+0000
181: <strong>ec2-create-volume -s 5 -z us-east-1c</strong> # 5GiB -- will contain the root file-system
182: VOLUME vol-36f88d5e 5 us-east-1c creating 2011-02-18T00:06:32+0000
183: *** Wait until both volumes are marked as "available" ***
184: <strong>ec2-describe-volumes vol-24f88d4c vol-36f88d5e</strong>
185: VOLUME vol-36f88d5e 5 us-east-1c available 2011-02-18T00:06:32+0000
186: VOLUME vol-24f88d4c 1 us-east-1c available 2011-02-18T00:06:21+0000
187: # Attach them under /dev/sdf and /dev/sdg respectively
188: <strong>ec2-attach-volume vol-36f88d5e -i i-5babe737 -d "/dev/sdf"</strong> # root file-system
189: ATTACHMENT vol-36f88d5e i-5babe737 /dev/sdf attaching 2011-02-18T00:13:53+0000
190: <strong>ec2-attach-volume vol-24f88d4c -i i-5babe737 -d "/dev/sdg"</strong> # Grub and kernel
191: ATTACHMENT vol-24f88d4c i-5babe737 /dev/sdg attaching 2011-02-18T00:14:02+0000
192: *** Wait until both volumes are "attached" ***
193: <strong>ec2-describe-volumes vol-24f88d4c vol-36f88d5e</strong>
194: VOLUME vol-36f88d5e 5 us-east-1c in-use 2011-02-18T00:06:32+0000
195: ATTACHMENT vol-36f88d5e i-5babe737 /dev/sdf attached 2011-02-18T00:14:00+0000
196: VOLUME vol-24f88d4c 1 us-east-1c in-use 2011-02-18T00:06:21+0000
197: ATTACHMENT vol-24f88d4c i-5babe737 /dev/sdg attached 2011-02-18T00:14:10+0000
200: ### Snapshots!
202: We have to upload the kernel and the NetBSD disk image created earlier, *NetBSD-AMI.img*, to our instance host:
204: [[!template id=programlisting text="""
205: # Upload kernel to Linux AMI
206: rsync -aPv -e "ssh -i $EC2_SSH_KEY" OBJ/sys/arch/amd64/compile/XEN3_DOMU/netbsd \
208: # Upload disk image
209: rsync -aPv -e "ssh -i $EC2_SSH_KEY" NetBSD-AMI.img.gz \
213: 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.
215: [[!template id=programlisting text="""
216: $ ec2-describe-instances i-5babe737
217: INSTANCE i-5babe737 ami-74f0061d <strong>ec2-67-202-24-108.compute-1.amazonaws.com</strong> 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 22.214.171.124 10.99.86.193 ebs
218: $ ec2-authorize default -p 22
219: GROUP default
220: PERMISSION default ALLOWS tcp 22 22 FROM CIDR 0.0.0.0/0
221: $ ssh -i "$EC2_SSH_KEY" firstname.lastname@example.org
223: [ec2-user@ip-10-99-86-193 ~]$ sudo su
224: [root@ip-10-99-86-193 ec2-user]# mkdir /mnt/grub
225: [root@ip-10-99-86-193 ec2-user]# mkfs.ext2 /dev/sdg
227: [root@ip-10-99-86-193 ec2-user]# mount /dev/sdg /mnt/grub/
228: [root@ip-10-99-86-193 ec2-user]# mkdir -p /mnt/grub/boot/grub/
229: [root@ip-10-99-86-193 ec2-user]# cat > /mnt/grub/boot/grub/menu.lst << EOF
234: title NetBSD AMI
235: root (hd0)
236: kernel /boot/netbsd root=xbd1
238: [root@ip-10-99-86-193 ec2-user]# mv netbsd /mnt/grub/boot/
239: [root@ip-10-99-86-193 ec2-user]# umount /dev/sdg
240: [root@ip-10-99-86-193 ec2-user]# gunzip < NetBSD-AMI.img.gz | dd of=/dev/sdf bs=32k
241: [root@ip-10-99-86-193 ec2-user]# sync
244: ### Shutdown the Linux instance
246: We now have to detach volumes, snapshot them, then we shutdown the Linux instance.
248: [[!template id=programlisting text="""
249: # ec2-detach-volume vol-36f88d5e
250: ATTACHMENT vol-36f88d5e i-5babe737 /dev/sdf detaching 2011-02-18T00:14:00+0000
251: # ec2-detach-volume vol-24f88d4c
252: ATTACHMENT vol-24f88d4c i-5babe737 /dev/sdg detaching 2011-02-18T00:14:10+0000
253: # ec2-create-snapshot vol-36f88d5e
254: SNAPSHOT <strong>snap-deef2bb2</strong> vol-36f88d5e pending 2011-02-18T01:17:59+0000 983624114127 5
255: # ec2-create-snapshot vol-24f88d4c
256: SNAPSHOT <strong>snap-8aef2be6</strong> vol-24f88d4c pending 2011-02-18T01:18:10+0000 983624114127 1
257: # ec2-terminate-instances i-5babe737
258: INSTANCE i-5babe737 running shutting-down
261: ## Create your first NetBSD AMI
263: An AMI requires multiples components to be registered: the snapshots IDs we made in the previous chapter, as well as a specific AKI: the one that can chain-load Xenified kernels through PyGrub.
265: /!\ AKIs are entitled to the same conditions as AMIs: their IDs are region-specific. So chose one carefully, or you will not be able to launch a NetBSD instance later!
267: The list of AKIs that suits our situation can be obtained with the following command:
269: [[!template id=programlisting text="""
270: # Obtain all kernel images (AKI) for region US East, for which manifest location contains pv-grub (for PyGrub)
271: # ec2-describe-images -a --region=us-east-1 -F image-type=kernel -F manifest-location=*pv-grub*
272: IMAGE aki-407d9529 ec2-public-images/pv-grub-hd0-V1.01-i386.gz.manifest.xml amazon available public i386 kernel instance-store paravirtual xen
273: IMAGE 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
274: IMAGE aki-4c7d9525 ec2-public-images/pv-grub-hd00-V1.01-i386.gz.manifest.xml amazon available public i386 kernel instance-store paravirtual xen
275: <strong>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</strong>
278: We pick the one with the correct architecture (x86_64). Its ID is **aki-4e7d9527**. Then we can proceed to the creation of our AMI, with:
280: 1. */dev/sda1* as Grub partition (*/dev/sdg*, snapshot *snap-8aef2be6* of volume *vol-24f88d4c*)
281: 1. */dev/sda2* as root file-system (*/dev/sdf*, snapshot *snap-deef2bb2* of volume *vol-36f88d5e*)
283: [[!template id=programlisting text="""
284: $ ec2-register -a x86_64 --kernel aki-4e7d9527 --region us-east-1 \
285: -b "/dev/sda1=snap-8aef2be6" -b "/dev/sda2=snap-deef2bb2" -n "NetBSD-x86_64-current" \
286: -d "<add your own description here>
287: IMAGE <strong>ami-74d0231d</strong>
290: # Play with your first NetBSD instance
292: You can now start your own NetBSD instance, via:
294: [[!template id=programlisting text="""
295: $ ec2-run-instances ami-74d0231d -t t1.micro -z us-east-1c
296: RESERVATION r-08218465 983624114127 default
297: INSTANCE <strong>i-953d72f9</strong> ami-74d0231d pending 0 t1.micro 2011-02-18T02:05:46+0000 us-east-1c aki-4e7d9527 monitoring-disabled
298: *** Wait a few minutes, micro instances take time to start ***
299: # Query console output for your new instance
300: $ ec2-get-console-output i-953d72f9
304: ## Connect to it
306: ## And now?
CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb