luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
open-nomad/client/allocrunner/interfaces/runner.go

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

72 lines
2.2 KiB
Go
Raw Normal View History

[COMPLIANCE] Add Copyright and License Headers
2023-04-10 15:36:59 +00:00
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
Initial V2 alloc runner
2018-06-22 00:35:07 +00:00
package interfaces
Define and thread through state updating interface
2018-07-18 20:45:55 +00:00
import (
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
"github.com/hashicorp/nomad/client/allocdir"
allocrunnerv2 -> allocrunner
2018-10-04 23:22:01 +00:00
"github.com/hashicorp/nomad/client/allocrunner/state"
CSI: set mounts in alloc hook resources atomically (#16722) The allocrunner has a facility for passing data written by allocrunner hooks to taskrunner hooks. Currently the only consumers of this facility are the allocrunner CSI hook (which writes data) and the taskrunner volume hook (which reads that same data). The allocrunner hook for CSI volumes doesn't set the alloc hook resources atomically. Instead, it gets the current resources and then writes a new version back. Because the CSI hook is currently the only writer and all readers happen long afterwards, this should be safe but #16623 shows there's some sequence of events during restore where this breaks down. Refactor hook resources so that hook data is accessed via setters and getters that hold the mutex.
2023-04-03 15:03:36 +00:00
"github.com/hashicorp/nomad/client/pluginmanager/csimanager"
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
"github.com/hashicorp/nomad/client/pluginmanager/drivermanager"
move files around
2018-10-04 22:45:46 +00:00
cstructs "github.com/hashicorp/nomad/client/structs"
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
"github.com/hashicorp/nomad/nomad/structs"
"github.com/hashicorp/nomad/plugins/drivers"
Define and thread through state updating interface
2018-07-18 20:45:55 +00:00
)
Initial V2 alloc runner
2018-06-22 00:35:07 +00:00
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
// AllocRunner is the interface to the allocRunner struct used by client.Client
Initial V2 alloc runner
2018-06-22 00:35:07 +00:00
type AllocRunner interface {
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
Alloc() *structs.Allocation
Initial V2 alloc runner
2018-06-22 00:35:07 +00:00
Run()
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
Restore() error
Update(*structs.Allocation)
Reconnect(update *structs.Allocation) error
Shutdown()
Destroy()
Initial V2 alloc runner
2018-06-22 00:35:07 +00:00
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
IsDestroyed() bool
IsMigrating() bool
IsWaiting() bool
Define and thread through state updating interface
2018-07-18 20:45:55 +00:00
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
WaitCh() <-chan struct{}
DestroyCh() <-chan struct{}
ShutdownCh() <-chan struct{}
AllocState() *state.State
PersistState() error
AcknowledgeState(*state.State)
prioritized client updates (#17354) The allocrunner sends several updates to the server during the early lifecycle of an allocation and its tasks. Clients batch-up allocation updates every 200ms, but experiments like the C2M challenge has shown that even with this batching, servers can be overwhelmed with client updates during high volume deployments. Benchmarking done in #9451 has shown that client updates can easily represent ~70% of all Nomad Raft traffic. Each allocation sends many updates during its lifetime, but only those that change the `ClientStatus` field are critical for progressing a deployment or kicking off a reschedule to recover from failures. Add a priority to the client allocation sync and update the `syncTicker` receiver so that we only send an update if there's a high priority update waiting, or on every 5th tick. This means when there are no high priority updates, the client will send updates at most every 1s instead of 200ms. Benchmarks have shown this can reduce overall Raft traffic by 10%, as well as reduce client-to-server RPC traffic. This changeset also switches from a channel-based collection of updates to a shared buffer, so as to split batching from sending and prevent backpressure onto the allocrunner when the RPC is slow. This doesn't have a major performance benefit in the benchmarks but makes the implementation of the prioritized update simpler. Fixes: #9451
2023-05-31 19:34:16 +00:00
GetUpdatePriority(*structs.Allocation) cstructs.AllocUpdatePriority
allocrunner: provide factory function so we can build mock ARs (#17161) Tools like `nomad-nodesim` are unable to implement a minimal implementation of an allocrunner so that we can test the client communication without having to lug around the entire allocrunner/taskrunner code base. The allocrunner was implemented with an interface specifically for this purpose, but there were circular imports that made it challenging to use in practice. Move the AllocRunner interface into an inner package and provide a factory function type. Provide a minimal test that exercises the new function so that consumers have some idea of what the minimum implementation required is.
2023-05-12 17:29:44 +00:00
SetClientStatus(string)
Signal(taskName, signal string) error
RestartTask(taskName string, taskEvent *structs.TaskEvent) error
RestartRunning(taskEvent *structs.TaskEvent) error
RestartAll(taskEvent *structs.TaskEvent) error
GetTaskEventHandler(taskName string) drivermanager.EventHandler
GetTaskExecHandler(taskName string) drivermanager.TaskExecHandler
GetTaskDriverCapabilities(taskName string) (*drivers.Capabilities, error)
StatsReporter() AllocStatsReporter
Listener() *cstructs.AllocListener
GetAllocDir() *allocdir.AllocDir
Initial V2 alloc runner
2018-06-22 00:35:07 +00:00
}
Define and thread through state updating interface
2018-07-18 20:45:55 +00:00
// TaskStateHandler exposes a handler to be called when a task's state changes
type TaskStateHandler interface {
ar: refactor task killing into 1 method Update comments and address some PR comments from #4775
2018-10-16 03:38:12 +00:00
// TaskStateUpdated is used to notify the alloc runner about task state
// changes.
TaskStateUpdated()
Initial V2 alloc runner
2018-06-22 00:35:07 +00:00
}
move files around
2018-10-04 22:45:46 +00:00
client: add NetworkStatus to Allocation (#8657)
2020-10-12 17:43:04 +00:00
// AllocStatsReporter gives access to the latest resource usage from the
move files around
2018-10-04 22:45:46 +00:00
// allocation
type AllocStatsReporter interface {
LatestAllocStats(taskFilter string) (*cstructs.AllocResourceUsage, error)
}
CSI: set mounts in alloc hook resources atomically (#16722) The allocrunner has a facility for passing data written by allocrunner hooks to taskrunner hooks. Currently the only consumers of this facility are the allocrunner CSI hook (which writes data) and the taskrunner volume hook (which reads that same data). The allocrunner hook for CSI volumes doesn't set the alloc hook resources atomically. Instead, it gets the current resources and then writes a new version back. Because the CSI hook is currently the only writer and all readers happen long afterwards, this should be safe but #16623 shows there's some sequence of events during restore where this breaks down. Refactor hook resources so that hook data is accessed via setters and getters that hold the mutex.
2023-04-03 15:03:36 +00:00
// HookResourceSetter is used to communicate between alloc hooks and task hooks
type HookResourceSetter interface {
SetCSIMounts(map[string]*csimanager.MountInfo)
GetCSIMounts(map[string]*csimanager.MountInfo)
}
Reference in a new issue Copy permalink