Adding a HowTo Guide #44

sanathkr · 2016-12-21T22:51:33Z

No description provided.

roryj

I think this is super helpful to have, and like what you have written. Some minor comments. I wonder if there is a way to relate the weird AWS parts (things with templates and changesets) in an easier to understand way

roryj · 2016-12-22T04:54:24Z

HOWTO.md

+        ...
+```
+
+## Packing Artifacts (Automated)


I think switching the order around so automatic would make more sense. That way people who are just taking a look get the easier version first.

Done. The Manual step felt redundant so I merged both of them together

roryj · 2016-12-22T04:55:07Z

HOWTO.md

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


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

Yeah, that's the new official name

roryj · 2016-12-22T04:56:43Z

HOWTO.md

+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 \


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

good catch. fixed

roryj · 2016-12-22T04:57:30Z

HOWTO.md

+```
+
+
+## Deploying to AWS CloudFormation


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?

roryj · 2016-12-22T04:58:01Z

HOWTO.md

+aws cloudformation deploy \
+    --template-file /path_to_template/packaged-template.json \
+    --stack-name my-new-stack \
+    --parameter-overrides Key1=Value1 Key2=Value2


What do these commands do?

Added a description of the command

sanathkr · 2016-12-22T19:19:36Z

@roryj Addressed your comments

jamesbyars · 2016-12-22T20:35:10Z

HOWTO.md

    --template-file /path_to_template/packaged-template.json \
-    --stack-name my-new-stack \
-    --parameter-overrides Key1=Value1 Key2=Value2
+    --stack-name my-new-stack 


I think you're missing a \ at the end of this line

Good catch. fixed

roryj · 2017-01-06T05:25:07Z

HOWTO.md

+## Deploying to AWS CloudFormation
+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. 


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

roryj · 2017-01-06T05:30:33Z

HOWTO.md

@@ -0,0 +1,73 @@
+# How to create serverless applications using AWS SAM


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

Good idea. Done

sanathkr · 2017-01-06T19:08:25Z

Uploaded a new commit with an introduction to CloudFormation stacks

vikrambhatt

Glad that you are adding this 👍 .

vikrambhatt · 2017-01-09T06:06:55Z

HOWTO.md

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


CLI command to deploy ...
If also prints debugging ...

Cool, will change

vikrambhatt · 2017-01-09T06:10:12Z

HOWTO.md

+## Deploying to AWS CloudFormation
+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. 


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.

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

vikrambhatt · 2017-01-09T06:14:59Z

HOWTO.md

+aws cloudformation package \
+    --template-file /path_to_template/template.yaml \
+    --s3-bucket bucket-name \
+    --output-template-file packaged-template.json


Wont the output be yaml too?

Yeah, it will be. Will change

vikrambhatt

LGTM.

Adding a HowTo Guide

8ebe3ea

sanathkr assigned roryj Dec 21, 2016

roryj reviewed Dec 22, 2016

View reviewed changes

Addressing comments to make the doc clear

14d7e62

jamesbyars reviewed Dec 22, 2016

View reviewed changes

adding missing slash

382436a

sanathkr requested a review from vikrambhatt January 3, 2017 20:18

roryj reviewed Jan 6, 2017

View reviewed changes

adding a bit of introduction to CloudFormation

31fb8ba

vikrambhatt reviewed Jan 9, 2017

View reviewed changes

addressing minor comments

3c1e7a9

vikrambhatt approved these changes Jan 10, 2017

View reviewed changes

sanathkr merged commit 33194de into master Jan 11, 2017

sanathkr deleted the howto_guide branch April 3, 2018 06:10

jamesiri unassigned roryj Aug 24, 2020

		@@ -0,0 +1,73 @@
		# How to create serverless applications using AWS SAM

Adding a HowTo Guide #44

Adding a HowTo Guide #44

Uh oh!

Conversation

sanathkr commented Dec 21, 2016

Uh oh!

roryj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanathkr commented Dec 22, 2016

Uh oh!

jamesbyars Dec 22, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sanathkr commented Jan 6, 2017

Uh oh!

vikrambhatt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vikrambhatt left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jamesbyars Dec 22, 2016 •

edited

Loading