|
| 1 | +# signer |
| 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. |
| 4 | + |
| 5 | +- signer - Code for the application's Lambda function. |
| 6 | +- events - Invocation events that you can use to invoke the function. |
| 7 | +- signer/tests - Unit tests for the application code. |
| 8 | +- template.yaml - A template that defines the application's AWS resources. |
| 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. |
| 11 | + |
| 12 | +If you prefer to use an integrated development environment (IDE) to build and test your application, you can use the AWS Toolkit. |
| 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 | +- [PyCharm](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html) |
| 16 | +- [IntelliJ](https://docs.aws.amazon.com/toolkit-for-jetbrains/latest/userguide/welcome.html) |
| 17 | +- [VS Code](https://docs.aws.amazon.com/toolkit-for-vscode/latest/userguide/welcome.html) |
| 18 | +- [Visual Studio](https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/welcome.html) |
| 19 | + |
| 20 | +## Deploy the sample application |
| 21 | + |
| 22 | +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. |
| 23 | + |
| 24 | +To use the SAM CLI, you need the following tools. |
| 25 | + |
| 26 | +- AWS CLI - [Install the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) and [configure it with your AWS credentials]. |
| 27 | +- SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) |
| 28 | +- Node.js - [Install Node.js 10](https://nodejs.org/en/), including the NPM package management tool. |
| 29 | +- Docker - [Install Docker community edition](https://hub.docker.com/search/?type=edition&offering=community) |
| 30 | + |
| 31 | +The SAM CLI uses an Amazon S3 bucket to store your application's deployment artifacts. If you don't have a bucket suitable for this purpose, create one. Replace `BUCKET_NAME` in the commands in this section with a unique bucket name. |
| 32 | + |
| 33 | +```bash |
| 34 | +signer$ aws s3 mb s3://BUCKET_NAME |
| 35 | +``` |
| 36 | + |
| 37 | +To prepare the application for deployment, use the `sam package` command. |
| 38 | + |
| 39 | +```bash |
| 40 | +signer$ sam package \ |
| 41 | + --output-template-file packaged.yaml \ |
| 42 | + --s3-bucket BUCKET_NAME |
| 43 | +``` |
| 44 | + |
| 45 | +The SAM CLI creates deployment packages, uploads them to the S3 bucket, and creates a new version of the template that refers to the artifacts in the bucket. |
| 46 | + |
| 47 | +To deploy the application, use the `sam deploy` command. |
| 48 | + |
| 49 | +```bash |
| 50 | +signer$ sam deploy \ |
| 51 | + --template-file packaged.yaml \ |
| 52 | + --stack-name signer \ |
| 53 | + --capabilities CAPABILITY_IAM |
| 54 | +``` |
| 55 | + |
| 56 | +After deployment is complete you can run the following command to retrieve the API Gateway Endpoint URL: |
| 57 | + |
| 58 | +```bash |
| 59 | +signer$ aws cloudformation describe-stacks \ |
| 60 | + --stack-name signer \ |
| 61 | + --query 'Stacks[].Outputs[?OutputKey==`HelloWorldApi`]' \ |
| 62 | + --output table |
| 63 | +``` |
| 64 | + |
| 65 | +## Use the SAM CLI to build and test locally |
| 66 | + |
| 67 | +Build your application with the `sam build` command. |
| 68 | + |
| 69 | +```bash |
| 70 | +signer$ sam build |
| 71 | +``` |
| 72 | + |
| 73 | +The SAM CLI installs dependencies defined in `signer/package.json`, creates a deployment package, and saves it in the `.aws-sam/build` folder. |
| 74 | + |
| 75 | +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. |
| 76 | + |
| 77 | +Run functions locally and invoke them with the `sam local invoke` command. |
| 78 | + |
| 79 | +```bash |
| 80 | +signer$ sam local invoke putItemFunction --event events/event.json |
| 81 | +``` |
| 82 | + |
| 83 | +The SAM CLI can also emulate your application's API. Use the `sam local start-api` to run the API locally on port 3000. |
| 84 | + |
| 85 | +```bash |
| 86 | +signer$ sam local start-api |
| 87 | +signer$ curl http://localhost:3000/ |
| 88 | +``` |
| 89 | + |
| 90 | +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. |
| 91 | + |
| 92 | +```yaml |
| 93 | +Events: |
| 94 | + HelloWorld: |
| 95 | + Type: Api |
| 96 | + Properties: |
| 97 | + Path: /sign-data |
| 98 | + Method: post |
| 99 | +``` |
| 100 | +
|
| 101 | +## Add a resource to your application |
| 102 | +
|
| 103 | +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. |
| 104 | +
|
| 105 | +## Fetch, tail, and filter Lambda function logs |
| 106 | +
|
| 107 | +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. |
| 108 | + |
| 109 | +`NOTE`: This command works for all AWS Lambda functions; not just the ones you deploy using SAM. |
| 110 | + |
| 111 | +```bash |
| 112 | +signer$ sam logs -n HelloWorldFunction --stack-name signer --tail |
| 113 | +``` |
| 114 | + |
| 115 | +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). |
| 116 | + |
| 117 | +## Unit tests |
| 118 | + |
| 119 | +Tests are defined in the `signer/tests` folder in this project. Use NPM to install the [Mocha test framework](https://mochajs.org/) and run unit tests. |
| 120 | + |
| 121 | +```bash |
| 122 | +signer$ cd signer |
| 123 | +signer$ npm install |
| 124 | +signer$ npm run test |
| 125 | +``` |
| 126 | + |
| 127 | +## Cleanup |
| 128 | + |
| 129 | +To delete the sample application and the bucket that you created, use the AWS CLI. |
| 130 | + |
| 131 | +```bash |
| 132 | +signer$ aws cloudformation delete-stack --stack-name signer |
| 133 | +signer$ aws s3 rb s3://BUCKET_NAME |
| 134 | +``` |
| 135 | + |
| 136 | +## Resources |
| 137 | + |
| 138 | +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. |
| 139 | + |
| 140 | +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/) |
0 commit comments