Documentation
¶
Index ¶
- Constants
- Variables
- func GetInstanceStoragePVPlacementFailedTTL() time.Duration
- func GetInstanceStorageRequeueDelay() time.Duration
- func GetNetworkProviderType() string
- func GetPrivilegedUsers() map[string]struct{}
- func GetVMOpNamespaceFromEnv() (string, error)
- func IsNotFoundError(err error) bool
- func IsVMServiceV1Alpha2FSSEnabled() bool
- func SetVMOpNamespaceEnv(namespace string) error
Constants ¶
const ( TrueString = "true" FalseString = "false" VmopNamespaceEnv = "POD_NAMESPACE" WcpFaultDomainsFSS = "FSS_WCP_FAULTDOMAINS" VMServiceV1Alpha2FSS = "FSS_WCP_VMSERVICE_V1ALPHA2" InstanceStorageFSS = "FSS_WCP_INSTANCE_STORAGE" UnifiedTKGFSS = "FSS_WCP_Unified_TKG" VMClassAsConfigFSS = "FSS_WCP_VM_CLASS_AS_CONFIG" VMClassAsConfigDaynDateFSS = "FSS_WCP_VM_CLASS_AS_CONFIG_DAYNDATE" VMImageRegistryFSS = "FSS_WCP_VM_IMAGE_REGISTRY" NamespacedVMClassFSS = "FSS_WCP_NAMESPACED_VM_CLASS" WindowsSysprepFSS = "FSS_WCP_WINDOWS_SYSPREP" VMServiceBackupRestoreFSS = "FSS_WCP_VMSERVICE_BACKUPRESTORE" MaxCreateVMsOnProviderEnv = "MAX_CREATE_VMS_ON_PROVIDER" DefaultMaxCreateVMsOnProvider = 80 // PrivilegedUsersEnv is the key for the environment variable // containing a set of privileged users. Currently, users pointed by // this env variable (if VM Service Backup/Restore FSS is enabled), // along with kube-admin and system users are allowed to make changes // to certain restricted annotations on a VirtualMachine resource. PrivilegedUsersEnv = "PRIVILEGED_USERS" InstanceStoragePVPlacementFailedTTLEnv = "INSTANCE_STORAGE_PV_PLACEMENT_FAILED_TTL" // DefaultInstanceStoragePVPlacementFailedTTL is the default wait time before declaring PV placement failed // after error annotation is set on PVC. DefaultInstanceStoragePVPlacementFailedTTL = 5 * time.Minute // InstanceStorageJitterMaxFactorEnv is env variable for setting max factor to be used in wait.Jitter // for instance storage. InstanceStorageJitterMaxFactorEnv = "INSTANCE_STORAGE_JITTER_MAX_FACTOR" // DefaultInstanceStorageJitterMaxFactor is the default max factor to compute jitter requeue duration // for instance storage. // Note that wait.Jitter sets the maxFactor to 1.0 if the input maxFactor is <= 0.0. With this default // max factor and 10s default seed duration, wait.Jitter returns requeue delay between 11 and 19. // These numbers ensures multiple reconcile threads aren't re queuing VMs at the exact interval. We want // to have a little entropy around the requeue time. DefaultInstanceStorageJitterMaxFactor = 1.0 // InstanceStorageSeedRequeueDurationEnv is environment variable for setting seed requeue // duration for instance storage. InstanceStorageSeedRequeueDurationEnv = "INSTANCE_STORAGE_SEED_REQUEUE_DURATION" // DefaultInstanceStorageSeedRequeueDuration is the default seed requeue duration for instance storage. DefaultInstanceStorageSeedRequeueDuration = 10 * time.Second // NetworkProviderType is the cluster network provider type. Valid values // include: NAMED, NSXT, VSPHERE_NETWORK. Please note that NAMED is only // used for testing and is not supported in production environments. NetworkProviderType = "NETWORK_PROVIDER" NetworkProviderTypeNamed = "NAMED" NetworkProviderTypeNSXT = "NSXT" NetworkProviderTypeVDS = "VSPHERE_NETWORK" // DefaultVirtualMachineClassControllerNameEnv is the name of the // environment variable that contains the name of the default value for // the VirtualMachineClass field spec.controllerName. // // If the environment variable is not set or empty it will be treated as // if it contains vmoperator.vmware.com/vsphere. DefaultVirtualMachineClassControllerNameEnv = "DEFAULT_VM_CLASS_CONTROLLER_NAME" )
Variables ¶
var GetDefaultVirtualMachineClassControllerName = func() string { v := os.Getenv(DefaultVirtualMachineClassControllerNameEnv) if v == "" { return "vmoperator.vmware.com/vsphere" } return v }
GetDefaultVirtualMachineClassControllerName returns the value to use if a VirtualMachineClass resource's spec.controllerName field is empty.
var IsInstanceStorageFSSEnabled = func() bool { return os.Getenv(InstanceStorageFSS) == TrueString }
var IsNamedNetworkProviderEnabled = func() bool { return GetNetworkProviderType() == NetworkProviderTypeNamed }
var IsNamespacedVMClassFSSEnabled = func() bool { return os.Getenv(NamespacedVMClassFSS) == TrueString }
var IsUnifiedTKGFSSEnabled = func() bool { return os.Getenv(UnifiedTKGFSS) == TrueString }
var IsVMClassAsConfigFSSDaynDateEnabled = func() bool { return os.Getenv(VMClassAsConfigDaynDateFSS) == TrueString }
var IsVMClassAsConfigFSSEnabled = func() bool { return os.Getenv(VMClassAsConfigFSS) == TrueString }
var IsVMServiceBackupRestoreFSSEnabled = func() bool { return os.Getenv(VMServiceBackupRestoreFSS) == TrueString }
var IsWCPVMImageRegistryEnabled = func() bool { return os.Getenv(VMImageRegistryFSS) == TrueString }
var IsWcpFaultDomainsFSSEnabled = func() bool { return os.Getenv(WcpFaultDomainsFSS) == TrueString }
var IsWindowsSysprepFSSEnabled = func() bool { return os.Getenv(WindowsSysprepFSS) == TrueString }
var MaxConcurrentCreateVMsOnProvider = func() int { v := os.Getenv(MaxCreateVMsOnProviderEnv) if v == "" { return DefaultMaxCreateVMsOnProvider } val, err := strconv.Atoi(v) if err != nil { return DefaultMaxCreateVMsOnProvider } return val }
MaxConcurrentCreateVMsOnProvider returns the percentage of reconciler threads that can be used to create VMs on the provider concurrently. The default is 80.
Functions ¶
func GetInstanceStoragePVPlacementFailedTTL ¶
GetInstanceStoragePVPlacementFailedTTL returns the configured wait time before declaring PV placement failed after error annotation is set on PVC.
func GetInstanceStorageRequeueDelay ¶
GetInstanceStorageRequeueDelay returns requeue delay for instance storage.
func GetNetworkProviderType ¶ added in v1.8.5
func GetNetworkProviderType() string
func GetPrivilegedUsers ¶ added in v1.8.5
func GetPrivilegedUsers() map[string]struct{}
GetPrivilegedUsers returns a set of privileged users specified as comma separated values via the environment variable "PRIVILEGED_USERS".
func GetVMOpNamespaceFromEnv ¶
GetVMOpNamespaceFromEnv resolves the VM Operator pod's namespace from the environment.
func IsNotFoundError ¶
func IsVMServiceV1Alpha2FSSEnabled ¶
func IsVMServiceV1Alpha2FSSEnabled() bool
func SetVMOpNamespaceEnv ¶
SetVMOpNamespaceEnv sets the VM Operator pod's namespace in the environment.
Types ¶
This section is empty.