Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nzoschke/gofaas
A boilerplate Go and AWS Lambda app. Demonstrates an expert configuration of 10+ AWS services to support running Go functions-as-a-service (FaaS).
https://github.com/nzoschke/gofaas
aws-lambda cloudformation golang sam serverless
Last synced: 4 days ago
JSON representation
A boilerplate Go and AWS Lambda app. Demonstrates an expert configuration of 10+ AWS services to support running Go functions-as-a-service (FaaS).
- Host: GitHub
- URL: https://github.com/nzoschke/gofaas
- Owner: nzoschke
- License: apache-2.0
- Created: 2018-02-16T14:58:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-09T13:47:55.000Z (about 6 years ago)
- Last Synced: 2024-11-01T17:37:27.277Z (12 days ago)
- Topics: aws-lambda, cloudformation, golang, sam, serverless
- Language: Go
- Homepage:
- Size: 15.7 MB
- Stars: 802
- Watchers: 18
- Forks: 43
- Open Issues: 21
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
- Security: docs/security-cors-jwt.md
Awesome Lists containing this project
README
# Go Functions-as-a-Service
Running a Go application on AWS Lambda is easier than ever, once you figure out how to configure Lambda, API Gateway and 10 or other "serverless" services to support the Go functions.
This is a boilerplate app with all the AWS pieces configured correctly and explained in depth. See [the docs folder](docs/) for detailed guides about functions, tracing, security, automation and more with AWS and Go.
With this foundation you can skip over all the undifferentiated setup, and focus entirely on your Go code.
## Motivation
Functions-as-a-Service (FaaS) like AWS Lambda are one of the latest advances in cloud Infrastructure-as-a-Service (IaaS). Go is particularly well-suited to run in Lambda due to its speed, size and cross-compiler. Check out the [Intro to Go Functions-as-a-Service and Lambda](docs/intro-go-faas.md) doc for more explanation.
For a long time, Go in Lambda was only possible through hacks -- execution shims, 3rd party frameworks and middleware, and little dev/prod parity. But in January 2018, [AWS launched official Go support for Lambda](https://aws.amazon.com/blogs/compute/announcing-go-support-for-aws-lambda/) and [Go released v1.10](https://golang.org/doc/go1.10) paving the clearest path yet for us Gophers.
This project demonstrates a simple and clean foundation for Go in Lambda. You can clone and deploy it with a few commands to get a feel for the stack. Or you can fork and rework it to turn it into your own web app.
It demonstrates:
| Component | Via | Config, Code |
| ---------------------------------------------- |-----------------------------------------|:-----------------------:|
| [HTTP functions][1] | Lambda, API Gateway | [💾](dashboard.go) |
| [Worker functions (one-off and periodic)][2] | Lambda, Invoke API, CloudWatch Events | [💾](worker.go) |
| [Development, packaging and deployment][3] | make, go, aws-sam-cli, CloudFormation | [⚙️](Makefile) |
| [Per-function environment and policies][4] | Lambda, IAM | [⚙️](template.yml) |
| [Custom domains][5] | CloudFront, ACM | [⚙️](template.yml) |
| [Static web content][6] | S3, CloudFront, ACM | [⚙️](template.yml) |
| [Static web security with Google OAuth 2.0][7] | CloudFront, Lambda@Edge, SSM Parameters | [💾](web-auth/index.js) |
| [Function security with CORS and JWT][8] | API Gateway, jwt-go | [💾](jwt.go) |
| [Function traces and logs][9] | CloudWatch Logs, X-Ray, AWS SDKs for Go | [💾](aws.go) |
| [Notifications][10] | SNS | [💾](notify.go) |
| [Databases and encryption at rest][11] | DynamoDB, KMS | [💾](user.go) |
| [Testing with mock AWS clients][12] | Go interfaces, aws-sdk-go | [💾](aws_test.go) |
[1]: docs/http-functions.md
[2]: docs/worker-functions.md
[3]: docs/dev-package-deploy.md
[4]: docs/per-function-policies.md
[5]: docs/custom-domains.md
[6]: docs/static-sites.md
[7]: docs/lambda-at-edge-oauth.md
[8]: docs/security-cors-jwt.md
[9]: docs/traces-logs.md
[10]: docs/notifications.md
[11]: docs/databases-encryption.md
[12]: docs/mock-aws-client.md
What's remarkable is how little work is required to get all functionality for our app. We don't need a framework, platform-as-a-service, or even any 3rd party software-as-a-service. And no, we don't need servers. By standing on the shoulders of Go and AWS, all the undifferentiated heavy lifting is managed for us.
We just need an expert [CloudFormation config file](template.yml) and a simple [Makefile](Makefile), then we can focus entirely on writing Go functions.
## Quick Start
This project uses :
- [AWS CLI](https://aws.amazon.com/cli/)
- [AWS SAM CLI](https://github.com/awslabs/aws-sam-cli)
- [Docker CE](https://www.docker.com/community-edition)
- [Go 1.10](https://golang.org/)
- [watchexec](https://github.com/mattgreen/watchexec)
Install the CLI tools and Docker CE
```console
$ brew install awscli go node python@2 watchexec
$ pip2 install aws-sam-cli
$ open https://store.docker.com/search?type=edition&offering=community
```
We may want to upgrade existing tools...
```console
$ brew upgrade awscli go node python@2 watchexec
$ pip2 install --upgrade aws-sam-cli
```
We may want to double check the installed versions...
```console
$ aws --version
aws-cli/1.16.20 Python/3.7.0 Darwin/17.7.0 botocore/1.12.10
$ sam --version
SAM CLI, version 0.6.0
$ docker version
Client:
Version: 18.06.1-ce
API version: 1.38
Go version: go1.10.3
Git commit: e68fc7a
Built: Tue Aug 21 17:21:31 2018
OS/Arch: darwin/amd64
Experimental: false
Server:
Engine:
Version: 18.06.1-ce
API version: 1.38 (minimum version 1.12)
Go version: go1.10.3
Git commit: e68fc7a
Built: Tue Aug 21 17:29:02 2018
OS/Arch: linux/amd64
Experimental: true
$ go version
go version go1.11.1 darwin/amd64
$ watchexec --version
watchexec 1.9.2
```
We may also want to configure the AWS CLI with IAM keys to develop and deploy our application...
Follow the [Creating an IAM User in Your AWS Account](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html) doc to create a IAM user with programmatic access. Call the user `gofaas-admin` and attach the "Administrator Access" policy for now.
Then configure the CLI. Here we are creating a new profile that we can switch to with `export AWS_PROFILE=gofaas`. This will help us isolate our experiments from other AWS work.
Configure an AWS profile with keys and switch to the profile:
```console
$ aws configure --profile gofaas
AWS Access Key ID [None]: AKIA................
AWS Secret Access Key [None]: PQN4CWZXXbJEgnrom2fP0Z+z................
Default region name [None]: us-east-1
Default output format [None]: json
$ export AWS_PROFILE=gofaas
$ aws iam get-user
{
"User": {
"Path": "/",
"UserName": "gofaas-admin",
"UserId": "AIDAJA44LJEOECDPZ3S5U",
"Arn": "arn:aws:iam::572007530218:user/gofaas-admin",
"CreateDate": "2018-02-16T16:17:24Z"
}
}
```
### Get the App
We start by getting and testing the `github.com/nzoschke/gofaas`.
```console
$ git clone https://github.com/nzoschke/gofaas.git ~/dev/gofaas
$ cd ~/dev/gofaas
$ make test
go test -v ./...
go: finding github.com/aws/aws-xray-sdk-go v1.0.0-rc.8
go: finding github.com/aws/aws-lambda-go v1.6.0
go: finding github.com/aws/aws-sdk-go v1.15.49
...
=== RUN TestUserCreate
--- PASS: TestUserCreate (0.00s)
...
ok github.com/nzoschke/gofaas 0.014s
PASS
```
This gives us confidence in our Go environment.
### Develop the App
We can then build the app and start a development server:
```console
$ make dev
cd ./handlers/dashboard && GOOS=linux go build...
2018/02/25 08:03:12 Connected to Docker 1.35
2018/02/16 07:40:32 Fetching lambci/lambda:go1.x image for go1.x runtime...
Mounting handler (go1.x) at http://127.0.0.1:3000/users/{id} [DELETE]
Mounting handler (go1.x) at http://127.0.0.1:3000/users/{id} [PUT]
Mounting handler (go1.x) at http://127.0.0.1:3000/users/{id} [GET]
Mounting handler (go1.x) at http://127.0.0.1:3000/ [GET]
Mounting handler (go1.x) at http://127.0.0.1:3000/users [POST]
```
Now we can access our HTTP functions on port 3000:
```console
$ curl http://localhost:3000
gofaas dashboard
```
We can also invoke a function directly:
```
$ echo '{}' | sam local invoke WorkerFunction
...
START RequestId: 36d6d40e-0d4b-168c-63d5-76b25f543d21 Version: $LATEST
2018/02/25 16:05:21 Worker Event: {SourceIP: TimeEnd:0001-01-01 00:00:00 +0000 UTC TimeStart:0001-01-01 00:00:00 +0000 UTC}
END RequestId: 36d6d40e-0d4b-168c-63d5-76b25f543d21
REPORT RequestId: 36d6d40e-0d4b-168c-63d5-76b25f543d21 Duration: 681.67 ms Billed Duration: 700 ms Memory Size: 128 MB Max Memory Used: 14 MB
```
Note: if you see `No AWS credentials found. Missing credentials may lead to slow startup...`, review `aws configure list` and your `AWS_PROFILE` env var.
This gives us confidence in our development environment.
### Deploy the App
Now we can package and deploy the app:
```console
$ make deploy
make_bucket: pkgs-572007530218-us-east-1
Uploading to 59d2ea5b6bdf38fcbcf62236f4c26f21 3018471 / 3018471.0 (100.00%)
Waiting for changeset to be created
Waiting for stack create/update to complete
Successfully created/updated stack - gofaas
ApiUrl https://x19vpdk568.execute-api.us-east-1.amazonaws.com/Prod
```
Now we can access our HTTP functions on AWS:
```console
$ curl https://x19vpdk568.execute-api.us-east-1.amazonaws.com/Prod
gofaas dashboard
```
We can also invoke a function directly:
```console
$ aws lambda invoke --function-name gofaas-WorkerFunction --log-type Tail --output text --query 'LogResult' out.log | base64 -D
START RequestId: 0bb47628-1718-11e8-ad73-c58e72b8826c Version: $LATEST
2018/02/21 15:01:07 Worker Event: {SourceIP: TimeEnd:0001-01-01 00:00:00 +0000 UTC TimeStart:0001-01-01 00:00:00 +0000 UTC}
END RequestId: 0bb47628-1718-11e8-ad73-c58e72b8826c
REPORT RequestId: 0bb47628-1718-11e8-ad73-c58e72b8826c Duration: 11.11 ms Billed Duration: 100 ms Memory Size: 128 MB Max Memory Used: 41 MB
```
Look at that speedy 11 ms duration! Go is faster than the minimum billing duration of 100 ms.
This gives us confidence in our production environment.
### Development Environment
If we want to work on the [worker](docs/worker-functions.md) or [database](docs/databases.md) functions locally, we need to give the functions environment variables with pointers to DynamoDB, KMS and S3. Open up `env.json` and set `BUCKET`, etc. with the ids of the resources we just created on deploy:
```console
$ aws cloudformation describe-stack-resources --output text --stack-name gofaas \
--query 'StackResources[*].{Name:LogicalResourceId,Id:PhysicalResourceId,Type:ResourceType}' | \
grep 'Bucket\|Key\|UsersTable'
gofaas-bucket-aykdokk6aek8 Bucket AWS::S3::Bucket
8eb8e209-51fb-41fa-adfe-1ec401667df4 Key AWS::KMS::Key
gofaas-UsersTable-1CYAQH3HHHRGW UsersTable AWS::DynamoDB::Table
```
### Integration Testing
We can verify the app functionality by creating an isolated testing stack, testing all the endpoints, then deleting the stack. The `ci.sh` script automates this:
```console
$ ./ci.sh
aws cloudformation package ...
aws cloudformation deploy ...
...
My first gofaas/Vue app
"username": "test"
{"ExecutedVersion":null,"FunctionError":null,"LogResult":null,"Payload":"","StatusCode":202}
...
✅ SUCCESS!
```
## Docs
Check out [the docs folder](docs/) where each component is explained in more detail.
## Contributing
Find a bug or see a way to improve the project? [Open an issue](https://github.com/nzoschke/gofaas/issues).
## License
Apache 2.0 © 2018 Noah Zoschke