Skip to content
This repository has been archived by the owner on Mar 9, 2021. It is now read-only.

Commit

Permalink
install: Add AWS installation guide
Browse files Browse the repository at this point in the history
Fixes kata-containers#273

Installation guide for AWS.

Signed-off-by: Ricardo Aravena <raravena@branch.io>
  • Loading branch information
raravena80 authored and scooley committed Oct 30, 2018
1 parent 1d6c296 commit bd18f9d
Show file tree
Hide file tree
Showing 2 changed files with 141 additions and 0 deletions.
1 change: 1 addition & 0 deletions install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ Manual installation instructions are available for [these distributions](#suppor
|[Ubuntu](ubuntu-installation-guide.md) | 16.04, 18.04 |

## Installing on a Cloud Service Platform
* [Amazon Web Services (AWS)](aws-installation-guide.md)
* [Google Compute Engine (GCE)](gce-installation-guide.md)

## Further information
Expand Down
140 changes: 140 additions & 0 deletions install/aws-installation-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
# Install Kata Containers on Amazon Web Services

* [Install and Configure AWS CLI](#install-and-configure-aws-cli)
* [Create or Import an EC2 SSH key pair](#create-or-import-an-ec2-ssh-key-pair)
* [Launch i3.metal instance](#launch-i3metal-instance)
* [Install Kata](#install-kata)

Kata Containers on Amazon Web Services (AWS) makes use of [i3.metal](https://aws.amazon.com/ec2/instance-types/i3/) instances. Most of the installation procedure is identical to that for Kata on your preferred distribution, except that you have to run it on bare metal instances since AWS doesn't support nested virtualization yet. This guide walks you through creating an i3.metal instance.

## Install and Configure AWS CLI

### Requirements

* Python:
* Python 2 version 2.6.5+
* Python 3 version 3.3+

### Install

Install with this command:

```bash
$ pip install awscli --upgrade --user
```

### Configure

First, verify it:

```bash
$ aws --version
```

Then configure it:

```bash
$ aws configure
```

Specify the required parameters:

```
AWS Access Key ID []: <your-key-id-from-iam>
AWS Secret Access Key []: <your-secret-access-key-from-iam>
Default region name []: <your-aws-region-for-your-i3-metal-instance>
Default output format [None]: <yaml-or-json-or-empty>
```

Alternatively, you can create the files: `~/.aws/credentials` and `~/.aws/config`:

```bash
$ cat <<EOF > ~/.aws/credentials
[default]
aws_access_key_id = <your-key-id-from-iam>
aws_secret_access_key = <your-secret-access-key-from-iam>
EOF
$ cat <<EOF > ~/.aws/config
[default]
region = <your-aws-region-for-your-i3-metal-instance>
EOF
```

For more information on how to get AWS credentials please refer to [this guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). Alternatively, you can ask the administrator of your AWS account to issue one with the AWS CLI:

```sh
$ aws_username="myusername"
$ aws iam create-access-key --user-name="$aws_username"
```

More general AWS CLI guidelines can be found [here](https://docs.aws.amazon.com/cli/latest/userguide/installing.html).

## Create or Import an EC2 SSH key pair

You will need this to access your instance.

To create:

```bash
$ aws ec2 create-key-pair --key-name MyKeyPair | grep KeyMaterial | cut -d: -f2- | tr -d ' \n\"\,' > MyKeyPair.pem
$ chmod 400 MyKeyPair.pem
```

Alternatively to import using your public SSH key:

```bash
$ aws ec2 import-key-pair --key-name "MyKeyPair" --public-key-material file://MyKeyPair.pub
```

## Launch i3.metal instance

Get the latest Bionic Ubuntu AMI (Amazon Image) or the latest AMI for the Linux distribution you would like to use. For example:

```bash
$ aws ec2 describe-images --owners 099720109477 --filters "Name=name,Values=ubuntu/images/hvm-ssd/ubuntu-bionic-18.04-amd64-server*" --query 'sort_by(Images, &CreationDate)[].ImageId '
```

This command will produce output similar to the following:

```
[
...
"ami-063aa838bd7631e0b",
"ami-03d5270fcb641f79b"
]
```

Launch the EC2 instance and pick ip the `INSTANCEID`:

```bash
$ aws ec2 run-instances --image-id ami-03d5270fcb641f79b --count 1 --instance-type i3.metal --key-name MyKeyPair --associate-public-ip-address > /tmp/aws.json
$ export INSTANCEID=$(grep InstanceId /tmp/aws.json | cut -d: -f2- | tr -d ' \n\"\,')
```

Wait for the instance to come up, the output of the following command should be `running`:

```bash
$ aws ec2 describe-instances --instance-id=${INSTANCEID} | grep running | cut -d: -f2- | tr -d ' \"\,'
```

Get the public IP address for the instances:

```bash
$ export IP=$(aws ec2 describe-instances --instance-id=${INSTANCEID} | grep PublicIpAddress | cut -d: -f2- | tr -d ' \n\"\,')
```

Refer to [this guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-launch.html) for more details on how to launch instances with the AWS CLI.

SSH into the machine

```bash
$ ssh -i MyKeyPair.pen ubuntu@${IP}
```

Go onto the next step.

## Install Kata

The process for installing Kata itself on bare metal is identical to that of a virtualization-enabled VM.

For detailed information to install Kata on your distribution of choice, see the [Kata Containers installation user guides](https://github.com/kata-containers/documentation/blob/master/install/README.md).

0 comments on commit bd18f9d

Please sign in to comment.