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

# Packages

Package aws provides functionality for the aws provider.
Package azure allows roachprod to create instances within the Microsoft Azure cloud.

# Functions

AllProviderNames returns the names of all known vm Providers.
CreateDNSRecord creates a new DNS record.
CreatePreemptedVMs returns a list of PreemptedVM created from given list of vmNames.
CreateProviderOptionsContainer returns a ProviderOptionsContainer which is populated with options for all registered providers.
CreateSRVRecord creates a new SRV DNS record.
DefaultCreateOpts returns a new vm.CreateOpts with default values set.
DNSSafeName takes a string and returns a cleaned version of the string that can be used in DNS entries.
ExpandZonesFlag takes a slice of strings which may be of the format zone:N which implies that a given zone should be repeated N times and expands it.
FanOut collates a collection of VMs by their provider and invoke the callbacks in parallel.
FanOutDNS collates a collection of VMs by their DNS providers and invoke the callbacks in parallel.
FindActiveAccounts queries the active providers for the name of the user account.
ForDNSProvider resolves the DNSProvider with the given name and executes the action.
ForProvider resolves the Provider with the given name and executes the action.
GetDefaultLabelMap returns a label map for a common set of labels.
Name generates the name for the i'th node in a cluster.
ParseArch parses a string into a CPUArch using a simple, non-exhaustive heuristic.
ProvidersParallel concurrently executes actions for each named Provider.
ProvidersSequential sequentially executes actions for each named Provider.
SanitizeLabel returns a version of the string that can be used as a (resource) label.
SanitizeLabelValues returns the same set of keys with sanitized values.
ZonePlacement allocates zones to numNodes in an equally sized groups in the same order as zones.

# Constants

AcceptMultipleProjects means that multiple projects are supported.
DisksInitializedFile is a marker file that is created on a VM to indicate that the disks have been initialized by the VM start-up script.
Ext4 refers to the ext4 file system.
InitializedFile is the base name of the initialization paths defined below.
OSInitializedFile is a marker file that is created on a VM to indicate that it has been initialized at least once by the VM start-up script.
SingleProject means that a single project is accepted.
StartupLogs is a log file that is created on a VM to redirect startup script output logs.
TagArch is the CPU architecture tag const.
TagCluster is cluster name tag const.
TagCreated is created time tag const, RFC3339-formatted timestamp.
TagLifetime is lifetime tag const.
TagRoachprod is roachprod tag const, value is true & false.
TagSpotInstance is a tag added to spot instance vms with value as true.
TagUsage indicates where a certain resource is used.
Zfs refers to the zfs file system.

# Variables

Error values for VM.Error.
Error values for VM.Error.
Error values for VM.Error.
Error values for VM.Error.
Providers contains all known Provider instances.
UnimplementedError is returned when a method is not implemented by a provider.

# Structs

CreateOpts is the set of options when creating VMs.
DNSRecord represents a DNS record.
ServiceAddress stores the IP and port of a service.
A VM is an abstract representation of a specific machine instance.
Volume is an abstract representation of a specific volume/disks.
VolumeCreateOpts groups input callers can provide when creating volumes.
VolumeSnapshot is an abstract representation of a specific volume snapshot.
VolumeSnapshotCreateOpts groups input callers can provide when creating volume snapshots.
VolumeSnapshotListOpts provides a way to search for specific volume snapshots.

# Interfaces

DeleteCluster is an optional capability for a Provider which can destroy an entire cluster in a single operation.
DNSProvider is an optional capability for a Provider that provides DNS management services.
A Provider is a source of virtual machines running on some hosting platform.
ProviderOpts is a hook point for Providers to supply additional, provider-specific options to various roachprod commands.

# Type aliases

DNSType represents a DNS record type.
List represents a list of VMs.
MultipleProjectsOption is used to specify whether a command accepts multiple values for the --gce-project flag.
ProviderOptionsContainer is a container for a collection of provider-specific options.