sti

Documentation

Index

• type Builder
  • func NewBuilder(req *STIRequest) (*Builder, error)
  • func (b *Builder) Build() (*STIResult, error)
• type STIRequest
• type STIResult
• type Usage
  • func NewUsage(req *STIRequest) (*Usage, error)
  • func (u *Usage) Show() error

Types

type Builder

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

func NewBuilder

func NewBuilder(req *STIRequest) (*Builder, error)

func (*Builder) Build

func (b *Builder) Build() (*STIResult, error)

Build processes a Request and returns a *Result and an error. An error represents a failure performing the build rather than a failure of the build itself. Callers should check the Success field of the result to determine whether a build succeeded or not.

type STIRequest

type STIRequest struct {
	BaseImage           string
	DockerSocket        string
	Verbose             bool
	PreserveWorkingDir  bool
	Source              string
	Ref                 string
	Tag                 string
	Clean               bool
	RemovePreviousImage bool
	Environment         map[string]string
	CallbackUrl         string
	ScriptsUrl          string
	// contains filtered or unexported fields
}

STIRequest contains essential fields for any request: a base image, source directory, and tag

type STIResult

type STIResult struct {
	Success    bool
	Messages   []string
	WorkingDir string
	ImageID    string
}

STIResult includes a flag that indicates whether the build was successful and if an image was created, the image ID

type Usage

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

Usage display usage information about a particular build image

func NewUsage

func NewUsage(req *STIRequest) (*Usage, error)

NewUsage creates a new instance of the default Usage implementation

func (*Usage) Show

func (u *Usage) Show() error

Show starts the builder container and invokes the usage script on it to print usage information for the script.