Spotinst - adding Serverless.yml file reference for documentation

This commit is contained in:
jeffnoehren 2017-10-16 16:52:13 -07:00
parent cfc3614c45
commit d26a4f5c4d
3 changed files with 53 additions and 1 deletions

View File

@ -26,6 +26,7 @@ If you have questions, join the [chat in gitter](https://gitter.im/serverless/se
<li><a href="./guide/intro.md">Intro</a></li>
<li><a href="./guide/quick-start.md">Quick Start</a></li>
<li><a href="./guide/credentials.md">Credentials</a></li>
<li><a href="./guide/serverless.yml.md">Serverless.yml Reference</a></li>
</ul>
</div>
</div>

View File

@ -1,7 +1,7 @@
<!--
title: Serverless Framework - Spotinst Guide - Quick Start
menuText: Quick Start
menuOrder: 1
menuOrder: 2
description: Getting started with the Serverless Framework on AWS Lambda
layout: Doc
-->

View File

@ -0,0 +1,51 @@
<!--
title: Serverless Framework - Spotinst Guide - Serverless.yml Reference
menuText: Serverless.yml
menuOrder: 4
description: Serverless.yml reference
layout: Doc
-->
# Serverless.yml Reference
This is an outline of a `serverless.yml` file with descriptions of the properties for reference
```yml
# serverless.yml
# The service can be whatever you choose. You can have multiple functions
# under one service
service: your-service
# The provider is Spotinst and the Environment ID can be found on the
# Spotinst Console under Functions
provider:
name: spotinst
spotinst:
environment: #{Your Environment ID}
# Here is where you will list your functions for this service. Each Function is
# required to have a name, runtime, handler, memory and timeout. The runtime is
# the language that you want to run your function with, the handler tells which
# file and function to run, memory is the amount of memory needed to run your
# function, timeout is the time the function will take to run, if it goes over
# this time it will terminate itself. Access is default set to private so if you
# want to be able to run the function by HTTPS request this needs to be set to
# public. For information on cron functions read the post here.
functions:
function-name:
runtime: nodejs4.8
handler: handler.main
memory: 128
timeout: 30
# access: public
# cron:
# active: false
# value: '*/1 * * * *'
plugins:
- serverless-spotinst-functions
```