cmd

Documentation

Index

• Constants
• Variables
• func ClusterFlagValue() string
• func DeleteProfiles(profiles []*config.Profile) []error
• func Execute()
• func GenerateBashCompletion(w io.Writer, cmd *cobra.Command) error
• func GenerateFishCompletion(w io.Writer, cmd *cobra.Command) error
• func GenerateZshCompletion(out io.Writer, cmd *cobra.Command) error
• func HandleDeletionErrors(errors []error)
• func KubectlCommand(version string, args ...string) (*exec.Cmd, error)
• type BaseState
• type CacheListTemplate
• type ClusterState
• type DeletionError
  • func (error DeletionError) Error() string
• type DockerEnvConfig
• type DockerShellConfig
• type EnvNoProxyGetter
  • func (EnvNoProxyGetter) GetNoProxyVar() (string, string)
• type NoProxyGetter
• type NodeState
• type PodmanEnvConfig
• type PodmanShellConfig
• type Status

Constants

const (
	// Fatal is a type of DeletionError
	Fatal typeOfError = 0
	// MissingProfile is a type of DeletionError
	MissingProfile typeOfError = 1
	// MissingCluster is a type of DeletionError
	MissingCluster typeOfError = 2
)

const (

	// Configured means configured
	Configured = "Configured" // ~state.Saved
	// Misconfigured means misconfigured
	Misconfigured = "Misconfigured" // ~state.Error
	// Nonexistent means the resource does not exist
	Nonexistent = "Nonexistent" // ~state.None
	// Irrelevant is used for statuses that aren't meaningful for worker nodes
	Irrelevant = "Irrelevant"

	Starting  = 100
	Pausing   = 101
	Unpausing = 102
	Stopping  = 110
	Deleting  = 120

	OK      = 200
	Warning = 203

	NotFound = 404
	Stopped  = 405
	Paused   = 418 // I'm a teapot!

	Error               = 500
	InsufficientStorage = 507
	Unknown             = 520
)

Variables

var RootCmd = &cobra.Command{
	Use:   "minikube",
	Short: "minikube quickly sets up a local Kubernetes cluster",
	Long:  `minikube provisions and manages local Kubernetes clusters optimized for development workflows.`,
	PersistentPreRun: func(cmd *cobra.Command, args []string) {
		for _, path := range dirs {
			if err := os.MkdirAll(path, 0o777); err != nil {
				exit.Error(reason.HostHomeMkdir, "Error creating minikube directory", err)
			}
		}
	},
}

RootCmd represents the base command when called without any subcommands

Functions

func ClusterFlagValue

func ClusterFlagValue() string

ClusterFlagValue returns the current cluster name based on flags

func DeleteProfiles

func DeleteProfiles(profiles []*config.Profile) []error

DeleteProfiles deletes one or more profiles

func Execute

func Execute()

Execute adds all child commands to the root command sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func GenerateBashCompletion

func GenerateBashCompletion(w io.Writer, cmd *cobra.Command) error

GenerateBashCompletion generates the completion for the bash shell

func GenerateFishCompletion

func GenerateFishCompletion(w io.Writer, cmd *cobra.Command) error

GenerateFishCompletion generates the completion for the bash shell

func GenerateZshCompletion

func GenerateZshCompletion(out io.Writer, cmd *cobra.Command) error

GenerateZshCompletion generates the completion for the zsh shell

func HandleDeletionErrors

func HandleDeletionErrors(errors []error)

HandleDeletionErrors handles deletion errors from DeleteProfiles

func KubectlCommand

func KubectlCommand(version string, args ...string) (*exec.Cmd, error)

KubectlCommand will return kubectl command with a version matching the cluster

Types

type BaseState

type BaseState struct {
	// Name is the name of the object
	Name string

	// StatusCode is an HTTP-like status code for this object
	StatusCode int
	// Name is a human-readable name for the status code
	StatusName string
	// StatusDetail is long human-readable string describing why this particular status code was chosen
	StatusDetail string `json:",omitempty"` // Not yet implemented

	// Step is which workflow step the object is at.
	Step string `json:",omitempty"`
	// StepDetail is a long human-readable string describing the step
	StepDetail string `json:",omitempty"`
}

BaseState holds a component state representation, such as "apiserver" or "kubeconfig"

type CacheListTemplate

type CacheListTemplate struct {
	CacheImage string
}

CacheListTemplate represents the cache list template

type ClusterState

type ClusterState struct {
	BaseState

	BinaryVersion string
	TimeToStop    string
	Components    map[string]BaseState
	Nodes         []NodeState
}

ClusterState holds a cluster state representation

type DeletionError

type DeletionError struct {
	Err     error
	Errtype typeOfError
}

DeletionError can be returned from DeleteProfiles

func (DeletionError) Error

func (error DeletionError) Error() string

type DockerEnvConfig

type DockerEnvConfig struct {
	shell.EnvConfig
	// contains filtered or unexported fields
}

DockerEnvConfig encapsulates all external inputs into shell generation for Docker

type DockerShellConfig

type DockerShellConfig struct {
	shell.Config
	DockerCertPath         string
	DockerHost             string
	DockerTLSVerify        string
	MinikubeDockerdProfile string
	NoProxyVar             string
	NoProxyValue           string

	ExistingDockerCertPath  string
	ExistingDockerHost      string
	ExistingDockerTLSVerify string
}

DockerShellConfig represents the shell config for Docker

type EnvNoProxyGetter

type EnvNoProxyGetter struct{}

EnvNoProxyGetter gets the no_proxy variable, using environment

func (EnvNoProxyGetter) GetNoProxyVar

func (EnvNoProxyGetter) GetNoProxyVar() (string, string)

GetNoProxyVar gets the no_proxy var

type NoProxyGetter

type NoProxyGetter interface {
	GetNoProxyVar() (string, string)
}

NoProxyGetter gets the no_proxy variable

type NodeState

type NodeState struct {
	BaseState
	Components map[string]BaseState `json:",omitempty"`
}

NodeState holds a node state representation

type PodmanEnvConfig

type PodmanEnvConfig struct {
	shell.EnvConfig
	// contains filtered or unexported fields
}

PodmanEnvConfig encapsulates all external inputs into shell generation for Podman

type PodmanShellConfig

type PodmanShellConfig struct {
	shell.Config
	VarlinkBridge         string
	ContainerHost         string
	ContainerSSHKey       string
	MinikubePodmanProfile string

	ExistingContainerHost string
}

PodmanShellConfig represents the shell config for Podman

type Status

type Status struct {
	Name       string
	Host       string
	Kubelet    string
	APIServer  string
	Kubeconfig string
	Worker     bool
	TimeToStop string
}

Status holds string representations of component states