builder

Documentation

Overview

Package builder contains builders for STI and Docker in OpenShift Origin

Index

• Variables
• type DockerBuilder
  • func NewDockerBuilder(dockerClient DockerClient, build *api.Build) *DockerBuilder
  • func (d *DockerBuilder) Build() error
• type DockerClient
• type KeyValue
• type STIBuilder
  • func NewSTIBuilder(client DockerClient, dockerSocket string, build *api.Build) *STIBuilder
  • func (s *STIBuilder) Build() error

Variables

var (
	// DefaultPushRetryCount is the number of retries of pushing the built Docker image
	// into a configured repository
	DefaultPushRetryCount = 6
	// DefaultPushRetryDelay is the time to wait before triggering a push retry
	DefaultPushRetryDelay = 5 * time.Second
	// RetriableErrors is a set of strings that indicate that an retriable error occurred.
	RetriableErrors = []string{
		"ping attempt failed with error",
		"is already in progress",
		"connection reset by peer",
		"transport closed before response was received",
	}
)

Types

type DockerBuilder

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

DockerBuilder builds Docker images given a git repository URL

func NewDockerBuilder

func NewDockerBuilder(dockerClient DockerClient, build *api.Build) *DockerBuilder

NewDockerBuilder creates a new instance of DockerBuilder

func (*DockerBuilder) Build

func (d *DockerBuilder) Build() error

Build executes a Docker build

type DockerClient

type DockerClient interface {
	BuildImage(opts docker.BuildImageOptions) error
	PushImage(opts docker.PushImageOptions, auth docker.AuthConfiguration) error
	RemoveImage(name string) error
}

DockerClient is an interface to the Docker client that contains the methods used by the common builder

type KeyValue

type KeyValue struct {
	Key   string
	Value string
}

A KeyValue can be used to build ordered lists of key-value pairs.

type STIBuilder

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

STIBuilder performs an STI build given the build object

func NewSTIBuilder

func NewSTIBuilder(client DockerClient, dockerSocket string, build *api.Build) *STIBuilder

NewSTIBuilder creates a new STIBuilder instance

func (*STIBuilder) Build

func (s *STIBuilder) Build() error

Build executes STI build based on configured builder, S2I builder factory and S2I config validator