ssube
/
salty-dog
1
0
Fork 0
Code

docs: fix tags

This commit is contained in:
ssube 2019-06-30 19:26:35 -05:00
parent 0996390183
commit 94e26ccb5c
Signed by: ssube
GPG Key ID: 3EED7B957D362AF1
2 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Makefile
View File

@ -131,7 +131,7 @@ run-rules: ## validate the rules directory
--config-name config-stderr.yml \ --config-name config-stderr.yml \
--rules $(ROOT_PATH)/rules/salty-dog.yml \ --rules $(ROOT_PATH)/rules/salty-dog.yml \
--source $${file} \ --source $${file} \
--tag important > /dev/null || exit 1; \ --tag salty-dog > /dev/null || exit 1; \
done done
run-stream: ## validate stdin and write it to stdout, errors to stderr run-stream: ## validate stdin and write it to stdout, errors to stderr
@ -142,5 +142,4 @@ run-stream: ## validate stdin and write it to stdout, errors to stderr
--format yaml \ --format yaml \
--rules $(ROOT_PATH)/rules/kubernetes.yml \ --rules $(ROOT_PATH)/rules/kubernetes.yml \
--source - \ --source - \
--tag important \ --tag kubernetes
--tag optional

10
README.md
View File

@ -45,7 +45,7 @@ To download, validate, and apply a Kubernetes resource:
salty-dog \ salty-dog \
--rules rules/kubernetes.yml \ --rules rules/kubernetes.yml \
--source - \ --source - \
--tag important | \ --tag kubernetes | \
kubectl apply --dry-run -f - kubectl apply --dry-run -f -
... ...
@ -164,14 +164,14 @@ document will be printed to `--dest`.
```shell ```shell
> cat examples/kubernetes-resources-pass.yml | salty-dog \ > cat examples/kubernetes-resources-pass.yml | salty-dog \
--rules rules/kubernetes.yml \ --rules rules/kubernetes.yml \
--tag important --tag kubernetes
... ...
[2019-06-15T23:53:34.223Z] INFO: salty-dog/19839 on cerberus: all rules passed [2019-06-15T23:53:34.223Z] INFO: salty-dog/19839 on cerberus: all rules passed
> cat examples/kubernetes-resources-fail.yml | salty-dog \ > cat examples/kubernetes-resources-fail.yml | salty-dog \
--rules rules/kubernetes.yml \ --rules rules/kubernetes.yml \
--tag important --tag kubernetes
... ...
[2019-06-15T23:56:04.764Z] ERROR: salty-dog/22211 on cerberus: some rules failed (errors=1) [2019-06-15T23:56:04.764Z] ERROR: salty-dog/22211 on cerberus: some rules failed (errors=1)
@ -183,7 +183,7 @@ The `--source` and `--dest` default to stdin and stdout, respectively, but a pat
```shell ```shell
> salty-dog \ > salty-dog \
--rules rules/kubernetes.yml \ --rules rules/kubernetes.yml \
--tag important \ --tag kubernetes \
--source examples/kubernetes-resources-pass.yml \ --source examples/kubernetes-resources-pass.yml \
--dest /tmp/kubernetes-resource.yml --dest /tmp/kubernetes-resource.yml
@ -215,7 +215,7 @@ is documented by Ajv.
```shell ```shell
> salty-dog \ > salty-dog \
--rules rules/kubernetes.yml \ --rules rules/kubernetes.yml \
--tag important \ --tag kubernetes \
--mode list --mode list
... ...