https://github.com/softprops/serverless-aws-rust-kinesis
⚡🏗️ template for new aws lambda serverless kinesis rust apps
https://github.com/softprops/serverless-aws-rust-kinesis
aws-lambda lambda serverless serverless-framework
Last synced: 10 months ago
JSON representation
⚡🏗️ template for new aws lambda serverless kinesis rust apps
- Host: GitHub
- URL: https://github.com/softprops/serverless-aws-rust-kinesis
- Owner: softprops
- Created: 2019-05-07T01:03:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-01T22:48:58.000Z (almost 6 years ago)
- Last Synced: 2025-06-13T00:24:22.027Z (10 months ago)
- Topics: aws-lambda, lambda, serverless, serverless-framework
- Language: Rust
- Size: 131 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# serverless AWS Rust kinesis stream template
A sample template for bootstraping [Rustlang AWS Lambda](https://github.com/awslabs/aws-lambda-rust-runtime/) [kinesis stream](https://aws.amazon.com/kinesis/data-streams/) 🚰 applications with ⚡ serverless framework ⚡
## ✨ features
* 🦀 Build Rustlang applications with ease
- 🛵 Continuous integration testing with GitHub Actions
- 🚀 Continuous deployment with GitHub Actions
* 🧪 Getting started unit tests
## 📦 install
Install the [serverless framework](https://www.serverless.com/framework/docs/getting-started/) cli.
Then then run the following in your terminal
```bash
$ npx serverless install \
--url https://github.com/softprops/serverless-aws-rust-kinesis \
--name my-new-kinesis-func
```
This will download the source of a sample Rustlang application and unpack it as a new service named
"my-new-kinesis-func" in a directory called "my-new-kinesis-func"
## 🧙 how to be a wizard
Assumming you have [aws credentials with appropriate deployment permissions configured](https://serverless.com/framework/docs/providers/aws/guide/credentials/) (if you already use any existing AWS tooling installed you likely already have this configured), you could impress your friends by creating a project connected to an existing
kinesis stream identified by environment variable `KINESIS_STREAM_ARN` that is _born_ in production.
```bash
$ npx serverless install \
--url https://github.com/softprops/serverless-aws-rust-multi \
--name my-new-kinesis-func \
&& cd my-new-kinesis-func \
&& npm ci \
&& KINESIS_STREAM_ARN=xxx npx serverless deploy
```
`npm ci` will make sure npm dependencies are installed based directly on your package-lock.json file. This only needs run once.
The first time you run `npx serverless deploy` it will pull down and compile the base set
of dependencies and your application. Unless the dependencies change afterwards,
this should only happen once, resulting in an out of the box rapid deployment
cycle.
## 🛵 continuous integration and deployment
This template includes an example [GitHub actions](https://travis-ci.org/) [configuration file](.github/workflows/main.yml) which can unlock a virtuous cycle of continuous integration and deployment
( i.e all tests are run on prs and every push to master results in a deployment ).
GitHub actions is managed simply by the presence of a file checked into your repository. To set up GitHub Actions to deploy to AWS you'll need to do a few things
Firstly, version control your source. [Github](https://github.com/) is free for opensource.
```bash
$ git init
$ git remote add origin git@github.com:{username}/{my-new-service}.git
```
Store a `AWS_ACCESS_KEY_ID` `AWS_SECRET_ACCESS_KEY` used for aws deployment in your repositories secrets https://github.com/{username}/{my-new-service}/settings/secrets
Add your changes to git and push them to GitHub.
Finally, open https://github.com/{username}/{my-new-service}/actions in your browser and grab a bucket of popcorn 🍿
## 🔫 function triggering
With your function deployed you can now start triggering it using `serverless` framework directly or
the AWS integration you've configured to trigger it on your behalf
```sh
$ npx serverless invoke local -f hello \
< tests/example-event.json
```
## 🔬 logs
With your function deployed you can now tail it's logs right from your project
```sh
$ npx serverless logs -f hello
```
## 👴 retiring
Good code should be easily replaceable. Good code is should also be easily disposable. Retiring applications should be as easy as creating and deploying them them. The dual of `serverless deploy` is `serverless remove`. Use this for retiring services and cleaning up resources.
```bash
$ npx serverless remove
```
## ℹ️ additional information
* See the [serverless-rust plugin's documentation](https://github.com/softprops/serverless-rust) for more information on plugin usage.
* See the [aws rust runtime's documentation](https://github.com/awslabs/aws-lambda-rust-runtime) for more information on writing Rustlang lambda functions
* See the [Serverless Framework docs](https://serverless.com/framework/docs/providers/aws/events/streams/) for more information on configuration options for kinesis streams
* See the [AWS docs](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html) for more information on general lambda information about working with kinesis streams.
## 👯 Contributing
This template's intent is to set a minimal baseline for getting engineers up an running with a set of repeatable best practices. See something you'd like in this template that would help others? Feel free to [open a new GitHub issue](https://github.com/softprops/serverless-aws-rust-kinesis/issues/new). Pull requests are also welcome.