mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: Add usage & installation sections

Browse source
This commit is contained in:
Vincent Ambo 2017-02-08 13:53:46 +01:00
parent 3ef0f35bfe
commit 6147ea7b9b
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -39,6 +39,23 @@ include:
Those values are then templated into the resource files of `some-api`. Those values are then templated into the resource files of `some-api`.
## Installation
Assuming you have Go configured correctly, you can simply `go get github.com/tazjin/kontemplate/...`.
## Usage ## Usage
You must have `kubectl` installed to use KonTemplate. You must have `kubectl` installed to use KonTemplate effectively.
At the moment KonTemplate will simply output the templated Kubernetes resource files, which can
then be piped into `kubectl`:
```
# Look at output and check to see if it's correct ...
kontemplate run -f example/prod-cluster.yaml -l some-api
# ... if it is, go ahead and apply it
kontemplate run -f example/prod-cluster.yaml -l some-api | kubectl apply -f -
# That's it!
```