services

Documentation

Overview

Package services contains tools for handling VSphere services.

Index

• type ControlPlaneEndpointService
• type NetworkProvider
• type ResourcePolicyService
• type VSphereMachineService
• type VimMachineService
  • func (v *VimMachineService) FetchVSphereCluster(ctx context.Context, cluster *clusterv1.Cluster, ...) (capvcontext.MachineContext, error)
  • func (v *VimMachineService) FetchVSphereMachine(ctx context.Context, name types.NamespacedName) (capvcontext.MachineContext, error)
  • func (v *VimMachineService) GetHostInfo(ctx context.Context, machineCtx capvcontext.MachineContext) (string, error)
  • func (v *VimMachineService) GetMachinesInCluster(ctx context.Context, namespace, clusterName string) ([]client.Object, error)
  • func (v *VimMachineService) ReconcileDelete(ctx context.Context, machineCtx capvcontext.MachineContext) error
  • func (v *VimMachineService) ReconcileNormal(ctx context.Context, machineCtx capvcontext.MachineContext) (bool, error)
  • func (v *VimMachineService) SyncFailureReason(ctx context.Context, machineCtx capvcontext.MachineContext) (bool, error)
• type VirtualMachineService

Types

type ControlPlaneEndpointService

type ControlPlaneEndpointService interface {
	// ReconcileControlPlaneEndpointService manages the lifecycle of a
	// control plane endpoint managed by a vmoperator VirtualMachineService
	ReconcileControlPlaneEndpointService(ctx context.Context, clusterCtx *vmware.ClusterContext, netProvider NetworkProvider) (*clusterv1.APIEndpoint, error)
}

ControlPlaneEndpointService is a service for reconciling load balanced control plane endpoints.

type NetworkProvider

type NetworkProvider interface {
	// HasLoadBalancer indicates whether this provider has a load balancer for Services.
	HasLoadBalancer() bool

	// SupportsVMReadinessProbe indicates whether this provider support vm readiness probe.
	SupportsVMReadinessProbe() bool

	// ProvisionClusterNetwork creates network resource for a given cluster
	// This operation should be idempotent
	ProvisionClusterNetwork(ctx context.Context, clusterCtx *vmware.ClusterContext) error

	// GetClusterNetworkName returns the name of a valid cluster network if one exists
	// Returns an empty string if the operation is not supported
	GetClusterNetworkName(ctx context.Context, clusterCtx *vmware.ClusterContext) (string, error)

	// GetVMServiceAnnotations returns the annotations, if any, to place on a VM Service.
	GetVMServiceAnnotations(ctx context.Context, clusterCtx *vmware.ClusterContext) (map[string]string, error)

	// ConfigureVirtualMachine configures a VM for the particular network
	ConfigureVirtualMachine(ctx context.Context, clusterCtx *vmware.ClusterContext, vm *vmoprv1.VirtualMachine) error

	// VerifyNetworkStatus verifies the status of the network after vnet creation
	VerifyNetworkStatus(ctx context.Context, clusterCtx *vmware.ClusterContext, obj runtime.Object) error
}

NetworkProvider provision network resources and configures VM based on network type.

type ResourcePolicyService

type ResourcePolicyService interface {
	// ReconcileResourcePolicy ensures that a VirtualMachineSetResourcePolicy exists for the cluster
	// Returns the name of a policy if it exists, otherwise returns an error
	ReconcileResourcePolicy(ctx context.Context, clusterCtx *vmware.ClusterContext) (string, error)
}

ResourcePolicyService is a service for reconciling a VirtualMachineSetResourcePolicy for a cluster.

type VSphereMachineService

type VSphereMachineService interface {
	GetMachinesInCluster(ctx context.Context, namespace, clusterName string) ([]client.Object, error)
	FetchVSphereMachine(ctx context.Context, name types.NamespacedName) (capvcontext.MachineContext, error)
	FetchVSphereCluster(ctx context.Context, cluster *clusterv1.Cluster, machineContext capvcontext.MachineContext) (capvcontext.MachineContext, error)
	ReconcileDelete(ctx context.Context, machineCtx capvcontext.MachineContext) error
	SyncFailureReason(ctx context.Context, machineCtx capvcontext.MachineContext) (bool, error)
	ReconcileNormal(ctx context.Context, machineCtx capvcontext.MachineContext) (bool, error)
	GetHostInfo(ctx context.Context, machineCtx capvcontext.MachineContext) (string, error)
}

VSphereMachineService is used for vsphere VM lifecycle and syncing with VSphereMachine types.

type VimMachineService

type VimMachineService struct {
	Client client.Client
}

VimMachineService reconciles VSphere VMs.

func (*VimMachineService) FetchVSphereCluster

func (v *VimMachineService) FetchVSphereCluster(ctx context.Context, cluster *clusterv1.Cluster, machineContext capvcontext.MachineContext) (capvcontext.MachineContext, error)

FetchVSphereCluster adds the VSphereCluster associated with the passed cluster to the machineContext.

func (*VimMachineService) FetchVSphereMachine

func (v *VimMachineService) FetchVSphereMachine(ctx context.Context, name types.NamespacedName) (capvcontext.MachineContext, error)

FetchVSphereMachine returns a new MachineContext containing the vsphereMachine.

func (*VimMachineService) GetHostInfo

func (v *VimMachineService) GetHostInfo(ctx context.Context, machineCtx capvcontext.MachineContext) (string, error)

GetHostInfo returns the hostname or IP address of the infrastructure host for the VSphere VM.

func (*VimMachineService) GetMachinesInCluster

func (v *VimMachineService) GetMachinesInCluster(
	ctx context.Context,
	namespace, clusterName string) ([]client.Object, error)

GetMachinesInCluster returns a list of VSphereMachine objects belonging to the cluster.

func (*VimMachineService) ReconcileDelete

func (v *VimMachineService) ReconcileDelete(ctx context.Context, machineCtx capvcontext.MachineContext) error

ReconcileDelete reconciles delete events for the VSphere VM.

func (*VimMachineService) ReconcileNormal

func (v *VimMachineService) ReconcileNormal(ctx context.Context, machineCtx capvcontext.MachineContext) (bool, error)

ReconcileNormal reconciles create and update events for the VSphere VM.

func (*VimMachineService) SyncFailureReason

func (v *VimMachineService) SyncFailureReason(ctx context.Context, machineCtx capvcontext.MachineContext) (bool, error)

SyncFailureReason returns true if the VSphere Machine has failed.

type VirtualMachineService

type VirtualMachineService interface {
	// ReconcileVM reconciles a VM with the intended state.
	ReconcileVM(ctx context.Context, vmCtx *capvcontext.VMContext) (infrav1.VirtualMachine, error)

	// DestroyVM powers off and removes a VM from the inventory.
	DestroyVM(ctx context.Context, vmCtx *capvcontext.VMContext) (reconcile.Result, infrav1.VirtualMachine, error)
}

VirtualMachineService is a service for creating/updating/deleting virtual machines on vSphere.