Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/epiphone/serverless-nim
Serverless Framework Nim language plugin
https://github.com/epiphone/serverless-nim
aws-lambda nim nim-web serverless serverless-framework
Last synced: 12 days ago
JSON representation
Serverless Framework Nim language plugin
- Host: GitHub
- URL: https://github.com/epiphone/serverless-nim
- Owner: epiphone
- License: mit
- Created: 2019-12-12T13:42:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:11:49.000Z (almost 2 years ago)
- Last Synced: 2024-11-01T09:51:39.737Z (19 days ago)
- Topics: aws-lambda, nim, nim-web, serverless, serverless-framework
- Language: JavaScript
- Homepage:
- Size: 1.38 MB
- Stars: 20
- Watchers: 3
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Serverless Nim plugin
[](https://badge.fury.io/js/%40epiphone%2Fserverless-nim)
Easier builds/packaging for Nim Lambda functions on the AWS `provided` runtime.
- Compile Nim functions automatically on serverless workflow commands such as `deploy` or `package` - no need for a manual build step
- Choose between local or dockerized builds ([see below](#build-in-docker))
Built upon [lambci/awslambda.nim](https://github.com/lambci/awslambda.nim), adapted from [softprops/serverless-rust](https://github.com/softprops/serverless-rust/).
Check the **sample project** at https://github.com/epiphone/serverless-nim-sample.
## Setup
### Template
The easiest way to get started is via [the template](https://github.com/epiphone/serverless-nim-template):
```bash
serverless create --template-url https://github.com/epiphone/serverless-nim-template --path my-service-path --name my-service
cd my-service-path
yarn install # or npm install
serverless deploy
```
Alternatively try cloning the sample project from https://github.com/epiphone/serverless-nim-sample.
### Manual setup
First install the NPM dependency with
```bash
yarn add @epiphone/serverless-nim
```
and then include the following configuration in `serverless.yml`:
```yaml
provider:
name: aws
runtime: nim # or use function-specific runtime option
package:
excludeDevDependencies: false # Not necessary, but speeds up builds since dev dependencies are anyway ignored in case of Nim functions
individually: true
plugins:
- "@epiphone/serverless-nim" # Note the parenthesis
```
You also need set up a `.nimble` file with the [`awslambda`](https://github.com/lambci/awslambda.nim) dependency to integrate Nim functions with the custom Lambda runtime.
## Configuration
### Compile flags
Use the `nim.flags` configuration property to set `nimble compile` command flags (defaults to `['-d:release']`):
```yaml
# either globally:
custom:
nim:
flags:
- -d:unsafe
# or per individual function:
functions:
myFunction:
nim:
flags:
- -d:unsafe
...
```
### Build in Docker
Depending on your OS you might want to build Nim functions inside a Docker container to better match the Lambda runtime. Use the following configuration properties to achieve this:
```yaml
custom:
nim:
dockerFlags: [] # defaults to []
dockerTag: nimlang/nim # defaults to nimlang/nim
useDocker: true # defaults to false
```
One way to speed up Docker builds is to mount your local `~/.nimble` folder as a Docker volume and thus avoid re-fetching dependencies for every Nim function build:
```yaml
custom:
nim:
dockerFlags:
- -v
- /home/user/.nimble/pkgs:/root/.nimble/pkgs
- -v
- /home/user/.nimble/packages_official.json:/root/.nimble/packages_official.json
useDocker: true
```
### Include files in Lambda package
`serverless-nim` overrides Nim functions packaging configuration with the following configuration:
```yaml
exclude:
- '**/*'
include:
- bootstrap
```
If you want to include other files such as static assets in the package, use the [`include` configuration in `serverless.yml`](https://serverless.com/framework/docs/providers/aws/guide/packaging/#exclude--include):
```yaml
# either globally:
package:
include:
- assets/configuration.json
# or per individual function:
functions:
myFunction:
package:
include:
- assets/configuration.json
```
The Nim binary gets automatically included in the package.
### Optimize binary size
Nim compiler already produces pretty compact binaries, but the output can be further minimized with the `--opt:size` compiler flag or with external tools like `strip` or `upx`. The easiest way to enable all these is to add [this `config.nims` Nimscript file](https://github.com/epiphone/serverless-nim-sample/blob/master/config.nims) to your service root directory. You'll also of course need to install the external tools, or if building in Docker make sure the Docker image contains the tools.
Read more about optimizing binary size [here](https://scripter.co/nim-deploying-static-binaries/).