No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
src
.editorconfig
.gitignore
LICENSE
README.md
template.yaml

README.md

vcs-stratus

This is VCS Stratus service SAM template.

Requirements

Setup process

Installing dependencies

In this example we use npm but you can use yarn if you prefer to manage NodeJS dependencies:

cd src
npm install
cd ../

Local development

Invoking function locally through local API Gateway

sam local start-api

If the previous command ran successfully you should now be able to hit the following local endpoint to invoke your function http://localhost:3000/

SAM CLI is used to emulate both Lambda and API Gateway locally and uses our template.yaml to understand how to bootstrap this environment (runtime, where the source code is, etc.) - The following excerpt is what the CLI will read in order to initialize an API and its routes:

...
Events:
    ProxyApiRoot:
        Type: Api
        Properties:
            Path: /
            Method: any
    ProxyApiGreedy:
        Type: Api
        Properties:
            Path: /{proxy+}
            Method: any

Packaging and deployment

AWS Lambda NodeJS runtime requires a flat folder with all dependencies including the application. SAM will use CodeUri property to know where to look up for both application and dependencies:

...
    StratusFunction:
        Type: AWS::Serverless::Function
        Properties:
            CodeUri: src/
            ...

Next, the following command will create a Cloudformation Stack and deploy your SAM resources.

sam deploy \
    --template-file serverless-output.yaml \
    --stack-name vcs-stratus-stack \
    --capabilities CAPABILITY_IAM \
    --parameter-overrides Param1=paramvalue Param2=paramvalue

See Serverless Application Model (SAM) HOWTO Guide for more details in how to get started.

After deployment is complete you can run the following command to retrieve the API Gateway Endpoint URL:

aws cloudformation describe-stacks \
    --stack-name vcs-stratus-stack \
    --query 'Stacks[].Outputs'

Testing

We use mocha for testing our code and it is already added in package.json under scripts, so that we can simply run the following command to run our tests:

cd src
npm test

AWS CLI commands

AWS CLI commands to package, deploy and describe outputs defined within the cloudformation stack:

sam package \
    --template-file template.yaml \
    --output-template-file packaged.yaml \
    --s3-bucket REPLACE_THIS_WITH_YOUR_S3_BUCKET_NAME

sam deploy \
    --template-file packaged.yaml \
    --stack-name vcs-stratus-stack \
    --capabilities CAPABILITY_IAM \
    --parameter-overrides MyParameterSample=MySampleValue

NOTE: Alternatively this could be part of package.json scripts section.