Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
timothysmith0609 committed Feb 22, 2019
1 parent 70b427b commit fcc73b9
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ offical compatibility chart below.

## Usage

`kubernetes-deploy <app's namespace> <kube context>`
`kubernetes-deploy <app's namespace> <kube context> [OPTIONS] [filenames...]`

*Environment variables:*

Expand All @@ -116,11 +116,12 @@ offical compatibility chart below.

Refer to `kubernetes-deploy --help` for the authoritative set of options.

- `--template-dir=DIR`: Used to set the deploy directory. Set `$ENVIRONMENT` instead to use `config/deploy/$ENVIRONMENT`.
- `--template-dir=DIR`: Used to set the deploy directory. Set `$ENVIRONMENT` instead to use `config/deploy/$ENVIRONMENT`. You can set multiple template directories by repeating the `--template-dir` flag.
- `--bindings=BINDINGS`: Makes additional variables available to your ERB templates. For example, `kubernetes-deploy my-app cluster1 --bindings=color=blue,size=large` will expose `color` and `size`.
- `--no-prune`: Skips pruning of resources that are no longer in your Kubernetes template set. Not recommended, as it allows your namespace to accumulate cruft that is not reflected in your deploy directory.
- `--max-watch-seconds=seconds`: Raise a timeout error if it takes longer than _seconds_ for any
resource to deploy.
- `kubernetes-deploy` also supports reading from STDIN. If combined with the `[filenames...]` option, you must specify `-` in the filename list as well. Example: `cat templates_from_stdin/*.yml | kubernetes-deploy ns ctx --template-dir=template_dir another_template.yml -`. Ensure your yamls are separated with `---` when using this feature.


### Using templates and variables
Expand Down

0 comments on commit fcc73b9

Please sign in to comment.