cli

Documentation

Index

• Variables
• func AddVClusterHelm(ctx context.Context, options *AddVClusterOptions, ...) error
• func ConnectHelm(ctx context.Context, options *ConnectOptions, globalFlags *flags.GlobalFlags, ...) error
• func ConnectPlatform(ctx context.Context, options *ConnectOptions, globalFlags *flags.GlobalFlags, ...) error
• func CreateHelm(ctx context.Context, options *CreateOptions, globalFlags *flags.GlobalFlags, ...) error
• func CreatePlatform(ctx context.Context, options *CreateOptions, globalFlags *flags.GlobalFlags, ...) error
• func DeleteHelm(ctx context.Context, options *DeleteOptions, globalFlags *flags.GlobalFlags, ...) error
• func DeletePlatform(ctx context.Context, options *DeleteOptions, config *config.CLI, ...) error
• func DescribeHelm(ctx context.Context, flags *flags.GlobalFlags, output io.Writer, ...) error
• func DescribePlatform(ctx context.Context, globalFlags *flags.GlobalFlags, output io.Writer, ...) error
• func ListHelm(ctx context.Context, options *ListOptions, globalFlags *flags.GlobalFlags, ...) error
• func ListPlatform(ctx context.Context, options *ListOptions, globalFlags *flags.GlobalFlags, ...) error
• func PauseHelm(ctx context.Context, globalFlags *flags.GlobalFlags, vClusterName string, ...) error
• func PausePlatform(ctx context.Context, options *PauseOptions, cfg *cliconfig.CLI, ...) error
• func ResumeHelm(ctx context.Context, globalFlags *flags.GlobalFlags, vClusterName string, ...) error
• func ResumePlatform(ctx context.Context, options *ResumeOptions, config *config.CLI, ...) error
• type AddVClusterOptions
• type ConnectOptions
• type CreateOptions
• type DeleteOptions
• type DescribeOutput
• type ImageTag
• type ListOptions
• type ListVCluster
• type PauseOptions
• type ResumeOptions

Variables

var AllowedDistros = []string{config.K8SDistro, config.K3SDistro, config.K0SDistro}

var CreatedByVClusterAnnotation = "vcluster.loft.sh/created"

var ErrPlatformDriverRequired = errors.New("cannot resume a virtual cluster that is paused by the platform, please run 'vcluster use driver platform' or use the '--driver platform' flag")

Functions

func AddVClusterHelm

func AddVClusterHelm(
	ctx context.Context,
	options *AddVClusterOptions,
	globalFlags *flags.GlobalFlags,
	args []string,
	log log.Logger,
) error

func ConnectHelm

func ConnectHelm(ctx context.Context, options *ConnectOptions, globalFlags *flags.GlobalFlags, vClusterName string, command []string, log log.Logger) error

func ConnectPlatform

func ConnectPlatform(ctx context.Context, options *ConnectOptions, globalFlags *flags.GlobalFlags, vClusterName string, command []string, log log.Logger) error

func CreateHelm

func CreateHelm(ctx context.Context, options *CreateOptions, globalFlags *flags.GlobalFlags, vClusterName string, log log.Logger, reuseNamespace bool) error

func CreatePlatform

func CreatePlatform(ctx context.Context, options *CreateOptions, globalFlags *flags.GlobalFlags, virtualClusterName string, log log.Logger) error

func DeleteHelm

func DeleteHelm(ctx context.Context, options *DeleteOptions, globalFlags *flags.GlobalFlags, vClusterName string, log log.Logger) error

func DeletePlatform

func DeletePlatform(ctx context.Context, options *DeleteOptions, config *config.CLI, vClusterName string, log log.Logger) error

func DescribeHelm

func DescribeHelm(ctx context.Context, flags *flags.GlobalFlags, output io.Writer, name, format string) error

func DescribePlatform

func DescribePlatform(ctx context.Context, globalFlags *flags.GlobalFlags, output io.Writer, l log.Logger, name, projectName, format string) error

func ListHelm

func ListHelm(ctx context.Context, options *ListOptions, globalFlags *flags.GlobalFlags, log log.Logger) error

func ListPlatform

func ListPlatform(ctx context.Context, options *ListOptions, globalFlags *flags.GlobalFlags, logger log.Logger, projectName string) error

func PauseHelm

func PauseHelm(ctx context.Context, globalFlags *flags.GlobalFlags, vClusterName string, log log.Logger) error

func PausePlatform

func PausePlatform(ctx context.Context, options *PauseOptions, cfg *cliconfig.CLI, vClusterName string, log log.Logger) error

func ResumeHelm

func ResumeHelm(ctx context.Context, globalFlags *flags.GlobalFlags, vClusterName string, log log.Logger) error

func ResumePlatform

func ResumePlatform(ctx context.Context, options *ResumeOptions, config *config.CLI, vClusterName string, log log.Logger) error

Types

type AddVClusterOptions

type AddVClusterOptions struct {
	Project                  string
	ImportName               string
	Restart                  bool
	Insecure                 bool
	AccessKey                string
	Host                     string
	CertificateAuthorityData []byte
	All                      bool
}

type ConnectOptions

type ConnectOptions struct {
	Driver string

	ServiceAccountClusterRole string
	PodName                   string
	Address                   string
	KubeConfigContextName     string
	Server                    string
	KubeConfig                string
	ServiceAccount            string
	LocalPort                 int
	ServiceAccountExpiration  int
	Print                     bool
	UpdateCurrent             bool
	BackgroundProxy           bool
	Insecure                  bool

	Project string
}

type CreateOptions

type CreateOptions struct {
	Driver string

	KubeConfigContextName string
	ChartVersion          string
	ChartName             string
	ChartRepo             string
	LocalChartDir         string
	Distro                string
	Values                []string
	SetValues             []string
	Print                 bool

	KubernetesVersion string

	CreateNamespace bool
	UpdateCurrent   bool
	BackgroundProxy bool
	Add             bool
	Expose          bool
	ExposeLocal     bool
	Connect         bool
	Upgrade         bool

	// Platform
	Project         string
	Cluster         string
	Template        string
	TemplateVersion string
	Links           []string
	Annotations     []string
	Labels          []string
	Params          string
	SetParams       []string
	Description     string
	DisplayName     string
	Team            string
	User            string
	UseExisting     bool
	Recreate        bool
	SkipWait        bool
}

CreateOptions holds the create cmd options

type DeleteOptions

type DeleteOptions struct {
	Driver string

	Project             string
	Wait                bool
	KeepPVC             bool
	DeleteNamespace     bool
	DeleteContext       bool
	DeleteConfigMap     bool
	AutoDeleteNamespace bool
	IgnoreNotFound      bool
}

type DescribeOutput

type DescribeOutput struct {
	Distro       string   `json:"distro"`
	Version      string   `json:"version"`
	BackingStore string   `json:"backingStore"`
	ImageTags    ImageTag `json:"imageTags"`
}

type ImageTag

type ImageTag struct {
	APIServer         string `json:"apiServer,omitempty"`
	Syncer            string `json:"syncer,omitempty"`
	Scheduler         string `json:"scheduler,omitempty"`
	ControllerManager string `json:"controllerManager,omitempty"`
}

type ListOptions

type ListOptions struct {
	Driver string

	Output string
}

type ListVCluster

type ListVCluster struct {
	Created    time.Time
	Name       string
	Namespace  string
	Version    string
	Status     string
	AgeSeconds int
	Connected  bool
}

ListVCluster holds information about a cluster

type PauseOptions

type PauseOptions struct {
	Driver string

	Project       string
	ForceDuration int64
}

type ResumeOptions

type ResumeOptions struct {
	Driver string

	Project string
}