Skip to content

Commit 13b5089

Browse files
committed
Update documentation with latest features
1 parent 464fbe4 commit 13b5089

1 file changed

Lines changed: 33 additions & 2 deletions

File tree

‎docs/index.md‎

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,33 @@ Warning: Set to ignore missing schemas
7373
The document fixtures/test_crd.yaml contains a valid SealedSecret
7474
```
7575

76+
If you would prefer to be more explicit about which custom resources to skip you can instead
77+
provide a list of resources to skip like so.
78+
79+
```
80+
$ kubeval --skip-kinds SealedSecret fixtures/test_crd.yam
81+
The file fixtures/test_crd.yaml containing a SealedSecret was not validated against a schema
82+
```
83+
84+
85+
## Helm
86+
87+
Helm chart configurations generally have a reference to the source template in a comment
88+
like so:
89+
90+
```
91+
# Source: chart/templates/frontend.yam
92+
```
93+
94+
When kubeval detects these comments it will report the relevant chart template files in
95+
the output.
96+
97+
```
98+
$ kubeval fixtures/multi_valid_source.yaml
99+
The file chart/templates/primary.yaml contains a valid Service
100+
The file chart/templates/primary.yaml contains a valid ReplicationControlle
101+
```
102+
76103

77104
## Full usage instructions
78105

@@ -84,14 +111,18 @@ Usage:
84111
kubeval <file> [file...] [flags]
85112
86113
Flags:
114+
-d, --directories strings A comma-separated list of directories to recursively search for YAML documents
115+
--exit-on-error Immediately stop execution when the first error is encountered
87116
-f, --filename string filename to be displayed when testing manifests read from stdin (default "stdin")
117+
--force-color Force colored output even if stdout is not a TTY
88118
-h, --help help for kubeval
89119
--ignore-missing-schemas Skip validation for resource definitions without a schema
90120
-v, --kubernetes-version string Version of Kubernetes to validate against (default "master")
91121
--openshift Use OpenShift schemas instead of upstream Kubernetes
92-
--schema-location string Base URL used to download schemas. Can also be specified with the environment variable KUBEVAL_SCHEMA_LOCATION (default "https://raw.githubusercontent.com/garethr")
122+
--schema-location string Base URL used to download schemas. Can also be specified with the environment variable KUBEVAL_SCHEMA_LOCATION (default "https://kubernetesjsonschema.dev")
123+
--skip-kinds strings Comma-separated list of case-sensitive kinds to skip when validating against schemas
93124
--strict Disallow additional properties not in schema
94-
--version Display the kubeval version information and exit
125+
--version version for kubeval
95126
```
96127

97128
The command has three important features:

0 commit comments

Comments
 (0)