package
25.1.0+incompatible
Repository: https://github.com/cockroachdb/cockroach.git
Documentation: pkg.go.dev
# Functions
DefaultEnvVars returns default environment variables used in conjunction with CLI and MakeClusterSettings.
EnvOrDefaultString returns the value of the environment variable with the given key, or the default value if the environment variable is not set.
IsLocalClusterName returns true if the given name is a valid name for a local cluster.
SSHPublicKey returns the contents of the default public key expected by roachprod.
SSHPublicKeyPath returns the path to the default public key expected by roachprod.
# Constants
ClustersDir is the directory where we cache information about clusters.
DefaultAdminUIPort is the default port on which the cockroach process is listening for HTTP connections for the Admin UI.
DefaultDebugDir is used to stash debug information.
DefaultLockPath is the path to the lock file used to synchronize access to shared roachprod resources.
DefaultNumFilesLimit is the default limit on the number of files that can be opened by the process.
DefaultOpenPortStart is the default starting range used to find open ports.
DefaultSQLPort is the default port on which the cockroach process is listening for SQL connections.
DisableMetamorphicTestingEnvVar is the env var needed to disable metamorphic testing from being eligible.
DNSDir is the directory where we cache local cluster DNS information.
Local is the prefix used to identify local clusters.
MemoryMax is passed to systemd-run; the cockroach process is killed if it uses more than this percentage of the host's memory.
RootUser is the root username on all vms.
SharedUser is the linux username for shared use on all vms.
# Variables
Binary TODO(peter): document.
CockroachDevLicense is used by both roachprod and tools that import it.
DNSRequiredProviders is the list of cloud providers that must be active for DNS records to be synced when roachprod syncs its state.
DefaultEmailDomain is used to form the full account name for GCE and Slack.
DefaultPubKeyNames is the list of default public key names that `roachprod` will look for in the SSH directory.
DNSRequiredProviders is the list of cloud providers that must be active for.
EmailDomain used to form fully qualified usernames for gcloud and slack.
FastDNS enables fast DNS resolution via the standard Go net package.
The default roachprod logger.
MaxConcurrency specifies the maximum number of operations to execute on nodes concurrently, set to zero for infinite.
OSUser TODO(peter): document.
Quiet is used to disable fancy progress output.
SlackToken TODO(peter): document.
SSHDirectory is the path to search for SSH keys needed to set up set up new roachprod clusters.
UseSharedUser is used to determine if config.SharedUser should be used for SSH.