|
| 1 | +# go-echo-lambda-function-url-template |
| 2 | + |
| 3 | +This is a template for publishing Go's Echo Web app with Lambda Function URL using Lambda Web Adapter. |
| 4 | + |
| 5 | +## Requirements |
| 6 | + |
| 7 | +* AWS CLI already configured with Administrator permission |
| 8 | +* [Docker installed](https://www.docker.com/community-edition) |
| 9 | +* SAM CLI - [Install the SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) |
| 10 | + |
| 11 | +You may need the following for local testing. |
| 12 | +* [Golang](https://golang.org) |
| 13 | + |
| 14 | +## Setup process |
| 15 | + |
| 16 | +### Installing dependencies & building the target |
| 17 | + |
| 18 | +In this example we use the built-in `sam build` to build a docker image from a Dockerfile and then copy the source of your application inside the Docker image. |
| 19 | +Read more about [SAM Build here](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-build.html) |
| 20 | + |
| 21 | +### Local development |
| 22 | + |
| 23 | +```shell |
| 24 | +go run app/main.go |
| 25 | +``` |
| 26 | + |
| 27 | +If the previous command ran successfully you should now be able to hit the following local endpoint to invoke your function `http://localhost:8000/` |
| 28 | + |
| 29 | +## Packaging and deployment |
| 30 | + |
| 31 | +AWS Lambda Golang runtime requires a flat folder with the executable generated on build step. SAM will use `CodeUri` property to know where to look up for the application: |
| 32 | + |
| 33 | +```yaml |
| 34 | +... |
| 35 | + FirstFunction: |
| 36 | + Type: AWS::Serverless::Function |
| 37 | + Properties: |
| 38 | + CodeUri: app/ |
| 39 | + ... |
| 40 | +``` |
| 41 | + |
| 42 | +To deploy your application for the first time, run the following in your shell: |
| 43 | + |
| 44 | +```shell |
| 45 | +sam deploy --guided |
| 46 | +``` |
| 47 | + |
| 48 | +The command will package and deploy your application to AWS, with a series of prompts: |
| 49 | + |
| 50 | +* **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. |
| 51 | +* **AWS Region**: The AWS region you want to deploy your app to. |
| 52 | +* **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. |
| 53 | +* **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. |
| 54 | +* **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. |
| 55 | + |
| 56 | +You can find your API Gateway Endpoint URL in the output values displayed after deployment. |
| 57 | + |
| 58 | +### Testing |
| 59 | + |
| 60 | +We use `testing` package that is built-in in Golang and you can simply run the following command to run our tests locally: |
| 61 | + |
| 62 | +```shell |
| 63 | +go test ./app -v |
| 64 | +``` |
| 65 | + |
| 66 | +## Appendix |
| 67 | + |
| 68 | +### Golang installation |
| 69 | + |
| 70 | +Please ensure Go 1.x (where 'x' is the latest version) is installed as per the instructions on the official golang website: https://golang.org/doc/install |
| 71 | + |
| 72 | +A quickstart way would be to use Homebrew, chocolatey or your linux package manager. |
| 73 | + |
| 74 | +#### Homebrew (Mac) |
| 75 | + |
| 76 | +Issue the following command from the terminal: |
| 77 | + |
| 78 | +```shell |
| 79 | +brew install golang |
| 80 | +``` |
| 81 | + |
| 82 | +If it's already installed, run the following command to ensure it's the latest version: |
| 83 | + |
| 84 | +```shell |
| 85 | +brew update |
| 86 | +brew upgrade golang |
| 87 | +``` |
| 88 | + |
| 89 | +#### Chocolatey (Windows) |
| 90 | + |
| 91 | +Issue the following command from the powershell: |
| 92 | + |
| 93 | +```shell |
| 94 | +choco install golang |
| 95 | +``` |
| 96 | + |
| 97 | +If it's already installed, run the following command to ensure it's the latest version: |
| 98 | + |
| 99 | +```shell |
| 100 | +choco upgrade golang |
| 101 | +``` |
| 102 | + |
| 103 | +## Bringing to the next level |
| 104 | + |
| 105 | +Here are a few ideas that you can use to get more acquainted as to how this overall process works: |
| 106 | + |
| 107 | +* Create an additional API resource (e.g. /hello/{proxy+}) and return the name requested through this new path |
| 108 | +* Update unit test to capture that |
| 109 | +* Package & Deploy |
| 110 | + |
| 111 | +Next, you can use the following resources to know more about beyond hello world samples and how others structure their Serverless applications: |
| 112 | + |
| 113 | +* [AWS Serverless Application Repository](https://aws.amazon.com/serverless/serverlessrepo/) |
0 commit comments