platform

Documentation

Index

• Constants
• Variables
• func ConfigFilePath() (string, error)
• func GlobalFlags(globalFlags *flags.GlobalFlags) (*loftctlflags.GlobalFlags, error)
• func LatestCompatibleVersion(ctx context.Context) (string, error)
• func PrintManagerInfo(verb string, manager ManagerType, log log.Logger)
• func SaveManagerFile(managerConfig *ManagerConfig) error
• type Client
  • func CreatePlatformClient() (Client, error)
• type ManagerConfig
  • func LoadManagerFile() (*ManagerConfig, error)
• type ManagerType
  • func GetManager(manager string) (ManagerType, error)
• type VirtualClusterInstanceProject

Constants

const DefaultPlatformSecretName = "vcluster-platform-api-key"

const (
	VClusterProFolder = "pro"
)

Variables

var (
	MinimumVersionTag = "v3.3.0-alpha.26"
	MinimumVersion    = semver.MustParse(strings.TrimPrefix(MinimumVersionTag, "v"))
)

var ErrConfigNotFound = errors.New("couldn't find vCluster platform config")

var Self *managementv1.Self

Functions

func ConfigFilePath

func ConfigFilePath() (string, error)

ConfigFilePath returns the path to the loft config file

func GlobalFlags

func GlobalFlags(globalFlags *flags.GlobalFlags) (*loftctlflags.GlobalFlags, error)

GlobalFlags converts vcluster global flags to vcluster pro global flags

func LatestCompatibleVersion

func LatestCompatibleVersion(ctx context.Context) (string, error)

LatestCompatibleVersion returns the latest compatible version of vCluster.Pro

func PrintManagerInfo

func PrintManagerInfo(verb string, manager ManagerType, log log.Logger)

func SaveManagerFile

func SaveManagerFile(managerConfig *ManagerConfig) error

Types

type Client

type Client interface {
	loftclient.Client

	Self() *managementv1.Self
	ApplyPlatformSecret(ctx context.Context, kubeClient kubernetes.Interface, name, namespace, project string) error
	ListVClusters(ctx context.Context, virtualClusterName, projectName string) ([]VirtualClusterInstanceProject, error)
}

func CreatePlatformClient

func CreatePlatformClient() (Client, error)

type ManagerConfig

type ManagerConfig struct {
	// Manager is the current manager that is used, either helm or platform
	Manager ManagerType `json:"manager,omitempty"`
}

func LoadManagerFile

func LoadManagerFile() (*ManagerConfig, error)

type ManagerType

type ManagerType string

const (
	ManagerHelm     ManagerType = "helm"
	ManagerPlatform ManagerType = "platform"
)

func GetManager

func GetManager(manager string) (ManagerType, error)

type VirtualClusterInstanceProject

type VirtualClusterInstanceProject struct {
	VirtualCluster *managementv1.VirtualClusterInstance
	Project        *managementv1.Project
}