config

Documentation

Index

• Constants
• func ParseExtraHooks(valHooks []config.ValidatingWebhookConfiguration, ...) ([]admissionregistrationv1.ValidatingWebhookConfiguration, ...)
• func ValidateConfigAndSetDefaults(config *VirtualClusterConfig) error
• type Clients
• type ControllerContext
• type Filter
• type Hook
• type VirtualClusterConfig
  • func ParseConfig(path, name string, setValues []string) (*VirtualClusterConfig, error)
  • func (v VirtualClusterConfig) DisableMissingAPIs(discoveryClient discovery.DiscoveryInterface) error
  • func (v VirtualClusterConfig) EmbeddedDatabase() bool
  • func (v VirtualClusterConfig) LegacyOptions() (*legacyconfig.LegacyVirtualClusterOptions, error)
  • func (v VirtualClusterConfig) VirtualClusterKubeConfig() config.VirtualClusterKubeConfig

Constants

const (
	DefaultHostsRewriteImage = "library/alpine:3.20"
)

Functions

func ParseExtraHooks

func ParseExtraHooks(valHooks []config.ValidatingWebhookConfiguration, mutHooks []config.MutatingWebhookConfiguration) ([]admissionregistrationv1.ValidatingWebhookConfiguration, []admissionregistrationv1.MutatingWebhookConfiguration, error)

func ValidateConfigAndSetDefaults

func ValidateConfigAndSetDefaults(config *VirtualClusterConfig) error

Types

type Clients

type Clients struct {
	UncachedVirtualClient client.Client
	CachedVirtualClient   client.Client

	UncachedHostClient client.Client
	CachedHostClient   client.Client

	HostConfig    *rest.Config
	VirtualConfig *rest.Config
}

type ControllerContext

type ControllerContext struct {
	Context context.Context

	LocalManager          ctrl.Manager
	VirtualManager        ctrl.Manager
	VirtualRawConfig      *clientcmdapi.Config
	VirtualClusterVersion *version.Info

	WorkloadNamespaceClient client.Client

	Config   *VirtualClusterConfig
	StopChan <-chan struct{}

	// PreServerHooks are extra filters to inject into the server before everything else
	PreServerHooks []Filter

	// PostServerHooks are extra filters to inject into the server after everything else
	PostServerHooks []Filter

	// AcquiredLeaderHooks are hooks to start after vCluster acquired leader
	AcquiredLeaderHooks []Hook
}

type Filter

type Filter func(http.Handler, Clients) http.Handler

type Hook

type Hook func(ctx *ControllerContext) error

type VirtualClusterConfig

type VirtualClusterConfig struct {
	// Holds the vCluster config
	config.Config `json:",inline"`

	// WorkloadConfig is the config to access the workload cluster
	WorkloadConfig *rest.Config `json:"-"`

	// WorkloadClient is the client to access the workload cluster
	WorkloadClient kubernetes.Interface `json:"-"`

	// ControlPlaneConfig is the config to access the control plane cluster
	ControlPlaneConfig *rest.Config `json:"-"`

	// ControlPlaneClient is the client to access the control plane cluster
	ControlPlaneClient kubernetes.Interface `json:"-"`

	// Name is the name of the vCluster
	Name string `json:"name"`

	// WorkloadService is the name of the service of the vCluster
	WorkloadService string `json:"workloadService,omitempty"`

	// WorkloadNamespace is the namespace of the target cluster
	WorkloadNamespace string `json:"workloadNamespace,omitempty"`

	// WorkloadTargetNamespace is the namespace of the target cluster where the workloads should get created in
	WorkloadTargetNamespace string `json:"workloadTargetNamespace,omitempty"`

	// ControlPlaneService is the name of the service for the vCluster control plane
	ControlPlaneService string `json:"controlPlaneService,omitempty"`

	// ControlPlaneNamespace is the namespace where the vCluster control plane is running
	ControlPlaneNamespace string `json:"controlPlaneNamespace,omitempty"`
}

VirtualClusterConfig wraps the config and adds extra info such as name, serviceName and targetNamespace

func ParseConfig

func ParseConfig(path, name string, setValues []string) (*VirtualClusterConfig, error)

func (VirtualClusterConfig) DisableMissingAPIs

func (v VirtualClusterConfig) DisableMissingAPIs(discoveryClient discovery.DiscoveryInterface) error

DisableMissingAPIs checks if the apis are enabled, if any are missing, disable the syncer and print a log

func (VirtualClusterConfig) EmbeddedDatabase

func (v VirtualClusterConfig) EmbeddedDatabase() bool

func (VirtualClusterConfig) LegacyOptions

func (v VirtualClusterConfig) LegacyOptions() (*legacyconfig.LegacyVirtualClusterOptions, error)

LegacyOptions converts the config to the legacy cluster options

func (VirtualClusterConfig) VirtualClusterKubeConfig

func (v VirtualClusterConfig) VirtualClusterKubeConfig() config.VirtualClusterKubeConfig