1
0
Fork 0
Schema analysis, linting, and transformation for YAML
Go to file
ssube 27843c6252
feat(rules): add tsconfig rules
2019-06-30 17:41:45 -05:00
config build: remove license from chunks 2019-06-30 17:10:13 -05:00
docs lint: misc fixes 2019-06-30 17:09:56 -05:00
examples examples: add multi-document example 2019-06-25 08:19:16 -05:00
rules feat(rules): add tsconfig rules 2019-06-30 17:41:45 -05:00
scripts fix(scripts): use project path for status 2019-06-29 11:39:49 -05:00
src lint: misc fixes 2019-06-30 17:09:56 -05:00
test feat: rule selector helper 2019-06-29 16:27:10 -05:00
vendor/jsonpath-plus feat: make node selectors work 2019-06-15 17:53:07 -05:00
.codeclimate.yml lint: config markdownlint, fix some docs 2019-06-30 16:35:22 -05:00
.gitignore docs: include some examples, explicitly state success 2019-06-15 18:56:42 -05:00
.gitlab-ci.yml fix(build): artifact all output 2019-06-29 19:41:16 -05:00
.mdlrc fix(build): actually fix mdl config 2019-06-30 16:51:10 -05:00
.npmignore docs: add index page 2019-06-29 17:21:22 -05:00
CHANGELOG.md chore(release): 0.4.1 2019-06-29 16:52:05 -05:00
Dockerfile fix(build): split index into its own chunk 2019-06-29 19:36:41 -05:00
LICENSE.md docs: add repo url, fix example command 2019-06-15 18:33:50 -05:00
Makefile fix(build): split index into its own chunk 2019-06-29 19:36:41 -05:00
README.md lint: config markdownlint, fix some docs 2019-06-30 16:35:22 -05:00
package.json update: pin dependencies 2019-06-30 17:05:36 -05:00
renovate.json feat: extend renovate presets 2019-06-30 16:23:00 -05:00
tsconfig.json feat: project, build, and bundle 2019-06-15 15:20:04 -05:00
yarn.lock update: pin dependencies 2019-06-30 17:05:36 -05:00

README.md

SALTY DOG

Rule-based YAML validator using JSON schemas. Capable of filtering elements to validate partial documents, supports multiple documents per stream or file, inserting defaults, and other magic.

Getting Started

salty-dog is distributed as a package and container, and can be installed or pulled:

> docker pull ssube/salty-dog:master
> yarn add -D salty-dog
> yarn global add salty-dog

Note: while the container is the preferred way of running salty-dog, it has a serious limitation: docker run combines stdout and stderr, making it impossible to separate logs and the output document. Writing either the logs or dest to a file works around this.

To download, validate, and apply a Kubernetes resource:

> curl https://raw.githubusercontent.com/ssube/k8s-shards/master/roles/apps/gitlab/server/templates/ingress.yml | \
    salty-dog \
      --rules rules/kubernetes.yml \
      --source - \
      --tag important | \
    kubectl apply --dry-run -f -

...
{"name":"salty-dog","hostname":"cerberus","pid":7860,"level":30,"msg":"all rules passed","time":"2019-06-16T02:04:37.797Z","v":0}
ingress.extensions/gitlab created (dry run)

Status

Pipeline status MIT license

Open bug count Open issue count Closed issue count

Renovate badge Known vulnerabilities Dependency status Dev dependency status

Maintainability score Technical debt ratio Quality issues

Language grade: JavaScript Total alerts

Releases

Github release version Commits since release

npm release version Docker image size

Build

This project is written in Typescript and requires node and yarn to build.

> git clone git@github.com:ssube/salty-dog.git
> cd salty-dog
> make

After building, run with: node out/index.js

make targets are provided for some common arguments:

> curl https://raw.githubusercontent.com/ssube/k8s-shards/master/roles/apps/gitlab/server/templates/ingress.yml | \
    make run-stream 2> >($(yarn bin)/bunyan) > >(kubectl apply --dry-run -f -)

...
[2019-06-16T03:23:56.645Z]  INFO: salty-dog/8015 on cerberus: all rules passed
ingress.extensions/gitlab created (dry run)

Install

Docker

To run with Docker: docker run --rm ssube/salty-dog:master

The latest semi-stable image is ssube/salty-dog:master. All tags are listed here.

The Docker container is published for each branch and git tag, tagged with the version slug (. replaced with -, mostly).

Rules are baked into the image in /salty-dog/rules. To use custom rules, mount them with -v $(pwd)/rules:/salty-dog/rules:ro and load with --rules /rules/foo.yml.

Node

Global

To install with Yarn as a global CLI tool: yarn global add salty-dog

To run with Node:

> export PATH="${PATH}:$(yarn global bin)"
> salty-dog --help

Project

To install with Yarn for a single project: yarn add -D salty-dog

To run with Node:

> export PATH="${PATH}:$(yarn bin)"
> salty-dog --help

Usage

Modes

salty-dog can run in a few different modes: check mode will report errors, fix mode will attempt to modify the input document, and list mode will print the active set of rules.

Check Mode

By default, salty-dog will validate the structure and contents of the --source document. If all rules pass, the document will be printed to --dest.

> cat examples/kubernetes-resources-pass.yml | salty-dog \
    --rules rules/kubernetes.yml \
    --tag important

...
[2019-06-15T23:53:34.223Z]  INFO: salty-dog/19839 on cerberus: all rules passed

> cat examples/kubernetes-resources-fail.yml | salty-dog \
    --rules rules/kubernetes.yml \
    --tag important

...
[2019-06-15T23:56:04.764Z] ERROR: salty-dog/22211 on cerberus: some rules failed (errors=1)

The --source and --dest default to stdin and stdout, respectively, but a path may be provided:

> salty-dog \
    --rules rules/kubernetes.yml \
    --tag important \
    --source examples/kubernetes-resources-pass.yml \
    --dest /tmp/kubernetes-resource.yml

...
[2019-06-15T23:53:34.223Z]  INFO: salty-dog/19839 on cerberus: all rules passed

Fix Mode

salty-dog can also add default values to missing properties with --mode fix. If a rule does not immediately pass with the --source document, but defaults are provided in the schema, the defaults will be inserted before printing to --dest.

Default Values

Properties that appear in the schema with a default provided will be added to each element as it is checked. Rules apply in order, as do their defaults.

Coercing Values

Properties that appear in the document with a different type than they have in the schema may be coerced, if the value is compatible with the schema type. The full matrix of valid type coercions is documented by Ajv.

List Mode

salty-dog can list the active set of rules, to help debug tags and inclusion.

> salty-dog \
    --rules rules/kubernetes.yml \
    --tag important \
    --mode list

...
[2019-06-30T18:39:11.930Z]  INFO: salty-dog/26330 on cerberus: listing active rules
    rules: [
      {
        "desc": "resource limits are too low",
        "level": "debug",
        "name": "kubernetes-resources-minimum-cpu",

...
    ]

Rules

Rules combine a jsonpath expression and JSON schema to select and validate the document.

The rule's select expression is used to select nodes that should be validated, which are filtered, then checked.

The structure of rule files and the rules within them are documented here.

Enabling Rules

All rules are disabled by default and must be enabled by name, level, or tag.

To enable a single rule by name, --include-name foo-rule.

To enable a group of rules by level, --include-level warn.

To enable a group of rules by tag, --include-tag foo.

Validate Rules

To validate the rules in the rules/ directory using the meta-rules:

> make run-rules

...
{"name":"salty-dog","hostname":"cerberus","pid":29403,"level":30,"msg":"all rules passed","time":"2019-06-16T00:56:55.132Z","v":0}