ArchInfoForOS returns an ArchInfo for the given OS and Architecture if currently supported.

DefaultAuthMode is the auth mode used for functions that don't take an auth mode or the user doesn't specify one.

Download downloads the remote resource, preferring a GCS cache if available.

GenFilenameFromArgs given a list of cmd args, returns an alphahumeric string up to `maxLen` in length with hyphen delimiters, suitable for use in a filename.

Install TODO(peter): document.

ListNodes parses and validates a node selector string, which is either "all" (indicating all nodes in the cluster) or a comma-separated list of nodes and node ranges.

MakeClusterSettings makes a ClusterSettings.

NewSyncedCluster creates a SyncedCluster, given the cluster metadata, node selector string, and settings.

ServiceInstancePredicate returns a ServicePredicate that matches on the provided instance.

ServiceModePredicate returns a ServicePredicate that matches on the provided service mode.

ServiceNodePredicate returns a ServicePredicate that match on the given nodes.

SortedCmds TODO(peter): document.

StageApplication downloads the appropriate artifact for the given application name into the specified directory on each node in the cluster.

StageCockroachRelease downloads an official CockroachDB release binary with the specified version.

StageOptionalRemoteLibrary downloads a library from the cockroach edge with the provided application path to each specified by the cluster to <dir>/lib.

SuppressMetamorphicConstantsEnvVar returns the env var to disable metamorphic testing.

URLsForApplication returns a slice of URLs that should be downloaded for the given application.

VirtualClusterInfoFromLabel takes as parameter a tenant label produced with `VirtuaLClusterLabel()` and returns the corresponding tenant name and instance.

VirtualClusterLabel is the value used to "label" virtual cluster (cockroach) processes running locally or in a VM.

AuthRootCert authenticates using the root user and root cert + root client certs.

AuthUserCert authenticates using the default user and password, as well as the root cert and client certs.

AuthUserPassword authenticates using the default user and password.

CockroachNodeCertsDir is the certs directory that lives on the cockroach node itself.

FailDefault will use the default behaviour of the function it's being used with.

FailFast will exit immediately on the first error, in which case the slice of ParallelResults will only contain the one error result.

FailSlow will wait for all nodes to finish when encountering a command error on any node.

NoSQLTimeout indicates that a `cockroach sql` call is expected to succeed immediately (i.e., the server is known to be accepting requests at the time the call is made).

ServiceModeExternal is the service mode for services that are run in a separate process.

ServiceModeShared is the service mode for services that are shared on a host process.

ServiceTypeSQL is the service type for SQL services on a node.

ServiceTypeUI is the service type for UI services on a node.

SharedPriorityClass is the priority class used to indicate when a service is shared.

StartDefault starts a "full" (KV+SQL) node (the default).

StartServiceForVirtualCluster starts a SQL/HTTP-only server process for a virtual cluster.

StartSharedProcessForVirtualCluster starts an in-memory tenant (shared process) for a virtual cluster.

SystemInterfaceName is the virtual cluster name to use to access the system interface.

AlwaysTrue is a should retry predicate function that always returns true to indicate that the operation is always retryable no matter what the previous result was.

The first retry is after 5s, the second and final is after 25s.

ErrAfterRetry marks an error that has occurred/persisted after retries.

MonitorNoCockroachProcessesError is the error returned when the monitor is called on a node that is not running a `cockroach` process by the time the monitor runs.

PGAuthModes is a map from auth mode string names to the actual PGAuthMode.

ClusterSettings contains various knobs that affect operations on a cluster.

MonitorOpts is used to pass the options needed by Monitor.

MonitorProcessDead represents the cockroach process dying on a node.

MonitorProcessRunning represents the cockroach process running on a node.

NodeMonitorInfo is a message describing a cockroach process' status.

NodeStatus contains details about the status of a node.

RunCmdOptions is used to configure the behavior of `runCmdOnSingleNode`.

RunResultDetails holds details of the result of commands executed by Run().

ServiceDesc describes a service running on a node.

StartOpts houses the options needed by Start().

A SyncedCluster is created from the cluster metadata in the synced clusters cache and is used as the target for installing and managing various software components.

ClusterSettingOption is the interface satisfied by options to MakeClusterSettings.

MonitorEvent is an interface for events that can be sent by the monitor.

BinaryOption is used to pass a process tag.

ClusterSettingsOption adds cluster settings via SET CLUSTER SETTING.

DebugDirOption is used to stash debug information.

EnvOption is used to pass environment variables to the cockroach process.

FindOpenPortsFunc is a function signature for finding open ports on a node.

Node represents a node in a roachprod cluster; a cluster of N nodes consists of nodes 1 through N.

Nodes is a list of nodes.

NodeServiceMap is a convenience type for mapping services by service type for each node.

NumRacksOption is used to pass the number of racks to partition the nodes into.

PGUrlCertsDirOption is used to pass certs dir for secure connections.

SecureOption is passed to create a secure cluster.

ServiceDescriptors is a convenience type for a slice of service descriptors.

ServicePredicate is a predicate function definition for filtering services.

StartTarget identifies what flavor of cockroach we are starting.

TagOption is used to pass a process tag.

UseTreeDistOption is passed to use treedist copy algorithm.