api

Documentation

Index

• Constants
• type VApp
• type VSphereSystemDisk
• type VsphereProviderSpec

Constants

const (
	// TagClusterPrefix is the old tag prefix for tagging the cluster name
	TagClusterPrefix = "kubernetes.io/cluster/"
	// TagNodeRolePrefix is the old tag prefix for tagging the node role
	TagNodeRolePrefix = "kubernetes.io/role/"
	// TagMCMClusterName is the tag key for tagging a VM with the cluster name
	TagMCMClusterName = "mcm.gardener.cloud/cluster"
	// TagMCMRole is the tag key for tagging a VM with its role (e.g 'node')
	TagMCMRole = "mcm.gardener.cloud/role"
)

Types

type VApp

type VApp struct {
	// Properties are the properties values of the VApp
	Properties map[string]string `json:"properties"`
}

VApp contains the properties of the VApp

type VSphereSystemDisk

type VSphereSystemDisk struct {
	// Size is disk size in GB
	Size int `json:"size"`
}

VSphereSystemDisk specifies system disk of a machine

type VsphereProviderSpec

type VsphereProviderSpec struct {
	// Region is the vSphere region
	Region string `json:"region"`

	// Datacenter is the vSphere data center
	Datacenter string `json:"datacenter"`

	// DatastoreCluster is the data store cluster to use (either DatastoreCluster or Datastore must be specified)
	// +optional
	DatastoreCluster string `json:"datastoreCluster,omitempty"`
	// Datastore is the data store to use (either DatastoreCluster or Datastore must be specified)
	// +optional
	Datastore string `json:"datastore,omitempty"`

	// ComputeCluster is the compute cluster to use for placement (either ComputeCluster, ResourcePool, or HostSystem must be specified)
	// +optional
	ComputeCluster string `json:"computeCluster,omitempty"`
	// ResourcePool is the resource pool to use  for placement (either ComputeCluster, ResourcePool, or HostSystem must be specified)
	// +optional
	ResourcePool string `json:"resourcePool,omitempty"`
	// HostSystem is the host system to use for placement (either ComputeCluster, ResourcePool, or HostSystem must be specified)
	// +optional
	HostSystem string `json:"hostSystem,omitempty"`

	// Folder is the folder to place VMs into
	// +optional
	Folder string `json:"folder,omitempty"`
	// NumCpus is the number of virtual CPUs of the VM
	NumCpus int `json:"numCpus"`
	// Memory is VM memory size in MB
	Memory int `json:"memory"`
	// MemoryReservationLockedToMax is flag to reserve all guest OS memory (no swapping in ESXi host)
	// +optional
	MemoryReservationLockedToMax *bool `json:"memoryReservationLockedToMax,omitempty"`
	// SystemDisk specifies the system disk
	// +optional
	SystemDisk *VSphereSystemDisk `json:"systemDisk,omitempty"`
	// ExtraConfig allows to specify additional VM options.
	// e.g. sched.swap.vmxSwapEnabled=false to disable the VMX process swap file
	// +optional
	ExtraConfig map[string]string `json:"extraConfig,omitempty"`
	// Network is the vSphere network to use
	Network string `json:"network"`
	// SwitchUUID is VDS UUID (only needed if there are multiple virtual distributed switches the network is assigned to)
	// +optional
	SwitchUUID string `json:"switchUuid"`
	// TemplateVM is the VM template to clone
	TemplateVM string `json:"templateVM"`
	// GuestID is an optional value to overwrite the VM guest id of the templae
	// +optional
	GuestID string `json:"guestId,omitempty"`
	// VApp contains the Properties of the VApp to start on booting
	VApp *VApp `json:"vapp,omitempty"`
	// Force is an experimental flag to overwrite an existing VM with the same name
	// +optional
	Force bool `json:"force,omitempty"`
	// WaitForIP is an experimental flag if controller should wait until VM has IP assigned
	// +optional
	WaitForIP bool `json:"waitForIP,omitempty"`
	// Customization is an experimental option to add a CustomizationSpec
	// +optional
	Customization string `json:"customization,omitempty"`

	// SSHKeys is an optional array of ssh public keys to deploy to VM (may already be included in UserData)
	// +optional
	SSHKeys []string `json:"sshKeys,omitempty"`
	// Tags to be placed on the VM
	// +optional
	Tags map[string]string `json:"tags,omitempty"`
}

VsphereProviderSpec contains the fields of provider spec that the plugin expects