Apply takes in an options struct and a list of user-provided options, and applies those options to the container.

AuthMode allows the callers to change the authentication mode used when connecting to crdb.

ConnectionOption allows the caller to provide a custom connection option to be included in the pgurl.

ConnectTimeout allows callers to set a connection timeout.

DBName changes the database name used when connecting to crdb.

DefaultStartOpts returns a StartOpts populated with default values.

DefaultStopOpts returns a StopOpts populated with default values.

DisableWALFailover can be used to generate StartOpts that disable use of WAL failover.

FromInstallNodes converts install.Nodes to NodeListOption.

Graceful performs a graceful stop of the cockroach process.

InMemoryDB can be used to configure StartOpts that start in-memory cockroach processes.

NewNodeListOptionRange returns a NodeListOption between start and end inclusive.

NewStartOpts returns a StartOpts populated with default values when called with no options.

NewStopOpts returns a StopOpts populated with default values when called with no options.

NoBackupSchedule can be used to generate StartOpts that skip the creation of the default backup schedule.

SQLInstance allows the caller to indicate which sql instance to use.

DefaultStartSharedVirtualClusterOpts returns StartOpts for starting a shared process virtual cluster with the given name.

StartVirtualClusterOpts returns StartOpts for starting an external process virtual cluster with the given name and on the given nodes.

StopSharedVirtualClusterOpts creates StopOpts that can be used to stop the shared process virtual cluster with the given name.

StopVirtualClusterOpts returns stop options that can be used to stop the SQL instance process serving the virtual cluster with the given name.

StorageCluster indicates the set of nodes in the cluster that should be used as storage cluster when starting a separate process virtual cluster.

Tag sets a process tag when stopping processes.

User allows the customization of the user to use when connecting to crdb.

VirtualClusterInstance can be used to indicate the SQL instance to start or stop.

VirtualClusterName allows the customization of the virtual cluster to connect to.

WaitForReplication tells the start process to wait for at least 3X replication after starting a cockroach process.

WithInitTarget allows the caller to configure which node is used as `InitTarget` when starting cockroach.

WithNodes returns a RunOptions that will run on the given nodes.

ConnOptions contains connection-related options.

GlobalOptions is the set of all options that cluster functions can take.

NodeLister is a helper to create `option.NodeListOption`s.

StartOpts is a type that combines the start options needed by roachprod and roachtest.

StopOpts is a type that combines the stop options needed by roachprod and roachtest.

VirtualClusterOptions contains the options to be accepted by functions that can be applied on a specific virtual cluster.

Option is an interface used to configure operations against a Cluster.

A NodeListOption is a slice of roachprod node identifiers.

StartStopOption allows us to apply optional customizations to start or stop options.