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

Deploying an Express Application to AWS Elastic Beanstalk

This section walks you through deploying a sample application to AWS Elastic Beanstalk using eb (an updated command line interface) and Git, and then updating the application to use the Express framework.

Note

This example uses Amazon RDS, and you may be charged for its usage. For more information about pricing, go to Amazon Relational Database Service (RDS) Pricing. If you are a new customer, you can make use of the AWS Free Usage Tier. For details, go to AWS Free Usage Tier.

Step 1: Set Up 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

Step 2: Set Up Your Express Development Environment

Set up Express and create the project structure. The following walks you through setting up Express on a Linux operating system.

To set up your Express development environment on your local computer

  1. Install node.js. For instructions, go to http://nodejs.org/. Verify you have a successful installation before proceeding to the next step.

    $ node -v

    Note

    For information about what Node.js versions are supported, see Supported Platforms.

  2. Create a directory for your express application.

    $ mkdir node-express
    $ cd node-express
  3. Install npm if you don't already have it installed. Here's one example of how to install npm.

    node-express# cd . && yum install npm
  4. Install Express globally so that you have access to the express command.

    node-express# npm install -g express
  5. Depending on your operating system, you may need to set your path to run the express command. If you need to set your path, use the output from the previous step when you installed Express. The following is an example.

    node-express# export:PATH=$PATH:/usr/local/share/npm/bin/express
  6. Run the express command. This generates package.json.

    node-express# express

    When prompted if you want to continue, type y.

  7. Set up local dependencies.

    node-express# cd . && npm install
  8. Verify it works.

    node-express# node app.js

    You should see output similar to the following:

    Express server listening on port 3000

    Press Ctrl+C to stop the server.

  9. Initialize the Git repository.

    node-express# git init 
  10. Edit the .gitignore file and add the following files and directories to it. These files will be excluded from being added to the repository. This step is not required, but it is recommended.

    node-express# cat > .gitignore <<EOT 
    node_modules/
    .gitignore
    .elasticbeanstalk/
    EOT

Step 3: Configure AWS Elastic Beanstalk

You use eb, a command line tool, to configure AWS Elastic Beanstalk. If you haven't already installed eb on your local computer, do that now at the AWS Sample Code & Libraries website. If you are running eb on a Linux operating system, you will need to install Python 2.7 or 3.0.

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\

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.

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 auto-generates an application name based on the current directory name if an application name has not been previously configured. In this example, we use expressapp.

    Enter an AWS Elastic Beanstalk application name (auto-generated value is "node-express"): expressapp

    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 "node-express-env"): expressapp-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, choose an environment tier. For this example, we'll use 1.

    Available environment tiers are:
    1) WebServer::Standard::1.0
    2) Worker::SQS/HTTP::1.0
    
  8. When you are prompted for the solution stack, type the number of the solution stack you want. For this example, we'll use 32bit Amazon Linux running Node.js.

  9. When you are prompted, choose an environment type.

    Available environment types are: 
    1) LoadBalanced
    2) SingleInstance
    			
  10. 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]:
  11. When you are prompted to create the database from scratch or a snapshot, type your selection. For this example, we'll use No snapshot.

  12. 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: 
  13. 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

  14. 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 4: Create an 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 5: 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 6: Update the Application

After you have deployed a sample application, you can update it with your own application. In this step, we update the sample application to use the Express framework. You can download the final source code from http://elasticbeanstalk-samples-us-east-1.s3.amazonaws.com/nodejs-example-express.zip.

To update your application to use Express

  1. Stage the files.

    node-express# git add .
    node-express# git commit -m "First express app"
    node-express# git aws.push					
  2. Once the environment is green and ready, refresh the URL to verify it worked. You should see a web page that says "Welcome to Express".

You can access the logs for your EC2 instances running your application. For instructions on accessing your logs, see Working with Logs.

Next, let's update the Express application to server static files and add a new page.

To configure static files and add a new page to your Express application

  1. On your local computer, create an .ebextensions directory in the top-level directory of your source bundle. In this example, we use node-express/.ebextensions.

  2. Create a configuration file, /node-express/.ebextensions/static.config. For more information about the configuration file, see Customizing and Configuring a Node.js Environment. Type the following inside the configuration file to configure static files:

    option_settings:
      - namespace: aws:elasticbeanstalk:container:nodejs:staticfiles
        option_name: /public
        value: /public
  3. On your local computer, comment out the static mapping in node-express/app.js. This step is not required, but it is a good test to see if the static mappings are configured correctly.

    //  app.use(express.static(path.join(__dirname, 'public'))); 
  4. Add your updated files to your local repository and commit your changes.

    node-express# git add .ebextensions/ app.js
    node-express# git commit -m "Making stylesheets be served by nginx."
  5. On your local computer, add node-express/routes/hike.js. Type the following:

    exports.index = function(req, res) {
     res.render('hike', {title: 'My Hiking Log'});
    };
    
    exports.add_hike = function(req, res) {
    };
  6. On your local computer, update node-express/app.js to include three new lines.

    First, add the following line to add a require for this route:

     , hike = require('./routes/hike');

    Your file should look similar to the following snippet:

    var express = require('express')
      , routes = require('./routes')
      , user = require('./routes/user')
      , http = require('http')
      , path = require('path')
      , hike = require('./routes/hike');

    Then, add the following two lines to node-express/app.js after app.get('/users', users.list);

    app.get('/hikes', hike.index);
    app.post('/add_hike', hike.add_hike);

    Your file should look similar to the following snippet:

    app.get('/', routes.index);
    app.get('/users', user.list);
    app.get('/hikes', hike.index);
    app.post('/add_hike', hike.add_hike);
  7. On your local computer, copy node-express/views/index.jade to node-express/views/hike.jade.

    node-express# cp views/index.jade views/hike.jade
  8. Add your files to the local repository, commit your changes, and deploy your updated application.

    node-express# git add .
    node-express# git commit -m "added new file"
    node-express# git aws.push
  9. Your environment will be updated after a few minutes. After your environment is green and ready, verify it worked by refreshing your browser and appending hikes at the end of the URL (e.g., http://node-express-env-syypntcz2q.elasticbeanstalk.com/hikes).

    You should see a web page titled My Hiking Log.

Next, let's update the application to add a database.

To update your application with a database

  1. On your local computer, update node-express/app.js to add the database information and add a record to the database. You can also copy app.js from http://elasticbeanstalk-samples-us-east-1.s3.amazonaws.com/nodejs-example-express.zip.

    /**
     * Module dependencies.
     */
    
    var express = require('express')
      , routes = require('./routes')
      , user = require('./routes/user')
      , hike = require('./routes/hike')
      , http = require('http')
      , path = require('path')
      , mysql = require('mysql')
      , async = require('async');
    
    var app = express();
    
    app.configure(function(){
      app.set('port', process.env.PORT || 3000);
      app.set('views', __dirname + '/views');
      app.set('view engine', 'jade');
      app.use(express.favicon());
      app.use(express.logger('dev'));
      app.use(express.bodyParser());
      app.use(express.methodOverride());
      app.use(app.router);
    //  app.use(express.static(path.join(__dirname, 'public')));
    });
    
    app.configure('development', function() {
      console.log('Using development settings.');
      app.set('connection', mysql.createConnection({
        host: '',
        user: '',
        port: '',
        password: ''}));
      app.use(express.errorHandler());
    });
    
    app.configure('production', function() {
      console.log('Using production settings.');
      app.set('connection', mysql.createConnection({
        host: process.env.RDS_HOSTNAME,
        user: process.env.RDS_USERNAME,
        password: process.env.RDS_PASSWORD,
        port: process.env.RDS_PORT}));
    });
    
    function init() {
      app.get('/', routes.index);
      app.get('/users', user.list);
      app.get('/hikes', hike.index);
      app.post('/add_hike', hike.add_hike);
    
      http.createServer(app).listen(app.get('port'), function(){
        console.log("Express server listening on port " + app.get('port'));
      });
    }
    
    var client = app.get('connection');
    async.series([
      function connect(callback) {
        client.connect(callback);
      },
      function clear(callback) {
        client.query('DROP DATABASE IF EXISTS mynode_db', callback);
      },
      function create_db(callback) {
        client.query('CREATE DATABASE mynode_db', callback);
      },
      function use_db(callback) {
        client.query('USE mynode_db', callback);
      },
      function create_table(callback) {
         client.query('CREATE TABLE HIKES (' +
                             'ID VARCHAR(40), ' +
                             'HIKE_DATE DATE, ' +
                             'NAME VARCHAR(40), ' +
                             'DISTANCE VARCHAR(40), ' +
                             'LOCATION VARCHAR(40), ' +
                             'WEATHER VARCHAR(40), ' +
                             'PRIMARY KEY(ID))', callback);
      },
      function insert_default(callback) {
        var hike = {HIKE_DATE: new Date(), NAME: 'Hazard Stevens',
              LOCATION: 'Mt Rainier', DISTANCE: '4,027m vertical', WEATHER:'Bad'};
        client.query('INSERT INTO HIKES set ?', hike, callback);
      }
    ], function (err, results) {
      if (err) {
        console.log('Exception initializing database.');
        throw err;
      } else {
        console.log('Database initialization complete.');
        init();
      }
    });
  2. On your local computer, update node-express/views/hike.jade to display a record from the database.

    extends layout
    
    block content
      h1= title
      p Welcome to #{title}
    
      div
        h3 Hikes
        table(border="1")
          tr
            td Date
            td Name
            td Location
            td Distance
            td Weather
          each hike in hikes
            tr
              td #{hike.HIKE_DATE.toDateString()}
              td #{hike.NAME}
              td #{hike.LOCATION}
              td #{hike.DISTANCE}
              td #{hike.WEATHER}
  3. On your local computer, update node-express/routes/hike.js to configure the route to show the record.

    var uuid = require('node-uuid');
    
    exports.index = function(req, res) {
      res.app.get('connection').query( 'SELECT * FROM HIKES', function(err, rows) {
        if (err) {
          res.send(err);
        } else {
          console.log(JSON.stringify(rows));
          res.render('hike', {title: 'My Hiking Log', hikes: rows});
      }});
    };
    
    exports.add_hike = function(req, res){
    };
  4. On your local computer, update node-express/package.json to add dependencies.

    {
      "name": "application-name",
      "version": "0.0.1",
      "private": true,
      "scripts": {
        "start": "node app"
      },
      "dependencies": {
        "express": "3.1.0",
        "jade": "*",
        "mysql": "*",
        "async": "*",
        "node-uuid": "*"
      }
    }
  5. On your local computer, update node-express/.ebextensions/static.config to add a production flag to the environment variables.

    option_settings:
      - namespace: aws:elasticbeanstalk:container:nodejs:staticfiles
        option_name: /public
        value: /public
      - option_name: NODE_ENV
        value: production
  6. Add your files to the local repository, commit your changes, and deploy your updated application.

    node-express# git add .
    node-express# git commit -m "updated files"
    node-express# git aws.push
  7. Your environment will be updated after a few minutes. After your environment is green and ready, verify it worked by refreshing your URL. Remember to append hikes at the end of the URL. You should see the following page.

Next, update the application to accept new entries and display records from the database.

To update the application to allow new entries into the database

  1. On your local computer, update node-express/views/hike.jade so the user can enter new entries. Add the form block inside the block content.

    extends layout
    
    block content
      h1= title
      p Welcome to #{title}
    
      form(action="/add_hike", method="post")
        table(border="1")
          tr
            td Your Name
            td
              input(name="hike[NAME]", type="textbox")
          tr
            td Location
            td
              input(name="hike[LOCATION]", type="textbox")
          tr
            td Distance
            td
              input(name="hike[DISTANCE]", type="textbox")
          tr
            td Weather
            td
              input(name="hike[WEATHER]", type="radio", value="Good")
              | Good
              input(name="hike[WEATHER]", type="radio", value="Bad")
              | Bad
              input(name="hike[WEATHER]", type="radio", value="Seattle", checked)
              | Seattle
          tr
            td(colspan="2")
              input(type="submit", value="Record Hike")
    
      div
        h3 Hikes
        table(border="1")
          tr
            td Date
            td Name
            td Location
            td Distance
            td Weather
          each hike in hikes
            tr
              td #{hike.HIKE_DATE.toDateString()}
              td #{hike.NAME}
              td #{hike.LOCATION}
              td #{hike.DISTANCE}
              td #{hike.WEATHER}
  2. On your local computer, update node-express/routes/hike.js to accept new entries. Update exports.add_hike to be the following.

    exports.add_hike = function(req, res){
      var input = req.body.hike;
      var hike = { HIKE_DATE: new Date(), ID: uuid.v4(), NAME: input.NAME,
          LOCATION: input.LOCATION, DISTANCE: input.DISTANCE, WEATHER: input.WEATHER};
    
      console.log('Request to log hike:' + JSON.stringify(hike));
      req.app.get('connection').query('INSERT INTO HIKES set ?', hike, function(err) {
        if (err) {
          res.send(err);
        } else {
          res.redirect('/hikes');
        }
      });
    };
  3. Add your files to the local repository, commit your changes, and deploy your updated application.

    node-express# git add .
    node-express# git commit -m "added new file"
    node-express# git aws.push
  4. Your environment will be updated after a few minutes. After your environment is green and ready, verify it worked by refreshing your URL and adding a couple of entries. Remember to append hikes at the end of the URL. You should see a page similar to the following diagram.

Step 7: 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.