Method Delete

client/task.go:372–441

Delete deletes the task and its runtime state it returns the exit status of the task and any errors that were encountered during cleanup

(ctx context.Context, opts ...ProcessDeleteOpts)

// it returns the exit status of the task and any errors that were encountered
// during cleanup
func (t *task) Delete(ctx context.Context, opts ...ProcessDeleteOpts) (*ExitStatus, error) {
	ctx, span := tracing.StartSpan(ctx, tracing.Name("client.task", "Delete"),
		tracing.WithAttribute("task.id", t.ID()),
		tracing.WithNamespace(ctx),
	)
	defer span.End()
	for _, o := range opts {
		if err := o(ctx, t); err != nil {
			return nil, err
		}
	}
	status, err := t.Status(ctx)
	if err != nil && errdefs.IsNotFound(err) {
		return nil, err
	}

	runtime, err := t.client.defaultRuntime(ctx)
	if err != nil {
		return nil, fmt.Errorf("failed to get default runtime: %w", err)
	}

	switch status.Status {
	case Stopped, Unknown, "":
	case Created:
		if runtime == plugins.RuntimePlugin.String()+".windows" {
			// On windows Created is akin to Stopped
			break
		}
		if t.pid == 0 {
			// allow for deletion of created tasks with PID 0
			// https://github.com/containerd/containerd/issues/7357
			break
		}
		fallthrough
	default:
		return nil, fmt.Errorf("task must be stopped before deletion: %s: %w", status.Status, errdefs.ErrFailedPrecondition)
	}
	if t.io != nil {
		// io.Wait locks for restored tasks on Windows unless we call
		// io.Close first (https://github.com/containerd/containerd/issues/5621)
		// in other cases, preserve the contract and let IO finish before closing
		if runtime == plugins.RuntimePlugin.String()+".windows" {
			t.io.Close()
		}
		// io.Cancel is used to cancel the io goroutine while it is in
		// fifo-opening state. It does not stop the pipes since these
		// should be closed on the shim's side, otherwise we might lose
		// data from the container!
		t.io.Cancel()
		t.io.Wait()
	}
	r, err := t.client.TaskService().Delete(ctx, &tasks.DeleteTaskRequest{
		ContainerID: t.id,
	})
	if err != nil {
		return nil, errgrpc.ToNative(err)
	}