archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-18 14:58:43 +00:00
Code Issues Projects Releases Wiki Activity

Update jaws-json.md

Browse Source
This commit is contained in:
Ryan Pendergast 2015-09-18 11:12:12 -05:00
parent 2e1eeac273
commit 86697e10fa
1 changed files with 8 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/jaws-json.md
View File

@ -1,6 +1,7 @@
# jaws.json
v
See project `jaws.json` [example here](../examples/project-jaws.json)
The `jaws.json` file contains project configuration and authorship details.
It defines things like the project's stages and regions within each stage,
[like in this example.](../examples/project-jaws.json)
@ -9,31 +10,10 @@ It defines things like the project's stages and regions within each stage,
The following attributes should exist in either a project or lambda `jaws.json` at the top level
* **name**: project name
* **version**: project [Semantic Versioning](http://semver.org/) number.
* **location**: project scm url
* **name**: project/module or lambda action name
* **version**: project/module or lambda [Semantic Versioning](http://semver.org/) number.
* **location**: project/module or lambda scm url (if exists)
* **author**: `John Serverless <john@gmail.com> http://www.john.com`
* **description**: project desc.
* `project.stages`: map of all your stages, and regions those stages are in
* `project.envVarBucket`: name and region your s3 bucket that holds env var files
## Lambda level
See lambda `jaws.json` [example here](../examples/lambda-jaws.json)
## JAWS plug-in module
See plug-in module `jaws.json` [example here](../examples/plugin-module-jaws.json)
A JAWS plug-in module is installed into a project via the [`jaws install`](./commands.md#install) command. A plugin module should have a `jaws.json` in the root of its reop, that opitonally contains a `cfExtensions` attribute that defines an AWS CloudFormation extension point, for the AWS resources required by this module. These will be merged into the root [`jaws-cf.json`](./jaws-cf-json.md) if the user specifies the `--save` flag.
##### cfExtensions attributes
**Note**: All of the attrs below assume the `cfExtensions` attribute key prefix.
* `PolicyDocumentStatements` is a list of valid CloudFormation PolicyDocument objects. JAWS will create an IAM Group and Role who inherits these permissions. Other IAM Roles can then easily be added to this group. For example, an IAM Role can be made and added to this group for development/unit testing. This Role will have the exact permissions of the IAM lambda Role for the stage.
* `ResourceStatements` is a map of valid CloudFormation Resource statements.
Be sure to check out the [`jaws install`](./commands.md#install) command and [`jaws-cf.json`](./jaws-cf-json.md) docs for more info.
* **description**: project/module or lambda desc.
* **stages**: map of all your stages, and regions those stages are in as well as IAM roles
* **jawsBuckets**: map of region to bucket name for JAWS S3 bucket in the region