$ kpt fn doc --image gcr.io/kpt-fn/kubeval:v0.1
usage: FUNC [-h] [-i INPUT] [-o OUTPUT] [-f FUNCTION_CONFIG]
[-d [FUNCTION_CONFIG_LITERAL [FUNCTION_CONFIG_LITERAL ...]]]
[--json] [--log-to-stderr]
Validates configuration using kubeval.
If neither schema_location nor additional_schema_locations is provided, we
will use the baked-in schemas. Otherwise, we will try to download the schemas.
Configured using a ConfigMap with the following keys, all of which are optional:
schema_location: The base URL used to download schemas.
additional_schema_locations: List of secondary base URLs used to download
schemas. These URLs will be used if the URL specified by schema_location
did not have the required schema. By default, there are no secondary URLs,
and only the primary base URL will be used.
ignore_missing_schemas: Skip validation for resource definitions without a
schema. If omitted, a default value of false will be assumed.
skip_kinds: Comma-separated list of case-sensitive kinds to skip when
validating against schemas. If omitted, no kinds will be skipped.
strict: Disallow additional properties not in schema. If omitted, a default
value of false will be assumed.
Example invocations:
1. Using regular files for input and output:
$ FUNC -i in.yaml -o out.yaml
2. Print output to stdout:
$ FUNC -i in.yaml
3. Using redirection:
$ FUNC < in.yaml > out.yaml
4. Using pipes:
$ cat in.yaml | FUNC | cat
5. Using /dev/null for source/sink functions:
$ FUNC -i /dev/null -o /dev/null
6. Specifying 'functionConfig' as a separate file:
$ cat in.yaml | FUNC -f fc.yaml
If the input contains 'functionConfig' field, it will be ignored.
7. Specifying 'functionConfig' using key/value literals:
$ cat in.yaml | FUNC -d key1=value1 -d key2=value2
This is a convenient way to populate the functionConfig if it's a ConfigMap.
Optional arguments:
-h, --help Show this help message and exit.
-i INPUT, --input INPUT
Path to the input file (if not reading from stdin)
-o OUTPUT, --output OUTPUT
Path to the output file (if not writing to stdout)
-f FUNCTION_CONFIG, --function-config FUNCTION_CONFIG
Path to the function configuration file. If specified, ignores "functionConfig" field in the input
-d [FUNCTION_CONFIG_LITERAL [FUNCTION_CONFIG_LITERAL ...]], --function-config-literal [FUNCTION_CONFIG_LITERAL [FUNCTION_CONFIG_LITERAL ...]]
Specify a key and literal value (i.e. mykey=somevalue) to populate a ConfigMap instead of
specifying a file using --function-config.
Use this ONLY if the function accepts a ConfigMap.
--json Input and output files are in JSON instead of YAML
--log-to-stderr Emit structured results to stderr in addition to setting".results" field in stdout
Remember, everything here is CONFIDENTIAL unless specifically stated otherwise.
© 2020 Google LLC. All Rights Reserved.
