Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions HOWTO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# How to create serverless applications using AWS SAM
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this is the place to discuss what a stack is? I noticed we discussed it below, but didnt quite define what it is. I like your below definition of what a changeset is, but maybe a simple definition of a stack here would be helpful

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea. Done

AWS Serverless Application Model (AWS SAM) allows you to easily create and
manage resources used in your serverless application using AWS CloudFormation.
You can define your serverless application as a SAM template - a JSON or YAML
configuration file that describes Lambda function, API endpoints and
other resources in your application. Using nifty commands, you upload this
template to CloudFormation which creates all the individual resources and
groups them into a *CloudFormation Stack* for ease of management.
When you update your SAM template, you will re-deploy the changes to
this stack. AWS CloudFormation will take care of updating the individual
resources for you.


The remainder of document explains how to write SAM templates and
deploy them via AWS CloudFormation.

## Writing SAM Template
Checkout the [latest specification](versions/2016-10-31.md) for details on how to write a SAM template

## Packing Artifacts
Before you can deploy a SAM template, you should first upload your Lambda
function code zip and API's OpenAPI File to S3. Set the `CodeUri` and
`DefinitionUri` properties to the S3 URI of uploaded files. You
can choose to do this manually or use `aws cloudformation package` [CLI command](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/package.html) to automate the task of uploading local artifacts to S3 bucket. The command returns a copy of your template, replacing references to local artifacts with S3 location where the command uploaded your artifacts.

To use this command, set `CodeUri` property to be the path to your
source code folder/zip/jar and `DefinitionUri` property to be a path to
your OpenAPI file, as shown in the example below
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By OpenAPI do you mean swagger file? Is that the official name?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's the new official name


```
MyLambdaFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: ./code
...

MyApi:
Type: AWS::Serverless::Api
Properties:
DefinitionUri: ./specs/swagger.yaml
...
```

Run the following command to upload your artifacts to S3 and output a
packaged template that can be readily deployed to CloudFormation.
```
aws cloudformation package \
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

your examples above are using yaml, but your command for package uses json :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch. fixed

--template-file /path_to_template/template.yaml \
--s3-bucket bucket-name \
--output-template-file packaged-template.yaml
```

The packaged template will look something like this:
```
MyLambdaFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: s3://<mybucket>/<my-zipfile-path>
...

MyApi:
Type: AWS::Serverless::Api
Properties:
DefinitionUri: s3://<mybucket>/<my-openapi-file-path>
...
```


## Deploying to AWS CloudFormation
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the understanding of a changeset could be confusing for new users. Maybe have a brief description of what a changeset is and how cloudformation uses it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

SAM template is deployed to AWS CloudFormation by [creating a changeset](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets-create.html)
using the SAM template followed by [executing the changeset](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets-execute.html).
Think of a ChangeSet as a diff between your current stack template and the new template that you are deploying. After you create a ChangeSet, you have the opportunity to examine the diff before executing it. Both the AWS Console and AWS CLI provide commands to create and execute a changeset.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this line is really helpful, and will make it clear what this does. 👍

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know this is more of a cloudformation detail, but it might be worth mentioning that once a changeset is executed, other unused ones will be discarded.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is relevant to this audience. I'd rather not confuse them


Alternatively, you can use `aws cloudformation deploy` CLI command to deploy the SAM template. Under-the-hood it creates and executes a changeset and waits until the deployment completes. It also prints debugging hints when the deployment fails. Run the following command to deploy the packaged template to a stack called `my-new-stack`:

```
aws cloudformation deploy \
--template-file /path_to_template/packaged-template.yaml \
--stack-name my-new-stack \
--capabilities CAPABILITY_IAM
```

Refer to the [documentation](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/deploy/index.html) for more details.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,8 @@ version.

Each section should contain folders named per version to avoid confusion between
the versions.

## Usage and Examples
Checkout the [How-To Guide](HOWTO.md) and [examples folder](examples/) for
detailed instructions on how to write AWS SAM templates and deploy them
to AWS CloudFormation