UNPKG

osls

Version:

Open-source alternative to Serverless Framework

github.com/oss-serverless/serverless

24 lines (15 loc) • 1.86 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Service configuration validation The framework validates service configuration with the help of [AJV](https://ajv.js.org/) (JSON-schema validation engine). If you were presented with configuration error (or a warning, depending on `configValidationMode` setting) it could mean that: - Service configuration is invalid and you need to correct an issue related to your serverless.yml - Configuration related to external plugin does not have an associated JSON Schema. In such cases, please report the issue with the plugin author and provide them the details on how to [extend validation schema](./plugins) in order to permanently correct the issue. - However unlikely, there may be a bug (or missing) schema configuration for the framework. If you believe this to be the case please report at [https://github.com/serverless/serverless/issues/new](https://github.com/serverless/serverless/issues/new?template=bug_report.md) **Note**: In a warning mode (with `configValidationMode: warn` set in configuration) Framework commands are not blocked in any way, e.g. `sls deploy` will still attempt to deploy the service normally (still depending on the source of the warning, success of a deployment may vary) When the setting is not explicitly specified, serverless defaults to `configValidationMode: warn`. If you find this functionality problematic, you may also turn it off with `configValidationMode: off` setting. ## Configuration Add `configValidationMode` to your service configuration with one of the following values: | Value | Effect | | ----- | ----------------------------------------------------- | | error | Fail invoked command and output configuration errors. | | warn | Output configuration errors in form of warnings. | | off | Suppress configuration errors. |