Skip to content

vsphere: Cache REST API sessions to prevent excessive vCenter logouts #1432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

vsphere: Cache REST API sessions to prevent excessive vCenter logouts #1432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 23 additions & 31 deletions pkg/controller/vsphere/reconciler.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,15 +594,10 @@ func (r *Reconciler) reconcileRegionAndZoneLabels(vm *virtualMachine) error {
regionLabel := r.vSphereConfig.Labels.Region
zoneLabel := r.vSphereConfig.Labels.Zone

var res map[string]string

err := r.session.WithCachingTagsManager(vm.Context, func(c *session.CachingTagsManager) error {
var err error
res, err = vm.getRegionAndZone(c, regionLabel, zoneLabel)

return err
})

// Use cached tag manager to avoid creating new REST sessions.
// This eliminates excessive vCenter login/logout cycles.
tagManager := r.session.GetCachingTagsManager()
res, err := vm.getRegionAndZone(tagManager, regionLabel, zoneLabel)
if err != nil {
return err
}
Expand Down Expand Up @@ -1599,32 +1594,29 @@ func (vm *virtualMachine) getPowerState() (types.VirtualMachinePowerState, error
// reconcileTags ensures that the required tags are present on the virtual machine, eg the Cluster ID
// that is used by the installer on cluster deletion to ensure ther are no leaked resources.
func (vm *virtualMachine) reconcileTags(ctx context.Context, sessionInstance *session.Session, machine *machinev1.Machine, providerSpec *machinev1.VSphereMachineProviderSpec) error {
if err := sessionInstance.WithCachingTagsManager(vm.Context, func(c *session.CachingTagsManager) error {
klog.Infof("%v: Reconciling attached tags", machine.GetName())

clusterID := machine.Labels[machinev1.MachineClusterIDLabel]
tagIDs := []string{clusterID}
tagIDs = append(tagIDs, providerSpec.TagIDs...)
klog.Infof("%v: Reconciling %s tags to vm", machine.GetName(), tagIDs)
for _, tagID := range tagIDs {
attached, err := vm.checkAttachedTag(ctx, tagID, c)
if err != nil {
return err
}
// Use cached tag manager to avoid creating new REST sessions.
// This eliminates excessive vCenter login/logout cycles.
tagManager := sessionInstance.GetCachingTagsManager()
klog.Infof("%v: Reconciling attached tags", machine.GetName())

clusterID := machine.Labels[machinev1.MachineClusterIDLabel]
tagIDs := []string{clusterID}
tagIDs = append(tagIDs, providerSpec.TagIDs...)
klog.Infof("%v: Reconciling %s tags to vm", machine.GetName(), tagIDs)
for _, tagID := range tagIDs {
attached, err := vm.checkAttachedTag(ctx, tagID, tagManager)
if err != nil {
return err
}

if !attached {
klog.Infof("%v: Attaching %s tag to vm", machine.GetName(), tagID)
// the tag should already be created by installer or the administrator
if err := c.AttachTag(ctx, tagID, vm.Ref); err != nil {
return err
}
if !attached {
klog.Infof("%v: Attaching %s tag to vm", machine.GetName(), tagID)
// the tag should already be created by installer or the administrator
if err := tagManager.AttachTag(ctx, tagID, vm.Ref); err != nil {
return err
}
}
return nil
}); err != nil {
return err
}

return nil
}

Expand Down
70 changes: 68 additions & 2 deletions pkg/controller/vsphere/session/session.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,14 @@ const (
)

// Session is a vSphere session with a configured Finder.
// This implementation is inspired by cluster-api-provider-vsphere's session caching pattern
// to avoid excessive vCenter login/logout cycles for REST API operations.
// Reference: https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/main/pkg/session/session.go
type Session struct {
*govmomi.Client
Finder *find.Finder
Datacenter *object.Datacenter
TagManager *tags.Manager

username string
password string
Expand Down Expand Up @@ -80,13 +84,40 @@ func GetOrCreate(

sessionKey := server + username + datacenter
if session, ok := sessionCache[sessionKey]; ok {
// Check both SOAP and REST session validity before reusing cached session.
// This prevents reusing sessions where one connection type has expired.
// Pattern adapted from cluster-api-provider-vsphere:
// https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/main/pkg/session/session.go#L132-L149
sessionActive, err := session.SessionManager.SessionIsActive(ctx)
if err != nil {
klog.Errorf("Error performing session check request to vSphere: %v", err)
klog.Errorf("Error performing SOAP session check request to vSphere: %v", err)
}
if sessionActive {

var restSessionActive bool
if session.TagManager != nil {
restSession, err := session.TagManager.Session(ctx)
if err != nil {
klog.Errorf("Error performing REST session check request to vSphere: %v", err)
}
restSessionActive = restSession != nil
}

if sessionActive && restSessionActive {
klog.V(3).Infof("Found active cached vSphere session with valid SOAP and REST connections")
return &session, nil
}

// If either session is invalid, logout both to clean up
if session.TagManager != nil {
klog.Infof("Logging out inactive REST session")
if err := session.TagManager.Logout(ctx); err != nil {
klog.Errorf("Failed to logout REST session: %v", err)
}
}
klog.Infof("Logging out inactive SOAP session")
if err := session.Client.Logout(ctx); err != nil {
klog.Errorf("Failed to logout SOAP session: %v", err)
}
}
klog.Infof("No existing vCenter session found, creating new session")

Expand Down Expand Up @@ -127,6 +158,20 @@ func GetOrCreate(
session.Datacenter = dc
session.Finder.SetDatacenter(dc)

// Create and cache REST client for tag operations.
// This prevents creating a new REST session on every tag operation.
// Pattern adapted from cluster-api-provider-vsphere:
// https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/blob/main/pkg/session/session.go#L196-L205
restClient := rest.NewClient(session.Client.Client)
if err := restClient.Login(ctx, url.UserPassword(username, password)); err != nil {
// Cleanup SOAP session on REST login failure
if logoutErr := client.Logout(ctx); logoutErr != nil {
klog.Errorf("Failed to logout SOAP session after REST login failure: %v", logoutErr)
}
return nil, fmt.Errorf("unable to login REST client to vCenter: %w", err)
}
session.TagManager = tags.NewManager(restClient)

// Cache the session.
sessionCache[sessionKey] = session

Expand Down Expand Up @@ -206,7 +251,21 @@ func (s *Session) GetTask(ctx context.Context, taskRef string) (*mo.Task, error)
return &obj, nil
}

// GetCachingTagsManager returns a CachingTagsManager that wraps the cached TagManager.
// This replaces the previous WithCachingTagsManager pattern which created new sessions
// on every call. The returned manager uses the session's cached REST client.
func (s *Session) GetCachingTagsManager() *CachingTagsManager {
return newTagsCachingClient(s.TagManager, s.sessionKey)
}

// WithRestClient is deprecated. Use s.TagManager directly instead.
// This function is maintained for backward compatibility but creates excessive
// vCenter login/logout cycles. Migration path: replace callback pattern with
// direct access to s.TagManager.
//
// Deprecated: Use s.TagManager for direct REST client access.
func (s *Session) WithRestClient(ctx context.Context, f func(c *rest.Client) error) error {
klog.Warning("WithRestClient is deprecated and causes excessive vCenter logouts. Use s.TagManager directly instead.")
c := rest.NewClient(s.Client.Client)

user := url.UserPassword(s.username, s.password)
Expand All @@ -223,7 +282,14 @@ func (s *Session) WithRestClient(ctx context.Context, f func(c *rest.Client) err
return f(c)
}

// WithCachingTagsManager is deprecated. Use s.GetCachingTagsManager() instead.
// This function is maintained for backward compatibility but creates excessive
// vCenter login/logout cycles. Migration path: replace callback pattern with
// direct call to s.GetCachingTagsManager().
//
// Deprecated: Use s.GetCachingTagsManager() for cached tag manager access.
func (s *Session) WithCachingTagsManager(ctx context.Context, f func(m *CachingTagsManager) error) error {
klog.Warning("WithCachingTagsManager is deprecated and causes excessive vCenter logouts. Use s.GetCachingTagsManager() instead.")
c := rest.NewClient(s.Client.Client)

user := url.UserPassword(s.username, s.password)
Expand Down