diff options
| author | Vincent Ambo <tazjin@gmail.com> | 2017-02-08T15·47+0100 |
|---|---|---|
| committer | Vincent Ambo <tazjin@gmail.com> | 2017-02-08T15·53+0100 |
| commit | d6b16793c150202f78e5b862b372481f08a00a6f (patch) | |
| tree | ccbdd9520af11522180bb5e37f7b7b251666b18c | |
| parent | 8e08a282eb4f29618c8de8090927b521ea0c9c2b (diff) | |
docs: Update README with new options
| -rw-r--r-- | README.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md index 93761a855286..817f642d64cf 100644 --- a/README.md +++ b/README.md @@ -60,6 +60,7 @@ VERSION: COMMANDS: template Interpolate and print templates 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 GLOBAL OPTIONS: @@ -67,11 +68,20 @@ GLOBAL OPTIONS: --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: ``` # 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: kontemplate apply -f example/prod-cluster.yaml --dry-run |