File:  [NetBSD Developer Wiki] / wikisrc / amazon_ec2.mdwn
Revision 1.8: download - view: text, annotated - select for diffs
Thu Feb 17 21:10:12 2011 UTC (3 years, 1 month ago) by wiki
Branches: MAIN
CVS tags: HEAD
web commit by jym: Small fixes.

[[!toc]]

# 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.

# Subscribe to AWS (Amazon Web Services)

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.

## Quick overview

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:

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

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.

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):

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.
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.
1. create, or upload, a X.509 certificate, in PEM format. Keep the private key in a safe place.
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).

### Keep your credentials!

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.

For convenience, you could store them under a **.ec2** directory inside your **$HOME**:

[[!template id=programlisting text="""
$ ls .ec2/                                                                
cert-SOMERANDOMKEY.pem # the X.509 certificate
id_rsa.ec2             # private RSA SSH key
id_rsa.ec2.pub         # public RSA SSH key
pk-SOMERANDOMKEY.pem   # the private key associated to the certificate
"""]]

then set the environment accordingly:

[[!template id=programlisting text="""
export EC2_PRIVATE_KEY=$HOME/.ec2/pk-SOMERANDOMKEY.pem
export EC2_CERT=$HOME/.ec2/cert-SOMERANDOMKEY.pem
export EC2_SSH_KEY=$HOME/.ec2/id_rsa.ec2
export EC2_ACCOUNT_NUM=XXXX-XXXX-XXXX
export EC2_ACCESS_KEY=MYACCESSKEYID
export EC2_SECRET_KEY=MYSECRETACCESSKEY
"""]]

Please note that the rest of the tutorial will assume that these variables are set.

### EC2 vocabulary -- last notes

Before starting to play with EC2, you need to be familiar with the EC2 vocabulary used throughout this tutorial.

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.

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.

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 up your first AMI (Amazon Image)

## Pre-built AMIs

(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.

## Fetch and build NetBSD

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.

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.

XXX build and install /mnt/ec2

## Configuration

/!\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.

Under **/mnt/ec2**, edit the files to add (or modify) these lines:

[[!template id=filecontent name=etc/rc.conf text="""
rc_configured=YES

hostname=NetBSD-EC2-$(uname -m)
sshd=YES # for remote shell access to instance
"""]]

[[!template id=filecontent name=etc/ssh/sshd_config text="""
# Allows root to login via authentication keys
PermitRootLogin without-password
"""]]

Create **etc/fstab** and **etc/ifconfig.xennet0**:

[[!template id=programlisting text="""
cd /mnt/ec2
echo "dhcp" > etc/ifconfig.xennet0 # EC2 network configuration
cat > etc/fstab << EOF
/dev/xbd1a /        ffs    rw 1 1
/dev/xbd0a /grub    ext2   rw 2 2
kernfs     /kern    kernfs rw
ptyfs      /dev/pts ptyfs  rw
procfs     /proc    procfs rw
EOF
"""]]

Once done, you can modify the system living under **/mnt/ec2** to fit your needs (adding custom binaries, packages, etc).

## Upload your OS

When the NetBSD is properly installed and configured, we have to upload it to EC2. For that, we will have to create a minimalist EC2 instance, to which we will upload our files to construct our snapshots.

### Create an Amazon Linux AMI instance

### Upload your files

### Snapshots!

### Shutdown the instance

## Create your first NetBSD AMI


# Play with your first NetBSD instance

## Create the instance

## Connect to it

## And now?

CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb