Skip to content

Allow configuring request timeout per plugin #304

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

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

Allow configuring request timeout per plugin #304

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
20 changes: 20 additions & 0 deletions pkg/adaptation/adaptation_suite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import (
nri "github.com/containerd/nri/pkg/adaptation"
"github.com/containerd/nri/pkg/api"
"github.com/containerd/nri/pkg/plugin"
"github.com/containerd/nri/pkg/stub"
validator "github.com/containerd/nri/plugins/default-validator/builtin"
)

Expand Down Expand Up @@ -3350,6 +3351,25 @@ var _ = Describe("Plugin configuration request", func() {
Expect(s.plugins[0].stub.RequestTimeout()).To(Equal(requestTimeout))
})
})

When("plugin requests custom timeout", func() {
var (
customTimeout = 10 * time.Second
)

BeforeEach(func() {
s.Prepare(&mockRuntime{}, &mockPlugin{
idx: "00",
name: "test",
options: []stub.Option{stub.WithRequestTimeout(customTimeout)},
})
})

It("should use the per-plugin request timeout", func() {
s.Startup()
Expect(s.plugins[0].stub.RequestTimeout()).To(Equal(customTimeout))
})
})
})

var _ = Describe("NRI version exchange", func() {
Expand Down
78 changes: 47 additions & 31 deletions pkg/adaptation/plugin.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,21 +53,22 @@ var (

type plugin struct {
sync.Mutex
idx string
base string
cfg string
pid int
cmd *exec.Cmd
mux multiplex.Mux
rpcc *ttrpc.Client
rpcl stdnet.Listener
rpcs *ttrpc.Server
events EventMask
closed bool
regC chan error
closeC chan struct{}
r *Adaptation
impl *pluginType
idx string
base string
cfg string
pid int
cmd *exec.Cmd
mux multiplex.Mux
rpcc *ttrpc.Client
rpcl stdnet.Listener
rpcs *ttrpc.Server
events EventMask
requestTimeout time.Duration
closed bool
regC chan error
closeC chan struct{}
r *Adaptation
impl *pluginType
}

// SetPluginRegistrationTimeout sets the timeout for plugin registration.
Expand All @@ -83,7 +84,7 @@ func getPluginRegistrationTimeout() time.Duration {
return pluginRegistrationTimeout
}

// SetPluginRequestTimeout sets the timeout for plugins to handle a request.
// SetPluginRequestTimeout sets the default timeout for plugins to handle a request.
func SetPluginRequestTimeout(t time.Duration) {
timeoutCfgLock.Lock()
defer timeoutCfgLock.Unlock()
Expand All @@ -96,6 +97,17 @@ func getPluginRequestTimeout() time.Duration {
return pluginRequestTimeout
}

// getRequestTimeout returns the per-plugin request timeout if configured by the plugin,
// or the global default request timeout as a fallback.
func (p *plugin) getRequestTimeout() time.Duration {
p.Lock()
defer p.Unlock()
if p.requestTimeout > 0 {
return p.requestTimeout
}
return getPluginRequestTimeout()
}

// newLaunchedPlugin launches a pre-installed plugin with a pre-connected socketpair.
// If the plugin is a wasm binary, then it will use the internal wasm service
// to setup the plugin.
Expand Down Expand Up @@ -497,14 +509,18 @@ func (p *plugin) configure(ctx context.Context, name, version, config string) (e
}
p.events = events

if rpl.RequestTimeout > 0 {
p.requestTimeout = time.Duration(rpl.RequestTimeout) * time.Millisecond
}

return nil
}

// synchronize the plugin with the current state of the runtime.
func (p *plugin) synchronize(ctx context.Context, pods []*PodSandbox, containers []*Container) ([]*ContainerUpdate, error) {
log.Infof(ctx, "synchronizing plugin %s", p.name())

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

var (
Expand Down Expand Up @@ -614,7 +630,7 @@ func (p *plugin) runPodSandbox(ctx context.Context, req *RunPodSandboxRequest) (
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -641,7 +657,7 @@ func (p *plugin) updatePodSandbox(ctx context.Context, req *UpdatePodSandboxRequ
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -667,7 +683,7 @@ func (p *plugin) postUpdatePodSandbox(ctx context.Context, req *PostUpdatePodSan
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -694,7 +710,7 @@ func (p *plugin) stopPodSandbox(ctx context.Context, req *StopPodSandboxRequest)
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -721,7 +737,7 @@ func (p *plugin) removePodSandbox(ctx context.Context, req *RemovePodSandboxRequ
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -748,7 +764,7 @@ func (p *plugin) createContainer(ctx context.Context, req *CreateContainerReques
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand Down Expand Up @@ -777,7 +793,7 @@ func (p *plugin) postCreateContainer(ctx context.Context, req *PostCreateContain
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -804,7 +820,7 @@ func (p *plugin) startContainer(ctx context.Context, req *StartContainerRequest)
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -831,7 +847,7 @@ func (p *plugin) postStartContainer(ctx context.Context, req *PostStartContainer
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -858,7 +874,7 @@ func (p *plugin) updateContainer(ctx context.Context, req *UpdateContainerReques
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand Down Expand Up @@ -887,7 +903,7 @@ func (p *plugin) postUpdateContainer(ctx context.Context, req *PostUpdateContain
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -914,7 +930,7 @@ func (p *plugin) stopContainer(ctx context.Context, req *StopContainerRequest) (
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand Down Expand Up @@ -943,7 +959,7 @@ func (p *plugin) removeContainer(ctx context.Context, req *RemoveContainerReques
return nil, nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand All @@ -970,7 +986,7 @@ func (p *plugin) ValidateContainerAdjustment(ctx context.Context, req *ValidateC
return nil
}

ctx, cancel := context.WithTimeout(ctx, getPluginRequestTimeout())
ctx, cancel := context.WithTimeout(ctx, p.getRequestTimeout())
defer cancel()

start := time.Now()
Expand Down
Loading
Loading