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.
Available images
There are development and deploy images available.
Development
The development image is a bulky image containing a complete build toolchain.
It is well suited to hacking around and running the tests (including the
acceptance tests). To fetch this image, run ./builder.sh pull. The image can
be run conveniently via ./builder.sh.
Deployment
The deploy image is a downsized image containing a minimal environment for
running CockroachDB. It is based on Debian Jessie and contains only the main
CockroachDB binary. To fetch this image, run docker pull cockroachdb/cockroach in the usual fashion.
To build the image yourself, use ./build-docker-deploy.sh. The script will
build and run a development container. The CockroachDB binary will be built
inside of that container. That binary is built into our minimal container. The
resulting image cockroachdb/cockroach can be run via docker run in the
usual fashion.
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 (*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
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthInfo = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowInfo = fmt.Errorf("proto: integer overflow") )
Functions ¶
This section is empty.
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) ProtoMessage ¶
func (*Info) ProtoMessage()
Source Files