cluster

package
v1.1.9-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2018 License: Apache-2.0 Imports: 49 Imported by: 185

Documentation

Overview

Package cluster is a generated protocol buffer package.

It is generated from these files: 

cockroach/pkg/acceptance/cluster/testconfig.proto

It has these top-level messages: 

StoreConfig
NodeConfig
TestConfig

Index

Constants

View Source 
const CockroachBinaryInContainer = "/cockroach/cockroach"

CockroachBinaryInContainer is the container-side path to the CockroachDB binary.

View Source 
const DefaultTCP nat.Port = base.DefaultPort + "/tcp"

DefaultTCP is the default SQL/RPC port specification.

Variables

View Source 
var (
	ErrInvalidLengthTestconfig = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTestconfig   = fmt.Errorf("proto: integer overflow")
)
View Source 
var CockroachBinary = flag.String("b", func() string {
	rootPkg, err := build.Import("github.com/cockroachdb/cockroach", "", 0)
	if err != nil {
		panic(err)
	}

	return filepath.Join(rootPkg.Dir, "cockroach-linux-2.6.32-gnu-amd64")
}(), "the host-side binary to run")

CockroachBinary is the path to the host-side binary to use.

View Source 
var HTTPClient = http.Client{
	Timeout: base.NetworkTimeout,
	Transport: &http.Transport{
		TLSClientConfig: &tls.Config{
			InsecureSkipVerify: true,
		},
	},
}

HTTPClient is an http.Client configured for querying a cluster. We need to run with "InsecureSkipVerify" (at least on Docker) due to the fact that we cannot use a fixed hostname to reach the cluster. This in turn means that we do not have a verified server name in the certs.

View Source 
var InitMode_name = map[int32]string{
	0: "INIT_COMMAND",
	1: "INIT_BOOTSTRAP_NODE_ZERO",
	2: "INIT_NONE",
}
View Source 
var InitMode_value = map[string]int32{
	"INIT_COMMAND":             0,
	"INIT_BOOTSTRAP_NODE_ZERO": 1,
	"INIT_NONE":                2,
}

Functions

func Consistent 

func Consistent(ctx context.Context, c Cluster, i int) error

Consistent performs a replication consistency check on all the ranges in the cluster. It depends on a majority of the nodes being up, and does the check against the node at index i.

Types

type Cluster 

type Cluster interface {
	// NumNodes returns the number of nodes in the cluster, running or not.
	NumNodes() int
	// NewClient returns a kv client for the given node.
	NewClient(context.Context, int) (*client.DB, error)
	// PGUrl returns a URL string for the given node postgres server.
	PGUrl(context.Context, int) string
	// InternalIP returns the address used for inter-node communication.
	InternalIP(ctx context.Context, i int) net.IP
	// Assert verifies that the cluster state is as expected (i.e. no unexpected
	// restarts or node deaths occurred). Tests can call this periodically to
	// ascertain cluster health.
	Assert(context.Context, testing.TB)
	// AssertAndStop performs the same test as Assert but then proceeds to
	// dismantle the cluster.
	AssertAndStop(context.Context, testing.TB)
	// ExecCLI runs `./cockroach <args>`, while filling in required flags such as
	// --insecure, --certs-dir, --host or --port.
	//
	// Returns stdout, stderr, and an error.
	ExecCLI(ctx context.Context, i int, args []string) (string, string, error)
	// Kill terminates the cockroach process running on the given node number.
	// The given integer must be in the range [0,NumNodes()-1].
	Kill(context.Context, int) error
	// Restart terminates the cockroach process running on the given node
	// number, unless it is already stopped, and restarts it.
	// The given integer must be in the range [0,NumNodes()-1].
	Restart(context.Context, int) error
	// URL returns the HTTP(s) endpoint.
	URL(context.Context, int) string
	// Addr returns the host and port from the node in the format HOST:PORT.
	Addr(ctx context.Context, i int, port string) string
	// Hostname returns a node's hostname.
	Hostname(i int) string
}

A Cluster is an abstraction away from a concrete cluster deployment (i.e. a local docker cluster, or an AWS-provisioned one). It exposes a shared set of methods for test-related manipulation.

type Container 

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

Container provides the programmatic interface for a single docker container.

func (*Container) Addr 

func (c *Container) Addr(ctx context.Context, port nat.Port) *net.TCPAddr

Addr returns the TCP address to connect to.

func (*Container) Inspect 

func (c *Container) Inspect(ctx context.Context) (types.ContainerJSON, error)

Inspect retrieves detailed info about a container.

func (*Container) Kill 

func (c *Container) Kill(ctx context.Context) error

Kill stops a running container, without removing it.

func (*Container) Logs 

func (c *Container) Logs(ctx context.Context, w io.Writer) error

Logs outputs the containers logs to the given io.Writer.

func (Container) Name 

func (c Container) Name() string

Name returns the container's name.

func (*Container) Pause 

func (c *Container) Pause(ctx context.Context) error

Pause pauses a running container.

func (*Container) Remove 

func (c *Container) Remove(ctx context.Context) error

Remove removes the container from docker. It is an error to remove a running container.

func (*Container) Restart 

func (c *Container) Restart(ctx context.Context, timeout *time.Duration) error

Restart restarts a running container. Container will be killed after 'timeout' seconds if it fails to stop.

func (*Container) Start 

func (c *Container) Start(ctx context.Context) error

Start starts a non-running container.

TODO(pmattis): Generalize the setting of parameters here.

func (*Container) Stop 

func (c *Container) Stop(ctx context.Context, timeout *time.Duration) error

Stop a running container.

func (*Container) Unpause 

func (c *Container) Unpause(ctx context.Context) error

Unpause resumes a paused container.

func (*Container) Wait 

func (c *Container) Wait(ctx context.Context) error

Wait waits for a running container to exit.

type DockerCluster added in v1.1.0 

type DockerCluster struct {
	Nodes []*testNode

	CertsDir string
	// contains filtered or unexported fields
}

DockerCluster manages a local cockroach cluster running on docker. The cluster is composed of a "volumes" container which manages the persistent volumes used for certs and node data and N cockroach nodes.

func CreateDocker added in v1.1.0 

func CreateDocker(
	ctx context.Context, cfg TestConfig, logDir string, stopper *stop.Stopper,
) *DockerCluster

CreateDocker creates a Docker-based cockroach cluster. The stopper is used to gracefully shutdown the channel (e.g. when a signal arrives). The cluster must be started before being used and keeps logs in the specified logDir, if supplied.

func (*DockerCluster) Addr added in v1.1.0 

func (l *DockerCluster) Addr(ctx context.Context, i int, port string) string

Addr returns the host and port from the node in the format HOST:PORT.

func (*DockerCluster) Assert added in v1.1.0 

func (l *DockerCluster) Assert(ctx context.Context, t testing.TB)

Assert drains the Events channel and compares the actual events with those expected to have been generated by the operations performed on the nodes in the cluster (restart, kill, ...). In the event of a mismatch, the passed Tester receives a fatal error.

func (*DockerCluster) AssertAndStop added in v1.1.0 

func (l *DockerCluster) AssertAndStop(ctx context.Context, t testing.TB)

AssertAndStop calls Assert and then stops the cluster. It is safe to stop the cluster multiple times.

func (*DockerCluster) Cleanup added in v1.1.0 

func (l *DockerCluster) Cleanup(ctx context.Context)

Cleanup removes the log directory if it was initially created by this DockerCluster.

func (*DockerCluster) ExecCLI added in v1.1.0 

func (l *DockerCluster) ExecCLI(ctx context.Context, i int, cmd []string) (string, string, error)

ExecCLI runs ./cockroach <args> with sane defaults.

func (*DockerCluster) Hostname added in v1.1.0 

func (l *DockerCluster) Hostname(i int) string

Hostname implements the Cluster interface.

func (*DockerCluster) InternalIP added in v1.1.0 

func (l *DockerCluster) InternalIP(ctx context.Context, i int) net.IP

InternalIP returns the IP address used for inter-node communication.

func (*DockerCluster) Kill added in v1.1.0 

func (l *DockerCluster) Kill(ctx context.Context, i int) error

Kill kills the i-th node.

func (*DockerCluster) NewClient added in v1.1.0 

func (l *DockerCluster) NewClient(ctx context.Context, i int) (*roachClient.DB, error)

NewClient implements the Cluster interface.

func (*DockerCluster) NumNodes added in v1.1.0 

func (l *DockerCluster) NumNodes() int

NumNodes returns the number of nodes in the cluster.

func (*DockerCluster) OneShot added in v1.1.0 

func (l *DockerCluster) OneShot(
	ctx context.Context,
	ref string,
	ipo types.ImagePullOptions,
	containerConfig container.Config,
	hostConfig container.HostConfig,
	name string,
) error

OneShot runs a container, expecting it to successfully run to completion and die, after which it is removed. Not goroutine safe: only one OneShot can be running at once. Adds the same binds as the cluster containers (certs, binary, etc).

func (*DockerCluster) PGUrl added in v1.1.0 

func (l *DockerCluster) PGUrl(ctx context.Context, i int) string

PGUrl returns a URL string for the given node postgres server.

func (*DockerCluster) Restart added in v1.1.0 

func (l *DockerCluster) Restart(ctx context.Context, i int) error

Restart restarts the given node. If the node isn't running, this starts it.

func (*DockerCluster) RunInitCommand added in v1.1.0 

func (l *DockerCluster) RunInitCommand(ctx context.Context, nodeIdx int)

RunInitCommand runs the `cockroach init` command. Normally called automatically, but exposed for tests that use INIT_NONE. nodeIdx may designate any node in the cluster as the target of the command.

func (*DockerCluster) Start added in v1.1.0 

func (l *DockerCluster) Start(ctx context.Context)

Start starts the cluster.

func (*DockerCluster) URL added in v1.1.0 

func (l *DockerCluster) URL(ctx context.Context, i int) string

URL returns the base url.

type Event 

type Event struct {
	NodeIndex int
	Status    string
}

Event for a node containing a node index and the type of event.

type InitMode added in v1.1.0 

type InitMode int32

InitMode specifies different ways to initialize the cluster. 

const (
	// INIT_COMMAND starts every node with a join flag and issues the
	// init command.
	INIT_COMMAND InitMode = 0
	// INIT_BOOTSTRAP_NODE_ZERO uses the legacy protocol of omitting the
	// join flag from node zero.
	INIT_BOOTSTRAP_NODE_ZERO InitMode = 1
	// INIT_NONE starts every node with a join flag and leaves the
	// cluster uninitialized.
	INIT_NONE InitMode = 2
)

func (InitMode) Enum added in v1.1.0 

func (x InitMode) Enum() *InitMode

func (InitMode) EnumDescriptor added in v1.1.0 

func (InitMode) EnumDescriptor() ([]byte, []int)

func (InitMode) String added in v1.1.0 

func (x InitMode) String() string

func (*InitMode) UnmarshalJSON added in v1.1.0 

func (x *InitMode) UnmarshalJSON(data []byte) error

type NodeConfig 

type NodeConfig struct {
	Version string        `protobuf:"bytes,1,opt,name=version" json:"version"`
	Stores  []StoreConfig `protobuf:"bytes,2,rep,name=stores" json:"stores"`
}

NodeConfig holds the configuration of a collection of similar nodes.

func (*NodeConfig) Descriptor 

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

func (*NodeConfig) Marshal 

func (m *NodeConfig) Marshal() (dAtA []byte, err error)

func (*NodeConfig) MarshalTo 

func (m *NodeConfig) MarshalTo(dAtA []byte) (int, error)

func (*NodeConfig) ProtoMessage 

func (*NodeConfig) ProtoMessage()

func (*NodeConfig) Reset 

func (m *NodeConfig) Reset()

func (*NodeConfig) Size 

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

func (*NodeConfig) String 

func (m *NodeConfig) String() string

func (*NodeConfig) Unmarshal 

func (m *NodeConfig) Unmarshal(dAtA []byte) error

type StoreConfig 

type StoreConfig struct {
	MaxRanges int32 `protobuf:"varint,2,opt,name=max_ranges,json=maxRanges" json:"max_ranges"`
}

StoreConfig holds the configuration of a collection of similar stores.

func (*StoreConfig) Descriptor 

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

func (*StoreConfig) Marshal 

func (m *StoreConfig) Marshal() (dAtA []byte, err error)

func (*StoreConfig) MarshalTo 

func (m *StoreConfig) MarshalTo(dAtA []byte) (int, error)

func (*StoreConfig) ProtoMessage 

func (*StoreConfig) ProtoMessage()

func (*StoreConfig) Reset 

func (m *StoreConfig) Reset()

func (*StoreConfig) Size 

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

func (*StoreConfig) String 

func (m *StoreConfig) String() string

func (*StoreConfig) Unmarshal 

func (m *StoreConfig) Unmarshal(dAtA []byte) error

type TestConfig 

type TestConfig struct {
	Name  string       `protobuf:"bytes,1,opt,name=name" json:"name"`
	Nodes []NodeConfig `protobuf:"bytes,2,rep,name=nodes" json:"nodes"`
	// Duration is the total time that the test should run for. Important for
	// tests such as TestPut that will run indefinitely.
	Duration time.Duration `protobuf:"varint,3,opt,name=duration,casttype=time.Duration" json:"duration"`
	InitMode InitMode      `protobuf:"varint,4,opt,name=init_mode,json=initMode,enum=cockroach.acceptance.cluster.InitMode" json:"init_mode"`
}

func (*TestConfig) Descriptor 

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

func (*TestConfig) Marshal 

func (m *TestConfig) Marshal() (dAtA []byte, err error)

func (*TestConfig) MarshalTo 

func (m *TestConfig) MarshalTo(dAtA []byte) (int, error)

func (*TestConfig) ProtoMessage 

func (*TestConfig) ProtoMessage()

func (*TestConfig) Reset 

func (m *TestConfig) Reset()

func (*TestConfig) Size 

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

func (*TestConfig) String 

func (m *TestConfig) String() string

func (*TestConfig) Unmarshal 

func (m *TestConfig) Unmarshal(dAtA []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.