templatescompiler

Documentation

Index

• func NewJobEvaluationContext(releaseJob bireljob.Job, releaseJobProperties *biproperty.Map, ...) bierbrenderer.TemplateEvaluationContext
• type JobListRenderer
  • func NewJobListRenderer(jobRenderer JobRenderer, logger boshlog.Logger) JobListRenderer
• type JobRenderer
  • func NewJobRenderer(erbRenderer bierbrenderer.ERBRenderer, fs boshsys.FileSystem, ...) JobRenderer
• type RenderedJob
  • func NewRenderedJob(job bireljob.Job, path string, fs boshsys.FileSystem, logger boshlog.Logger) RenderedJob
• type RenderedJobList
  • func NewRenderedJobList() RenderedJobList
• type RenderedJobListArchive
  • func NewRenderedJobListArchive(list RenderedJobList, path string, fingerprint string, sha1 string, ...) RenderedJobListArchive
• type RenderedJobListCompressor
  • func NewRenderedJobListCompressor(fs boshsys.FileSystem, compressor boshcmd.Compressor, ...) RenderedJobListCompressor
• type RootContext

Functions

func NewJobEvaluationContext

func NewJobEvaluationContext(
	releaseJob bireljob.Job,
	releaseJobProperties *biproperty.Map,
	jobProperties biproperty.Map,
	globalProperties biproperty.Map,
	deploymentName string,
	address string,
	logger boshlog.Logger,
) bierbrenderer.TemplateEvaluationContext

Types

type JobListRenderer

type JobListRenderer interface {
	Render(
		releaseJobs []bireljob.Job,
		releaseJobProperties map[string]*biproperty.Map,
		jobProperties biproperty.Map,
		globalProperties biproperty.Map,
		deploymentName string,
		address string,
	) (RenderedJobList, error)
}

func NewJobListRenderer

func NewJobListRenderer(
	jobRenderer JobRenderer,
	logger boshlog.Logger,
) JobListRenderer

type JobRenderer

type JobRenderer interface {
	Render(releaseJob bireljob.Job, releaseJobProperties *biproperty.Map, jobProperties biproperty.Map, globalProperties biproperty.Map, deploymentName string, address string) (RenderedJob, error)
}

func NewJobRenderer

func NewJobRenderer(
	erbRenderer bierbrenderer.ERBRenderer,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) JobRenderer

type RenderedJob

type RenderedJob interface {
	Job() bireljob.Job
	Path() string // dir of multiple rendered files
	Delete() error
	DeleteSilently()
}

func NewRenderedJob

func NewRenderedJob(
	job bireljob.Job,
	path string,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) RenderedJob

type RenderedJobList

type RenderedJobList interface {
	Add(RenderedJob)
	All() []RenderedJob
	Delete() error
	DeleteSilently()
}

func NewRenderedJobList

func NewRenderedJobList() RenderedJobList

type RenderedJobListArchive

type RenderedJobListArchive interface {
	List() RenderedJobList
	Path() string
	Fingerprint() string
	SHA1() string
	Delete() error
	DeleteSilently()
}

func NewRenderedJobListArchive

func NewRenderedJobListArchive(
	list RenderedJobList,
	path string,
	fingerprint string,
	sha1 string,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) RenderedJobListArchive

type RenderedJobListCompressor

type RenderedJobListCompressor interface {
	Compress(RenderedJobList) (RenderedJobListArchive, error)
}

func NewRenderedJobListCompressor

func NewRenderedJobListCompressor(
	fs boshsys.FileSystem,
	compressor boshcmd.Compressor,
	sha1Calculator bicrypto.SHA1Calculator,
	logger boshlog.Logger,
) RenderedJobListCompressor

type RootContext

type RootContext struct {
	Index      int        `json:"index"`
	ID         string     `json:"id"`
	AZ         string     `json:"az"`
	Bootstrap  bool       `json:"bootstrap"`
	JobContext jobContext `json:"job"`
	Deployment string     `json:"deployment"`
	Address    string     `json:"address,omitempty"`

	// Usually is accessed with <%= spec.networks.default.ip %>
	NetworkContexts map[string]networkContext `json:"networks"`

	//TODO: this should be a map[string]interface{}
	GlobalProperties  biproperty.Map  `json:"global_properties"`  // values from manifest's top-level properties
	ClusterProperties biproperty.Map  `json:"cluster_properties"` // values from instance group (deployment job) properties
	JobProperties     *biproperty.Map `json:"job_properties"`     // values from release job (aka template) properties
	DefaultProperties biproperty.Map  `json:"default_properties"` // values from release's job's spec
}

RootContext is exposed as an open struct in ERB templates. It must stay same to provide backwards compatible API.