cli

Documentation

Index

• Constants
• Variables
• 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 GetVClusterNamespace(ctx context.Context, context, name, namespace string, log log.Logger) (string, error)
• func ImportHelm(ctx context.Context, options *ImportOptions, globalFlags *flags.GlobalFlags, ...) error
• func ImportPlatform(ctx context.Context, options *ImportOptions, globalFlags *flags.GlobalFlags, ...) 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 ConnectOptions
• type CreateOptions
• type DeleteOptions
• type ImportOptions
• type ListOptions
• type ListVCluster
• type PauseOptions
• type ResumeOptions

Constants

const VirtualClusterServiceUIDLabel = "vcluster.loft.sh/service-uid"

Variables

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

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

Functions

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) 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 GetVClusterNamespace

func GetVClusterNamespace(ctx context.Context, context, name, namespace string, log log.Logger) (string, error)

func ImportHelm

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

func ImportPlatform

func ImportPlatform(ctx context.Context, options *ImportOptions, globalFlags *flags.GlobalFlags, vClusterName string, log log.Logger) 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) 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 ConnectOptions

type ConnectOptions struct {
	Manager 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

	Cluster string
	Project string
	User    string
	Team    string
}

type CreateOptions

type CreateOptions struct {
	Manager 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
	CreateContext   bool
	SwitchContext   bool
	Expose          bool
	ExposeLocal     bool
	Connect         bool
	Upgrade         bool

	// Platform
	Activate        bool
	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 {
	Manager string

	Wait                bool
	KeepPVC             bool
	DeleteNamespace     bool
	DeleteContext       bool
	DeleteConfigMap     bool
	AutoDeleteNamespace bool
	IgnoreNotFound      bool

	Project string
}

type ImportOptions

type ImportOptions struct {
	Manager string

	ClusterName string
	Project     string
	ImportName  string
}

type ListOptions

type ListOptions struct {
	Manager 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 {
	Manager string

	Project       string
	ForceDuration int64
}

type ResumeOptions

type ResumeOptions struct {
	Manager string

	Project string
}