You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+44
Original file line number
Diff line number
Diff line change
@@ -59,6 +59,10 @@ sls-dev-tools is currently being actively maintained. If you find a problem with
59
59
-[Shortcuts to AWS Console](#shortcuts-to-aws-console)
60
60
-[Changing region using the map](#changing-region-using-the-map)
61
61
-[Shortcuts](#shortcuts)
62
+
-[Guardian](#guardian)
63
+
-[Usage](#usage-1)
64
+
-[Configuring Rules](#configuring-rules)
65
+
-[Contributing Rules](#contributing-rules)
62
66
63
67
[A note on AWS API calls and pricing](#a-note-on-aws-api-calls-and-pricing)\
64
68
[Libs](#libs)\
@@ -95,6 +99,7 @@ If the tool isn't able to find the stack name or region in local files or in the
95
99
-l, --location location of your serverless project (default is current directory)
96
100
--sls use the serverless framework to execute commands
97
101
--sam use the SAM framework to execute commands
102
+
--guardian run CI checks on your project with sls-dev-tools Guardian
98
103
```
99
104
100
105
- The location option allows you to specify the serverless project directory you want to work on.
@@ -196,6 +201,45 @@ Shortcuts
196
201
- Pressing "l" will display a box with more statistics on the selected lambda
197
202
```
198
203
204
+
## Guardian
205
+
206
+

207
+
208
+
sls-dev-tools Guardian in a highly opinionated, highly configurable, automated best-practice audit tool for Serverless architectures. Like all sls-dev-tools it's framework agnostic and can be run in one simple command.
209
+
210
+
sls-dev-tools Guardian can run locally, on a CI Platform or in a scheduled task to help you build with best practices from day one and resolve problems before they arise.
211
+
212
+
Documentation on each of the rules can be found 
213
+
214
+
### Usage
215
+
216
+
To run sls-dev-tools Guardian use the same command structure, but pass the —ci option:
sls-dev-tools is intended to be opinionated, but when that opinion does not match your expectations rules can be ignored on a per resource or global level.
225
+
226
+
To ignore a rule add a guardian section to your slsdevtools.config.js file
"no-max-memory":"1 May 2020 09:00 GMT"// ignore until a particular date
236
+
}
237
+
}
238
+
};
239
+
```
240
+
241
+
Rules can be ignored globally, per resource or until a specific date (e.g. delay checking this for 1 month).
242
+
199
243
# A note on AWS API calls and pricing
200
244
201
245
This tool does make use of the AWS API to get metrics. Authentication is handled implicitly via the AWS NodeJS SDK. Pricing around Cloudwatch is designed for scale, but be warned that this tool is making calls to AWS.
0 commit comments