gomplate

README

Read the docs at gomplate.hairyhenderson.ca.

A Go template-based CLI tool. gomplate can be used as an alternative to envsubst but also supports additional template datasources such as: JSON, YAML, AWS EC2 metadata, BoltDB, Hashicorp Consul and Hashicorp Vault secrets.

I really like envsubst for use as a super-minimalist template processor. But its simplicity is also its biggest flaw: it's all-or-nothing with shell-like variables.

Gomplate is an alternative that will let you process templates which also include shell-like variables. Also there are some useful built-in functions that can be used to make templates even more expressive.

Read more documentation at gomplate.hairyhenderson.ca!

Please report any bugs found in the issue tracker.

Releasing

Right now the release process is semi-automatic.

1. Create a release tag: git tag -a v0.0.9 -m "Releasing v0.9.9" && git push --tags
2. Build binaries & compress most of them: make build-release
3. Create a release in github!

License

The MIT License

Copyright (c) 2016-2018 Dave Henderson

Documentation

Index

• Variables
• func RunTemplates(o *Config) error
• type Config
• type MetricsType

Variables

var Stdout io.WriteCloser = os.Stdout

Stdout allows overriding the writer to use when templates are written to stdout ("-").

Functions

func RunTemplates

func RunTemplates(o *Config) error

RunTemplates - run all gomplate templates specified by the given configuration

Types

type Config

type Config struct {
	Input       string
	InputFiles  []string
	InputDir    string
	ExcludeGlob []string
	OutputFiles []string
	OutputDir   string

	DataSources       []string
	DataSourceHeaders []string

	LDelim string
	RDelim string
}

Config - values necessary for rendering templates with gomplate. Mainly for use by the CLI

type MetricsType

type MetricsType struct {
	TemplatesGathered   int
	TemplatesProcessed  int
	Errors              int
	GatherDuration      time.Duration            // time it took to gather templates
	TotalRenderDuration time.Duration            // time it took to render all templates
	RenderDuration      map[string]time.Duration // times for rendering each template
}

MetricsType - Warning: experimental! This may change in breaking ways without warning. This is not subject to any semantic versioning guarantees!

var Metrics *MetricsType

Metrics tracks interesting basic metrics around gomplate executions. Warning: experimental! This may change in breaking ways without warning. This is not subject to any semantic versioning guarantees!