maurice/snix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Update README with new options

Browse source
This commit is contained in:
Vincent Ambo 2017-02-08 16:47:33 +01:00
parent 8e08a282eb
commit d6b16793c1
1 changed files with 11 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -60,6 +60,7 @@ VERSION:
COMMANDS: COMMANDS:
template Interpolate and print templates template Interpolate and print templates
apply Interpolate templates and run 'kubectl apply' apply Interpolate templates and run 'kubectl apply'
replace Interpolate templates and run 'kubectl replace'
help, h Shows a list of commands or help for one command help, h Shows a list of commands or help for one command
GLOBAL OPTIONS: GLOBAL OPTIONS:
@ -67,11 +68,20 @@ GLOBAL OPTIONS:
--version, -v print the version --version, -v print the version
``` ```
All options support the same set of extra flags:
```
OPTIONS:
--file value, -f value Cluster configuration file to use
--include value, -i value Limit templating to explicitly included resource sets
--exclude value, -e value Exclude certain resource sets from templating
```
Examples: Examples:
``` ```
# Look at output for a specific resource set and check to see if it's correct ... # Look at output for a specific resource set and check to see if it's correct ...
kontemplate template -f example/prod-cluster.yaml -l some-api kontemplate template -f example/prod-cluster.yaml -i some-api
# ... maybe do a dry-run to see what kubectl would do: # ... maybe do a dry-run to see what kubectl would do:
kontemplate apply -f example/prod-cluster.yaml --dry-run kontemplate apply -f example/prod-cluster.yaml --dry-run