conveyor

README

Conveyor

Conveyor builds Docker images. Fast.

How it works

1. Conveyor receives a build request via a GitHub commit webhook.
2. Conveyor builds and tags the resulting image with 3 tags: latest, the git commit sha and the git branch.
3. It then pushes the image to the Docker registry and adds a commit status to the GitHub commit.

Installation

1. Conveyor needs access to pull GitHub repositories. The easiest way to do this is to add a bot user to your organization and generate an ssh key for them. Once you've done that, create a new S3 bucket and upload id_rsa and id_rsa.pub to the root of the bucket.
2. Create a GitHub access token with repo, admin:repo_hook scopes.
3. Create a new CloudFormation stack using cloudformation.json in this repo.

Configuration

The server command has the following available options:

NAME:
   server - Run an http server to build Docker images whenever a push event happens on GitHub

USAGE:
   command server [command options] [arguments...]

OPTIONS:
   --port '8080'        Port to run the server on [$PORT]
   --github.token         GitHub API token to use when updating commit statuses on repositories. [$GITHUB_TOKEN]
   --github.secret        Shared secret used by GitHub to sign webhook payloads. This secret will be used to verify that the request came from GitHub. [$GITHUB_SECRET]
   --dry          Enable dry run mode. [$DRY]
   --builder.image 'remind101/conveyor-builder' A docker image to use to perform the build. [$BUILDER_IMAGE]
   --logger 'stdout://'       The logger to use. Available options are `stdout://`, or `s3://bucket`. [$LOGGER]
   

Performance

Conveyor is designed to be faster than alternative build systems like the Docker Hub or Quay. It does this by making the following tradeoffs.

1. It uses the latest version of Docker (1.8), which has a number of performance improvements when building and pushing images.
2. It pulls the last built image for the branch to maximize the number of layers that can be used from the cache.

Cache

By default, conveyor will pull the last built image for the branch. This isn't always desirable, so you can disable the initial docker pull by adding the following to the git commit description:

[docker nocache]

Scale Out

Conveyor supports two methods to scale out to multiple machines.

Docker Swarm

The first method to scale out Conveyor is to scale out using Docker Swarm. Using this method, Conveyor runs its builds across a cluster of Docker daemons. The advantage of using this method is that you don't need to provide a queue flag since Conveyor can use an in memory queue.

Queue

The recommended way to scale out is to scale out using a build queue. Using this method, you run the conveyor worker subcommand on a machine that hosts a local Docker daemon. The worker process will pull build requests off of the queue and perform the build. The conveyor server command can then run completely separate from the worker nodes.

Conveyor currently supports the following build queues:

1. SQS

Slack Integration

Conveyor can optionally expose some management tasks via Slack slash commands.

Setup

1. Add a new Slash command. I'd recommend using /conveyor as the command.
2. Copy the token and provide it as the --slack.token flag.

Now, you can use Conveyor to automatically manage the GitHub webhook:

/conveyor setup org/repo

API (Soon)

Conveyor also sports a restful API for triggering builds. You can use this with tooling to, say for example, trigger a build before you deploy.

POST /builds

This endpoint will create a build and stream it's output back to the client.

Example Request

{
  "Repository": "remind101/acme-inc",
  "Sha": "827fecd2d36ebeaa2fd05aa8ef3eed1e56a8cd57"
}

Example Command

$ conveyor build remind101/acme-inc:827fecd2d36ebeaa2fd05aa8ef3eed1e56a8cd57
remind101/acme-inc@sha256:44be4f298f764a2a8eb7eecce5383d2b

Development

First, bootstrap the remind101/conveyor-builder image, SSH keys and docker config:

$ make bootstrap

Then start it up with docker-compose:

$ docker-compose up

If you want to test external GitHub webhooks, the easiest way to do that is using ngrok:

$ ngrok $(docker-machine ip default):8080

Then add a new push webhook to a repo, pointed at the ngrok URL. No secret is necessary unless you set GITHUB_SECRET in .env.

NOTE: If you're testing on a private repo, you need to make sure that you've added the generated SSH key to your github account. The generated SSH key can be found in ./builder/docker/data/.ssh/id_rsa.pub

Tests

To run the full test suite. Note that you need to run make bootstrap prior to running this:

$ godep go test ./...

To run only the unit tests (no need to run make bootstrap):

$ godep go test ./... -short

Documentation

Index

• Constants
• type BuildQueue
  • func NewBuildQueue(buffer int) BuildQueue
• type BuildRequest
• type Builder
  • func NewBuilder(b builder.Builder) *Builder
  • func (b *Builder) Build(ctx context.Context, w io.Writer, opts builder.BuildOptions) (image string, err error)
• type SQSBuildQueue
  • func NewSQSBuildQueue(config *aws.Config) *SQSBuildQueue
  • func (q *SQSBuildQueue) Push(ctx context.Context, options builder.BuildOptions) error
  • func (q *SQSBuildQueue) Subscribe(ch chan BuildRequest) error
• type Worker
  • func NewWorker(options WorkerOptions) *Worker
  • func (w *Worker) Shutdown() error
  • func (w *Worker) Start() error
• type WorkerOptions
• type Workers
  • func NewWorkerPool(num int, options WorkerOptions) (workers Workers)
  • func (w Workers) Shutdown() error
  • func (w Workers) Start()

Constants

const (
	// DefaultTimeout is the default amount of time to wait for a build
	// to complete before cancelling it.
	DefaultTimeout = 20 * time.Minute
)

Types

type BuildQueue

type BuildQueue interface {
	// Push pushes the build request onto the queue.
	Push(context.Context, builder.BuildOptions) error

	// Subscribe starts sending build requests on the channel. This method
	// should not block.
	Subscribe(chan BuildRequest) error
}

BuildQueue represents a queue that can push build requests onto a queue, and also pop requests from the queue.

func NewBuildQueue

func NewBuildQueue(buffer int) BuildQueue

NewBuildQueue returns a new in memory BuildQueue.

type BuildRequest

type BuildRequest struct {
	builder.BuildOptions
	Ctx context.Context
}

BuildRequest adds a context.Context to build options.

type Builder

type Builder struct {

	// A Reporter to use to report errors.
	Reporter reporter.Reporter

	// Timeout controls how long to wait before canceling a build. A timeout
	// of 0 means no timeout.
	Timeout time.Duration
	// contains filtered or unexported fields
}

Builder is an implementation of the builder.Builder interface that adds timeouts and error reporting.

func NewBuilder

func NewBuilder(b builder.Builder) *Builder

NewBuilder returns a new Builder instance backed by b. It also wraps it with cancellation and closes the logs when the build finishes.

func (*Builder) Build

func (b *Builder) Build(ctx context.Context, w io.Writer, opts builder.BuildOptions) (image string, err error)

Build builds the image.

type SQSBuildQueue

type SQSBuildQueue struct {
	// QueueURL is the URL for the SQS queue.
	QueueURL string

	// Context is used to generate a context.Context when receiving a
	// message. The zero value is context.Background.
	Context func() context.Context

	// ErrHandler is called when there is an error against the AWS API's.
	// SQSBuildQueue will continue trying to pull messages from the if an
	// error occurs. The zero value logs the error.
	ErrHandler func(error)
	// contains filtered or unexported fields
}

SQSBuildQueue is an implementation of the BuildQueue interface backed by Amazon SQS.

func NewSQSBuildQueue

func NewSQSBuildQueue(config *aws.Config) *SQSBuildQueue

NewSQSBuildQueue returns a new SQSBuildQueue instance backed by a pre-configured sqs client.

func (*SQSBuildQueue) Push

func (q *SQSBuildQueue) Push(ctx context.Context, options builder.BuildOptions) error

func (*SQSBuildQueue) Subscribe

func (q *SQSBuildQueue) Subscribe(ch chan BuildRequest) error

Subscribe enters into a loop and sends BuildRequests to ch. This method blocks.

type Worker

type Worker struct {
	// Builder to use to build.
	builder.Builder

	// Logger to use to build a builder.Logger
	Logger logs.Logger
	// contains filtered or unexported fields
}

Worker pulls jobs off of a BuildQueue and performs the build.

func NewWorker

func NewWorker(options WorkerOptions) *Worker

NewWorker returns a new Worker instance and subscribes to receive build requests from the BuildQueue.

func (*Worker) Shutdown

func (w *Worker) Shutdown() error

Shutdown stops this worker for processing any build requests. If the Builder supports the Cancel method, this function will block until all currently processesing builds have been canceled.

func (*Worker) Start

func (w *Worker) Start() error

Start starts the worker consuming for the BuildQueue.

type WorkerOptions

type WorkerOptions struct {
	// Builder to use to perform the builds.
	Builder builder.Builder

	// BuildQueue to pull BuildRequests from.
	BuildRequests chan BuildRequest

	// Logger used to generate an io.Writer for each build.
	Logger logs.Logger
}

WorkerOptions are options passed when building a new Worker instance.

type Workers

type Workers []*Worker

Workers is a collection of workers.

func NewWorkerPool

func NewWorkerPool(num int, options WorkerOptions) (workers Workers)

NewWorkerPool returns a new set of Worker instances.

func (Workers) Shutdown

func (w Workers) Shutdown() error

Shutdown shuts down all of the workers in the pool.

func (Workers) Start

func (w Workers) Start()

Start starts all of the workers in the pool in their own goroutine.