containers.proto 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. //
  2. // Copyright 2020 Docker Compose CLI authors
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. // http://www.apache.org/licenses/LICENSE-2.0
  7. // Unless required by applicable law or agreed to in writing, software
  8. // distributed under the License is distributed on an "AS IS" BASIS,
  9. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. // See the License for the specific language governing permissions and
  11. // limitations under the License.
  12. syntax = "proto3";
  13. package com.docker.api.protos.containers.v1;
  14. option go_package = "github.com/docker/compose-cli/protos/containers/v1;v1";
  15. service Containers {
  16. rpc List(ListRequest) returns (ListResponse);
  17. rpc Start(StartRequest) returns (StartResponse);
  18. rpc Stop(StopRequest) returns (StopResponse);
  19. rpc Kill(KillRequest) returns (KillResponse);
  20. rpc Run(RunRequest) returns (RunResponse);
  21. rpc Exec(ExecRequest) returns (ExecResponse);
  22. rpc Logs(LogsRequest) returns (stream LogsResponse);
  23. rpc Delete(DeleteRequest) returns (DeleteResponse);
  24. rpc Inspect(InspectRequest) returns (InspectResponse);
  25. }
  26. message Port {
  27. uint32 host_port = 1;
  28. uint32 container_port = 2;
  29. string protocol = 3;
  30. string host_ip = 4;
  31. }
  32. message Container {
  33. string id = 1;
  34. string image = 2;
  35. string status = 3;
  36. string command = 4;
  37. uint64 cpu_time = 5;
  38. uint64 memory_usage = 6;
  39. uint64 memory_limit = 7;
  40. uint64 pids_current = 8;
  41. uint64 pids_limit = 9;
  42. repeated string labels = 10;
  43. repeated Port ports = 11;
  44. uint64 cpu_limit = 12;
  45. string platform = 13;
  46. string restart_policy_condition = 14;
  47. }
  48. message InspectRequest {
  49. string id = 1;
  50. }
  51. message InspectResponse {
  52. Container container = 1;
  53. }
  54. message DeleteRequest {
  55. string id = 1;
  56. bool force = 2;
  57. }
  58. message DeleteResponse {
  59. }
  60. message StartRequest {
  61. string id = 1;
  62. }
  63. message StartResponse {
  64. }
  65. message StopRequest {
  66. string id = 1;
  67. uint32 timeout = 2;
  68. }
  69. message StopResponse {
  70. }
  71. message KillRequest {
  72. string id = 1;
  73. string signal = 2;
  74. }
  75. message KillResponse {
  76. }
  77. message RunRequest {
  78. string id = 1;
  79. string image = 2;
  80. repeated Port ports = 3;
  81. map<string, string> labels = 4;
  82. repeated string volumes = 5;
  83. uint64 memory_limit = 6;
  84. uint64 cpu_limit = 7;
  85. string restart_policy_condition = 8;
  86. }
  87. message RunResponse {
  88. }
  89. message ExecRequest {
  90. string id = 1;
  91. string command = 2;
  92. string stream_id = 3;
  93. repeated string args = 4;
  94. repeated string env = 5;
  95. bool tty = 6;
  96. }
  97. message ExecResponse {
  98. bytes output = 1;
  99. }
  100. message ListRequest {
  101. bool all = 1;
  102. }
  103. message ListResponse {
  104. repeated Container containers = 1;
  105. }
  106. message LogsRequest {
  107. string container_id = 1;
  108. bool follow = 3;
  109. }
  110. message LogsResponse {
  111. bytes value = 1;
  112. }