Documentation ¶
Index ¶
- Constants
- Variables
- func GetNodeUUID(node *v1.Node) (string, error)
- func GetUUIDFromProviderID(providerID string) string
- func GetVMUUID() (string, error)
- func IsUUIDSupportedNode(node *v1.Node) (bool, error)
- type Credential
- type NodeDetails
- type NodeInfo
- type NodeManager
- func (nm *NodeManager) CredentialManager() *SecretCredentialManager
- func (nm *NodeManager) DiscoverNode(node *v1.Node) error
- func (nm *NodeManager) GetHostsInZone(ctx context.Context, zoneFailureDomain string) ([]*object.HostSystem, error)
- func (nm *NodeManager) GetNode(nodeName k8stypes.NodeName) (v1.Node, error)
- func (nm *NodeManager) GetNodeDetails() ([]NodeDetails, error)
- func (nm *NodeManager) GetNodeInfo(nodeName k8stypes.NodeName) (NodeInfo, error)
- func (nm *NodeManager) GetNodeInfoWithNodeObject(node *v1.Node) (NodeInfo, error)
- func (nm *NodeManager) GetVSphereInstance(nodeName k8stypes.NodeName) (VSphereInstance, error)
- func (nm *NodeManager) RediscoverNode(nodeName k8stypes.NodeName) error
- func (nm *NodeManager) RegisterNode(node *v1.Node) error
- func (nm *NodeManager) UnRegisterNode(node *v1.Node) error
- func (nm *NodeManager) UpdateCredentialManager(credentialManager *SecretCredentialManager)
- type SecretCache
- type SecretCredentialManager
- type VSphere
- func (vs *VSphere) AddSSHKeyToAllInstances(ctx context.Context, user string, keyData []byte) error
- func (vs *VSphere) AttachDisk(vmDiskPath string, storagePolicyName string, nodeName k8stypes.NodeName) (diskUUID string, err error)
- func (vs *VSphere) Clusters() (cloudprovider.Clusters, bool)
- func (vs *VSphere) CreateVolume(volumeOptions *vclib.VolumeOptions) (canonicalVolumePath string, err error)
- func (vs *VSphere) CurrentNodeName(ctx context.Context, hostname string) (k8stypes.NodeName, error)
- func (vs *VSphere) DeleteVolume(vmDiskPath string) error
- func (vs *VSphere) DetachDisk(volPath string, nodeName k8stypes.NodeName) error
- func (vs *VSphere) DiskIsAttached(volPath string, nodeName k8stypes.NodeName) (bool, error)
- func (vs *VSphere) DisksAreAttached(nodeVolumes map[k8stypes.NodeName][]string) (map[k8stypes.NodeName]map[string]bool, error)
- func (vs *VSphere) GetLabelsForVolume(ctx context.Context, pv *v1.PersistentVolume) (map[string]string, error)
- func (vs *VSphere) GetNodeNameFromProviderID(providerID string) (string, error)
- func (vs *VSphere) GetVolumeLabels(volumePath string) (map[string]string, error)
- func (vs *VSphere) GetZone(ctx context.Context) (cloudprovider.Zone, error)
- func (vs *VSphere) GetZoneByNodeName(ctx context.Context, nodeName k8stypes.NodeName) (cloudprovider.Zone, error)
- func (vs *VSphere) GetZoneByProviderID(ctx context.Context, providerID string) (cloudprovider.Zone, error)
- func (vs *VSphere) GetZoneToHosts(ctx context.Context, vsi *VSphereInstance) (map[cloudprovider.Zone][]vmwaretypes.ManagedObjectReference, error)
- func (vs *VSphere) GetZonesForDatastore(ctx context.Context, datastore string) ([]cloudprovider.Zone, error)
- func (vs *VSphere) HasClusterID() bool
- func (vs *VSphere) Initialize(clientBuilder cloudprovider.ControllerClientBuilder, stop <-chan struct{})
- func (vs *VSphere) InstanceExistsByProviderID(ctx context.Context, providerID string) (bool, error)
- func (vs *VSphere) InstanceID(ctx context.Context, nodeName k8stypes.NodeName) (string, error)
- func (vs *VSphere) InstanceShutdownByProviderID(ctx context.Context, providerID string) (bool, error)
- func (vs *VSphere) InstanceType(ctx context.Context, name k8stypes.NodeName) (string, error)
- func (vs *VSphere) InstanceTypeByProviderID(ctx context.Context, providerID string) (string, error)
- func (vs *VSphere) Instances() (cloudprovider.Instances, bool)
- func (vs *VSphere) IsDummyVMPresent(vmName string) (bool, error)
- func (vs *VSphere) LoadBalancer() (cloudprovider.LoadBalancer, bool)
- func (vs *VSphere) NodeAdded(obj interface{})
- func (vs *VSphere) NodeAddresses(ctx context.Context, nodeName k8stypes.NodeName) ([]v1.NodeAddress, error)
- func (vs *VSphere) NodeAddressesByProviderID(ctx context.Context, providerID string) ([]v1.NodeAddress, error)
- func (vs *VSphere) NodeDeleted(obj interface{})
- func (vs *VSphere) NodeManager() (nodeManager *NodeManager)
- func (vs *VSphere) ProviderName() string
- func (vs *VSphere) Routes() (cloudprovider.Routes, bool)
- func (vs *VSphere) SetInformers(informerFactory informers.SharedInformerFactory)
- func (vs *VSphere) Zones() (cloudprovider.Zones, bool)
- type VSphereConfig
- type VSphereInstance
- type VirtualCenterConfig
- type Volumes
Constants ¶
const ( CredentialsNotFoundErrMsg = "Credentials not found" CredentialMissingErrMsg = "Username/Password is missing" UnknownSecretKeyErrMsg = "Unknown secret key" )
Error Messages
const ( POOL_SIZE = 8 QUEUE_SIZE = POOL_SIZE * 10 )
TODO: Make it configurable in vsphere.conf
const ( ProviderName = "vsphere" VolDir = "kubevols" RoundTripperDefaultCount = 3 DummyVMPrefixName = "vsphere-k8s" CleanUpDummyVMRoutineInterval = 5 )
VSphere Cloud Provider constants
const ( MissingUsernameErrMsg = "Username is missing" MissingPasswordErrMsg = "Password is missing" NoZoneTagInVCErrMsg = "No zone tags found in vCenter" )
Error Messages
const ( DatastoreProperty = "datastore" DatastoreInfoProperty = "info" Folder = "Folder" VirtualMachine = "VirtualMachine" DummyDiskName = "kube-dummyDisk.vmdk" ProviderPrefix = "vsphere://" UUIDPrefix = "VMware-" )
const UUIDPath = "/sys/class/dmi/id/product_serial"
Variables ¶
var ( ErrCredentialsNotFound = errors.New(CredentialsNotFoundErrMsg) ErrCredentialMissing = errors.New(CredentialMissingErrMsg) ErrUnknownSecretKey = errors.New(UnknownSecretKeyErrMsg) )
Error constants
var ( ErrUsernameMissing = errors.New(MissingUsernameErrMsg) ErrPasswordMissing = errors.New(MissingPasswordErrMsg) ErrNoZoneTagInVC = errors.New(NoZoneTagInVCErrMsg) )
Error constants
Functions ¶
func GetUUIDFromProviderID ¶ added in v1.9.6
Types ¶
type Credential ¶ added in v1.11.2
type NodeDetails ¶ added in v1.9.0
type NodeDetails struct { NodeName string VMUUID string Zone *cloudprovider.Zone // contains filtered or unexported fields }
type NodeInfo ¶ added in v1.9.0
type NodeInfo struct {
// contains filtered or unexported fields
}
Stores info about the kubernetes node
func (*NodeInfo) VM ¶ added in v1.10.8
func (nodeInfo *NodeInfo) VM() *vclib.VirtualMachine
type NodeManager ¶ added in v1.9.0
type NodeManager struct {
// contains filtered or unexported fields
}
func (*NodeManager) CredentialManager ¶ added in v1.11.2
func (nm *NodeManager) CredentialManager() *SecretCredentialManager
func (*NodeManager) DiscoverNode ¶ added in v1.9.0
func (nm *NodeManager) DiscoverNode(node *v1.Node) error
func (*NodeManager) GetHostsInZone ¶ added in v1.13.9
func (nm *NodeManager) GetHostsInZone(ctx context.Context, zoneFailureDomain string) ([]*object.HostSystem, error)
func (*NodeManager) GetNodeDetails ¶ added in v1.9.0
func (nm *NodeManager) GetNodeDetails() ([]NodeDetails, error)
GetNodeDetails returns NodeDetails for all the discovered nodes.
This method is a getter but it can cause side-effect of updating NodeInfo objects.
func (*NodeManager) GetNodeInfo ¶ added in v1.9.0
func (nm *NodeManager) GetNodeInfo(nodeName k8stypes.NodeName) (NodeInfo, error)
GetNodeInfo returns a NodeInfo which datacenter, vm and vc server ip address. This method returns an error if it is unable find node VCs and DCs listed in vSphere.conf NodeInfo returned may not be updated to reflect current VM location.
This method is a getter but it can cause side-effect of updating NodeInfo object.
func (*NodeManager) GetNodeInfoWithNodeObject ¶ added in v1.11.2
func (nm *NodeManager) GetNodeInfoWithNodeObject(node *v1.Node) (NodeInfo, error)
GetNodeInfoWithNodeObject returns a NodeInfo which datacenter, vm and vc server ip address. This method returns an error if it is unable find node VCs and DCs listed in vSphere.conf NodeInfo returned may not be updated to reflect current VM location.
This method is a getter but it can cause side-effect of updating NodeInfo object.
func (*NodeManager) GetVSphereInstance ¶ added in v1.9.0
func (nm *NodeManager) GetVSphereInstance(nodeName k8stypes.NodeName) (VSphereInstance, error)
func (*NodeManager) RediscoverNode ¶ added in v1.9.0
func (nm *NodeManager) RediscoverNode(nodeName k8stypes.NodeName) error
func (*NodeManager) RegisterNode ¶ added in v1.9.0
func (nm *NodeManager) RegisterNode(node *v1.Node) error
func (*NodeManager) UnRegisterNode ¶ added in v1.9.0
func (nm *NodeManager) UnRegisterNode(node *v1.Node) error
func (*NodeManager) UpdateCredentialManager ¶ added in v1.11.2
func (nm *NodeManager) UpdateCredentialManager(credentialManager *SecretCredentialManager)
type SecretCache ¶ added in v1.11.2
type SecretCache struct { VirtualCenter map[string]*Credential Secret *corev1.Secret // contains filtered or unexported fields }
func (*SecretCache) GetCredential ¶ added in v1.11.2
func (cache *SecretCache) GetCredential(server string) (Credential, bool)
func (*SecretCache) GetSecret ¶ added in v1.11.2
func (cache *SecretCache) GetSecret() *corev1.Secret
func (*SecretCache) UpdateSecret ¶ added in v1.11.2
func (cache *SecretCache) UpdateSecret(secret *corev1.Secret)
type SecretCredentialManager ¶ added in v1.11.2
type SecretCredentialManager struct { SecretName string SecretNamespace string SecretLister v1.SecretLister Cache *SecretCache }
func (*SecretCredentialManager) GetCredential ¶ added in v1.11.2
func (secretCredentialManager *SecretCredentialManager) GetCredential(server string) (*Credential, error)
GetCredential returns credentials for the given vCenter Server. GetCredential returns error if Secret is not added. GetCredential return error is the secret doesn't contain any credentials.
type VSphere ¶
type VSphere struct {
// contains filtered or unexported fields
}
VSphere is an implementation of cloud provider Interface for VSphere.
func GetVSphere ¶ added in v1.6.0
GetVSphere reads vSphere configuration from system environment and construct vSphere object
func (*VSphere) AddSSHKeyToAllInstances ¶ added in v1.6.5
AddSSHKeyToAllInstances add SSH key to all instances
func (*VSphere) AttachDisk ¶
func (vs *VSphere) AttachDisk(vmDiskPath string, storagePolicyName string, nodeName k8stypes.NodeName) (diskUUID string, err error)
AttachDisk attaches given virtual disk volume to the compute running kubelet.
func (*VSphere) CreateVolume ¶
func (vs *VSphere) CreateVolume(volumeOptions *vclib.VolumeOptions) (canonicalVolumePath string, err error)
CreateVolume creates a volume of given size (in KiB) and return the volume path. If the volumeOptions.Datastore is part of datastore cluster for example - DatastoreCluster/sharedVmfs-0 then return value will be DatastoreCluster/sharedVmfs-0 kubevols/<volume-name>.vmdk else return value will be [sharedVmfs-0] kubevols/<volume-name>.vmdk
func (*VSphere) CurrentNodeName ¶ added in v1.6.5
CurrentNodeName gives the current node name
func (*VSphere) DeleteVolume ¶
DeleteVolume deletes a volume given volume name.
func (*VSphere) DetachDisk ¶
DetachDisk detaches given virtual disk volume from the compute running kubelet.
func (*VSphere) DiskIsAttached ¶ added in v1.3.10
DiskIsAttached returns if disk is attached to the VM using controllers supported by the plugin.
func (*VSphere) DisksAreAttached ¶ added in v1.4.7
func (vs *VSphere) DisksAreAttached(nodeVolumes map[k8stypes.NodeName][]string) (map[k8stypes.NodeName]map[string]bool, error)
DisksAreAttached returns if disks are attached to the VM using controllers supported by the plugin. 1. Converts volPaths into canonical form so that it can be compared with the VM device path. 2. Segregates nodes by vCenter and Datacenter they are present in. This reduces calls to VC. 3. Creates go routines per VC-DC to find whether disks are attached to the nodes. 4. If the some of the VMs are not found or migrated then they are added to a list. 5. After successful execution of goroutines, 5a. If there are any VMs which needs to be retried, they are rediscovered and the whole operation is initiated again for only rediscovered VMs. 5b. If VMs are removed from vSphere inventory they are ignored.
func (*VSphere) GetLabelsForVolume ¶ added in v1.13.9
func (vs *VSphere) GetLabelsForVolume(ctx context.Context, pv *v1.PersistentVolume) (map[string]string, error)
GetLabelsForVolume implements the PVLabeler interface for VSphere since this interface is used by the PV label admission controller.
func (*VSphere) GetNodeNameFromProviderID ¶ added in v1.12.0
func (*VSphere) GetVolumeLabels ¶ added in v1.13.9
GetVolumeLabels returns the well known zone and region labels for given volume
func (*VSphere) GetZoneByNodeName ¶ added in v1.12.0
func (*VSphere) GetZoneByProviderID ¶ added in v1.12.0
func (*VSphere) GetZoneToHosts ¶ added in v1.13.9
func (vs *VSphere) GetZoneToHosts(ctx context.Context, vsi *VSphereInstance) (map[cloudprovider.Zone][]vmwaretypes.ManagedObjectReference, error)
GetZoneToHosts returns a map of 'zone' -> 'list of hosts in that zone' in given VC
func (*VSphere) GetZonesForDatastore ¶ added in v1.13.9
func (vs *VSphere) GetZonesForDatastore(ctx context.Context, datastore string) ([]cloudprovider.Zone, error)
GetZonesForDatastore returns all the zones from which this datastore is visible
func (*VSphere) HasClusterID ¶ added in v1.8.0
HasClusterID returns true if the cluster has a clusterID
func (*VSphere) Initialize ¶ added in v1.7.0
func (vs *VSphere) Initialize(clientBuilder cloudprovider.ControllerClientBuilder, stop <-chan struct{})
Initialize passes a Kubernetes clientBuilder interface to the cloud provider
func (*VSphere) InstanceExistsByProviderID ¶ added in v1.8.0
InstanceExistsByProviderID returns true if the instance with the given provider id still exists and is running. If false is returned with no error, the instance will be immediately deleted by the cloud controller manager.
func (*VSphere) InstanceID ¶ added in v1.6.5
InstanceID returns the cloud provider ID of the node with the specified Name.
func (*VSphere) InstanceShutdownByProviderID ¶ added in v1.11.2
func (vs *VSphere) InstanceShutdownByProviderID(ctx context.Context, providerID string) (bool, error)
InstanceShutdownByProviderID returns true if the instance is in safe state to detach volumes
func (*VSphere) InstanceType ¶ added in v1.6.5
func (*VSphere) InstanceTypeByProviderID ¶ added in v1.6.5
InstanceTypeByProviderID returns the cloudprovider instance type of the node with the specified unique providerID This method will not be called from the node that is requesting this ID. i.e. metadata service and other local methods cannot be used here
func (*VSphere) Instances ¶
func (vs *VSphere) Instances() (cloudprovider.Instances, bool)
Instances returns an implementation of Instances for vSphere.
func (*VSphere) IsDummyVMPresent ¶ added in v1.9.6
func (*VSphere) LoadBalancer ¶
func (vs *VSphere) LoadBalancer() (cloudprovider.LoadBalancer, bool)
LoadBalancer returns an implementation of LoadBalancer for vSphere.
func (*VSphere) NodeAdded ¶ added in v1.9.0
func (vs *VSphere) NodeAdded(obj interface{})
Notification handler when node is added into k8s cluster.
func (*VSphere) NodeAddresses ¶ added in v1.6.5
func (vs *VSphere) NodeAddresses(ctx context.Context, nodeName k8stypes.NodeName) ([]v1.NodeAddress, error)
NodeAddresses is an implementation of Instances.NodeAddresses.
func (*VSphere) NodeAddressesByProviderID ¶ added in v1.6.5
func (vs *VSphere) NodeAddressesByProviderID(ctx context.Context, providerID string) ([]v1.NodeAddress, error)
NodeAddressesByProviderID returns the node addresses of an instances with the specified unique providerID This method will not be called from the node that is requesting this ID. i.e. metadata service and other local methods cannot be used here
func (*VSphere) NodeDeleted ¶ added in v1.9.0
func (vs *VSphere) NodeDeleted(obj interface{})
Notification handler when node is removed from k8s cluster.
func (*VSphere) NodeManager ¶ added in v1.10.8
func (vs *VSphere) NodeManager() (nodeManager *NodeManager)
func (*VSphere) ProviderName ¶
ProviderName returns the cloud provider ID.
func (*VSphere) Routes ¶
func (vs *VSphere) Routes() (cloudprovider.Routes, bool)
Routes returns a false since the interface is not supported for vSphere.
func (*VSphere) SetInformers ¶ added in v1.9.6
func (vs *VSphere) SetInformers(informerFactory informers.SharedInformerFactory)
Initialize Node Informers
type VSphereConfig ¶
type VSphereConfig struct { Global struct { // vCenter username. User string `gcfg:"user"` // vCenter password in clear text. Password string `gcfg:"password"` // Deprecated. Use VirtualCenter to specify multiple vCenter Servers. // vCenter IP. VCenterIP string `gcfg:"server"` // vCenter port. VCenterPort string `gcfg:"port"` // True if vCenter uses self-signed cert. InsecureFlag bool `gcfg:"insecure-flag"` // Specifies the path to a CA certificate in PEM format. Optional; if not // configured, the system's CA certificates will be used. CAFile string `gcfg:"ca-file"` // Thumbprint of the VCenter's certificate thumbprint Thumbprint string `gcfg:"thumbprint"` // Datacenter in which VMs are located. // Deprecated. Use "datacenters" instead. Datacenter string `gcfg:"datacenter"` // Datacenter in which VMs are located. Datacenters string `gcfg:"datacenters"` // Datastore in which vmdks are stored. // Deprecated. See Workspace.DefaultDatastore DefaultDatastore string `gcfg:"datastore"` // WorkingDir is path where VMs can be found. Also used to create dummy VMs. // Deprecated. WorkingDir string `gcfg:"working-dir"` // Soap round tripper count (retries = RoundTripper - 1) RoundTripperCount uint `gcfg:"soap-roundtrip-count"` // Is required on the controller-manager if it does not run on a VMware machine // VMUUID is the VM Instance UUID of virtual machine which can be retrieved from instanceUuid // property in VmConfigInfo, or also set as vc.uuid in VMX file. // If not set, will be fetched from the machine via sysfs (requires root) VMUUID string `gcfg:"vm-uuid"` // Deprecated as virtual machine will be automatically discovered. // VMName is the VM name of virtual machine // Combining the WorkingDir and VMName can form a unique InstanceID. // When vm-name is set, no username/password is required on worker nodes. VMName string `gcfg:"vm-name"` // Name of the secret were vCenter credentials are present. SecretName string `gcfg:"secret-name"` // Secret Namespace where secret will be present that has vCenter credentials. SecretNamespace string `gcfg:"secret-namespace"` } VirtualCenter map[string]*VirtualCenterConfig Network struct { // PublicNetwork is name of the network the VMs are joined to. PublicNetwork string `gcfg:"public-network"` } Disk struct { // SCSIControllerType defines SCSI controller to be used. SCSIControllerType string `dcfg:"scsicontrollertype"` } // Endpoint used to create volumes Workspace struct { VCenterIP string `gcfg:"server"` Datacenter string `gcfg:"datacenter"` Folder string `gcfg:"folder"` DefaultDatastore string `gcfg:"default-datastore"` ResourcePoolPath string `gcfg:"resourcepool-path"` } // Tag categories and tags which correspond to "built-in node labels: zones and region" Labels struct { Zone string `gcfg:"zone"` Region string `gcfg:"region"` } }
Structure that represents the content of vsphere.conf file. Users specify the configuration of one or more Virtual Centers in vsphere.conf where the Kubernetes master and worker nodes are running.
type VSphereInstance ¶ added in v1.9.0
type VSphereInstance struct {
// contains filtered or unexported fields
}
Represents a vSphere instance where one or more kubernetes nodes are running.
type VirtualCenterConfig ¶ added in v1.9.0
type VirtualCenterConfig struct { // vCenter username. User string `gcfg:"user"` // vCenter password in clear text. Password string `gcfg:"password"` // vCenter port. VCenterPort string `gcfg:"port"` // Datacenter in which VMs are located. Datacenters string `gcfg:"datacenters"` // Soap round tripper count (retries = RoundTripper - 1) RoundTripperCount uint `gcfg:"soap-roundtrip-count"` // Thumbprint of the VCenter's certificate thumbprint Thumbprint string `gcfg:"thumbprint"` }
Structure that represents Virtual Center configuration
type Volumes ¶ added in v1.3.10
type Volumes interface { // AttachDisk attaches given disk to given node. Current node // is used when nodeName is empty string. AttachDisk(vmDiskPath string, storagePolicyName string, nodeName k8stypes.NodeName) (diskUUID string, err error) // DetachDisk detaches given disk to given node. Current node // is used when nodeName is empty string. // Assumption: If node doesn't exist, disk is already detached from node. DetachDisk(volPath string, nodeName k8stypes.NodeName) error // DiskIsAttached checks if a disk is attached to the given node. // Assumption: If node doesn't exist, disk is not attached to the node. DiskIsAttached(volPath string, nodeName k8stypes.NodeName) (bool, error) // DisksAreAttached checks if a list disks are attached to the given node. // Assumption: If node doesn't exist, disks are not attached to the node. DisksAreAttached(nodeVolumes map[k8stypes.NodeName][]string) (map[k8stypes.NodeName]map[string]bool, error) // CreateVolume creates a new vmdk with specified parameters. CreateVolume(volumeOptions *vclib.VolumeOptions) (volumePath string, err error) // DeleteVolume deletes vmdk. DeleteVolume(vmDiskPath string) error }