containerd.services.tasks.v1

github.com/containerd/containerd/api/services/tasks/v1/tasks.proto (syntax: proto3)

Dependencies

  • google/protobuf/empty.proto
  • google/protobuf/any.proto
  • gogoproto/gogo.proto
  • github.com/containerd/containerd/api/types/mount.proto
  • github.com/containerd/containerd/api/types/metrics.proto
  • github.com/containerd/containerd/api/types/descriptor.proto
  • github.com/containerd/containerd/api/types/task/task.proto
  • google/protobuf/timestamp.proto

Services

Tasks

MethodInput TypeOutput TypeDescription
Create CreateTaskRequest CreateTaskResponse

Create a task.
Start StartRequest StartResponse

Start a process.
Delete DeleteTaskRequest DeleteResponse

Delete a task and on disk state.
DeleteProcess DeleteProcessRequest DeleteResponse
Get GetRequest GetResponse
List ListTasksRequest ListTasksResponse
Kill KillRequest Empty

Kill a task or process.
Exec ExecProcessRequest Empty
ResizePty ResizePtyRequest Empty
CloseIO CloseIORequest Empty
Pause PauseTaskRequest Empty
Resume ResumeTaskRequest Empty
ListPids ListPidsRequest ListPidsResponse
Checkpoint CheckpointTaskRequest CheckpointTaskResponse
Update UpdateTaskRequest Empty
Metrics MetricsRequest MetricsResponse
Wait WaitRequest WaitResponse

Messages

Message: CreateTaskRequest

#FieldLabelTypeDescription
1 container_id optional string
3 rootfs repeated Mount

RootFS provides the pre-chroot mounts to perform in the shim before executing the container task.

These are for mounts that cannot be performed in the user namespace. Typically, these mounts should be resolved from snapshots specified on the container object.
4 stdin optional string
5 stdout optional string
6 stderr optional string
7 terminal optional bool
8 checkpoint optional Descriptor
9 options optional Any

Message: CreateTaskResponse

#FieldLabelTypeDescription
1 container_id optional string
2 pid optional uint32

Message: StartRequest

#FieldLabelTypeDescription
1 container_id optional string
2 exec_id optional string

Message: StartResponse

#FieldLabelTypeDescription
1 pid optional uint32

Message: DeleteTaskRequest

#FieldLabelTypeDescription
1 container_id optional string

Message: DeleteResponse

#FieldLabelTypeDescription
1 id optional string
2 pid optional uint32
3 exit_status optional uint32
4 exited_at optional Timestamp

Message: DeleteProcessRequest

#FieldLabelTypeDescription
1 container_id optional string
2 exec_id optional string

Message: GetRequest

#FieldLabelTypeDescription
1 container_id optional string
2 exec_id optional string

Message: GetResponse

#FieldLabelTypeDescription
1 process optional Process

Message: ListTasksRequest

#FieldLabelTypeDescription
1 filter optional string

Message: ListTasksResponse

#FieldLabelTypeDescription
1 tasks repeated Process

Message: KillRequest

#FieldLabelTypeDescription
1 container_id optional string
2 exec_id optional string
3 signal optional uint32
4 all optional bool

Message: ExecProcessRequest

#FieldLabelTypeDescription
1 container_id optional string
2 stdin optional string
3 stdout optional string
4 stderr optional string
5 terminal optional bool
6 spec optional Any

Spec for starting a process in the target container.

For runc, this is a process spec, for example.
7 exec_id optional string

id of the exec process

Message: ExecProcessResponse

#FieldLabelTypeDescription

Message: ResizePtyRequest

#FieldLabelTypeDescription
1 container_id optional string
2 exec_id optional string
3 width optional uint32
4 height optional uint32

Message: CloseIORequest

#FieldLabelTypeDescription
1 container_id optional string
2 exec_id optional string
3 stdin optional bool

Message: PauseTaskRequest

#FieldLabelTypeDescription
1 container_id optional string

Message: ResumeTaskRequest

#FieldLabelTypeDescription
1 container_id optional string

Message: ListPidsRequest

#FieldLabelTypeDescription
1 container_id optional string

Message: ListPidsResponse

#FieldLabelTypeDescription
1 processes repeated ProcessInfo

Processes includes the process ID and additional process information

Message: CheckpointTaskRequest

#FieldLabelTypeDescription
1 container_id optional string
2 parent_checkpoint optional string
3 options optional Any

Message: CheckpointTaskResponse

#FieldLabelTypeDescription
1 descriptors repeated Descriptor

Message: UpdateTaskRequest

#FieldLabelTypeDescription
1 container_id optional string
2 resources optional Any

Message: MetricsRequest

#FieldLabelTypeDescription
1 filters repeated string

Message: MetricsResponse

#FieldLabelTypeDescription
1 metrics repeated Metric

Message: WaitRequest

#FieldLabelTypeDescription
1 container_id optional string
2 exec_id optional string

Message: WaitResponse

#FieldLabelTypeDescription
1 exit_status optional uint32
2 exited_at optional Timestamp