mirror of
https://github.com/kemko/nomad.git
synced 2026-01-04 17:35:43 +03:00
e168548341
Some of our allocrunner hooks require a task environment for interpolating values based on the node or allocation. But several of the hooks accept an already-built environment or builder and then keep that in memory. Both of these retain a copy of all the node attributes and allocation metadata, which balloons memory usage until the allocation is GC'd. While we'd like to look into ways to avoid keeping the allocrunner around entirely (see #25372), for now we can significantly reduce memory usage by creating the task environment on-demand when calling allocrunner methods, rather than persisting it in the allocrunner hooks. In doing so, we uncover two other bugs: * The WID manager, the group service hook, and the checks hook have to interpolate services for specific tasks. They mutated a taskenv builder to do so, but each time they mutate the builder, they write to the same environment map. When a group has multiple tasks, it's possible for one task to set an environment variable that would then be interpolated in the service definition for another task if that task did not have that environment variable. Only the service definition interpolation is impacted. This does not leak env vars across running tasks, as each taskrunner has its own builder. To fix this, we move the `UpdateTask` method off the builder and onto the taskenv as the `WithTask` method. This makes a shallow copy of the taskenv with a deep clone of the environment map used for interpolation, and then overwrites the environment from the task. * The checks hook interpolates Nomad native service checks only on `Prerun` and not on `Update`. This could cause unexpected deregistration and registration of checks during in-place updates. To fix this, we make sure we interpolate in the `Update` method. I also bumped into an incorrectly implemented interface in the CSI hook. I've pulled that and some better guardrails out to https://github.com/hashicorp/nomad/pull/25472. Fixes: https://github.com/hashicorp/nomad/issues/25269 Fixes: https://hashicorp.atlassian.net/browse/NET-12310 Ref: https://github.com/hashicorp/nomad/issues/25372
78 lines
2.1 KiB
Go
78 lines
2.1 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package interfaces
|
|
|
|
import (
|
|
"github.com/hashicorp/nomad/client/taskenv"
|
|
"github.com/hashicorp/nomad/nomad/structs"
|
|
)
|
|
|
|
// RunnerHook is a lifecycle hook into the life cycle of an allocation runner.
|
|
type RunnerHook interface {
|
|
Name() string
|
|
}
|
|
|
|
// A RunnerPrerunHook is executed before calling TaskRunner.Run for
|
|
// non-terminal allocations. Terminal allocations do *not* call prerun.
|
|
type RunnerPrerunHook interface {
|
|
RunnerHook
|
|
Prerun(*taskenv.TaskEnv) error
|
|
}
|
|
|
|
// A RunnerPreKillHook is executed inside of KillTasks before
|
|
// iterating and killing each task. It will run before the Leader
|
|
// task is killed.
|
|
type RunnerPreKillHook interface {
|
|
RunnerHook
|
|
|
|
PreKill()
|
|
}
|
|
|
|
// A RunnerPostrunHook is executed after calling TaskRunner.Run, even for
|
|
// terminal allocations. Therefore Postrun hooks must be safe to call without
|
|
// first calling Prerun hooks.
|
|
type RunnerPostrunHook interface {
|
|
RunnerHook
|
|
Postrun() error
|
|
}
|
|
|
|
// A RunnerDestroyHook is executed after AllocRunner.Run has exited and must
|
|
// make a best effort cleanup allocation resources. Destroy hooks must be safe
|
|
// to call without first calling Prerun.
|
|
type RunnerDestroyHook interface {
|
|
RunnerHook
|
|
Destroy() error
|
|
}
|
|
|
|
// A RunnerUpdateHook is executed when an allocation update is received from
|
|
// the server. Update is called concurrently with AllocRunner execution and
|
|
// therefore must be safe for concurrent access with other hook methods. Calls
|
|
// to Update are serialized so allocation updates will always be processed in
|
|
// order.
|
|
type RunnerUpdateHook interface {
|
|
RunnerHook
|
|
Update(*RunnerUpdateRequest) error
|
|
}
|
|
|
|
type RunnerUpdateRequest struct {
|
|
Alloc *structs.Allocation
|
|
AllocEnv *taskenv.TaskEnv
|
|
}
|
|
|
|
// A RunnerTaskRestartHook is executed just before the allocation runner is
|
|
// going to restart all tasks.
|
|
type RunnerTaskRestartHook interface {
|
|
RunnerHook
|
|
|
|
PreTaskRestart() error
|
|
}
|
|
|
|
// ShutdownHook may be implemented by AllocRunner or TaskRunner hooks and will
|
|
// be called when the agent process is being shutdown gracefully.
|
|
type ShutdownHook interface {
|
|
RunnerHook
|
|
|
|
Shutdown()
|
|
}
|