aws-samples / Serverless Sinatra Sample

Running Ruby Sinatra on AWS Lambda

This sample code helps get you started with a simple Sinatra web app deployed on AWS Lambda. It is tested with Ruby 2.5.x and bundler-1.17.x.

Additional details can be found at: https://aws.amazon.com/blogs/compute/announcing-ruby-support-for-aws-lambda/

Other resources:

Ruby Sinatra on AWS Lambda: https://blog.eq8.eu/article/sinatra-on-aws-lambda.html

We want FaaS for Ruby: https://www.serverless-ruby.org/

What's Here

This sample includes:

• README.md - this file
• Gemfile - Gem requirements for the sample application
• app/config.ru - this file contains configuration for Rack middleware
• app/server.rb - this file contains the code for the sample service
• app/views - this directory has the template files
• spec/ - this directory contains the RSpec unit tests for the sample application
• template.yaml - this file contains the description of AWS resources used by AWS CloudFormation to deploy your serverless application
• pipeline-cfn.yaml - this is the CloudFormation template to create the CodePipeline and the other needed resources. You need to fork the repo if you use a personal GitHub token
• buildspec.yml - this file contains build commands used by AWS CodeBuild

Getting Started

These directions assume you already have Ruby 2.5.x and AWS CLI installed and configured. Please fork the repo and create an access token if you want to create a CodePipeline to deploy the app. The pipeline-cfn.yaml template can be used to automate the process.

To work on the sample code, you'll need to clone your project's repository to your local computer. If you haven't, do that first. You can find a guide here.

1. Ensure you are using ruby version 2.5.x

2. Install bundle

    $ gem install bundler -v "~> 1.17"
   

3. Install Ruby dependencies for this service

    $ bundle install
   

4. Download the Gems to the local vendor directory

    $ bundle install --deployment
   

5. Create the deployment package (note: if you don't have a S3 bucket, you need to create one):

    $ aws cloudformation package \
        --template-file template.yaml \
        --output-template-file serverless-output.yaml \
        --s3-bucket { your-bucket-name }
   

   Alternatively, if you have SAM CLI installed, you can run the following command which will do the same

    $ sam package \
        --template-file template.yaml \
        --output-template-file serverless-output.yaml \
        --s3-bucket { your-bucket-name }
   

6. Deploying your application

    $ aws cloudformation deploy --template-file serverless-output.yaml \
        --stack-name { your-stack-name } \
        --capabilities CAPABILITY_IAM
   

   Or use SAM CLI

    $ sam deploy \
        --template-file serverless-output.yaml \
        --stack-name { your-stack-name } \
        --capabilities CAPABILITY_IAM
   

7. Once the deployment is complete, you can find the application endpoint from the CloudFormation outputs tab. Alternatively, you can find it under the Stages link from the API gateway console.

Note: You can also use an Application Load Balancer instead of API gateway. For details, please visit https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html

What Do I Do Next?

If you have checked out a local copy of your repository you can start making changes to the sample code.

Learn more about Serverless Application Model (SAM) and how it works here: https://github.com/awslabs/serverless-application-model/blob/master/HOWTO.md

AWS Lambda Developer Guide: http://docs.aws.amazon.com/lambda/latest/dg/deploying-lambda-apps.html

How Do I Add Template Resources to My Project?

To add AWS resources to your project, you'll need to edit the template.yaml file in your project's repository. You may also need to modify permissions for your project's IAM roles. After you push the template change, AWS CloudFormation provisions the resources for you.

License

This library is licensed under the Apache 2.0 License.