job

Documentation

Index

• type DirReader
  • func NewDirReader(dir string, fs boshsys.FileSystem, logger boshlog.Logger) DirReader
  • func (r DirReader) Close() error
  • func (r DirReader) Read() (Job, error)
• type Job
• type Package
• type Property
• type PropertyExample
• type Reader
• type ReaderFactory
  • func NewReaderFactory(downloader bpdload.Downloader, extractor bptar.Extractor, ...) ReaderFactory
  • func (rf ReaderFactory) NewReader(url string) Reader
  • func (rf ReaderFactory) NewTarReader(url string) Reader
• type TarReader
  • func NewTarReader(path string, downloader bpdload.Downloader, extractor bptar.Extractor, ...) *TarReader
  • func (r TarReader) Close() error
  • func (r *TarReader) Read() (Job, error)
• type Template

Types

type DirReader

type DirReader struct {
	// contains filtered or unexported fields
}

func NewDirReader

func NewDirReader(
	dir string,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) DirReader

func (DirReader) Close

func (r DirReader) Close() error

func (DirReader) Read

func (r DirReader) Read() (Job, error)

type Job

type Job struct {
	Manifest bpreljobman.Manifest `json:"-"`

	Name        string
	Description string

	MonitTemplate Template

	Templates []Template

	DeploymentJobTemplates []bpdep.Template

	// Runtime package dependencies for this job
	Packages []Package

	Properties []Property
}

type Package

type Package struct {
	Name string
}

type Property

type Property struct {
	Name        string
	Description string

	Default interface{}

	Example  interface{}
	Examples []PropertyExample
}

type PropertyExample

type PropertyExample struct {
	Description string
	Value       interface{}
}

type Reader

type Reader interface {
	Read() (Job, error)
	Close() error
}

type ReaderFactory

type ReaderFactory struct {
	// contains filtered or unexported fields
}

func NewReaderFactory

func NewReaderFactory(
	downloader bpdload.Downloader,
	extractor bptar.Extractor,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) ReaderFactory

func (ReaderFactory) NewReader

func (rf ReaderFactory) NewReader(url string) Reader

func (ReaderFactory) NewTarReader

func (rf ReaderFactory) NewTarReader(url string) Reader

type TarReader

type TarReader struct {
	// contains filtered or unexported fields
}

TarReader reads .tgz job file and returns a Job. See unpacked job directory layout at the end of the file.

func NewTarReader

func NewTarReader(
	path string,
	downloader bpdload.Downloader,
	extractor bptar.Extractor,
	fs boshsys.FileSystem,
	logger boshlog.Logger,
) *TarReader

func (TarReader) Close

func (r TarReader) Close() error

func (*TarReader) Read

func (r *TarReader) Read() (Job, error)

type Template

type Template struct {
	SrcPathEnd string
	DstPathEnd string // End of the path on the VM

	Path string
}