Skip to content

aws.rst

Latest commit

 

History

History
183 lines (119 loc) · 5.48 KB

aws.rst

File metadata and controls

183 lines (119 loc) · 5.48 KB
title:Installing Deis on AWS
description:How to provision a multi-node Deis cluster on Amazon AWS

Amazon AWS

In this tutorial, we will show you how to set up your own 3-node cluster on Amazon Web Services.

Please refer to the scripts in contrib/ec2 while following this documentation.

Install the AWS Command Line Interface

In order to start working with Amazon's API, let's install awscli:

$ pip install awscli
Downloading/unpacking awscli
  Downloading awscli-1.5.0.tar.gz (248kB): 248kB downloaded
...
Successfully installed awscli

Configure aws-cli

Run aws configure to set your AWS credentials:

$ aws configure
AWS Access Key ID [None]: ***************
AWS Secret Access Key [None]: ************************
Default region name [None]: us-west-1
Default output format [None]:

Upload keys

Generate and upload a new keypair to AWS, ensuring that the name of the keypair is set to "deis".

$ ssh-keygen -q -t rsa -f ~/.ssh/deis -N '' -C deis
$ aws ec2 import-key-pair --key-name deis --public-key-material file://~/.ssh/deis.pub

Choose Number of Instances

By default, the script will provision 3 servers. You can override this by setting DEIS_NUM_INSTANCES:

$ export DEIS_NUM_INSTANCES=5

Note that for scheduling to work properly, clusters must consist of at least 3 nodes and always have an odd number of members. For more information, see optimal etcd cluster size.

Deis clusters of less than 3 nodes are unsupported.

Generate a New Discovery URL

To get started with provisioning Deis, we will need to generate a new Discovery URL. Discovery URLs help connect etcd instances together by storing a list of peer addresses and metadata under a unique address. You can generate a new discovery URL for use in your platform by running the following from the root of the repository:

$ make discovery-url

This will write a new discovery URL to the user-data file. Some convenience scripts are supplied in this user-data file, so it is mandatory for provisioning Deis.

Customize cloudformation.json

Any of the parameter defaults defined in deis.template.json can be overridden by setting the value in cloudformation.json like so:

{
    "ParameterKey":     "InstanceType",
    "ParameterValue":   "m3.xlarge"
},
{
    "ParameterKey":     "KeyPair",
    "ParameterValue":   "jsmith"
},
{
    "ParameterKey":     "EC2VirtualizationType",
    "ParameterValue":   "PV"
},
{
    "ParameterKey":     "AssociatePublicIP",
    "ParameterValue":   "false"
}

The only entry in cloudformation.json required to launch your cluster is KeyPair, which is already filled out. The defaults will be applied for the other settings.

If updated with update-ec2-cluster.sh, the InstanceType will only impact newly deployed instances (#1758).

NOTE: The smallest recommended instance size is large. Having not enough CPU or RAM will result in numerous issues when using the cluster.

Launch into an existing VPC

By default, the provided CloudFormation script will create a new VPC for Deis. However, the script supports provisioning into an existing VPC instead. You'll need to have a VPC configured with an internet gateway and a sane routing table (the default VPC in a region should be ready to go).

To launch your cluster into an existing VPC, export three additional environment variables:

  • VPC_ID
  • VPC_SUBNETS
  • VPC_ZONES

VPC_ZONES must list the availability zones of the subnets in order.

For example, if your VPC has ID vpc-a26218bf and consists of the subnets subnet-04d7f942 (which is in us-east-1b) and subnet-2b03ab7f (which is in us-east-1c) you would export:

export VPC_ID=vpc-a26218bf
export VPC_SUBNETS=subnet-04d7f942,subnet-2b03ab7f
export VPC_ZONES=us-east-1b,us-east-1c

Run the Provision Script

Run the cloudformation provision script to spawn a new CoreOS cluster:

$ cd contrib/ec2
$ ./provision-ec2-cluster.sh
{
    "StackId": "arn:aws:cloudformation:us-west-1:413516094235:stack/deis/9699ec20-c257-11e3-99eb-50fa01cd4496"
}
Your Deis cluster has successfully deployed.
Please wait for all instances to come up as "running" before continuing.

Check the AWS EC2 web control panel and wait until "Status Checks" for all instances have passed. This will take several minutes.

Configure DNS

See :ref:`configure-dns` for more information on properly setting up your DNS records with Deis.

Install Deis Platform

Now that you've finished provisioning a cluster, please refer to :ref:`install_deis_platform` to start installing the platform.