package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev

# Functions

Arch requests a specific CPU architecture.
AWSMachineType sets the machine (instance) type when the cluster is on AWS.
AWSVolumeThroughput sets the minimum provisioned EBS volume throughput when the cluster is on AWS.
AWSZones is a node option which requests Geo-distributed nodes; only applies when the test runs on AWS.
AzureZones is a node option which requests Geo-distributed nodes; only applies when the test runs on Azure.
CloudFromString parses the cloud provider from a string (e.g.
ClustersCompatible returns true if the clusters are compatible, i.e.
CPU sets the number of CPUs for each node.
DisableLocalSSD specifies that we never use instance-local SSDs.
GatherCores enables core gathering after test runs.
GCEMachineType sets the machine (instance) type when the cluster is on GCE.
GCEMinCPUPlatform sets the minimum CPU platform when the cluster is on GCE.
GCEVolumeType sets the volume type when the cluster is on GCE.
GCEZones is a node option which requests Geo-distributed nodes; only applies when the test runs on GCE.
Geo requests Geo-distributed nodes.
MakeClusterSpec makes a ClusterSpec.
Mem requests nodes with low/standard/high ratio of memory per CPU.
ParseMemCPU parses a string into a MemPerCPU value.
PreferLocalSSD specifies that we use instance-local SSDs whenever possible (depending on other constraints on machine type).
RAID0 enables RAID 0 striping across all disks on the node.
RandomlyUseZfs is an Option which randomly picks the file system to be used, and sets it to zfs, about 20% of the time.
ReuseAny is an Option that specifies a cluster with ReusePolicyAny.
ReuseNone is an Option that specifies a cluster with ReusePolicyNone.
ReuseTagged is an Option that specifies a cluster with ReusePolicyTagged.
SelectAWSMachineType selects a machine type given the desired number of CPUs, memory per CPU, support for locally-attached SSDs and CPU architecture.
SelectAzureMachineType selects a machine type given the desired number of CPUs, memory per CPU, support for locally-attached SSDs and CPU architecture.
SelectGCEMachineType selects a machine type given the desired number of CPUs, memory per CPU, and CPU architecture.
SetFileSystem is an Option which can be used to set the underlying file system to be used.
SSD is a node option which requests nodes with the specified number of SSDs.
TerminateOnMigration ensures VM is terminated in case GCE triggers a live migration.
TryCloudFromString parses the cloud provider from a string (e.g.
UseSpotVMs creates a spot vm or equivalent of a cloud provider.
VolumeSize is the size in GB of the disk volume.
TODO(GouravKumar): remove use of WorkloadNode, use WorkloadNodeCount instead.
WorkloadNodeCount indicates the count of last nodes in cluster to be treated as workload node.

# Constants

AnyCloud is a sentinel value for an unset Cloud value, which in most contexts means "any cloud".
AWS stands for Amazon Web Services.
Azure is Microsoft's cloud.
GCE stands for Google Compute Engine.
Local is a faux cloud value assigned to tests that are run on a local machine.
LocalSSDDefault is the default mode, when the test does not have any preference.
LocalSSDDisable means that we will never use a local SSD.
LocalSSDPreferOn means that we prefer to use a local SSD.
Zfs file system.

# Structs

ClusterSpec represents a test's description of what its cluster needs to look like.
ReusePolicyAny means that only clean clusters are accepted and the cluster can be used by any other test (i.e.
ReusePolicyNone means that only clean clusters are accepted and the cluster cannot be reused afterwards.
ReusePolicyTagged means that clusters left over by similarly-tagged tests are accepted in addition to clean cluster and, regardless of how the cluster started up, it will be tagged with the given tag at the end (so only similarly-tagged tests can use it afterwards).
RoachprodClusterConfig contains general roachprod cluster configuration that does not depend on the test.

# Type aliases

Cloud indicates the cloud provider.
LocalSSDSetting controls whether test cluster nodes use an instance-local SSD as storage.
Option for MakeClusterSpec.