implement PodSandboxStatus support

Signed-off-by: Michael Zappa <michael.zappa@gmail.com>

Author: MikeZappa87

pkg/adaptation/adaptation.go

@@ -272,6 +272,47 @@ func (r *Adaptation) UpdatePodSandbox(ctx context.Context, req *UpdatePodSandbox
 	return &UpdatePodSandboxResponse{}, nil
 }
 
+// PodSandboxStatus relays the corresponding CRI request to plugins.
+// If a plugin returns IP addresses, those will be returned to the caller.
+// An error is returned if multiple plugins attempt to set the same field.
+func (r *Adaptation) PodSandboxStatus(ctx context.Context, req *PodSandboxStatusRequest) (*PodSandboxStatusResponse, error) {
+	r.Lock()
+	defer r.Unlock()
+	defer r.removeClosedPlugins()
+
+	var (
+		rsp                = &PodSandboxStatusResponse{}
+		ipOwner            = ""
+		additionalIpsOwner = ""
+	)
+
+	for _, plugin := range r.plugins {
+		pluginRsp, err := plugin.podSandboxStatus(ctx, req)
+		if err != nil {
+			return nil, err
+		}
+		if pluginRsp == nil || (pluginRsp.Ip == "" && len(pluginRsp.AdditionalIps) == 0) {
+			continue
+		}
+		if pluginRsp.Ip != "" {
+			if ipOwner != "" {
+				return nil, fmt.Errorf("plugins %q and %q both tried to set PodSandboxStatus IP address field", ipOwner, plugin.name())
+			}
+			rsp.Ip = pluginRsp.Ip
+			ipOwner = plugin.name()
+		}
+		if len(pluginRsp.AdditionalIps) > 0 {
+			if additionalIpsOwner != "" {
+				return nil, fmt.Errorf("plugins %q and %q both tried to set PodSandboxStatus additional IP addresses field", additionalIpsOwner, plugin.name())
+			}
+			rsp.AdditionalIps = pluginRsp.AdditionalIps
+			additionalIpsOwner = plugin.name()
+		}
+	}
+
+	return rsp, nil
+}
+
 // PostUpdatePodSandbox relays the corresponding CRI request to plugins.
 func (r *Adaptation) PostUpdatePodSandbox(ctx context.Context, req *PostUpdatePodSandboxRequest) error {
 	r.Lock()

pkg/adaptation/api.go

@@ -54,6 +54,8 @@ type (
 	RunPodSandboxResponse        = api.RunPodSandboxResponse
 	UpdatePodSandboxRequest      = api.UpdatePodSandboxRequest
 	UpdatePodSandboxResponse     = api.UpdatePodSandboxResponse
+	PodSandboxStatusRequest      = api.PodSandboxStatusRequest
+	PodSandboxStatusResponse     = api.PodSandboxStatusResponse
 	StopPodSandboxRequest        = api.StopPodSandboxRequest
 	StopPodSandboxResponse       = api.StopPodSandboxResponse
 	RemovePodSandboxRequest      = api.RemovePodSandboxRequest
@@ -132,6 +134,7 @@ const (
 	Event_STOP_CONTAINER                = api.Event_STOP_CONTAINER
 	Event_REMOVE_CONTAINER              = api.Event_REMOVE_CONTAINER
 	Event_VALIDATE_CONTAINER_ADJUSTMENT = api.Event_VALIDATE_CONTAINER_ADJUSTMENT
+	Event_POD_SANDBOX_STATUS            = api.Event_POD_SANDBOX_STATUS
 	ValidEvents                         = api.ValidEvents
 
 	ContainerState_CONTAINER_UNKNOWN = api.ContainerState_CONTAINER_UNKNOWN

pkg/adaptation/builtin/plugin.go

@@ -43,6 +43,7 @@ type BuiltinHandlers struct {
 	RemovePodSandbox     func(context.Context, *api.RemovePodSandboxRequest) error
 	UpdatePodSandbox     func(context.Context, *api.UpdatePodSandboxRequest) (*api.UpdatePodSandboxResponse, error)
 	PostUpdatePodSandbox func(context.Context, *api.PostUpdatePodSandboxRequest) error
+	PodSandboxStatus     func(context.Context, *api.PodSandboxStatusRequest) (*api.PodSandboxStatusResponse, error)
 
 	CreateContainer             func(context.Context, *api.CreateContainerRequest) (*api.CreateContainerResponse, error)
 	PostCreateContainer         func(context.Context, *api.PostCreateContainerRequest) error
@@ -84,6 +85,9 @@ func (b *BuiltinPlugin) Configure(ctx context.Context, req *api.ConfigureRequest
 		if b.Handlers.PostUpdatePodSandbox != nil {
 			events.Set(api.Event_POST_UPDATE_POD_SANDBOX)
 		}
+		if b.Handlers.PodSandboxStatus != nil {
+			events.Set(api.Event_POD_SANDBOX_STATUS)
+		}
 		if b.Handlers.CreateContainer != nil {
 			events.Set(api.Event_CREATE_CONTAINER)
 		}
@@ -147,6 +151,14 @@ func (b *BuiltinPlugin) UpdatePodSandbox(ctx context.Context, req *api.UpdatePod
 	return &api.UpdatePodSandboxResponse{}, nil
 }
 
+// PodSandboxStatus implements PluginService of the NRI API.
+func (b *BuiltinPlugin) PodSandboxStatus(ctx context.Context, req *api.PodSandboxStatusRequest) (*api.PodSandboxStatusResponse, error) {
+	if b.Handlers.PodSandboxStatus != nil {
+		return b.Handlers.PodSandboxStatus(ctx, req)
+	}
+	return &api.PodSandboxStatusResponse{}, nil
+}
+
 // PostUpdatePodSandbox is a handler for the PostUpdatePodSandbox event.
 func (b *BuiltinPlugin) PostUpdatePodSandbox(ctx context.Context, req *api.PostUpdatePodSandboxRequest) (*api.PostUpdatePodSandboxResponse, error) {
 	if b.Handlers.PostUpdatePodSandbox != nil {

pkg/adaptation/plugin.go

@@ -660,6 +660,29 @@ func (p *plugin) updatePodSandbox(ctx context.Context, req *UpdatePodSandboxRequ
 	return &UpdatePodSandboxResponse{}, nil
 }
 
+// Relay PodSandboxStatus request to plugin.
+func (p *plugin) podSandboxStatus(ctx context.Context, req *PodSandboxStatusRequest) (*PodSandboxStatusResponse, error) {
+	if !p.events.IsSet(Event_POD_SANDBOX_STATUS) {
+		return nil, nil
+	}
+
+	ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
+	defer cancel()
+
+	rsp, err := p.impl.PodSandboxStatus(ctx, req)
+	if err != nil {
+		if isFatalError(err) {
+			log.Errorf(ctx, "closing plugin %s, failed to handle event %d: %v",
+				p.name(), Event_POD_SANDBOX_STATUS, err)
+			p.close()
+			return nil, nil
+		}
+		return nil, err
+	}
+
+	return rsp, nil
+}
+
 // Relay PostUpdatePodSandbox request to plugin.
 func (p *plugin) postUpdatePodSandbox(ctx context.Context, req *PostUpdatePodSandboxRequest) (*PostUpdatePodSandboxResponse, error) {
 	event := Event_POST_UPDATE_POD_SANDBOX

pkg/adaptation/plugin_type.go

@@ -111,6 +111,21 @@ func (p *pluginType) UpdatePodSandbox(ctx context.Context, req *UpdatePodSandbox
 	return nil, errUnknownImpl
 }
 
+// PodSandboxStatus handles type-specific details of relaying a
+// PodSandboxStatus request.
+func (p *pluginType) PodSandboxStatus(ctx context.Context, req *PodSandboxStatusRequest) (*PodSandboxStatusResponse, error) {
+	switch {
+	case p.ttrpcImpl != nil:
+		return p.ttrpcImpl.PodSandboxStatus(ctx, req)
+	case p.builtinImpl != nil:
+		return p.builtinImpl.PodSandboxStatus(ctx, req)
+	case p.wasmImpl != nil:
+		return p.wasmImpl.PodSandboxStatus(ctx, req)
+	}
+
+	return nil, errUnknownImpl
+}
+
 // PostUpdatePodSandbox handles type-specific details of relaying a
 // PostUpdatePodSandbox request.
 func (p *pluginType) PostUpdatePodSandbox(ctx context.Context, req *PostUpdatePodSandboxRequest) (*PostUpdatePodSandboxResponse, error) {