config

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 29, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultFilePath

func DefaultFilePath() (string, error)

func PrintDriverInfo

func PrintDriverInfo(verb string, driver DriverType, log log.Logger)

func Write

func Write(path string, c *CLI) error

Write writes the config content to the provided path.

Types

type CLI

type CLI struct {
	Driver          Driver `json:"driver,omitempty"`
	PreviousContext string `json:"previousContext,omitempty"`

	Platform          Platform `json:"platform,omitempty"`
	TelemetryDisabled bool     `json:"telemetryDisabled,omitempty"`
	// contains filtered or unexported fields
}

func New

func New() *CLI

New creates a new default config

func Read

func Read(path string, log log.Logger) *CLI

Read returns the current config by trying to read it from the given config path. It returns a new default config if there have been any errors during the read.

func (*CLI) Delete added in v0.22.0

func (c *CLI) Delete() error

func (*CLI) Save

func (c *CLI) Save() error

type Driver

type Driver struct {
	// Type is the current driver type that is used, either helm or platform
	Type DriverType `json:"type,omitempty"`
}

type DriverType

type DriverType string
const (
	DirName  = ".vcluster"
	FileName = "config.json"

	HelmDriver     DriverType = "helm"
	PlatformDriver DriverType = "platform"
	DockerDriver   DriverType = "docker"
)

func ParseDriverType

func ParseDriverType(driver string) (DriverType, error)

type Platform

type Platform struct {
	metav1.TypeMeta `json:",inline"`

	// VirtualClusterAccessKey will only be used as a fallback for older platforms and is deprecated.
	VirtualClusterAccessKey string `json:"virtualClusterAccessKey,omitempty"`

	// VirtualClusterAccessPointCertificates is a map of cached certificates for "access point" mode virtual clusters
	VirtualClusterAccessPointCertificates map[string]VirtualClusterCertificatesEntry `json:"virtualClusterAccessPointCertificates,omitempty"`
	// Host is the https endpoint of how to access loft
	Host string `json:"host,omitempty"`
	// LastInstallContext is the last install context
	LastInstallContext string `json:"lastInstallContext,omitempty"`
	// AccessKey is the access key for the given loft host
	AccessKey string `json:"accesskey,omitempty"`
	// Insecure specifies if the loft instance is insecure
	Insecure bool `json:"insecure,omitempty"`
	// CertificateAuthorityData is passed as certificate-authority-data to the platform config
	CertificateAuthorityData []byte `json:"certificateAuthorityData,omitempty"`
}

type VirtualClusterCertificatesEntry

type VirtualClusterCertificatesEntry struct {
	LastRequested   metav1.Time `json:"lastRequested,omitempty"`
	ExpirationTime  time.Time   `json:"expirationTime,omitempty"`
	CertificateData string      `json:"certificateData,omitempty"`
	KeyData         string      `json:"keyData,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL