Documentation ¶
Index ¶
- Constants
- Variables
- func CommandName() string
- type Config
- type GithubLatestVersioner
- type LatestVersioner
- type LiveConfig
- func (c *LiveConfig) GetBool(ns, key string) (bool, error)
- func (c *LiveConfig) GetBoolPtr(ns, key string) (*bool, error)
- func (c *LiveConfig) GetGodoClient(trace bool, accessToken string) (*godo.Client, error)
- func (c *LiveConfig) GetInt(ns, key string) (int, error)
- func (c *LiveConfig) GetIntPtr(ns, key string) (*int, error)
- func (c *LiveConfig) GetString(ns, key string) (string, error)
- func (c *LiveConfig) GetStringSlice(ns, key string) ([]string, error)
- func (c *LiveConfig) IsSet(key string) bool
- func (c *LiveConfig) SSH(user, host, keyPath string, port int, opts ssh.Options) runner.Runner
- func (c *LiveConfig) Set(ns, key string, val interface{})
- type MissingArgsErr
- type MockRunner
- type TestConfig
- func (c *TestConfig) GetBool(ns, key string) (bool, error)
- func (c *TestConfig) GetBoolPtr(ns, key string) (*bool, error)
- func (c *TestConfig) GetGodoClient(trace bool, accessToken string) (*godo.Client, error)
- func (c *TestConfig) GetInt(ns, key string) (int, error)
- func (c *TestConfig) GetIntPtr(ns, key string) (*int, error)
- func (c *TestConfig) GetString(ns, key string) (string, error)
- func (c *TestConfig) GetStringSlice(ns, key string) ([]string, error)
- func (c *TestConfig) IsSet(key string) bool
- func (c *TestConfig) SSH(user, host, keyPath string, port int, opts ssh.Options) runner.Runner
- func (c *TestConfig) Set(ns, key string, val interface{})
- type Version
Constants ¶
const ( // ArgAccessToken is the access token to be used for the operations ArgAccessToken = "access-token" // ArgContext is the name of the auth context ArgContext = "context" // ArgDefaultContext is the default auth context ArgDefaultContext = "default" // ArgActionID is an action id argument. ArgActionID = "action-id" // ArgActionAfter is an action after argument. ArgActionAfter = "after" // ArgActionBefore is an action before argument. ArgActionBefore = "before" // ArgActionResourceType is an action resource type argument. ArgActionResourceType = "resource-type" // ArgActionRegion is an action region argument. ArgActionRegion = "region" // ArgActionStatus is an action status argument. ArgActionStatus = "status" // ArgActionType is an action type argument. ArgActionType = "action-type" // ArgClusterName is a cluster name argument. ArgClusterName = "cluster-name" // ArgClusterVersionSlug is a cluster version argument. ArgClusterVersionSlug = "version" // ArgClusterNodePool are a cluster's node pools arguments. ArgClusterNodePool = "node-pool" // ArgClusterUpdateKubeconfig updates the local kubeconfig. ArgClusterUpdateKubeconfig = "update-kubeconfig" // ArgNodePoolName is a cluster's node pool name argument. ArgNodePoolName = "name" // ArgNodePoolCount is a cluster's node pool count argument. ArgNodePoolCount = "count" // ArgNodePoolAutoScale is a cluster's node pool auto_scale argument. ArgNodePoolAutoScale = "auto-scale" // ArgNodePoolMinNodes is a cluster's node pool min_nodes argument. ArgNodePoolMinNodes = "min-nodes" // ArgNodePoolMaxNodes is a cluster's node pool max_nodes argument. ArgNodePoolMaxNodes = "max-nodes" // ArgNodePoolNodeIDs is a cluster's node pool nodes argument. ArgNodePoolNodeIDs = "node-ids" // ArgMaintenanceWindow is a cluster's maintenance window argument ArgMaintenanceWindow = "maintenance-window" // ArgAutoUpgrade is a cluster's auto-upgrade argument. ArgAutoUpgrade = "auto-upgrade" // ArgCommandWait is a wait for a resource to be created argument. ArgCommandWait = "wait" // ArgSetCurrentContext is a flag to set the new kubeconfig context as current. ArgSetCurrentContext = "set-current-context" // ArgDropletID is a droplet id argument. ArgDropletID = "droplet-id" // ArgDropletIDs is a list of droplet IDs. ArgDropletIDs = "droplet-ids" // ArgKernelID is a ekrnel id argument. ArgKernelID = "kernel-id" // ArgImage is an image argument. ArgImage = "image" // ArgImageID is an image id argument. ArgImageID = "image-id" // ArgImagePublic is a public image argument. ArgImagePublic = "public" // ArgImageSlug is an image slug argment. ArgImageSlug = "image-slug" // ArgIPAddress is an IP address argument. ArgIPAddress = "ip-address" // ArgDropletName is a droplet name argument. ArgDropletName = "droplet-name" // ArgResizeDisk is a resize disk argument. ArgResizeDisk = "resize-disk" // ArgSnapshotName is a snapshot name argument. ArgSnapshotName = "snapshot-name" // ArgSnapshotDesc is the description for volume snapshot. ArgSnapshotDesc = "snapshot-desc" // ArgResourceType is the resource type for snapshot. ArgResourceType = "resource" // ArgBackups is an enable backups argument. ArgBackups = "enable-backups" // ArgIPv6 is an enable IPv6 argument. ArgIPv6 = "enable-ipv6" // ArgPrivateNetworking is an enable private networking argument. ArgPrivateNetworking = "enable-private-networking" // ArgMonitoring is an enable monitoring argument. ArgMonitoring = "enable-monitoring" // ArgRecordData is a record data argument. ArgRecordData = "record-data" // ArgRecordID is a record id argument. ArgRecordID = "record-id" // ArgRecordName is a record name argument. ArgRecordName = "record-name" // ArgRecordPort is a record port argument. ArgRecordPort = "record-port" // ArgRecordPriority is a record priority argument. ArgRecordPriority = "record-priority" // ArgRecordType is a record type argument. ArgRecordType = "record-type" // ArgRecordTTL is a record ttl argument. ArgRecordTTL = "record-ttl" // ArgRecordWeight is a record weight argument. ArgRecordWeight = "record-weight" // ArgRecordFlags is a record flags argument. ArgRecordFlags = "record-flags" // ArgRecordTag is a record tag argument. ArgRecordTag = "record-tag" // ArgRegionSlug is a region slug argument. ArgRegionSlug = "region" // ArgSizeSlug is a size slug argument. ArgSizeSlug = "size" // ArgsSSHKeyPath is a ssh argument. ArgsSSHKeyPath = "ssh-key-path" // ArgSSHKeys is a ssh key argument. ArgSSHKeys = "ssh-keys" // ArgsSSHPort is a ssh argument. ArgsSSHPort = "ssh-port" // ArgsSSHAgentForwarding is a ssh argument. ArgsSSHAgentForwarding = "ssh-agent-forwarding" // ArgsSSHPrivateIP is a ssh argument. ArgsSSHPrivateIP = "ssh-private-ip" // ArgSSHCommand is a ssh argument. ArgSSHCommand = "ssh-command" // ArgUserData is a user data argument. ArgUserData = "user-data" // ArgUserDataFile is a user data file location argument. ArgUserDataFile = "user-data-file" // ArgImageName name is an image name argument. ArgImageName = "image-name" // ArgImageExternalURL is a URL that returns an image file. ArgImageExternalURL = "image-url" // ArgImageDistro is the name of a custom image's distribution ArgImageDistro = "image-distribution" // ArgImageDescription is free text that describes the image. ArgImageDescription = "image-description" // ArgKey is a key argument. ArgKey = "key" // ArgKeyName is a key name argument. ArgKeyName = "key-name" // ArgKeyPublicKey is a public key argument. ArgKeyPublicKey = "public-key" // ArgKeyPublicKeyFile is a public key file argument. ArgKeyPublicKeyFile = "public-key-file" // ArgSSHUser is a SSH user argument. ArgSSHUser = "ssh-user" // ArgFormat is columns to include in output argment. ArgFormat = "format" // ArgNoHeader hides the output header. ArgNoHeader = "no-header" // ArgPollTime is how long before the next poll argument. ArgPollTime = "poll-timeout" // ArgTagName is a tag name // NOTE: ArgTagName will be deprecated once existing uses have been migrated // to use `--tag` (ArgTag). ArgTagName should not be used on new calls. ArgTagName = "tag-name" // ArgTagNames is a slice of possible tag names // NOTE: ArgTagNames will be deprecated once existing uses have been migrated // to use `--tag` (ArgTag). ArgTagNames should not be used on new calls. ArgTagNames = "tag-names" // ArgTag specifies tag. --tag can be repeated or multiple tags can be , separated. ArgTag = "tag" //ArgTemplate is template format ArgTemplate = "template" // ArgVersion is the version of the command to use ArgVersion = "version" // ArgVerbose enables verbose output ArgVerbose = "verbose" // ArgOutput is an output type argument. ArgOutput = "output" // ArgVolumeSize is the size of a volume. ArgVolumeSize = "size" // ArgVolumeDesc is the description of a volume. ArgVolumeDesc = "desc" // ArgVolumeRegion is the region of a volume. ArgVolumeRegion = "region" // ArgVolumeSnapshot is the snapshot from which to create a volume. ArgVolumeSnapshot = "snapshot" // ArgVolumeFilesystemType is the filesystem type for a volume. ArgVolumeFilesystemType = "fs-type" // ArgVolumeFilesystemLabel is the filesystem label for a volume. ArgVolumeFilesystemLabel = "fs-label" // ArgVolumeList is the IDs of many volumes. ArgVolumeList = "volumes" // ArgCDNTTL is a cdn ttl argument ArgCDNTTL = "ttl" // ArgCDNDomain is a cdn custom domain argument ArgCDNDomain = "domain" // ArgCDNCertificateID is a certificate id to use with a custom domain ArgCDNCertificateID = "certificate-id" // ArgCDNFiles is a cdn files argument ArgCDNFiles = "files" // ArgCertificateName is a name of the certificate. ArgCertificateName = "name" // ArgCertificateDNSNames is a list of DNS names. ArgCertificateDNSNames = "dns-names" // ArgPrivateKeyPath is a path to a private key for the certificate. ArgPrivateKeyPath = "private-key-path" // ArgLeafCertificatePath is a path to a certificate leaf. ArgLeafCertificatePath = "leaf-certificate-path" // ArgCertificateChainPath is a path to a certificate chain. ArgCertificateChainPath = "certificate-chain-path" // ArgCertificateType is a certificate type. ArgCertificateType = "type" // ArgLoadBalancerName is a name of the load balancer. ArgLoadBalancerName = "name" // ArgLoadBalancerAlgorithm is a load balancing algorithm. ArgLoadBalancerAlgorithm = "algorithm" // ArgRedirectHttpToHttps is a flag that indicates whether HTTP requests to the load balancer on port 80 should be redirected to HTTPS on port 443. ArgRedirectHttpToHttps = "redirect-http-to-https" // ArgStickySessions is a list of sticky sessions settings for the load balancer. ArgStickySessions = "sticky-sessions" // ArgHealthCheck is a list of health check settings for the load balancer. ArgHealthCheck = "health-check" // ArgForwardingRules is a list of forwarding rules for the load balancer. ArgForwardingRules = "forwarding-rules" // ArgFirewallName is a name of the firewall. ArgFirewallName = "name" // ArgInboundRules is a list of inbound rules for the firewall. ArgInboundRules = "inbound-rules" // ArgOutboundRules is a list of outbound rules for the firewall. ArgOutboundRules = "outbound-rules" // ArgProjectName is the name of a project. ArgProjectName = "name" // ArgProjectDescription is the description of a project. ArgProjectDescription = "description" // ArgProjectPurpose is the purpose of a project. ArgProjectPurpose = "purpose" // ArgProjectEnvironment is the environment of a project. Should be one of 'Development', 'Staging', 'Production'. ArgProjectEnvironment = "environment" // ArgProjectIsDefault is used to change the default project. ArgProjectIsDefault = "is_default" // ArgProjectResource is a flag for your resource URNs ArgProjectResource = "resource" // ArgDatabaseEngine is a flag for specifying which database engine to use ArgDatabaseEngine = "engine" // ArgDatabaseNumNodes is the number of nodes in the database cluster ArgDatabaseNumNodes = "num-nodes" // ArgDatabaseMaintenanceDay is the new day for the maintenance window ArgDatabaseMaintenanceDay = "day" // ArgDatabaseMaintenanceHour is the new hour for the maintenance window ArgDatabaseMaintenanceHour = "hour" // ArgDatabasePoolUserName is the name of user for use with connection pool ArgDatabasePoolUserName = "user" // ArgDatabasePoolDBName is the database for use with connection pool ArgDatabasePoolDBName = "db" // ArgDatabasePoolSize is the flag for connection pool size ArgDatabasePoolSize = "size" // ArgDatabasePoolMode is the flag for connection pool mode ArgDatabasePoolMode = "mode" // ArgDatabaseUserMySQLAuthPlugin is a flag for setting the MySQL user auth plugin ArgDatabaseUserMySQLAuthPlugin = "mysql-auth-plugin" // ArgPrivateNetworkUUID is the flag for VPC UUID ArgPrivateNetworkUUID = "private-network-uuid" // ArgForce forces confirmation on actions ArgForce = "force" // ArgObjectName is the Kubernetes object name ArgObjectName = "name" // ArgObjectNamespace is the Kubernetes object namespace ArgObjectNamespace = "namespace" )
const (
// ArgShortForce forces confirmation on actions
ArgShortForce = "f"
)
const (
// LatestReleaseURL is the latest release URL endpoint.
LatestReleaseURL = "https://api.github.com/repos/digitalocean/doctl/releases/latest"
)
Variables ¶
var (
// Build, Major, Minor, Patch and Label are set at build time
Build, Major, Minor, Patch, Label string
// DoitVersion is doctl's version.
DoitVersion Version
// TraceHTTP traces http connections.
TraceHTTP bool
)
Functions ¶
func CommandName ¶ added in v1.21.0
func CommandName() string
CommandName returns the name by which doctl was invoked
Types ¶
type Config ¶
type Config interface { GetGodoClient(trace bool, accessToken string) (*godo.Client, error) SSH(user, host, keyPath string, port int, opts ssh.Options) runner.Runner Set(ns, key string, val interface{}) IsSet(key string) bool GetString(ns, key string) (string, error) GetBool(ns, key string) (bool, error) GetBoolPtr(ns, key string) (*bool, error) GetInt(ns, key string) (int, error) GetIntPtr(ns, key string) (*int, error) GetStringSlice(ns, key string) ([]string, error) }
Config is an interface that represent doit's config.
type GithubLatestVersioner ¶ added in v1.0.0
type GithubLatestVersioner struct{}
GithubLatestVersioner retrieves the latest version from Github.
func (*GithubLatestVersioner) LatestVersion ¶ added in v1.0.0
func (glv *GithubLatestVersioner) LatestVersion() (string, error)
LatestVersion retrieves the latest version from Github or returns an error.
type LatestVersioner ¶ added in v1.0.0
LatestVersioner an interface for detecting the latest version.
type LiveConfig ¶
type LiveConfig struct {
// contains filtered or unexported fields
}
LiveConfig is an implementation of Config for live values.
func (*LiveConfig) GetBool ¶ added in v0.5.0
func (c *LiveConfig) GetBool(ns, key string) (bool, error)
GetBool returns a config value as a bool.
func (*LiveConfig) GetBoolPtr ¶ added in v1.31.0
func (c *LiveConfig) GetBoolPtr(ns, key string) (*bool, error)
GetBoolPtr returns a config value as a bool pointer.
func (*LiveConfig) GetGodoClient ¶ added in v0.5.0
GetGodoClient returns a GodoClient.
func (*LiveConfig) GetInt ¶ added in v0.5.0
func (c *LiveConfig) GetInt(ns, key string) (int, error)
GetInt returns a config value as an int.
func (*LiveConfig) GetIntPtr ¶ added in v1.31.0
func (c *LiveConfig) GetIntPtr(ns, key string) (*int, error)
GetIntPtr returns a config value as an int pointer.
func (*LiveConfig) GetString ¶ added in v0.5.0
func (c *LiveConfig) GetString(ns, key string) (string, error)
GetString returns a config value as a string.
func (*LiveConfig) GetStringSlice ¶ added in v0.5.0
func (c *LiveConfig) GetStringSlice(ns, key string) ([]string, error)
GetStringSlice returns a config value as a string slice.
func (*LiveConfig) IsSet ¶ added in v1.11.0
func (c *LiveConfig) IsSet(key string) bool
func (*LiveConfig) Set ¶ added in v0.5.0
func (c *LiveConfig) Set(ns, key string, val interface{})
Set sets a config key.
type MissingArgsErr ¶ added in v0.5.0
type MissingArgsErr struct {
Command string
}
MissingArgsErr is returned when there are too few arguments for a command.
func NewMissingArgsErr ¶ added in v0.5.0
func NewMissingArgsErr(cmd string) *MissingArgsErr
NewMissingArgsErr creates a MissingArgsErr instance.
func (*MissingArgsErr) Error ¶ added in v0.5.0
func (e *MissingArgsErr) Error() string
type MockRunner ¶ added in v0.5.0
type MockRunner struct {
Err error
}
MockRunner is an implemenation of Runner for mocking.
type TestConfig ¶
type TestConfig struct { SSHFn func(user, host, keyPath string, port int, opts ssh.Options) runner.Runner IsSetMap map[string]bool // contains filtered or unexported fields }
TestConfig is an implementation of Config for testing.
func NewTestConfig ¶
func NewTestConfig() *TestConfig
NewTestConfig creates a new, ready-to-use instance of a TestConfig.
func (*TestConfig) GetBool ¶ added in v1.22.0
func (c *TestConfig) GetBool(ns, key string) (bool, error)
GetBool returns the bool value for the key in the given namespace. Because this is a mock implementation, and error will never be returned.
func (*TestConfig) GetBoolPtr ¶ added in v1.31.0
func (c *TestConfig) GetBoolPtr(ns, key string) (*bool, error)
GetBoolPtr returns the bool value for the key in the given namespace. Because this is a mock implementation, and error will never be returned.
func (*TestConfig) GetGodoClient ¶ added in v1.22.0
GetGodoClient mocks a GetGodoClient call. The returned godo client will be nil.
func (*TestConfig) GetInt ¶ added in v1.22.0
func (c *TestConfig) GetInt(ns, key string) (int, error)
GetInt returns the int value for the key in the given namespace. Because this is a mock implementation, and error will never be returned.
func (*TestConfig) GetIntPtr ¶ added in v1.31.0
func (c *TestConfig) GetIntPtr(ns, key string) (*int, error)
GetIntPtr returns the int value for the key in the given namespace. Because this is a mock implementation, and error will never be returned.
func (*TestConfig) GetString ¶ added in v1.22.0
func (c *TestConfig) GetString(ns, key string) (string, error)
GetString returns the string value for the key in the given namespace. Because this is a mock implementation, and error will never be returned.
func (*TestConfig) GetStringSlice ¶ added in v1.22.0
func (c *TestConfig) GetStringSlice(ns, key string) ([]string, error)
GetStringSlice returns the string slice value for the key in the given namespace. Because this is a mock implementation, and error will never be returned.
func (*TestConfig) IsSet ¶ added in v1.22.0
func (c *TestConfig) IsSet(key string) bool
IsSet returns true if the given key is set on the config.
func (*TestConfig) Set ¶ added in v1.22.0
func (c *TestConfig) Set(ns, key string, val interface{})
Set sets a config key.