compose/protos/containers/v1/containers.proto

167 lines
3.4 KiB
Protocol Buffer

/*
Copyright (c) 2020 Docker Inc.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use, copy,
modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH
THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
syntax = "proto3";
package com.docker.api.protos.containers.v1;
option go_package = "github.com/docker/api/protos/containers/v1;v1";
service Containers {
rpc List(ListRequest) returns (ListResponse);
rpc Create(CreateRequest) returns (CreateResponse);
rpc Start(StartRequest) returns (StartResponse);
rpc Stop(StopRequest) returns (StopResponse);
rpc Kill(KillRequest) returns (KillResponse);
rpc Delete(DeleteRequest) returns (DeleteResponse);
rpc Update(UpdateRequest) returns (UpdateResponse);
rpc Exec(ExecRequest) returns (ExecResponse);
rpc Logs(LogsRequest) returns (stream LogsResponse);
}
message Port {
uint32 host_port = 1;
uint32 container_port = 2;
string protocol = 3;
string host_ip = 4;
}
message Container {
string id = 1;
string image = 2;
string status = 3;
string command = 4;
uint64 cpu_time = 5;
uint64 memory_usage = 6;
uint64 memory_limit = 7;
uint64 pids_current = 8;
uint64 pids_limit = 9;
repeated string labels = 10;
repeated Port ports = 11;
}
message CreateRequest {
string id = 1;
repeated string args = 2;
repeated string env = 3;
bool tty = 4;
string image = 5;
string hostname = 6;
repeated string networks = 7;
string snapshotter = 8;
string logger = 9;
string profile = 10;
string restart_status = 11;
repeated Mount mounts = 12;
string working_dir = 13;
map<string, string> labels = 14;
}
message Mount {
string type = 1;
string source = 2;
string destination = 3;
repeated string options = 4;
}
message CreateResponse {
}
message UpdateRequest {
string id = 1;
string image = 2;
}
message UpdateResponse {
}
message DeleteRequest {
string id = 1;
bool force = 2;
}
message DeleteResponse {
}
message StartRequest {
string id = 1;
string stream_id = 2;
}
message StartResponse {
}
message StopRequest {
string id = 1;
uint32 timeout = 2;
}
message StopResponse {
}
message ExecRequest {
string id = 1;
string stream_id = 2;
repeated string args = 3;
repeated string env = 4;
bool tty = 5;
string working_dir = 6;
}
message ExecResponse {
}
message KillRequest {
string id = 1;
int64 signal = 2;
}
message KillResponse {
}
message ListRequest {
bool all = 1;
}
message ListResponse {
repeated Container containers = 1;
}
message LogsRequest {
string container_id = 1;
bool follow = 2;
}
message LogsResponse {
bytes logs = 1;
}