Mercurial > public > tweet-analysis

comparison README.md @ 1:0277e7fc0f0a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
first successful sam deploy
author Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
date Thu, 16 Sep 2021 09:38:07 +0200
parents cea9500dca25
children 5c36f51105c2
comparison
equal deleted inserted replaced
0:cea9500dca25 1:0277e7fc0f0a
1 # tweet-analysis 1 # tweet-analysis
2 2
3 This project contains source code and supporting files for a serverless application that you can deploy with the SAM CLI. It includes the following files and folders. 3 ## Structure
4 4
5 - hello_world - Code for the application's Lambda function. 5 - src - Code for the application's Lambda function.
6 - events - Invocation events that you can use to invoke the function. 6 - events - Invocation events that you can use to invoke the function.
7 - tests - Unit tests for the application code. 7 - tests - Unit tests for the application code.
8 - template.yaml - A template that defines the application's AWS resources. 8 - template.yaml - A template that defines the application's AWS resources.
9 9
10 The application uses several AWS resources, including Lambda functions and an API Gateway API. These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS resources through the same deployment process that updates your application code. 10 The application uses several AWS resources, including Lambda functions and an API Gateway API.
11 These resources are defined in the `template.yaml` file in this project. You can update the template to add AWS
12 resources through the same deployment process that updates your application code.
11 13
12 If you prefer to use an integrated development environment (IDE) to build and test your application, you can use the AWS Toolkit. 14 ## Deploy the application
13 The AWS Toolkit is an open source plug-in for popular IDEs that uses the SAM CLI to build and deploy serverless applications on AWS. The AWS Toolkit also adds a simplified step-through debugging experience for Lambda function code. See the following links to get started.
14 15
15 * [CLion](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html) 16 The Serverless Application Model Command Line Interface (SAM CLI) is an extension of the AWS CLI that adds functionality
16 * [GoLand](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html) 17 for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that
17 * [IntelliJ](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html) 18 matches Lambda. It can also emulate your application's build environment and API.
18 * [WebStorm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
19 * [Rider](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
20 * [PhpStorm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
21 * [PyCharm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
22 * [RubyMine](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
23 * [DataGrip](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html)
24 * [VS Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/welcome.html)
25 * [Visual Studio](https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/welcome.html)
26
27 ## Deploy the sample application
28
29 The Serverless Application Model Command Line Interface (SAM CLI) is an extension of the AWS CLI that adds functionality for building and testing Lambda applications. It uses Docker to run your functions in an Amazon Linux environment that matches Lambda. It can also emulate your application's build environment and API.
30 19
31 To use the SAM CLI, you need the following tools. 20 To use the SAM CLI, you need the following tools.
32 21
33 * SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) 22 * SAM CLI -
23 [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
34 * [Python 3 installed](https://www.python.org/downloads/) 24 * [Python 3 installed](https://www.python.org/downloads/)
35 * Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) 25 * Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community)
36 26
37 To build and deploy your application for the first time, run the following in your shell: 27 To build and deploy your application for the first time, run the following in your shell:
38 28
39 ```bash 29 ```bash
40 sam build --use-container 30 sam build --use-container
41 sam deploy --guided 31 sam deploy --guided
42 ``` 32 ```
43 33
44 The first command will build the source of your application. The second command will package and deploy your application to AWS, with a series of prompts: 34 The first command will build the source of your application. The second command will package and deploy your application
35 to AWS, with a series of prompts:
45 36
46 * **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region, and a good starting point would be something matching your project name. 37 * **Stack Name**: The name of the stack to deploy to CloudFormation. This should be unique to your account and region,
38 and a good starting point would be something matching your project name.
47 * **AWS Region**: The AWS region you want to deploy your app to. 39 * **AWS Region**: The AWS region you want to deploy your app to.
48 * **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual review. If set to no, the AWS SAM CLI will automatically deploy application changes. 40 * **Confirm changes before deploy**: If set to yes, any change sets will be shown to you before execution for manual
49 * **Allow SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command. 41 review. If set to no, the AWS SAM CLI will automatically deploy application changes.
50 * **Save arguments to samconfig.toml**: If set to yes, your choices will be saved to a configuration file inside the project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application. 42 * **Allow SAM CLI IAM role creation**: Many AWS SAM templates, including this example, create AWS IAM roles required
43 for the AWS Lambda function(s) included to access AWS services. By default, these are scoped down to minimum required
44 permissions. To deploy an AWS CloudFormation stack which creates or modifies IAM roles, the `CAPABILITY_IAM` value for
45 `capabilities` must be provided. If permission isn't provided through this prompt, to deploy this example you must
46 explicitly pass `--capabilities CAPABILITY_IAM` to the `sam deploy` command.
47 * **Save arguments to `samconfig.toml`**: If set to yes, your choices will be saved to a configuration file inside the
48 project, so that in the future you can just re-run `sam deploy` without parameters to deploy changes to your application.
51 49
52 You can find your API Gateway Endpoint URL in the output values displayed after deployment. 50 You can find your API Gateway Endpoint URL in the output values displayed after deployment.
51
52 **If a certificate in AWS Certificate Manager is created with the template, you have to create manually the DNS
53 validation record to issue the certificate**
53 54
54 ## Use the SAM CLI to build and test locally 55 ## Use the SAM CLI to build and test locally
55 56
56 Build your application with the `sam build --use-container` command. 57 Build your application with the `sam build --use-container` command.
57 58
58 ```bash 59 ```bash
59 tweet-analysis$ sam build --use-container 60 tweet-analysis$ sam build --use-container
60 ``` 61 ```
61 62
62 The SAM CLI installs dependencies defined in `hello_world/requirements.txt`, creates a deployment package, and saves it in the `.aws-sam/build` folder. 63 The SAM CLI installs dependencies defined in `src/requirements.txt`, creates a deployment package, and saves it in the
64 `.aws-sam/build` folder.
63 65
64 Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input that the function receives from the event source. Test events are included in the `events` folder in this project. 66 Test a single function by invoking it directly with a test event. An event is a JSON document that represents the input
67 that the function receives from the event source. Test events are included in the `events` folder in this project.
65 68
66 Run functions locally and invoke them with the `sam local invoke` command. 69 Run functions locally and invoke them with the `sam local invoke` command.
67 70
68 ```bash 71 ```bash
69 tweet-analysis$ sam local invoke HelloWorldFunction --event events/event.json 72 tweet-analysis$ sam local invoke HelloWorldFunction --event events/event.json
74 ```bash 77 ```bash
75 tweet-analysis$ sam local start-api 78 tweet-analysis$ sam local start-api
76 tweet-analysis$ curl http://localhost:3000/ 79 tweet-analysis$ curl http://localhost:3000/
77 ``` 80 ```
78 81
79 The SAM CLI reads the application template to determine the API's routes and the functions that they invoke. The `Events` property on each function's definition includes the route and method for each path. 82 The SAM CLI reads the application template to determine the API's routes and the functions that they invoke. The
83 `Events` property on each function's definition includes the route and method for each path.
80 84
81 ```yaml 85 ```yaml
82 Events: 86 Events:
83 HelloWorld: 87 HelloWorld:
84 Type: Api 88 Type: Api
86 Path: /hello 90 Path: /hello
87 Method: get 91 Method: get
88 ``` 92 ```
89 93
90 ## Add a resource to your application 94 ## Add a resource to your application
91 The application template uses AWS Serverless Application Model (AWS SAM) to define application resources. AWS SAM is an extension of AWS CloudFormation with a simpler syntax for configuring common serverless application resources such as functions, triggers, and APIs. For resources not included in [the SAM specification](https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md), you can use standard [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) resource types. 95 The application template uses AWS Serverless Application Model (AWS SAM) to define application resources. AWS SAM is an
96 extension of AWS CloudFormation with a simpler syntax for configuring common serverless application resources such as
97 functions, triggers, and APIs. For resources not included in
98 [the SAM specification](https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md),
99 you can use standard
100 [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
101 resource types.
92 102
93 ## Fetch, tail, and filter Lambda function logs 103 ## Fetch, tail, and filter Lambda function logs
94 104
95 To simplify troubleshooting, SAM CLI has a command called `sam logs`. `sam logs` lets you fetch logs generated by your deployed Lambda function from the command line. In addition to printing the logs on the terminal, this command has several nifty features to help you quickly find the bug. 105 To simplify troubleshooting, SAM CLI has a command called `sam logs`. `sam logs` lets you fetch logs generated by your
106 deployed Lambda function from the command line. In addition to printing the logs on the terminal, this command has
107 several nifty features to help you quickly find the bug.
96 108
97 `NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using SAM. 109 `NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using SAM.
98 110
99 ```bash 111 ```bash
100 tweet-analysis$ sam logs -n HelloWorldFunction --stack-name tweet-analysis --tail 112 tweet-analysis$ sam logs -n HelloWorldFunction --stack-name tweet-analysis --tail
101 ``` 113 ```
102 114
103 You can find more information and examples about filtering Lambda function logs in the [SAM CLI Documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-logging.html). 115 You can find more information and examples about filtering Lambda function logs in the
116 [SAM CLI Documentation](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-logging.html).
104 117
105 ## Tests 118 ## Tests
106 119
107 Tests are defined in the `tests` folder in this project. Use PIP to install the test dependencies and run tests. 120 Tests are defined in the `tests` folder in this project. Use PIP to install the test dependencies and run tests.
108 121
115 tweet-analysis$ AWS_SAM_STACK_NAME=<stack-name> python -m pytest tests/integration -v 128 tweet-analysis$ AWS_SAM_STACK_NAME=<stack-name> python -m pytest tests/integration -v
116 ``` 129 ```
117 130
118 ## Cleanup 131 ## Cleanup
119 132
120 To delete the sample application that you created, use the AWS CLI. Assuming you used your project name for the stack name, you can run the following: 133 To delete the sample application that you created, use the AWS CLI. Assuming you used your project name for the stack
134 name, you can run the following:
121 135
122 ```bash 136 ```bash
123 aws cloudformation delete-stack --stack-name tweet-analysis 137 aws cloudformation delete-stack --stack-name tweet-analysis
124 ``` 138 ```
125 139
126 ## Resources 140 ## Resources
127 141
128 See the [AWS SAM developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html) for an introduction to SAM specification, the SAM CLI, and serverless application concepts. 142 See the [AWS SAM developer guide](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/what-is-sam.html)
143 for an introduction to SAM specification, the SAM CLI, and serverless application concepts.
129 144
130 Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples and learn how authors developed their applications: [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/) 145 Next, you can use AWS Serverless Application Repository to deploy ready to use Apps that go beyond hello world samples
146 and learn how authors developed their applications:
147 [AWS Serverless Application Repository main page](https://aws.amazon.com/serverless/serverlessrepo/)