open-nomad/client/allocrunner
Luiz Aoqui e012d9411e
Task lifecycle restart (#14127)
* allocrunner: handle lifecycle when all tasks die

When all tasks die the Coordinator must transition to its terminal
state, coordinatorStatePoststop, to unblock poststop tasks. Since this
could happen at any time (for example, a prestart task dies), all states
must be able to transition to this terminal state.

* allocrunner: implement different alloc restarts

Add a new alloc restart mode where all tasks are restarted, even if they
have already exited. Also unifies the alloc restart logic to use the
implementation that restarts tasks concurrently and ignores
ErrTaskNotRunning errors since those are expected when restarting the
allocation.

* allocrunner: allow tasks to run again

Prevent the task runner Run() method from exiting to allow a dead task
to run again. When the task runner is signaled to restart, the function
will jump back to the MAIN loop and run it again.

The task runner determines if a task needs to run again based on two new
task events that were added to differentiate between a request to
restart a specific task, the tasks that are currently running, or all
tasks that have already run.

* api/cli: add support for all tasks alloc restart

Implement the new -all-tasks alloc restart CLI flag and its API
counterpar, AllTasks. The client endpoint calls the appropriate restart
method from the allocrunner depending on the restart parameters used.

* test: fix tasklifecycle Coordinator test

* allocrunner: kill taskrunners if all tasks are dead

When all non-poststop tasks are dead we need to kill the taskrunners so
we don't leak their goroutines, which are blocked in the alloc restart
loop. This also ensures the allocrunner exits on its own.

* taskrunner: fix tests that waited on WaitCh

Now that "dead" tasks may run again, the taskrunner Run() method will
not return when the task finishes running, so tests must wait for the
task state to be "dead" instead of using the WaitCh, since it won't be
closed until the taskrunner is killed.

* tests: add tests for all tasks alloc restart

* changelog: add entry for #14127

* taskrunner: fix restore logic.

The first implementation of the task runner restore process relied on
server data (`tr.Alloc().TerminalStatus()`) which may not be available
to the client at the time of restore.

It also had the incorrect code path. When restoring a dead task the
driver handle always needs to be clear cleanly using `clearDriverHandle`
otherwise, after exiting the MAIN loop, the task may be killed by
`tr.handleKill`.

The fix is to store the state of the Run() loop in the task runner local
client state: if the task runner ever exits this loop cleanly (not with
a shutdown) it will never be able to run again. So if the Run() loops
starts with this local state flag set, it must exit early.

This local state flag is also being checked on task restart requests. If
the task is "dead" and its Run() loop is not active it will never be
able to run again.

* address code review requests

* apply more code review changes

* taskrunner: add different Restart modes

Using the task event to differentiate between the allocrunner restart
methods proved to be confusing for developers to understand how it all
worked.

So instead of relying on the event type, this commit separated the logic
of restarting an taskRunner into two methods:
- `Restart` will retain the current behaviour and only will only restart
  the task if it's currently running.
- `ForceRestart` is the new method where a `dead` task is allowed to
  restart if its `Run()` method is still active. Callers will need to
  restart the allocRunner taskCoordinator to make sure it will allow the
  task to run again.

* minor fixes
2022-08-24 17:43:07 -04:00
..
interfaces client: add support for checks in nomad services 2022-07-12 17:09:50 -05:00
state chore: fixup inconsistent method receiver names. (#11704) 2021-12-20 11:44:21 +01:00
tasklifecycle Task lifecycle restart (#14127) 2022-08-24 17:43:07 -04:00
taskrunner Task lifecycle restart (#14127) 2022-08-24 17:43:07 -04:00
alloc_runner.go Task lifecycle restart (#14127) 2022-08-24 17:43:07 -04:00
alloc_runner_hooks.go client: add support for checks in nomad services 2022-07-12 17:09:50 -05:00
alloc_runner_test.go Task lifecycle restart (#14127) 2022-08-24 17:43:07 -04:00
alloc_runner_unix_test.go Task lifecycle restart (#14127) 2022-08-24 17:43:07 -04:00
allocdir_hook.go client: cleanup and document context uses 2019-03-12 15:03:54 -07:00
cgroup_hook.go client/ar: thread through cpuset manager 2021-04-13 13:28:36 -04:00
checks_hook.go client: updates from pr feedback 2022-07-21 09:54:27 -05:00
checks_hook_test.go client: add support for checks in nomad services 2022-07-12 17:09:50 -05:00
config.go client: add support for checks in nomad services 2022-07-12 17:09:50 -05:00
consul_grpc_sock_hook.go cleanup: purge github.com/pkg/errors 2022-04-01 19:24:02 -05:00
consul_grpc_sock_hook_test.go test: use T.TempDir to create temporary test directory (#12853) 2022-05-12 11:42:40 -04:00
consul_http_sock_hook.go cleanup: purge github.com/pkg/errors 2022-04-01 19:24:02 -05:00
consul_http_sock_hook_test.go ci: swap ci parallelization for unconstrained gomaxprocs 2022-03-15 12:58:52 -05:00
csi_hook.go csi_hook: valid if any driver supports csi (#13446) 2022-06-22 10:43:43 -04:00
csi_hook_test.go cleanup: replace TypeToPtr helper methods with pointer.Of (#14151) 2022-08-17 18:26:34 +02:00
group_service_hook.go client: add support for checks in nomad services 2022-07-12 17:09:50 -05:00
group_service_hook_test.go cleanup: replace TypeToPtr helper methods with pointer.Of (#14151) 2022-08-17 18:26:34 +02:00
health_hook.go client: add support for checks in nomad services 2022-07-12 17:09:50 -05:00
health_hook_test.go client: add support for checks in nomad services 2022-07-12 17:09:50 -05:00
migrate_hook.go client: cleanup and document context uses 2019-03-12 15:03:54 -07:00
network_hook.go allow configuration of Docker hostnames in bridge mode (#11173) 2021-09-16 08:13:09 +02:00
network_hook_test.go ci: swap ci parallelization for unconstrained gomaxprocs 2022-03-15 12:58:52 -05:00
network_manager_linux.go allow configuration of Docker hostnames in bridge mode (#11173) 2021-09-16 08:13:09 +02:00
network_manager_linux_test.go ci: swap ci parallelization for unconstrained gomaxprocs 2022-03-15 12:58:52 -05:00
network_manager_nonlinux.go gofmt all the files 2021-10-01 10:14:28 -04:00
networking.go ar: isolate network actions performed by client 2021-02-02 23:24:57 -05:00
networking_bridge_linux.go cni: add loopback to linux bridge (#13428) 2022-06-20 11:22:53 -04:00
networking_cni.go gofmt all the files 2021-10-01 10:14:28 -04:00
networking_cni_test.go ci: swap ci parallelization for unconstrained gomaxprocs 2022-03-15 12:58:52 -05:00
testing.go Task lifecycle restart (#14127) 2022-08-24 17:43:07 -04:00
upstream_allocs_hook.go client: cleanup and document context uses 2019-03-12 15:03:54 -07:00