render

README

render

Universal file renderer based on go-template and Sprig functions.

• Installation
  • Binaries
  • Via Go
• Usage
  • Custom functions
  • Helm compatibility
  • Limitations and future work
• Development
• The Name

Installation

Binaries

For binaries please visit the Releases Page.

Via Go

$ go get github.com/VirtusLab/render

Usage

$ render --help
NAME:
   render - Universal file renderer

USAGE:
   render [global options] command [command options] [arguments...]

VERSION:
   v0.0.3-9545028

AUTHOR:
   VirtusLab

COMMANDS:
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug, -d               run in debug mode
   --in value                the input template file, stdin if empty
   --out value               the output file, stdout if empty
   --config value            optional configuration YAML file, can be used multiple times
   --set value, --var value  additional parameters in key=value format, can be used multiple times
   --help, -h                show help
   --version, -v             print the version

Notes:

• --in, --out take only files (not directories) at the moment, --in will consume any file as long as it can be parsed
• stdin and stdout can be used instead of --in and --out
• --config accepts any YAML file, can be used multiple times, the values of the configs will be merged
• --set, --var are the same (one is used in Helm, the other in Terraform), we provide both for convinience, any values set here will override values form configuration files

Custom functions

• render - invokes the render from inside of the template, making the renderer recursive, see example, can be combined with other functions, e.g. b64dec, b64enc, readFile
• readFile - reads a file from a given path, relative paths are translated to absolute paths, based on root function
• root - the root path for rendering, used relative to absolute path translation in any file based operations; by default PWD is used, can be overridden with a --config or --set

Helm compatibility

As of now, there is a limited Helm 2 Chart compatibility, simple Charts will render just fine.

There is no plan to implement full compatibility with Helm, because of unnecessary complexity that would bring.

Limitations and future work

Planned new functions:

• encrypt, decrypt - cloud KMS (AWS, Amazon, Google) based encryption for any data
• gzip, ungzip - use gzip compression and extraction inside the templates

Planned new features:

• directories as --in and --out arguments, currently only files are supported

Development

mkdir $GOPATH/src/github.com/VirtusLab/
git clone 

go get -u github.com/golang/dep/cmd/dep

export PATH=$PATH:$GOPATH/bin
cd $GOPATH/src/github.com/VirtusLab/render
make all

The name

We believe in obvious names. It renders. It's a verb, render.