From d26a4f5c4de60355ddccbaff38ebcc107fb2b1a9 Mon Sep 17 00:00:00 2001 From: jeffnoehren Date: Mon, 16 Oct 2017 16:52:13 -0700 Subject: [PATCH] Spotinst - adding Serverless.yml file reference for documentation --- docs/providers/spotinst/README.md | 1 + docs/providers/spotinst/guide/quick-start.md | 2 +- .../spotinst/guide/serverless.yml.md | 51 +++++++++++++++++++ 3 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 docs/providers/spotinst/guide/serverless.yml.md diff --git a/docs/providers/spotinst/README.md b/docs/providers/spotinst/README.md index 551696812..f43b6c78e 100755 --- a/docs/providers/spotinst/README.md +++ b/docs/providers/spotinst/README.md @@ -26,6 +26,7 @@ If you have questions, join the [chat in gitter](https://gitter.im/serverless/se
  • Intro
  • Quick Start
  • Credentials
  • +
  • Serverless.yml Reference
  • diff --git a/docs/providers/spotinst/guide/quick-start.md b/docs/providers/spotinst/guide/quick-start.md index 00a17c253..d54d4dc0f 100644 --- a/docs/providers/spotinst/guide/quick-start.md +++ b/docs/providers/spotinst/guide/quick-start.md @@ -1,7 +1,7 @@ diff --git a/docs/providers/spotinst/guide/serverless.yml.md b/docs/providers/spotinst/guide/serverless.yml.md new file mode 100644 index 000000000..81e8f4e9b --- /dev/null +++ b/docs/providers/spotinst/guide/serverless.yml.md @@ -0,0 +1,51 @@ + +# 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 +``` \ No newline at end of file