cmd

Documentation

Index

• Constants
• Variables
• func BuildRoot(log log.Logger) *cobra.Command
• func Execute()
• func GetKubeConfig(ctx context.Context, kubeClient *kubernetes.Clientset, vclusterName string, ...) (*api.Config, error)
• func GetPodStatus(pod *corev1.Pod) string
• func NewBashCommand() *cobra.Command
• func NewCompletionCmd() *cobra.Command
• func NewConnectCmd(globalFlags *flags.GlobalFlags) *cobra.Command
• func NewCreateCmd(globalFlags *flags.GlobalFlags) *cobra.Command
• func NewDeleteCmd(globalFlags *flags.GlobalFlags) *cobra.Command
• func NewListCmd(globalFlags *flags.GlobalFlags) *cobra.Command
• func NewPauseCmd(globalFlags *flags.GlobalFlags) *cobra.Command
• func NewResumeCmd(globalFlags *flags.GlobalFlags) *cobra.Command
• func NewRootCmd(log log.Logger) *cobra.Command
• func NewUpgradeCmd() *cobra.Command
• func NewZshCommand() *cobra.Command
• type ConnectCmd
  • func (cmd *ConnectCmd) Connect(vclusterName string, command []string) error
  • func (cmd *ConnectCmd) Run(args []string) error
• type CreateCmd
  • func (cmd *CreateCmd) Run(args []string) error
  • func (cmd *CreateCmd) ToChartOptions(kubernetesVersion *version.Info) (*helm.ChartOptions, error)
• type DeleteCmd
  • func (cmd *DeleteCmd) Run(cobraCmd *cobra.Command, args []string) error
• type ListCmd
  • func (cmd *ListCmd) Run(cobraCmd *cobra.Command, args []string) error
• type PauseCmd
  • func (cmd *PauseCmd) Run(args []string) error
• type ResumeCmd
  • func (cmd *ResumeCmd) Run(args []string) error
• type UpgradeCmd
  • func (cmd *UpgradeCmd) Run(cobraCmd *cobra.Command, args []string) error
• type VCluster

Constants

const VirtualClusterSelector = "app=vcluster"

Variables

var (
	PausedAnnotation         = "loft.sh/paused"
	PausedReplicasAnnotation = "loft.sh/paused-replicas"
)

var (
	AllowedDistros = []string{"k3s", "k0s", "k8s", "eks"}
)

Functions

func BuildRoot

func BuildRoot(log log.Logger) *cobra.Command

BuildRoot creates a new root command from the

func Execute

func Execute()

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

func GetKubeConfig

func GetKubeConfig(ctx context.Context, kubeClient *kubernetes.Clientset, vclusterName string, restConfig *rest.Config, podName, namespace string, log log.Logger) (*api.Config, error)

GetKubeConfig attempts to read the kubeconfig from the default Secret and falls back to reading from filesystem if the Secret is not read successfully. Reading from filesystem is implemented for the backward compatibility and can be eventually removed in the future.

This is retried until the kube config is successfully retrieve, or until 10 minute timeout is reached.

func GetPodStatus

func GetPodStatus(pod *corev1.Pod) string

GetPodStatus returns the pod status as a string Taken from https://github.com/kubernetes/kubernetes/pkg/printers/internalversion/printers.go

func NewBashCommand

func NewBashCommand() *cobra.Command

func NewCompletionCmd

func NewCompletionCmd() *cobra.Command

func NewConnectCmd

func NewConnectCmd(globalFlags *flags.GlobalFlags) *cobra.Command

NewConnectCmd creates a new command

func NewCreateCmd

func NewCreateCmd(globalFlags *flags.GlobalFlags) *cobra.Command

NewCreateCmd creates a new command

func NewDeleteCmd

func NewDeleteCmd(globalFlags *flags.GlobalFlags) *cobra.Command

NewDeleteCmd creates a new command

func NewListCmd

func NewListCmd(globalFlags *flags.GlobalFlags) *cobra.Command

NewListCmd creates a new command

func NewPauseCmd

func NewPauseCmd(globalFlags *flags.GlobalFlags) *cobra.Command

NewPauseCmd creates a new command

func NewResumeCmd

func NewResumeCmd(globalFlags *flags.GlobalFlags) *cobra.Command

NewResumeCmd creates a new command

func NewRootCmd

func NewRootCmd(log log.Logger) *cobra.Command

NewRootCmd returns a new root command

func NewUpgradeCmd

func NewUpgradeCmd() *cobra.Command

NewUpgradeCmd creates a new upgrade command

func NewZshCommand

func NewZshCommand() *cobra.Command

Types

type ConnectCmd

type ConnectCmd struct {
	*flags.GlobalFlags

	KubeConfig    string
	PodName       string
	UpdateCurrent bool
	Print         bool
	LocalPort     int
	Address       string

	ServiceAccount            string
	ServiceAccountClusterRole string
	ServiceAccountExpiration  int

	Server   string
	Insecure bool

	Log log.Logger
}

ConnectCmd holds the cmd flags

func (*ConnectCmd) Connect

func (cmd *ConnectCmd) Connect(vclusterName string, command []string) error

func (*ConnectCmd) Run

func (cmd *ConnectCmd) Run(args []string) error

Run executes the functionality

type CreateCmd

type CreateCmd struct {
	*flags.GlobalFlags
	create.CreateOptions
	// contains filtered or unexported fields
}

CreateCmd holds the login cmd flags

func (*CreateCmd) Run

func (cmd *CreateCmd) Run(args []string) error

Run executes the functionality

func (*CreateCmd) ToChartOptions

func (cmd *CreateCmd) ToChartOptions(kubernetesVersion *version.Info) (*helm.ChartOptions, error)

type DeleteCmd

type DeleteCmd struct {
	*flags.GlobalFlags

	KeepPVC         bool
	DeleteNamespace bool
	// contains filtered or unexported fields
}

DeleteCmd holds the login cmd flags

func (*DeleteCmd) Run

func (cmd *DeleteCmd) Run(cobraCmd *cobra.Command, args []string) error

Run executes the functionality

type ListCmd

type ListCmd struct {
	*flags.GlobalFlags
	// contains filtered or unexported fields
}

ListCmd holds the login cmd flags

func (*ListCmd) Run

func (cmd *ListCmd) Run(cobraCmd *cobra.Command, args []string) error

Run executes the functionality

type PauseCmd

type PauseCmd struct {
	*flags.GlobalFlags
	Log log.Logger
}

PauseCmd holds the cmd flags

func (*PauseCmd) Run

func (cmd *PauseCmd) Run(args []string) error

Run executes the functionality

type ResumeCmd

type ResumeCmd struct {
	*flags.GlobalFlags
	Log log.Logger
}

ResumeCmd holds the cmd flags

func (*ResumeCmd) Run

func (cmd *ResumeCmd) Run(args []string) error

Run executes the functionality

type UpgradeCmd

type UpgradeCmd struct {
	Version string
	// contains filtered or unexported fields
}

UpgradeCmd is a struct that defines a command call for "upgrade"

func (*UpgradeCmd) Run

func (cmd *UpgradeCmd) Run(cobraCmd *cobra.Command, args []string) error

Run executes the command logic

type VCluster

type VCluster struct {
	Name       string
	Namespace  string
	Created    time.Time
	AgeSeconds int
	Status     string
}

VCluster holds information about a cluster