build

README

Docker Deploy

Installing docker is a prerequisite. The instructions differ depending on the environment. Docker is comprised of two parts: the daemon server which runs on Linux and accepts commands, and the client which is a Go program capable of running on MacOS, all Unix variants and Windows.

Docker Installation

Follow the Docker install instructions.

If deploying to a modern Linux-based environment, Docker is installed locally and provides Cockroach containerization directly on top of the host OS.

If deploying to a MacOS or Windows-based environment, the docker installation includes a virtual machine (VirtualBox) which runs a minimal Tiny Core Linux OS with Docker support, to provide Cockroach containerization on top of the Linux virtual machine.

Available images

There are development and deploy images available.

Development

The development image is bulky, dynamically linked and contains a complete build toolchain. It is well suited to hacking around and running the tests (including acceptance tests and such). To build this image, run ./builder.sh init. The resulting image cockroachdb/builder can be run conveniently via ./builder.sh.

Deployment

The deploy image is a downsized image containing a minimal environment for running Cockroach. It is based on Debian Jessie and contains only the main Cockroach binary as well as the resources required for starting the server (certs, etc.). To build the image yourself, use ./build-docker-deploy.sh. The script will build and run a development container. Inside of that container, the binary will be built along with the individual tests. These created files will be extracted from the image and saved in ./build/deploy. From those files, we build our minimal container. After the build is complete, the script will fire up the container, supplying the test files via mounting ./build/deploy, running them one by one and propagating failure.

Documentation

Overview

Package build is a generated protocol buffer package.

It is generated from these files:

cockroach/build/info.proto

It has these top-level messages:

Info

Index

• Variables
• type Info
  • func GetInfo() Info
  • func (*Info) Descriptor() ([]byte, []int)
  • func (m *Info) Marshal() (data []byte, err error)
  • func (m *Info) MarshalTo(data []byte) (int, error)
  • func (*Info) ProtoMessage()
  • func (m *Info) Reset()
  • func (b Info) Short() string
  • func (m *Info) Size() (n int)
  • func (m *Info) String() string
  • func (m *Info) Unmarshal(data []byte) error

Variables

var (
	ErrInvalidLengthInfo = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowInfo   = fmt.Errorf("proto: integer overflow")
)

Types

type Info

type Info struct {
	GoVersion    string `protobuf:"bytes,1,opt,name=go_version,json=goVersion" json:"go_version"`
	Tag          string `protobuf:"bytes,2,opt,name=tag" json:"tag"`
	Time         string `protobuf:"bytes,3,opt,name=time" json:"time"`
	Dependencies string `protobuf:"bytes,4,opt,name=dependencies" json:"dependencies"`
	CgoCompiler  string `protobuf:"bytes,5,opt,name=cgo_compiler,json=cgoCompiler" json:"cgo_compiler"`
	Platform     string `protobuf:"bytes,6,opt,name=platform" json:"platform"`
}

Info describes build information for this CockroachDB binary.

func GetInfo

func GetInfo() Info

GetInfo returns an Info struct populated with the build information.

func (*Info) Descriptor

func (*Info) Descriptor() ([]byte, []int)

func (*Info) Marshal

func (m *Info) Marshal() (data []byte, err error)

func (*Info) MarshalTo

func (m *Info) MarshalTo(data []byte) (int, error)

func (*Info) ProtoMessage

func (*Info) ProtoMessage()

func (*Info) Reset

func (m *Info) Reset()

func (Info) Short

func (b Info) Short() string

Short returns a pretty printed build and version summary.

func (*Info) Size

func (m *Info) Size() (n int)

func (*Info) String

func (m *Info) String() string

func (*Info) Unmarshal

func (m *Info) Unmarshal(data []byte) error