AWS Elastic Beanstalk
Developer Guide (API Version 2010-12-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

Getting Started with Eb

Eb is an updated command line interface (CLI) for AWS Elastic Beanstalk that enables you to deploy applications quickly and more easily. This section provides an end-to-end walkthrough using eb to launch a sample application, view it, update it, and then delete it.

To complete this walkthrough, you will need to download the command line tools at the AWS Sample Code & Libraries website. For a complete CLI reference for more advanced scenarios, see Operations, and see Getting Set Up for instructions on how to get set up.

Step 1: Initialize Your Git Repository

Eb is a command line interface that enables you to deploy applications quickly and more easily using Git. Eb is available as part of the Elastic Beanstalk command line tools package. Follow the steps below to install eb and initialize your Git repository.

To install eb, its prerequisite software, and initialize your Git repository

  1. Install the following software onto your local computer:

    1. Linux/Unix/MAC

      • Download and unzip the Elastic Beanstalk command line tools package at the AWS Sample Code & Libraries website. You can install either version 2.6.0 or version 2.6.1 of the AWS DevTools. Version 2.6.0 uses Ruby. Version 2.6.1 uses Python.

      • Git 1.6.6 or later. To download Git, go to http://git-scm.com/.

      • Ruby version 1.8.7 or later. To view and download Ruby clients, go to http://www.ruby-lang.org/en/.

      • Python 2.7 or 3.0.

    2. Windows

  2. Initialize your Git repository.

    git init .

Step 2: Configure AWS Elastic Beanstalk

AWS Elastic Beanstalk needs the following information to deploy an application:

  • AWS access key ID

  • AWS secret key

  • Service region

  • Application name

  • Environment name

  • Solution stack

Use the init command, and AWS Elastic Beanstalk will prompt you to enter this information. If a default value is available, and you want to use it, press Enter.

Before you use eb, set your PATH to the location of eb. The following table shows an example for Linux/UNIX and Windows.

On Linux and UNIXOn Windows
$ export PATH=$PATH:<path to unzipped EB CLI package>/eb/linux/python2.7/ C:\> set PATH=%PATH%;<path to unzipped EB CLI package>\eb\windows\

To configure AWS Elastic Beanstalk

  1. From your directory where you created your local repository, type the following command.

    eb init
  2. When you are prompted for the access key ID, type your access key ID. To get your access key ID, see How Do I Get Security Credentials? in the AWS General Reference.

    Enter your AWS Access Key ID (current value is "AKIAIOSFODNN7EXAMPLE"): 
  3. When you are prompted for the secret access key, type your secret access key. To get your secret access key, see How Do I Get Security Credentials? in the AWS General Reference.

    Enter your AWS Secret Access Key (current value is "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"): 
  4. When you are prompted for the AWS Elastic Beanstalk region, type the number of the region. For information about this product's regions, go to Regions and Endpoints in the Amazon Web Services General Reference. For this example, we'll use US East (Virginia).

  5. When you are prompted for the AWS Elastic Beanstalk application name, type the name of the application. AWS Elastic Beanstalk autogenerates an application name based on the current directory name if an application name has not been previously configured. In this example, we use HelloWorld.

    Enter an AWS Elastic Beanstalk application name (auto-generated value is "windows"): HelloWorld

    Note

    If you have a space in your application name, make sure you do not use quotes.

  6. When you are prompted for the AWS Elastic Beanstalk environment name, type the name of the environment. AWS Elastic Beanstalk automatically creates an environment name based on your application name. If you want to accept the default, press Enter.

    Enter an AWS Elastic Beanstalk environment name (current value is "HelloWorld-env"): 

    Note

    If you have a space in your application name, make sure you do not have a space in your environment name.

  7. When you are prompted for the solution stack, type the number of the solution stack you want. For this example, we'll use 64bit Amazon Linux running PHP 5.4.

  8. When you are prompted to create an Amazon RDS DB instance, type y or n. For this example, we'll type y.

    Create an RDS DB Instance? [y/n]:
  9. When you are prompted to create the database from scratch or a snapshot, type your selection. For this example, we'll use No snapshot.

  10. When you are prompted to enter your RDS user master password, type your password containing from 8 to 16 printable ASCII characters (excluding /, \, and @).

    Enter an RDS DB master password: 
    Retype password to confirm: 
  11. When you are prompted to create a snapshot if you delete the Amazon RDS DB instance, type y or n. For this example, we'll type n. If you type n, then your RDS DB instance will be deleted and your data will be lost if you terminate your environment.

    You should see a confirmation that your AWS Credential file was successfully updated.

    By default, eb sets the following default values for Amazon RDS.

    • Database engine — MySQL

    • Default version: — 5.5

    • Database name: — ebdb

    • Allocated storage — 5GB

    • Instance class — db.t1.micro

    • Deletion policy — delete

    • Master username — ebroot

  12. When you are prompted to enter your instance profile name, you can choose to create a default instance profile or use an existing instance profile. Using an instance profile enables IAM users and AWS services to gain access to temporary security credentials to make AWS API calls. Using instance profiles prevents you from having to store long-term security credentials on the EC2 instance. For more information about instance profiles, see Granting Permissions to Users and Services Using IAM Roles. For this example, we'll use Create a default instance profile.

After configuring AWS Elastic Beanstalk, you are ready to deploy a sample application.

If you want to update your AWS Elastic Beanstalk configuration, you can use the init command again. When prompted, you can update your configuration options. If you want to keep any previous settings, press the Enter key. If you want to update your Amazon RDS DB configuration settings, you can update your optionsettings file in the .elasticbeanstalk directory, and then use the eb update command to update your AWS Elastic Beanstalk environment.

Step 3: Create the Application

Next, you need to create and deploy a sample application. In these procedures, you use a sample application that is already prepared. AWS Elastic Beanstalk uses the configuration information you specified in the previous step to do the following:

  • Create an application using the application name you specified.

  • Launch an environment using the environment name you specified that provisions the AWS resources to host the application.

  • Deploy the application into the newly created environment.

Use the start command to create and deploy a sample application.

To create the application

  • From your directory where you created your local repository, type the following command.

    eb start

This process may take several minutes to complete. AWS Elastic Beanstalk will provide status updates during the process. If at any time you want to stop polling for status updates, press Ctrl+C. Once the environment status is Green, AWS Elastic Beanstalk will output a URL for the application.

Step 4: View the Application

In the previous step, you created an application and deployed it to AWS Elastic Beanstalk. After the environment is ready and its status is Green, AWS Elastic Beanstalk provides a URL to view the application. In this step, you can check the status of the environment to make sure it is set to Green and then copy and paste the URL to view the application.

Use the status command to check the environment status, and then use the URL to view the application.

To view the application

  1. From your directory where you created your local repository, type the following command.

    eb status --verbose

    AWS Elastic Beanstalk displays the environment status. If the environment is set to Green, AWS Elastic Beanstalk displays the URL for the application. If you attached an RDS DB instance to your environment, your RDS DB information is displayed.

  2. Copy and paste the URL into your web browser to view your application.

Step 5: Update the Application

After you have deployed a sample application, you can update the sample application with your own application. In this step, we'll update the sample PHP application with a simple HelloWorld application.

To update the sample application

  1. Create a simple PHP file that displays "Hello World" and add it to your Git repository.

    <html>
     <head>
      <title>PHP Test</title>
     </head>
     <body>
     <?php echo '<p>Hello World</p>'; ?> 
     </body>
    </html>		

    Next, add your new program to your local Git repository, and then commit your change.

    git add index.php
    git commit -m "initial check-in"			

    Note

    For information about Git commands, go to Git - Fast Version Control System.

  2. Deploy to AWS Elastic Beanstalk.

    git aws.push
  3. View your updated application. Copy and paste the same URL in your web browser as you did in Step 4: View the Application.

Step 6: Clean Up

If you no longer want to run your application, you can clean up by terminating your environment and deleting your application.

Use the stop command to terminate your environment and the delete command to delete your application.

To delete the application

  1. From your directory where you created your local repository, type the following command.

    eb stop

    This process may take a few minutes. AWS Elastic Beanstalk will display a message once the environment has been successfully terminated.

    Note

    If you attached an RDS DB instance to your environment, your RDS DB will be deleted, and you will lose your data. To save your data, create a snapshot before you delete the application. For instructions on how to create a snapshot, go to Creating a DB Snapshot in the Amazon Relational Database Service User Guide.

  2. From your directory where you installed the command line interface, type the following command.

    eb delete

    AWS Elastic Beanstalk will display a message once it has successfully deleted the application.