docker-engine-ruby 0.2.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (338) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/docker_engine_ruby/models/config.rb +6 -6
  5. data/lib/docker_engine_ruby/models/config_create_params.rb +1 -11
  6. data/lib/docker_engine_ruby/models/config_list_params.rb +1 -14
  7. data/lib/docker_engine_ruby/models/config_list_response.rb +1 -1
  8. data/lib/docker_engine_ruby/models/config_object.rb +77 -0
  9. data/lib/docker_engine_ruby/models/config_spec.rb +68 -0
  10. data/lib/docker_engine_ruby/models/config_update_params.rb +1 -7
  11. data/lib/docker_engine_ruby/models/connect_request.rb +5 -5
  12. data/lib/docker_engine_ruby/models/container.rb +61 -143
  13. data/lib/docker_engine_ruby/models/container_archive_params.rb +1 -3
  14. data/lib/docker_engine_ruby/models/container_attach_params.rb +6 -29
  15. data/lib/docker_engine_ruby/models/container_create_params.rb +3 -1701
  16. data/lib/docker_engine_ruby/models/container_delete_params.rb +3 -9
  17. data/lib/docker_engine_ruby/models/container_exec_params.rb +11 -39
  18. data/lib/docker_engine_ruby/models/container_inspect_params.rb +1 -3
  19. data/lib/docker_engine_ruby/models/container_kill_params.rb +1 -6
  20. data/lib/docker_engine_ruby/models/container_list_params.rb +4 -36
  21. data/lib/docker_engine_ruby/models/container_logs_params.rb +7 -25
  22. data/lib/docker_engine_ruby/models/container_prune_params.rb +1 -16
  23. data/lib/docker_engine_ruby/models/container_prune_response.rb +2 -5
  24. data/lib/docker_engine_ruby/models/container_rename_params.rb +1 -3
  25. data/lib/docker_engine_ruby/models/container_resize_params.rb +2 -6
  26. data/lib/docker_engine_ruby/models/container_restart_params.rb +2 -9
  27. data/lib/docker_engine_ruby/models/container_start_params.rb +1 -8
  28. data/lib/docker_engine_ruby/models/container_stats_params.rb +2 -11
  29. data/lib/docker_engine_ruby/models/container_stop_params.rb +2 -9
  30. data/lib/docker_engine_ruby/models/container_top_params.rb +1 -3
  31. data/lib/docker_engine_ruby/models/container_update_params.rb +4 -80
  32. data/lib/docker_engine_ruby/models/container_wait_params.rb +1 -11
  33. data/lib/docker_engine_ruby/models/create_request.rb +17 -121
  34. data/lib/docker_engine_ruby/models/exec_inspect_response.rb +1 -12
  35. data/lib/docker_engine_ruby/models/exec_resize_params.rb +2 -6
  36. data/lib/docker_engine_ruby/models/exec_start_params.rb +3 -9
  37. data/lib/docker_engine_ruby/models/filesystem_change.rb +3 -3
  38. data/lib/docker_engine_ruby/models/image.rb +33 -66
  39. data/lib/docker_engine_ruby/models/image_build_params.rb +25 -122
  40. data/lib/docker_engine_ruby/models/image_build_prune_params.rb +5 -32
  41. data/lib/docker_engine_ruby/models/image_build_prune_response.rb +1 -3
  42. data/lib/docker_engine_ruby/models/image_commit_params.rb +7 -21
  43. data/lib/docker_engine_ruby/models/image_delete_params.rb +3 -14
  44. data/lib/docker_engine_ruby/models/image_get_all_params.rb +2 -13
  45. data/lib/docker_engine_ruby/models/image_get_params.rb +1 -10
  46. data/lib/docker_engine_ruby/models/image_history_params.rb +1 -15
  47. data/lib/docker_engine_ruby/models/image_inspect_params.rb +1 -3
  48. data/lib/docker_engine_ruby/models/image_list_params.rb +5 -29
  49. data/lib/docker_engine_ruby/models/image_list_response.rb +1 -1
  50. data/lib/docker_engine_ruby/models/image_load_params.rb +2 -14
  51. data/lib/docker_engine_ruby/models/image_prune_params.rb +1 -16
  52. data/lib/docker_engine_ruby/models/image_prune_response.rb +2 -5
  53. data/lib/docker_engine_ruby/models/image_pull_params.rb +13 -60
  54. data/lib/docker_engine_ruby/models/image_push_params.rb +2 -19
  55. data/lib/docker_engine_ruby/models/image_search_params.rb +3 -16
  56. data/lib/docker_engine_ruby/models/image_search_response.rb +1 -13
  57. data/lib/docker_engine_ruby/models/image_summary.rb +638 -0
  58. data/lib/docker_engine_ruby/models/image_tag_params.rb +2 -6
  59. data/lib/docker_engine_ruby/models/info.rb +27 -56
  60. data/lib/docker_engine_ruby/models/inspect.rb +5 -7
  61. data/lib/docker_engine_ruby/models/list_response.rb +0 -3
  62. data/lib/docker_engine_ruby/models/network.rb +7 -4
  63. data/lib/docker_engine_ruby/models/network_create_params.rb +11 -26
  64. data/lib/docker_engine_ruby/models/network_create_response.rb +27 -0
  65. data/lib/docker_engine_ruby/models/network_inspect_params.rb +2 -6
  66. data/lib/docker_engine_ruby/models/network_inspect_response.rb +219 -89
  67. data/lib/docker_engine_ruby/models/network_list_params.rb +1 -21
  68. data/lib/docker_engine_ruby/models/network_list_response.rb +1 -1
  69. data/lib/docker_engine_ruby/models/network_prune_params.rb +1 -16
  70. data/lib/docker_engine_ruby/models/network_prune_response.rb +1 -2
  71. data/lib/docker_engine_ruby/models/network_summary.rb +260 -0
  72. data/lib/docker_engine_ruby/models/node.rb +12 -25
  73. data/lib/docker_engine_ruby/models/node_delete_params.rb +1 -3
  74. data/lib/docker_engine_ruby/models/node_list_params.rb +1 -15
  75. data/lib/docker_engine_ruby/models/node_spec.rb +67 -0
  76. data/lib/docker_engine_ruby/models/node_update_params.rb +1 -7
  77. data/lib/docker_engine_ruby/models/plugin.rb +2 -24
  78. data/lib/docker_engine_ruby/models/plugin_create_params.rb +1 -8
  79. data/lib/docker_engine_ruby/models/plugin_delete_params.rb +1 -7
  80. data/lib/docker_engine_ruby/models/plugin_disable_params.rb +1 -6
  81. data/lib/docker_engine_ruby/models/plugin_enable_params.rb +1 -3
  82. data/lib/docker_engine_ruby/models/plugin_list_params.rb +1 -12
  83. data/lib/docker_engine_ruby/models/plugin_privileges_params.rb +1 -7
  84. data/lib/docker_engine_ruby/models/plugin_pull_params.rb +8 -21
  85. data/lib/docker_engine_ruby/models/plugin_set_params.rb +3 -3
  86. data/lib/docker_engine_ruby/models/plugin_upgrade_params.rb +4 -13
  87. data/lib/docker_engine_ruby/models/secret.rb +9 -9
  88. data/lib/docker_engine_ruby/models/secret_create_params.rb +1 -11
  89. data/lib/docker_engine_ruby/models/secret_list_params.rb +1 -14
  90. data/lib/docker_engine_ruby/models/secret_spec.rb +99 -0
  91. data/lib/docker_engine_ruby/models/secret_update_params.rb +1 -7
  92. data/lib/docker_engine_ruby/models/service.rb +21 -36
  93. data/lib/docker_engine_ruby/models/service_create_params.rb +1 -15
  94. data/lib/docker_engine_ruby/models/service_create_response.rb +32 -0
  95. data/lib/docker_engine_ruby/models/service_inspect_params.rb +1 -3
  96. data/lib/docker_engine_ruby/models/service_list_params.rb +2 -17
  97. data/lib/docker_engine_ruby/models/service_logs_params.rb +7 -25
  98. data/lib/docker_engine_ruby/models/{spec.rb → service_spec.rb} +93 -158
  99. data/lib/docker_engine_ruby/models/service_update_params.rb +4 -34
  100. data/lib/docker_engine_ruby/models/service_update_response.rb +17 -0
  101. data/lib/docker_engine_ruby/models/stats_response.rb +143 -68
  102. data/lib/docker_engine_ruby/models/summary.rb +12 -32
  103. data/lib/docker_engine_ruby/models/swarm.rb +9 -12
  104. data/lib/docker_engine_ruby/models/swarm_init_params.rb +10 -38
  105. data/lib/docker_engine_ruby/models/swarm_join_params.rb +5 -31
  106. data/lib/docker_engine_ruby/models/swarm_leave_params.rb +1 -7
  107. data/lib/docker_engine_ruby/models/swarm_spec.rb +270 -0
  108. data/lib/docker_engine_ruby/models/swarm_unlock_key_response.rb +1 -2
  109. data/lib/docker_engine_ruby/models/swarm_unlock_params.rb +1 -3
  110. data/lib/docker_engine_ruby/models/swarm_update_params.rb +4 -16
  111. data/lib/docker_engine_ruby/models/system_data_usage_params.rb +43 -16
  112. data/lib/docker_engine_ruby/models/system_data_usage_response.rb +0 -19
  113. data/lib/docker_engine_ruby/models/system_events_params.rb +3 -29
  114. data/lib/docker_engine_ruby/models/system_events_response.rb +0 -3
  115. data/lib/docker_engine_ruby/models/task.rb +13 -15
  116. data/lib/docker_engine_ruby/models/task_list_params.rb +1 -16
  117. data/lib/docker_engine_ruby/models/task_logs_params.rb +7 -25
  118. data/lib/docker_engine_ruby/models/task_spec.rb +1439 -0
  119. data/lib/docker_engine_ruby/models/version.rb +8 -17
  120. data/lib/docker_engine_ruby/models/volume.rb +38 -194
  121. data/lib/docker_engine_ruby/models/volume_delete_params.rb +1 -3
  122. data/lib/docker_engine_ruby/models/volume_list_params.rb +1 -15
  123. data/lib/docker_engine_ruby/models/volume_prune_params.rb +1 -14
  124. data/lib/docker_engine_ruby/models/volume_prune_response.rb +2 -5
  125. data/lib/docker_engine_ruby/models/volume_update_params.rb +18 -127
  126. data/lib/docker_engine_ruby/models.rb +23 -1
  127. data/lib/docker_engine_ruby/resources/auth.rb +1 -2
  128. data/lib/docker_engine_ruby/resources/configs.rb +14 -23
  129. data/lib/docker_engine_ruby/resources/containers.rb +88 -337
  130. data/lib/docker_engine_ruby/resources/distribution.rb +2 -3
  131. data/lib/docker_engine_ruby/resources/exec.rb +11 -22
  132. data/lib/docker_engine_ruby/resources/images.rb +100 -230
  133. data/lib/docker_engine_ruby/resources/networks.rb +26 -45
  134. data/lib/docker_engine_ruby/resources/nodes.rb +8 -18
  135. data/lib/docker_engine_ruby/resources/plugins.rb +27 -74
  136. data/lib/docker_engine_ruby/resources/secrets.rb +10 -19
  137. data/lib/docker_engine_ruby/resources/services.rb +27 -56
  138. data/lib/docker_engine_ruby/resources/swarm.rb +28 -40
  139. data/lib/docker_engine_ruby/resources/system.rb +8 -49
  140. data/lib/docker_engine_ruby/resources/tasks.rb +12 -32
  141. data/lib/docker_engine_ruby/resources/volumes.rb +8 -22
  142. data/lib/docker_engine_ruby/version.rb +1 -1
  143. data/lib/docker_engine_ruby.rb +16 -5
  144. data/rbi/docker_engine_ruby/models/config.rbi +9 -7
  145. data/rbi/docker_engine_ruby/models/config_create_params.rbi +2 -34
  146. data/rbi/docker_engine_ruby/models/config_list_params.rbi +1 -22
  147. data/rbi/docker_engine_ruby/models/config_list_response.rbi +3 -1
  148. data/rbi/docker_engine_ruby/models/config_object.rbi +130 -0
  149. data/rbi/docker_engine_ruby/models/config_spec.rbi +127 -0
  150. data/rbi/docker_engine_ruby/models/config_update_params.rbi +1 -8
  151. data/rbi/docker_engine_ruby/models/connect_request.rbi +7 -12
  152. data/rbi/docker_engine_ruby/models/container.rbi +73 -194
  153. data/rbi/docker_engine_ruby/models/container_archive_params.rbi +1 -6
  154. data/rbi/docker_engine_ruby/models/container_attach_params.rbi +0 -28
  155. data/rbi/docker_engine_ruby/models/container_create_params.rbi +1 -3250
  156. data/rbi/docker_engine_ruby/models/container_delete_params.rbi +1 -12
  157. data/rbi/docker_engine_ruby/models/container_exec_params.rbi +0 -28
  158. data/rbi/docker_engine_ruby/models/container_inspect_params.rbi +1 -6
  159. data/rbi/docker_engine_ruby/models/container_kill_params.rbi +1 -6
  160. data/rbi/docker_engine_ruby/models/container_list_params.rbi +0 -50
  161. data/rbi/docker_engine_ruby/models/container_logs_params.rbi +0 -16
  162. data/rbi/docker_engine_ruby/models/container_prune_params.rbi +1 -26
  163. data/rbi/docker_engine_ruby/models/container_prune_response.rbi +1 -8
  164. data/rbi/docker_engine_ruby/models/container_rename_params.rbi +1 -6
  165. data/rbi/docker_engine_ruby/models/container_resize_params.rbi +1 -9
  166. data/rbi/docker_engine_ruby/models/container_restart_params.rbi +1 -9
  167. data/rbi/docker_engine_ruby/models/container_start_params.rbi +1 -10
  168. data/rbi/docker_engine_ruby/models/container_stats_params.rbi +1 -13
  169. data/rbi/docker_engine_ruby/models/container_stop_params.rbi +1 -9
  170. data/rbi/docker_engine_ruby/models/container_top_params.rbi +1 -6
  171. data/rbi/docker_engine_ruby/models/container_update_params.rbi +1 -170
  172. data/rbi/docker_engine_ruby/models/container_wait_params.rbi +1 -13
  173. data/rbi/docker_engine_ruby/models/create_request.rbi +7 -139
  174. data/rbi/docker_engine_ruby/models/exec_inspect_response.rbi +0 -2
  175. data/rbi/docker_engine_ruby/models/exec_resize_params.rbi +1 -9
  176. data/rbi/docker_engine_ruby/models/exec_start_params.rbi +0 -6
  177. data/rbi/docker_engine_ruby/models/filesystem_change.rbi +10 -13
  178. data/rbi/docker_engine_ruby/models/image.rbi +48 -106
  179. data/rbi/docker_engine_ruby/models/image_build_params.rbi +0 -127
  180. data/rbi/docker_engine_ruby/models/image_build_prune_params.rbi +0 -38
  181. data/rbi/docker_engine_ruby/models/image_build_prune_response.rbi +1 -6
  182. data/rbi/docker_engine_ruby/models/image_commit_params.rbi +0 -14
  183. data/rbi/docker_engine_ruby/models/image_delete_params.rbi +0 -10
  184. data/rbi/docker_engine_ruby/models/image_get_all_params.rbi +1 -17
  185. data/rbi/docker_engine_ruby/models/image_get_params.rbi +1 -14
  186. data/rbi/docker_engine_ruby/models/image_history_params.rbi +1 -24
  187. data/rbi/docker_engine_ruby/models/image_inspect_params.rbi +1 -6
  188. data/rbi/docker_engine_ruby/models/image_list_params.rbi +0 -32
  189. data/rbi/docker_engine_ruby/models/image_list_response.rbi +3 -1
  190. data/rbi/docker_engine_ruby/models/image_load_params.rbi +1 -18
  191. data/rbi/docker_engine_ruby/models/image_prune_params.rbi +1 -26
  192. data/rbi/docker_engine_ruby/models/image_prune_response.rbi +1 -8
  193. data/rbi/docker_engine_ruby/models/image_pull_params.rbi +6 -79
  194. data/rbi/docker_engine_ruby/models/image_push_params.rbi +0 -22
  195. data/rbi/docker_engine_ruby/models/image_search_params.rbi +1 -20
  196. data/rbi/docker_engine_ruby/models/image_search_response.rbi +0 -10
  197. data/rbi/docker_engine_ruby/models/image_summary.rbi +1073 -0
  198. data/rbi/docker_engine_ruby/models/image_tag_params.rbi +1 -9
  199. data/rbi/docker_engine_ruby/models/info.rbi +33 -80
  200. data/rbi/docker_engine_ruby/models/inspect.rbi +6 -12
  201. data/rbi/docker_engine_ruby/models/network.rbi +7 -4
  202. data/rbi/docker_engine_ruby/models/network_create_params.rbi +0 -30
  203. data/rbi/docker_engine_ruby/models/network_create_response.rbi +37 -0
  204. data/rbi/docker_engine_ruby/models/network_inspect_params.rbi +1 -9
  205. data/rbi/docker_engine_ruby/models/network_inspect_response.rbi +345 -198
  206. data/rbi/docker_engine_ruby/models/network_list_params.rbi +1 -36
  207. data/rbi/docker_engine_ruby/models/network_list_response.rbi +3 -1
  208. data/rbi/docker_engine_ruby/models/network_prune_params.rbi +1 -26
  209. data/rbi/docker_engine_ruby/models/network_prune_response.rbi +1 -5
  210. data/rbi/docker_engine_ruby/models/network_summary.rbi +444 -0
  211. data/rbi/docker_engine_ruby/models/node.rbi +15 -21
  212. data/rbi/docker_engine_ruby/models/node_delete_params.rbi +1 -6
  213. data/rbi/docker_engine_ruby/models/node_list_params.rbi +1 -24
  214. data/rbi/docker_engine_ruby/models/node_spec.rbi +126 -0
  215. data/rbi/docker_engine_ruby/models/node_update_params.rbi +1 -8
  216. data/rbi/docker_engine_ruby/models/plugin.rbi +1 -11
  217. data/rbi/docker_engine_ruby/models/plugin_create_params.rbi +1 -9
  218. data/rbi/docker_engine_ruby/models/plugin_delete_params.rbi +1 -8
  219. data/rbi/docker_engine_ruby/models/plugin_disable_params.rbi +1 -6
  220. data/rbi/docker_engine_ruby/models/plugin_enable_params.rbi +1 -6
  221. data/rbi/docker_engine_ruby/models/plugin_list_params.rbi +1 -18
  222. data/rbi/docker_engine_ruby/models/plugin_privileges_params.rbi +1 -8
  223. data/rbi/docker_engine_ruby/models/plugin_pull_params.rbi +6 -21
  224. data/rbi/docker_engine_ruby/models/plugin_set_params.rbi +3 -6
  225. data/rbi/docker_engine_ruby/models/plugin_upgrade_params.rbi +3 -17
  226. data/rbi/docker_engine_ruby/models/secret.rbi +12 -12
  227. data/rbi/docker_engine_ruby/models/secret_create_params.rbi +2 -34
  228. data/rbi/docker_engine_ruby/models/secret_list_params.rbi +1 -22
  229. data/rbi/docker_engine_ruby/models/secret_spec.rbi +181 -0
  230. data/rbi/docker_engine_ruby/models/secret_update_params.rbi +1 -8
  231. data/rbi/docker_engine_ruby/models/service.rbi +24 -44
  232. data/rbi/docker_engine_ruby/models/service_create_params.rbi +1 -36
  233. data/rbi/docker_engine_ruby/models/service_create_response.rbi +50 -0
  234. data/rbi/docker_engine_ruby/models/service_inspect_params.rbi +1 -6
  235. data/rbi/docker_engine_ruby/models/service_list_params.rbi +1 -25
  236. data/rbi/docker_engine_ruby/models/service_logs_params.rbi +0 -16
  237. data/rbi/docker_engine_ruby/models/{spec.rbi → service_spec.rbi} +157 -186
  238. data/rbi/docker_engine_ruby/models/service_update_params.rbi +0 -50
  239. data/rbi/docker_engine_ruby/models/service_update_response.rbi +33 -0
  240. data/rbi/docker_engine_ruby/models/stats_response.rbi +213 -141
  241. data/rbi/docker_engine_ruby/models/summary.rbi +16 -53
  242. data/rbi/docker_engine_ruby/models/swarm.rbi +12 -12
  243. data/rbi/docker_engine_ruby/models/swarm_init_params.rbi +4 -54
  244. data/rbi/docker_engine_ruby/models/swarm_join_params.rbi +0 -36
  245. data/rbi/docker_engine_ruby/models/swarm_leave_params.rbi +1 -8
  246. data/rbi/docker_engine_ruby/models/swarm_spec.rbi +568 -0
  247. data/rbi/docker_engine_ruby/models/swarm_unlock_key_response.rbi +1 -5
  248. data/rbi/docker_engine_ruby/models/swarm_unlock_params.rbi +1 -6
  249. data/rbi/docker_engine_ruby/models/swarm_update_params.rbi +0 -10
  250. data/rbi/docker_engine_ruby/models/system_data_usage_params.rbi +79 -27
  251. data/rbi/docker_engine_ruby/models/system_events_params.rbi +1 -46
  252. data/rbi/docker_engine_ruby/models/task.rbi +16 -20
  253. data/rbi/docker_engine_ruby/models/task_list_params.rbi +1 -26
  254. data/rbi/docker_engine_ruby/models/task_logs_params.rbi +0 -16
  255. data/rbi/docker_engine_ruby/models/task_spec.rbi +3011 -0
  256. data/rbi/docker_engine_ruby/models/version.rbi +8 -22
  257. data/rbi/docker_engine_ruby/models/volume.rbi +25 -225
  258. data/rbi/docker_engine_ruby/models/volume_delete_params.rbi +1 -6
  259. data/rbi/docker_engine_ruby/models/volume_list_params.rbi +1 -24
  260. data/rbi/docker_engine_ruby/models/volume_prune_params.rbi +1 -22
  261. data/rbi/docker_engine_ruby/models/volume_prune_response.rbi +1 -8
  262. data/rbi/docker_engine_ruby/models/volume_update_params.rbi +7 -143
  263. data/rbi/docker_engine_ruby/models.rbi +23 -1
  264. data/rbi/docker_engine_ruby/resources/auth.rbi +1 -2
  265. data/rbi/docker_engine_ruby/resources/configs.rbi +11 -32
  266. data/rbi/docker_engine_ruby/resources/containers.rbi +36 -388
  267. data/rbi/docker_engine_ruby/resources/distribution.rbi +2 -6
  268. data/rbi/docker_engine_ruby/resources/exec.rbi +5 -24
  269. data/rbi/docker_engine_ruby/resources/images.rbi +73 -366
  270. data/rbi/docker_engine_ruby/resources/networks.rbi +9 -78
  271. data/rbi/docker_engine_ruby/resources/nodes.rbi +7 -31
  272. data/rbi/docker_engine_ruby/resources/plugins.rbi +22 -91
  273. data/rbi/docker_engine_ruby/resources/secrets.rbi +9 -30
  274. data/rbi/docker_engine_ruby/resources/services.rbi +14 -62
  275. data/rbi/docker_engine_ruby/resources/swarm.rbi +8 -61
  276. data/rbi/docker_engine_ruby/resources/system.rbi +11 -66
  277. data/rbi/docker_engine_ruby/resources/tasks.rbi +3 -34
  278. data/rbi/docker_engine_ruby/resources/volumes.rbi +7 -43
  279. data/sig/docker_engine_ruby/models/config.rbs +11 -9
  280. data/sig/docker_engine_ruby/models/config_create_params.rbs +3 -24
  281. data/sig/docker_engine_ruby/models/config_list_response.rbs +1 -1
  282. data/sig/docker_engine_ruby/models/config_object.rbs +64 -0
  283. data/sig/docker_engine_ruby/models/config_spec.rbs +59 -0
  284. data/sig/docker_engine_ruby/models/connect_request.rbs +12 -12
  285. data/sig/docker_engine_ruby/models/container.rbs +62 -62
  286. data/sig/docker_engine_ruby/models/container_create_params.rbs +1 -1321
  287. data/sig/docker_engine_ruby/models/container_update_params.rbs +0 -51
  288. data/sig/docker_engine_ruby/models/create_request.rbs +5 -5
  289. data/sig/docker_engine_ruby/models/filesystem_change.rbs +1 -1
  290. data/sig/docker_engine_ruby/models/image.rbs +51 -53
  291. data/sig/docker_engine_ruby/models/image_list_response.rbs +1 -1
  292. data/sig/docker_engine_ruby/models/image_pull_params.rbs +5 -7
  293. data/sig/docker_engine_ruby/models/image_summary.rbs +457 -0
  294. data/sig/docker_engine_ruby/models/info.rbs +61 -41
  295. data/sig/docker_engine_ruby/models/inspect.rbs +12 -8
  296. data/sig/docker_engine_ruby/models/network.rbs +5 -5
  297. data/sig/docker_engine_ruby/models/network_create_response.rbs +15 -0
  298. data/sig/docker_engine_ruby/models/network_inspect_response.rbs +179 -90
  299. data/sig/docker_engine_ruby/models/network_list_response.rbs +1 -1
  300. data/sig/docker_engine_ruby/models/network_summary.rbs +238 -0
  301. data/sig/docker_engine_ruby/models/node.rbs +23 -19
  302. data/sig/docker_engine_ruby/models/node_spec.rbs +70 -0
  303. data/sig/docker_engine_ruby/models/plugin_pull_params.rbs +5 -9
  304. data/sig/docker_engine_ruby/models/plugin_set_params.rbs +2 -4
  305. data/sig/docker_engine_ruby/models/plugin_upgrade_params.rbs +2 -6
  306. data/sig/docker_engine_ruby/models/secret.rbs +15 -15
  307. data/sig/docker_engine_ruby/models/secret_create_params.rbs +3 -24
  308. data/sig/docker_engine_ruby/models/secret_spec.rbs +82 -0
  309. data/sig/docker_engine_ruby/models/service.rbs +32 -30
  310. data/sig/docker_engine_ruby/models/service_create_params.rbs +1 -16
  311. data/sig/docker_engine_ruby/models/service_create_response.rbs +17 -0
  312. data/sig/docker_engine_ruby/models/service_spec.rbs +471 -0
  313. data/sig/docker_engine_ruby/models/service_update_params.rbs +0 -13
  314. data/sig/docker_engine_ruby/models/service_update_response.rbs +15 -0
  315. data/sig/docker_engine_ruby/models/stats_response.rbs +188 -74
  316. data/sig/docker_engine_ruby/models/summary.rbs +20 -16
  317. data/sig/docker_engine_ruby/models/swarm.rbs +15 -15
  318. data/sig/docker_engine_ruby/models/swarm_init_params.rbs +5 -5
  319. data/sig/docker_engine_ruby/models/swarm_spec.rbs +293 -0
  320. data/sig/docker_engine_ruby/models/system_data_usage_params.rbs +25 -10
  321. data/sig/docker_engine_ruby/models/task.rbs +20 -20
  322. data/sig/docker_engine_ruby/models/task_spec.rbs +1480 -0
  323. data/sig/docker_engine_ruby/models/version.rbs +13 -4
  324. data/sig/docker_engine_ruby/models/volume.rbs +27 -25
  325. data/sig/docker_engine_ruby/models/volume_update_params.rbs +5 -5
  326. data/sig/docker_engine_ruby/models.rbs +23 -1
  327. data/sig/docker_engine_ruby/resources/configs.rbs +3 -3
  328. data/sig/docker_engine_ruby/resources/containers.rbs +1 -2
  329. data/sig/docker_engine_ruby/resources/images.rbs +3 -3
  330. data/sig/docker_engine_ruby/resources/networks.rbs +2 -2
  331. data/sig/docker_engine_ruby/resources/nodes.rbs +1 -1
  332. data/sig/docker_engine_ruby/resources/plugins.rbs +3 -3
  333. data/sig/docker_engine_ruby/resources/secrets.rbs +2 -2
  334. data/sig/docker_engine_ruby/resources/services.rbs +4 -4
  335. data/sig/docker_engine_ruby/resources/swarm.rbs +2 -2
  336. data/sig/docker_engine_ruby/resources/system.rbs +1 -1
  337. metadata +37 -4
  338. data/sig/docker_engine_ruby/models/spec.rbs +0 -467
@@ -7,1718 +7,20 @@ module DockerEngineRuby
7
7
  extend DockerEngineRuby::Internal::Type::RequestParameters::Converter
8
8
  include DockerEngineRuby::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute config
11
- # Configuration for a container that is portable between hosts.
12
- #
13
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config]
14
- required :config, -> { DockerEngineRuby::ContainerCreateParams::Config }
15
-
16
10
  # @!attribute name
17
- # Assign the specified name to the container. Must match
18
- # `/?[a-zA-Z0-9][a-zA-Z0-9_.-]+`.
19
11
  #
20
12
  # @return [String, nil]
21
13
  optional :name, String
22
14
 
23
15
  # @!attribute platform
24
- # Platform in the format `os[/arch[/variant]]` used for image lookup.
25
- #
26
- # When specified, the daemon checks if the requested image is present in the local
27
- # image cache with the given OS and Architecture, and otherwise returns a `404`
28
- # status.
29
- #
30
- # If the option is not set, the host's native OS and Architecture are used to look
31
- # up the image in the image cache. However, if no platform is passed and the given
32
- # image does exist in the local image cache, but its OS or architecture does not
33
- # match, the container is created with the available image, and a warning is added
34
- # to the `Warnings` field in the response, for example;
35
- #
36
- # WARNING: The requested image's platform (linux/arm64/v8) does not
37
- # match the detected host platform (linux/amd64) and no
38
- # specific platform was requested
39
16
  #
40
17
  # @return [String, nil]
41
18
  optional :platform, String
42
19
 
43
- # @!method initialize(config:, name: nil, platform: nil, request_options: {})
44
- # Some parameter documentations has been truncated, see
45
- # {DockerEngineRuby::Models::ContainerCreateParams} for more details.
46
- #
47
- # @param config [DockerEngineRuby::Models::ContainerCreateParams::Config] Configuration for a container that is portable between hosts.
48
- #
49
- # @param name [String] Assign the specified name to the container. Must match
50
- #
51
- # @param platform [String] Platform in the format `os[/arch[/variant]]` used for image lookup.
52
- #
20
+ # @!method initialize(name: nil, platform: nil, request_options: {})
21
+ # @param name [String]
22
+ # @param platform [String]
53
23
  # @param request_options [DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}]
54
-
55
- class Config < DockerEngineRuby::Models::Config
56
- # @!attribute host_config
57
- # Container configuration that depends on the host we are running on
58
- #
59
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig, nil]
60
- optional :host_config,
61
- -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig },
62
- api_name: :HostConfig
63
-
64
- # @!attribute networking_config
65
- # NetworkingConfig represents the container's networking configuration for each of
66
- # its interfaces. It is used for the networking configs specified in the
67
- # `docker create` and `docker network connect` commands.
68
- #
69
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig, nil]
70
- optional :networking_config,
71
- -> { DockerEngineRuby::ContainerCreateParams::Config::NetworkingConfig },
72
- api_name: :NetworkingConfig
73
-
74
- # @!method initialize(host_config: nil, networking_config: nil)
75
- # Some parameter documentations has been truncated, see
76
- # {DockerEngineRuby::Models::ContainerCreateParams::Config} for more details.
77
- #
78
- # Configuration for a container that is portable between hosts.
79
- #
80
- # @param host_config [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig] Container configuration that depends on the host we are running on
81
- #
82
- # @param networking_config [DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig] NetworkingConfig represents the container's networking configuration for
83
-
84
- class HostConfig < DockerEngineRuby::Internal::Type::BaseModel
85
- # @!attribute annotations
86
- # Arbitrary non-identifying metadata attached to container and provided to the
87
- # runtime when the container is started.
88
- #
89
- # @return [Hash{Symbol=>String}, nil]
90
- optional :annotations, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Annotations
91
-
92
- # @!attribute auto_remove
93
- # Automatically remove the container when the container's process exits. This has
94
- # no effect if `RestartPolicy` is set.
95
- #
96
- # @return [Boolean, nil]
97
- optional :auto_remove, DockerEngineRuby::Internal::Type::Boolean, api_name: :AutoRemove
98
-
99
- # @!attribute binds
100
- # A list of volume bindings for this container. Each volume binding is a string in
101
- # one of these forms:
102
- #
103
- # - `host-src:container-dest[:options]` to bind-mount a host path into the
104
- # container. Both `host-src`, and `container-dest` must be an _absolute_ path.
105
- # - `volume-name:container-dest[:options]` to bind-mount a volume managed by a
106
- # volume driver into the container. `container-dest` must be an _absolute_ path.
107
- #
108
- # `options` is an optional, comma-delimited list of:
109
- #
110
- # - `nocopy` disables automatic copying of data from the container path to the
111
- # volume. The `nocopy` flag only applies to named volumes.
112
- # - `[ro|rw]` mounts a volume read-only or read-write, respectively. If omitted or
113
- # set to `rw`, volumes are mounted read-write.
114
- # - `[z|Z]` applies SELinux labels to allow or deny multiple containers to read
115
- # and write to the same volume.
116
- # - `z`: a _shared_ content label is applied to the content. This label
117
- # indicates that multiple containers can share the volume content, for both
118
- # reading and writing.
119
- # - `Z`: a _private unshared_ label is applied to the content. This label
120
- # indicates that only the current container can use a private volume. Labeling
121
- # systems such as SELinux require proper labels to be placed on volume content
122
- # that is mounted into a container. Without a label, the security system can
123
- # prevent a container's processes from using the content. By default, the
124
- # labels set by the host operating system are not modified.
125
- # - `[[r]shared|[r]slave|[r]private]` specifies mount
126
- # [propagation behavior](https://www.kernel.org/doc/Documentation/filesystems/sharedsubtree.txt).
127
- # This only applies to bind-mounted volumes, not internal volumes or named
128
- # volumes. Mount propagation requires the source mount point (the location where
129
- # the source directory is mounted in the host operating system) to have the
130
- # correct propagation properties. For shared volumes, the source mount point
131
- # must be set to `shared`. For slave volumes, the mount must be set to either
132
- # `shared` or `slave`.
133
- #
134
- # @return [Array<String>, nil]
135
- optional :binds, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Binds
136
-
137
- # @!attribute blkio_device_read_bps
138
- # Limit read rate (bytes per second) from a device, in the form:
139
- #
140
- # ```
141
- # [{"Path": "device_path", "Rate": rate}]
142
- # ```
143
- #
144
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceReadBp>, nil]
145
- optional :blkio_device_read_bps,
146
- -> {
147
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::BlkioDeviceReadBp]
148
- },
149
- api_name: :BlkioDeviceReadBps
150
-
151
- # @!attribute blkio_device_read_i_ops
152
- # Limit read rate (IO per second) from a device, in the form:
153
- #
154
- # ```
155
- # [{"Path": "device_path", "Rate": rate}]
156
- # ```
157
- #
158
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceReadIOp>, nil]
159
- optional :blkio_device_read_i_ops,
160
- -> {
161
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::BlkioDeviceReadIOp]
162
- },
163
- api_name: :BlkioDeviceReadIOps
164
-
165
- # @!attribute blkio_device_write_bps
166
- # Limit write rate (bytes per second) to a device, in the form:
167
- #
168
- # ```
169
- # [{"Path": "device_path", "Rate": rate}]
170
- # ```
171
- #
172
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceWriteBp>, nil]
173
- optional :blkio_device_write_bps,
174
- -> {
175
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::BlkioDeviceWriteBp]
176
- },
177
- api_name: :BlkioDeviceWriteBps
178
-
179
- # @!attribute blkio_device_write_i_ops
180
- # Limit write rate (IO per second) to a device, in the form:
181
- #
182
- # ```
183
- # [{"Path": "device_path", "Rate": rate}]
184
- # ```
185
- #
186
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceWriteIOp>, nil]
187
- optional :blkio_device_write_i_ops,
188
- -> {
189
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::BlkioDeviceWriteIOp]
190
- },
191
- api_name: :BlkioDeviceWriteIOps
192
-
193
- # @!attribute blkio_weight
194
- # Block IO weight (relative weight).
195
- #
196
- # @return [Integer, nil]
197
- optional :blkio_weight, Integer, api_name: :BlkioWeight
198
-
199
- # @!attribute blkio_weight_device
200
- # Block IO weight (relative device weight) in the form:
201
- #
202
- # ```
203
- # [{"Path": "device_path", "Weight": weight}]
204
- # ```
205
- #
206
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioWeightDevice>, nil]
207
- optional :blkio_weight_device,
208
- -> {
209
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::BlkioWeightDevice]
210
- },
211
- api_name: :BlkioWeightDevice
212
-
213
- # @!attribute cap_add
214
- # A list of kernel capabilities to add to the container. Conflicts with option
215
- # 'Capabilities'.
216
- #
217
- # @return [Array<String>, nil]
218
- optional :cap_add, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :CapAdd
219
-
220
- # @!attribute cap_drop
221
- # A list of kernel capabilities to drop from the container. Conflicts with option
222
- # 'Capabilities'.
223
- #
224
- # @return [Array<String>, nil]
225
- optional :cap_drop, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :CapDrop
226
-
227
- # @!attribute cgroup
228
- # Cgroup to use for the container.
229
- #
230
- # @return [String, nil]
231
- optional :cgroup, String, api_name: :Cgroup
232
-
233
- # @!attribute cgroupns_mode
234
- # cgroup namespace mode for the container. Possible values are:
235
- #
236
- # - `"private"`: the container runs in its own private cgroup namespace
237
- # - `"host"`: use the host system's cgroup namespace
238
- #
239
- # If not specified, the daemon default is used, which can either be `"private"` or
240
- # `"host"`, depending on daemon version, kernel support and configuration.
241
- #
242
- # @return [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::CgroupnsMode, nil]
243
- optional :cgroupns_mode,
244
- enum: -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::CgroupnsMode },
245
- api_name: :CgroupnsMode
246
-
247
- # @!attribute cgroup_parent
248
- # Path to `cgroups` under which the container's `cgroup` is created. If the path
249
- # is not absolute, the path is considered to be relative to the `cgroups` path of
250
- # the init process. Cgroups are created if they do not already exist.
251
- #
252
- # @return [String, nil]
253
- optional :cgroup_parent, String, api_name: :CgroupParent
254
-
255
- # @!attribute console_size
256
- # Initial console size, as an `[height, width]` array.
257
- #
258
- # @return [Array<Integer>, nil]
259
- optional :console_size,
260
- DockerEngineRuby::Internal::Type::ArrayOf[Integer],
261
- api_name: :ConsoleSize,
262
- nil?: true
263
-
264
- # @!attribute container_id_file
265
- # Path to a file where the container ID is written
266
- #
267
- # @return [String, nil]
268
- optional :container_id_file, String, api_name: :ContainerIDFile
269
-
270
- # @!attribute cpu_count
271
- # The number of usable CPUs (Windows only).
272
- #
273
- # On Windows Server containers, the processor resource controls are mutually
274
- # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
275
- # `CPUPercent` last.
276
- #
277
- # @return [Integer, nil]
278
- optional :cpu_count, Integer, api_name: :CpuCount
279
-
280
- # @!attribute cpu_percent
281
- # The usable percentage of the available CPUs (Windows only).
282
- #
283
- # On Windows Server containers, the processor resource controls are mutually
284
- # exclusive. The order of precedence is `CPUCount` first, then `CPUShares`, and
285
- # `CPUPercent` last.
286
- #
287
- # @return [Integer, nil]
288
- optional :cpu_percent, Integer, api_name: :CpuPercent
289
-
290
- # @!attribute cpu_period
291
- # The length of a CPU period in microseconds.
292
- #
293
- # @return [Integer, nil]
294
- optional :cpu_period, Integer, api_name: :CpuPeriod
295
-
296
- # @!attribute cpu_quota
297
- # Microseconds of CPU time that the container can get in a CPU period.
298
- #
299
- # @return [Integer, nil]
300
- optional :cpu_quota, Integer, api_name: :CpuQuota
301
-
302
- # @!attribute cpu_realtime_period
303
- # The length of a CPU real-time period in microseconds. Set to 0 to allocate no
304
- # time allocated to real-time tasks.
305
- #
306
- # @return [Integer, nil]
307
- optional :cpu_realtime_period, Integer, api_name: :CpuRealtimePeriod
308
-
309
- # @!attribute cpu_realtime_runtime
310
- # The length of a CPU real-time runtime in microseconds. Set to 0 to allocate no
311
- # time allocated to real-time tasks.
312
- #
313
- # @return [Integer, nil]
314
- optional :cpu_realtime_runtime, Integer, api_name: :CpuRealtimeRuntime
315
-
316
- # @!attribute cpuset_cpus
317
- # CPUs in which to allow execution (e.g., `0-3`, `0,1`).
318
- #
319
- # @return [String, nil]
320
- optional :cpuset_cpus, String, api_name: :CpusetCpus
321
-
322
- # @!attribute cpuset_mems
323
- # Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on
324
- # NUMA systems.
325
- #
326
- # @return [String, nil]
327
- optional :cpuset_mems, String, api_name: :CpusetMems
328
-
329
- # @!attribute cpu_shares
330
- # An integer value representing this container's relative CPU weight versus other
331
- # containers.
332
- #
333
- # @return [Integer, nil]
334
- optional :cpu_shares, Integer, api_name: :CpuShares
335
-
336
- # @!attribute device_cgroup_rules
337
- # a list of cgroup rules to apply to the container
338
- #
339
- # @return [Array<String>, nil]
340
- optional :device_cgroup_rules,
341
- DockerEngineRuby::Internal::Type::ArrayOf[String],
342
- api_name: :DeviceCgroupRules
343
-
344
- # @!attribute device_requests
345
- # A list of requests for devices to be sent to device drivers.
346
- #
347
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::DeviceRequest>, nil]
348
- optional :device_requests,
349
- -> {
350
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::DeviceRequest]
351
- },
352
- api_name: :DeviceRequests
353
-
354
- # @!attribute devices
355
- # A list of devices to add to the container.
356
- #
357
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Device>, nil]
358
- optional :devices,
359
- -> {
360
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Device]
361
- },
362
- api_name: :Devices
363
-
364
- # @!attribute dns
365
- # A list of DNS servers for the container to use.
366
- #
367
- # @return [Array<String>, nil]
368
- optional :dns, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Dns
369
-
370
- # @!attribute dns_options
371
- # A list of DNS options.
372
- #
373
- # @return [Array<String>, nil]
374
- optional :dns_options, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DnsOptions
375
-
376
- # @!attribute dns_search
377
- # A list of DNS search domains.
378
- #
379
- # @return [Array<String>, nil]
380
- optional :dns_search, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DnsSearch
381
-
382
- # @!attribute extra_hosts
383
- # A list of hostnames/IP mappings to add to the container's `/etc/hosts` file.
384
- # Specified in the form `["hostname:IP"]`.
385
- #
386
- # @return [Array<String>, nil]
387
- optional :extra_hosts, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :ExtraHosts
388
-
389
- # @!attribute group_add
390
- # A list of additional groups that the container process will run as.
391
- #
392
- # @return [Array<String>, nil]
393
- optional :group_add, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :GroupAdd
394
-
395
- # @!attribute init
396
- # Run an init inside the container that forwards signals and reaps processes. This
397
- # field is omitted if empty, and the default (as configured on the daemon) is
398
- # used.
399
- #
400
- # @return [Boolean, nil]
401
- optional :init, DockerEngineRuby::Internal::Type::Boolean, api_name: :Init, nil?: true
402
-
403
- # @!attribute io_maximum_bandwidth
404
- # Maximum IO in bytes per second for the container system drive (Windows only).
405
- #
406
- # @return [Integer, nil]
407
- optional :io_maximum_bandwidth, Integer, api_name: :IOMaximumBandwidth
408
-
409
- # @!attribute io_maximum_i_ops
410
- # Maximum IOps for the container system drive (Windows only)
411
- #
412
- # @return [Integer, nil]
413
- optional :io_maximum_i_ops, Integer, api_name: :IOMaximumIOps
414
-
415
- # @!attribute ipc_mode
416
- # IPC sharing mode for the container. Possible values are:
417
- #
418
- # - `"none"`: own private IPC namespace, with /dev/shm not mounted
419
- # - `"private"`: own private IPC namespace
420
- # - `"shareable"`: own private IPC namespace, with a possibility to share it with
421
- # other containers
422
- # - `"container:<name|id>"`: join another (shareable) container's IPC namespace
423
- # - `"host"`: use the host system's IPC namespace
424
- #
425
- # If not specified, daemon default is used, which can either be `"private"` or
426
- # `"shareable"`, depending on daemon version and configuration.
427
- #
428
- # @return [String, nil]
429
- optional :ipc_mode, String, api_name: :IpcMode
430
-
431
- # @!attribute isolation
432
- # Isolation technology of the container. (Windows only)
433
- #
434
- # @return [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Isolation, nil]
435
- optional :isolation,
436
- enum: -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Isolation },
437
- api_name: :Isolation
438
-
439
- # @!attribute links
440
- # A list of links for the container in the form `container_name:alias`.
441
- #
442
- # @return [Array<String>, nil]
443
- optional :links, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Links
444
-
445
- # @!attribute log_config
446
- # The logging configuration for this container
447
- #
448
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::LogConfig, nil]
449
- optional :log_config,
450
- -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::LogConfig },
451
- api_name: :LogConfig
452
-
453
- # @!attribute masked_paths
454
- # The list of paths to be masked inside the container (this overrides the default
455
- # set of paths).
456
- #
457
- # @return [Array<String>, nil]
458
- optional :masked_paths, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :MaskedPaths
459
-
460
- # @!attribute memory
461
- # Memory limit in bytes.
462
- #
463
- # @return [Integer, nil]
464
- optional :memory, Integer, api_name: :Memory
465
-
466
- # @!attribute memory_reservation
467
- # Memory soft limit in bytes.
468
- #
469
- # @return [Integer, nil]
470
- optional :memory_reservation, Integer, api_name: :MemoryReservation
471
-
472
- # @!attribute memory_swap
473
- # Total memory limit (memory + swap). Set as `-1` to enable unlimited swap.
474
- #
475
- # @return [Integer, nil]
476
- optional :memory_swap, Integer, api_name: :MemorySwap
477
-
478
- # @!attribute memory_swappiness
479
- # Tune a container's memory swappiness behavior. Accepts an integer between 0
480
- # and 100.
481
- #
482
- # @return [Integer, nil]
483
- optional :memory_swappiness, Integer, api_name: :MemorySwappiness
484
-
485
- # @!attribute mounts
486
- # Specification for mounts to be added to the container.
487
- #
488
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount>, nil]
489
- optional :mounts,
490
- -> {
491
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount]
492
- },
493
- api_name: :Mounts
494
-
495
- # @!attribute nano_cpus
496
- # CPU quota in units of 10<sup>-9</sup> CPUs.
497
- #
498
- # @return [Integer, nil]
499
- optional :nano_cpus, Integer, api_name: :NanoCpus
500
-
501
- # @!attribute network_mode
502
- # Network mode to use for this container. Supported standard values are: `bridge`,
503
- # `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom
504
- # network's name to which this container should connect to.
505
- #
506
- # @return [String, nil]
507
- optional :network_mode, String, api_name: :NetworkMode
508
-
509
- # @!attribute oom_kill_disable
510
- # Disable OOM Killer for the container.
511
- #
512
- # @return [Boolean, nil]
513
- optional :oom_kill_disable, DockerEngineRuby::Internal::Type::Boolean, api_name: :OomKillDisable
514
-
515
- # @!attribute oom_score_adj
516
- # An integer value containing the score given to the container in order to tune
517
- # OOM killer preferences.
518
- #
519
- # @return [Integer, nil]
520
- optional :oom_score_adj, Integer, api_name: :OomScoreAdj
521
-
522
- # @!attribute pid_mode
523
- # Set the PID (Process) Namespace mode for the container. It can be either:
524
- #
525
- # - `"container:<name|id>"`: joins another container's PID namespace
526
- # - `"host"`: use the host's PID namespace inside the container
527
- #
528
- # @return [String, nil]
529
- optional :pid_mode, String, api_name: :PidMode
530
-
531
- # @!attribute pids_limit
532
- # Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null` to not
533
- # change.
534
- #
535
- # @return [Integer, nil]
536
- optional :pids_limit, Integer, api_name: :PidsLimit, nil?: true
537
-
538
- # @!attribute port_bindings
539
- # PortMap describes the mapping of container ports to host ports, using the
540
- # container's port-number and protocol as key in the format `<port>/<protocol>`,
541
- # for example, `80/udp`.
542
- #
543
- # If a container's port is mapped for multiple protocols, separate entries are
544
- # added to the mapping table.
545
- #
546
- # @return [Hash{Symbol=>Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::PortBinding>}, nil]
547
- optional :port_bindings,
548
- -> do
549
- DockerEngineRuby::Internal::Type::HashOf[
550
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::PortBinding]
551
- ]
552
- end,
553
- api_name: :PortBindings
554
-
555
- # @!attribute privileged
556
- # Gives the container full access to the host.
557
- #
558
- # @return [Boolean, nil]
559
- optional :privileged, DockerEngineRuby::Internal::Type::Boolean, api_name: :Privileged
560
-
561
- # @!attribute publish_all_ports
562
- # Allocates an ephemeral host port for all of a container's exposed ports.
563
- #
564
- # Ports are de-allocated when the container stops and allocated when the container
565
- # starts. The allocated port might be changed when restarting the container.
566
- #
567
- # The port is selected from the ephemeral port range that depends on the kernel.
568
- # For example, on Linux the range is defined by
569
- # `/proc/sys/net/ipv4/ip_local_port_range`.
570
- #
571
- # @return [Boolean, nil]
572
- optional :publish_all_ports, DockerEngineRuby::Internal::Type::Boolean, api_name: :PublishAllPorts
573
-
574
- # @!attribute readonly_paths
575
- # The list of paths to be set as read-only inside the container (this overrides
576
- # the default set of paths).
577
- #
578
- # @return [Array<String>, nil]
579
- optional :readonly_paths,
580
- DockerEngineRuby::Internal::Type::ArrayOf[String],
581
- api_name: :ReadonlyPaths
582
-
583
- # @!attribute readonly_rootfs
584
- # Mount the container's root filesystem as read only.
585
- #
586
- # @return [Boolean, nil]
587
- optional :readonly_rootfs, DockerEngineRuby::Internal::Type::Boolean, api_name: :ReadonlyRootfs
588
-
589
- # @!attribute restart_policy
590
- # The behavior to apply when the container exits. The default is not to restart.
591
- #
592
- # An ever increasing delay (double the previous delay, starting at 100ms) is added
593
- # before each restart to prevent flooding the server.
594
- #
595
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::RestartPolicy, nil]
596
- optional :restart_policy,
597
- -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::RestartPolicy },
598
- api_name: :RestartPolicy
599
-
600
- # @!attribute runtime
601
- # Runtime to use with this container.
602
- #
603
- # @return [String, nil]
604
- optional :runtime, String, api_name: :Runtime, nil?: true
605
-
606
- # @!attribute security_opt
607
- # A list of string values to customize labels for MLS systems, such as SELinux.
608
- #
609
- # @return [Array<String>, nil]
610
- optional :security_opt, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :SecurityOpt
611
-
612
- # @!attribute shm_size
613
- # Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
614
- #
615
- # @return [Integer, nil]
616
- optional :shm_size, Integer, api_name: :ShmSize
617
-
618
- # @!attribute storage_opt
619
- # Storage driver options for this container, in the form `{"size": "120G"}`.
620
- #
621
- # @return [Hash{Symbol=>String}, nil]
622
- optional :storage_opt, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :StorageOpt
623
-
624
- # @!attribute sysctls
625
- # A list of kernel parameters (sysctls) to set in the container.
626
- #
627
- # This field is omitted if not set.
628
- #
629
- # @return [Hash{Symbol=>String}, nil]
630
- optional :sysctls, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Sysctls, nil?: true
631
-
632
- # @!attribute tmpfs
633
- # A map of container directories which should be replaced by tmpfs mounts, and
634
- # their corresponding mount options. For example:
635
- #
636
- # ```
637
- # { "/run": "rw,noexec,nosuid,size=65536k" }
638
- # ```
639
- #
640
- # @return [Hash{Symbol=>String}, nil]
641
- optional :tmpfs, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Tmpfs
642
-
643
- # @!attribute ulimits
644
- # A list of resource limits to set in the container. For example:
645
- #
646
- # ```
647
- # {"Name": "nofile", "Soft": 1024, "Hard": 2048}
648
- # ```
649
- #
650
- # @return [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Ulimit>, nil]
651
- optional :ulimits,
652
- -> {
653
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Ulimit]
654
- },
655
- api_name: :Ulimits
656
-
657
- # @!attribute userns_mode
658
- # Sets the usernamespace mode for the container when usernamespace remapping
659
- # option is enabled.
660
- #
661
- # @return [String, nil]
662
- optional :userns_mode, String, api_name: :UsernsMode
663
-
664
- # @!attribute uts_mode
665
- # UTS namespace to use for the container.
666
- #
667
- # @return [String, nil]
668
- optional :uts_mode, String, api_name: :UTSMode
669
-
670
- # @!attribute volume_driver
671
- # Driver that this container uses to mount volumes.
672
- #
673
- # @return [String, nil]
674
- optional :volume_driver, String, api_name: :VolumeDriver
675
-
676
- # @!attribute volumes_from
677
- # A list of volumes to inherit from another container, specified in the form
678
- # `<container name>[:<ro|rw>]`.
679
- #
680
- # @return [Array<String>, nil]
681
- optional :volumes_from, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :VolumesFrom
682
-
683
- # @!method initialize(annotations: nil, auto_remove: nil, binds: nil, blkio_device_read_bps: nil, blkio_device_read_i_ops: nil, blkio_device_write_bps: nil, blkio_device_write_i_ops: nil, blkio_weight: nil, blkio_weight_device: nil, cap_add: nil, cap_drop: nil, cgroup: nil, cgroupns_mode: nil, cgroup_parent: nil, console_size: nil, container_id_file: nil, cpu_count: nil, cpu_percent: nil, cpu_period: nil, cpu_quota: nil, cpu_realtime_period: nil, cpu_realtime_runtime: nil, cpuset_cpus: nil, cpuset_mems: nil, cpu_shares: nil, device_cgroup_rules: nil, device_requests: nil, devices: nil, dns: nil, dns_options: nil, dns_search: nil, extra_hosts: nil, group_add: nil, init: nil, io_maximum_bandwidth: nil, io_maximum_i_ops: nil, ipc_mode: nil, isolation: nil, links: nil, log_config: nil, masked_paths: nil, memory: nil, memory_reservation: nil, memory_swap: nil, memory_swappiness: nil, mounts: nil, nano_cpus: nil, network_mode: nil, oom_kill_disable: nil, oom_score_adj: nil, pid_mode: nil, pids_limit: nil, port_bindings: nil, privileged: nil, publish_all_ports: nil, readonly_paths: nil, readonly_rootfs: nil, restart_policy: nil, runtime: nil, security_opt: nil, shm_size: nil, storage_opt: nil, sysctls: nil, tmpfs: nil, ulimits: nil, userns_mode: nil, uts_mode: nil, volume_driver: nil, volumes_from: nil)
684
- # Some parameter documentations has been truncated, see
685
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig} for more
686
- # details.
687
- #
688
- # Container configuration that depends on the host we are running on
689
- #
690
- # @param annotations [Hash{Symbol=>String}] Arbitrary non-identifying metadata attached to container and
691
- #
692
- # @param auto_remove [Boolean] Automatically remove the container when the container's process
693
- #
694
- # @param binds [Array<String>] A list of volume bindings for this container. Each volume binding
695
- #
696
- # @param blkio_device_read_bps [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceReadBp>] Limit read rate (bytes per second) from a device, in the form:
697
- #
698
- # @param blkio_device_read_i_ops [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceReadIOp>] Limit read rate (IO per second) from a device, in the form:
699
- #
700
- # @param blkio_device_write_bps [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceWriteBp>] Limit write rate (bytes per second) to a device, in the form:
701
- #
702
- # @param blkio_device_write_i_ops [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioDeviceWriteIOp>] Limit write rate (IO per second) to a device, in the form:
703
- #
704
- # @param blkio_weight [Integer] Block IO weight (relative weight).
705
- #
706
- # @param blkio_weight_device [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::BlkioWeightDevice>] Block IO weight (relative device weight) in the form:
707
- #
708
- # @param cap_add [Array<String>] A list of kernel capabilities to add to the container. Conflicts
709
- #
710
- # @param cap_drop [Array<String>] A list of kernel capabilities to drop from the container. Conflicts
711
- #
712
- # @param cgroup [String] Cgroup to use for the container.
713
- #
714
- # @param cgroupns_mode [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::CgroupnsMode] cgroup namespace mode for the container. Possible values are:
715
- #
716
- # @param cgroup_parent [String] Path to `cgroups` under which the container's `cgroup` is created. If
717
- #
718
- # @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
719
- #
720
- # @param container_id_file [String] Path to a file where the container ID is written
721
- #
722
- # @param cpu_count [Integer] The number of usable CPUs (Windows only).
723
- #
724
- # @param cpu_percent [Integer] The usable percentage of the available CPUs (Windows only).
725
- #
726
- # @param cpu_period [Integer] The length of a CPU period in microseconds.
727
- #
728
- # @param cpu_quota [Integer] Microseconds of CPU time that the container can get in a CPU period.
729
- #
730
- # @param cpu_realtime_period [Integer] The length of a CPU real-time period in microseconds. Set to 0 to
731
- #
732
- # @param cpu_realtime_runtime [Integer] The length of a CPU real-time runtime in microseconds. Set to 0 to
733
- #
734
- # @param cpuset_cpus [String] CPUs in which to allow execution (e.g., `0-3`, `0,1`).
735
- #
736
- # @param cpuset_mems [String] Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only
737
- #
738
- # @param cpu_shares [Integer] An integer value representing this container's relative CPU weight
739
- #
740
- # @param device_cgroup_rules [Array<String>] a list of cgroup rules to apply to the container
741
- #
742
- # @param device_requests [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::DeviceRequest>] A list of requests for devices to be sent to device drivers.
743
- #
744
- # @param devices [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Device>] A list of devices to add to the container.
745
- #
746
- # @param dns [Array<String>] A list of DNS servers for the container to use.
747
- #
748
- # @param dns_options [Array<String>] A list of DNS options.
749
- #
750
- # @param dns_search [Array<String>] A list of DNS search domains.
751
- #
752
- # @param extra_hosts [Array<String>] A list of hostnames/IP mappings to add to the container's `/etc/hosts`
753
- #
754
- # @param group_add [Array<String>] A list of additional groups that the container process will run as.
755
- #
756
- # @param init [Boolean, nil] Run an init inside the container that forwards signals and reaps
757
- #
758
- # @param io_maximum_bandwidth [Integer] Maximum IO in bytes per second for the container system drive
759
- #
760
- # @param io_maximum_i_ops [Integer] Maximum IOps for the container system drive (Windows only)
761
- #
762
- # @param ipc_mode [String] IPC sharing mode for the container. Possible values are:
763
- #
764
- # @param isolation [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Isolation] Isolation technology of the container. (Windows only)
765
- #
766
- # @param links [Array<String>] A list of links for the container in the form `container_name:alias`.
767
- #
768
- # @param log_config [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::LogConfig] The logging configuration for this container
769
- #
770
- # @param masked_paths [Array<String>] The list of paths to be masked inside the container (this overrides
771
- #
772
- # @param memory [Integer] Memory limit in bytes.
773
- #
774
- # @param memory_reservation [Integer] Memory soft limit in bytes.
775
- #
776
- # @param memory_swap [Integer] Total memory limit (memory + swap). Set as `-1` to enable unlimited
777
- #
778
- # @param memory_swappiness [Integer] Tune a container's memory swappiness behavior. Accepts an integer
779
- #
780
- # @param mounts [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount>] Specification for mounts to be added to the container.
781
- #
782
- # @param nano_cpus [Integer] CPU quota in units of 10<sup>-9</sup> CPUs.
783
- #
784
- # @param network_mode [String] Network mode to use for this container. Supported standard values
785
- #
786
- # @param oom_kill_disable [Boolean] Disable OOM Killer for the container.
787
- #
788
- # @param oom_score_adj [Integer] An integer value containing the score given to the container in
789
- #
790
- # @param pid_mode [String] Set the PID (Process) Namespace mode for the container. It can be
791
- #
792
- # @param pids_limit [Integer, nil] Tune a container's PIDs limit. Set `0` or `-1` for unlimited, or `null`
793
- #
794
- # @param port_bindings [Hash{Symbol=>Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::PortBinding>}] PortMap describes the mapping of container ports to host ports, using the
795
- #
796
- # @param privileged [Boolean] Gives the container full access to the host.
797
- #
798
- # @param publish_all_ports [Boolean] Allocates an ephemeral host port for all of a container's
799
- #
800
- # @param readonly_paths [Array<String>] The list of paths to be set as read-only inside the container
801
- #
802
- # @param readonly_rootfs [Boolean] Mount the container's root filesystem as read only.
803
- #
804
- # @param restart_policy [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::RestartPolicy] The behavior to apply when the container exits. The default is not to
805
- #
806
- # @param runtime [String, nil] Runtime to use with this container.
807
- #
808
- # @param security_opt [Array<String>] A list of string values to customize labels for MLS systems, such
809
- #
810
- # @param shm_size [Integer] Size of `/dev/shm` in bytes. If omitted, the system uses 64MB.
811
- #
812
- # @param storage_opt [Hash{Symbol=>String}] Storage driver options for this container, in the form `{"size": "120G"}`.
813
- #
814
- # @param sysctls [Hash{Symbol=>String}, nil] A list of kernel parameters (sysctls) to set in the container.
815
- #
816
- # @param tmpfs [Hash{Symbol=>String}] A map of container directories which should be replaced by tmpfs
817
- #
818
- # @param ulimits [Array<DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Ulimit>] A list of resource limits to set in the container. For example:
819
- #
820
- # @param userns_mode [String] Sets the usernamespace mode for the container when usernamespace
821
- #
822
- # @param uts_mode [String] UTS namespace to use for the container.
823
- #
824
- # @param volume_driver [String] Driver that this container uses to mount volumes.
825
- #
826
- # @param volumes_from [Array<String>] A list of volumes to inherit from another container, specified in
827
-
828
- class BlkioDeviceReadBp < DockerEngineRuby::Internal::Type::BaseModel
829
- # @!attribute path
830
- # Device path
831
- #
832
- # @return [String, nil]
833
- optional :path, String, api_name: :Path
834
-
835
- # @!attribute rate
836
- # Rate
837
- #
838
- # @return [Integer, nil]
839
- optional :rate, Integer, api_name: :Rate
840
-
841
- # @!method initialize(path: nil, rate: nil)
842
- # @param path [String] Device path
843
- #
844
- # @param rate [Integer] Rate
845
- end
846
-
847
- class BlkioDeviceReadIOp < DockerEngineRuby::Internal::Type::BaseModel
848
- # @!attribute path
849
- # Device path
850
- #
851
- # @return [String, nil]
852
- optional :path, String, api_name: :Path
853
-
854
- # @!attribute rate
855
- # Rate
856
- #
857
- # @return [Integer, nil]
858
- optional :rate, Integer, api_name: :Rate
859
-
860
- # @!method initialize(path: nil, rate: nil)
861
- # @param path [String] Device path
862
- #
863
- # @param rate [Integer] Rate
864
- end
865
-
866
- class BlkioDeviceWriteBp < DockerEngineRuby::Internal::Type::BaseModel
867
- # @!attribute path
868
- # Device path
869
- #
870
- # @return [String, nil]
871
- optional :path, String, api_name: :Path
872
-
873
- # @!attribute rate
874
- # Rate
875
- #
876
- # @return [Integer, nil]
877
- optional :rate, Integer, api_name: :Rate
878
-
879
- # @!method initialize(path: nil, rate: nil)
880
- # @param path [String] Device path
881
- #
882
- # @param rate [Integer] Rate
883
- end
884
-
885
- class BlkioDeviceWriteIOp < DockerEngineRuby::Internal::Type::BaseModel
886
- # @!attribute path
887
- # Device path
888
- #
889
- # @return [String, nil]
890
- optional :path, String, api_name: :Path
891
-
892
- # @!attribute rate
893
- # Rate
894
- #
895
- # @return [Integer, nil]
896
- optional :rate, Integer, api_name: :Rate
897
-
898
- # @!method initialize(path: nil, rate: nil)
899
- # @param path [String] Device path
900
- #
901
- # @param rate [Integer] Rate
902
- end
903
-
904
- class BlkioWeightDevice < DockerEngineRuby::Internal::Type::BaseModel
905
- # @!attribute path
906
- #
907
- # @return [String, nil]
908
- optional :path, String, api_name: :Path
909
-
910
- # @!attribute weight
911
- #
912
- # @return [Integer, nil]
913
- optional :weight, Integer, api_name: :Weight
914
-
915
- # @!method initialize(path: nil, weight: nil)
916
- # @param path [String]
917
- # @param weight [Integer]
918
- end
919
-
920
- # cgroup namespace mode for the container. Possible values are:
921
- #
922
- # - `"private"`: the container runs in its own private cgroup namespace
923
- # - `"host"`: use the host system's cgroup namespace
924
- #
925
- # If not specified, the daemon default is used, which can either be `"private"` or
926
- # `"host"`, depending on daemon version, kernel support and configuration.
927
- #
928
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig#cgroupns_mode
929
- module CgroupnsMode
930
- extend DockerEngineRuby::Internal::Type::Enum
931
-
932
- PRIVATE = :private
933
- HOST = :host
934
-
935
- # @!method self.values
936
- # @return [Array<Symbol>]
937
- end
938
-
939
- class DeviceRequest < DockerEngineRuby::Internal::Type::BaseModel
940
- # @!attribute capabilities
941
- # A list of capabilities; an OR list of AND lists of capabilities.
942
- #
943
- # Note that if a driver is specified the capabilities have no effect on selecting
944
- # a driver as the driver name is used directly.
945
- #
946
- # Note that if no driver is specified the capabilities are used to select a driver
947
- # with the required capabilities.
948
- #
949
- # @return [Array<Array<String>>, nil]
950
- optional :capabilities,
951
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Internal::Type::ArrayOf[String]],
952
- api_name: :Capabilities
953
-
954
- # @!attribute count
955
- #
956
- # @return [Integer, nil]
957
- optional :count, Integer, api_name: :Count
958
-
959
- # @!attribute device_ids
960
- #
961
- # @return [Array<String>, nil]
962
- optional :device_ids, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DeviceIDs
963
-
964
- # @!attribute driver
965
- # The name of the device driver to use for this request.
966
- #
967
- # Note that if this is specified the capabilities are ignored when selecting a
968
- # device driver.
969
- #
970
- # @return [String, nil]
971
- optional :driver, String, api_name: :Driver
972
-
973
- # @!attribute options
974
- # Driver-specific options, specified as a key/value pairs. These options are
975
- # passed directly to the driver.
976
- #
977
- # @return [Hash{Symbol=>String}, nil]
978
- optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
979
-
980
- # @!method initialize(capabilities: nil, count: nil, device_ids: nil, driver: nil, options: nil)
981
- # Some parameter documentations has been truncated, see
982
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::DeviceRequest}
983
- # for more details.
984
- #
985
- # A request for devices to be sent to device drivers
986
- #
987
- # @param capabilities [Array<Array<String>>] A list of capabilities; an OR list of AND lists of capabilities.
988
- #
989
- # @param count [Integer]
990
- #
991
- # @param device_ids [Array<String>]
992
- #
993
- # @param driver [String] The name of the device driver to use for this request.
994
- #
995
- # @param options [Hash{Symbol=>String}] Driver-specific options, specified as a key/value pairs. These options
996
- end
997
-
998
- class Device < DockerEngineRuby::Internal::Type::BaseModel
999
- # @!attribute cgroup_permissions
1000
- #
1001
- # @return [String, nil]
1002
- optional :cgroup_permissions, String, api_name: :CgroupPermissions
1003
-
1004
- # @!attribute path_in_container
1005
- #
1006
- # @return [String, nil]
1007
- optional :path_in_container, String, api_name: :PathInContainer
1008
-
1009
- # @!attribute path_on_host
1010
- #
1011
- # @return [String, nil]
1012
- optional :path_on_host, String, api_name: :PathOnHost
1013
-
1014
- # @!method initialize(cgroup_permissions: nil, path_in_container: nil, path_on_host: nil)
1015
- # A device mapping between the host and container
1016
- #
1017
- # @param cgroup_permissions [String]
1018
- # @param path_in_container [String]
1019
- # @param path_on_host [String]
1020
- end
1021
-
1022
- # Isolation technology of the container. (Windows only)
1023
- #
1024
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig#isolation
1025
- module Isolation
1026
- extend DockerEngineRuby::Internal::Type::Enum
1027
-
1028
- DEFAULT = :default
1029
- PROCESS = :process
1030
- HYPERV = :hyperv
1031
- EMPTY = :""
1032
-
1033
- # @!method self.values
1034
- # @return [Array<Symbol>]
1035
- end
1036
-
1037
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig#log_config
1038
- class LogConfig < DockerEngineRuby::Internal::Type::BaseModel
1039
- # @!attribute config
1040
- # Driver-specific configuration options for the logging driver.
1041
- #
1042
- # @return [Hash{Symbol=>String}, nil]
1043
- optional :config, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Config
1044
-
1045
- # @!attribute type
1046
- # Name of the logging driver used for the container or "none" if logging is
1047
- # disabled.
1048
- #
1049
- # @return [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::LogConfig::Type, nil]
1050
- optional :type,
1051
- enum: -> {
1052
- DockerEngineRuby::ContainerCreateParams::Config::HostConfig::LogConfig::Type
1053
- },
1054
- api_name: :Type
1055
-
1056
- # @!method initialize(config: nil, type: nil)
1057
- # Some parameter documentations has been truncated, see
1058
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::LogConfig}
1059
- # for more details.
1060
- #
1061
- # The logging configuration for this container
1062
- #
1063
- # @param config [Hash{Symbol=>String}] Driver-specific configuration options for the logging driver.
1064
- #
1065
- # @param type [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::LogConfig::Type] Name of the logging driver used for the container or "none"
1066
-
1067
- # Name of the logging driver used for the container or "none" if logging is
1068
- # disabled.
1069
- #
1070
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::LogConfig#type
1071
- module Type
1072
- extend DockerEngineRuby::Internal::Type::Enum
1073
-
1074
- LOCAL = :local
1075
- JSON_FILE = :"json-file"
1076
- SYSLOG = :syslog
1077
- JOURNALD = :journald
1078
- GELF = :gelf
1079
- FLUENTD = :fluentd
1080
- AWSLOGS = :awslogs
1081
- SPLUNK = :splunk
1082
- ETWLOGS = :etwlogs
1083
- NONE = :none
1084
-
1085
- # @!method self.values
1086
- # @return [Array<Symbol>]
1087
- end
1088
- end
1089
-
1090
- class Mount < DockerEngineRuby::Internal::Type::BaseModel
1091
- # @!attribute bind_options
1092
- # Optional configuration for the `bind` type.
1093
- #
1094
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::BindOptions, nil]
1095
- optional :bind_options,
1096
- -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount::BindOptions },
1097
- api_name: :BindOptions
1098
-
1099
- # @!attribute consistency
1100
- # The consistency requirement for the mount: `default`, `consistent`, `cached`, or
1101
- # `delegated`.
1102
- #
1103
- # @return [String, nil]
1104
- optional :consistency, String, api_name: :Consistency
1105
-
1106
- # @!attribute image_options
1107
- # Optional configuration for the `image` type.
1108
- #
1109
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::ImageOptions, nil]
1110
- optional :image_options,
1111
- -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount::ImageOptions },
1112
- api_name: :ImageOptions
1113
-
1114
- # @!attribute read_only
1115
- # Whether the mount should be read-only.
1116
- #
1117
- # @return [Boolean, nil]
1118
- optional :read_only, DockerEngineRuby::Internal::Type::Boolean, api_name: :ReadOnly
1119
-
1120
- # @!attribute source
1121
- # Mount source (e.g. a volume name, a host path). The source cannot be specified
1122
- # when using `Type=tmpfs`. For `Type=bind`, the source path must either exist, or
1123
- # the `CreateMountpoint` must be set to `true` to create the source path on the
1124
- # host if missing.
1125
- #
1126
- # For `Type=npipe`, the pipe must exist prior to creating the container.
1127
- #
1128
- # @return [String, nil]
1129
- optional :source, String, api_name: :Source
1130
-
1131
- # @!attribute target
1132
- # Container path.
1133
- #
1134
- # @return [String, nil]
1135
- optional :target, String, api_name: :Target
1136
-
1137
- # @!attribute tmpfs_options
1138
- # Optional configuration for the `tmpfs` type.
1139
- #
1140
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::TmpfsOptions, nil]
1141
- optional :tmpfs_options,
1142
- -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount::TmpfsOptions },
1143
- api_name: :TmpfsOptions
1144
-
1145
- # @!attribute type
1146
- # The mount type. Available types:
1147
- #
1148
- # - `bind` a mount of a file or directory from the host into the container.
1149
- # - `cluster` a Swarm cluster volume.
1150
- # - `image` an OCI image.
1151
- # - `npipe` a named pipe from the host into the container.
1152
- # - `tmpfs` a `tmpfs`.
1153
- # - `volume` a docker volume with the given `Name`.
1154
- #
1155
- # @return [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::Type, nil]
1156
- optional :type,
1157
- enum: -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount::Type },
1158
- api_name: :Type
1159
-
1160
- # @!attribute volume_options
1161
- # Optional configuration for the `volume` type.
1162
- #
1163
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions, nil]
1164
- optional :volume_options,
1165
- -> { DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions },
1166
- api_name: :VolumeOptions
1167
-
1168
- # @!method initialize(bind_options: nil, consistency: nil, image_options: nil, read_only: nil, source: nil, target: nil, tmpfs_options: nil, type: nil, volume_options: nil)
1169
- # Some parameter documentations has been truncated, see
1170
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount} for
1171
- # more details.
1172
- #
1173
- # @param bind_options [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::BindOptions] Optional configuration for the `bind` type.
1174
- #
1175
- # @param consistency [String] The consistency requirement for the mount: `default`, `consistent`, `cached`, or
1176
- #
1177
- # @param image_options [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::ImageOptions] Optional configuration for the `image` type.
1178
- #
1179
- # @param read_only [Boolean] Whether the mount should be read-only.
1180
- #
1181
- # @param source [String] Mount source (e.g. a volume name, a host path). The source cannot be
1182
- #
1183
- # @param target [String] Container path.
1184
- #
1185
- # @param tmpfs_options [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::TmpfsOptions] Optional configuration for the `tmpfs` type.
1186
- #
1187
- # @param type [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::Type] The mount type. Available types:
1188
- #
1189
- # @param volume_options [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions] Optional configuration for the `volume` type.
1190
-
1191
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount#bind_options
1192
- class BindOptions < DockerEngineRuby::Internal::Type::BaseModel
1193
- # @!attribute create_mountpoint
1194
- # Create mount point on host if missing
1195
- #
1196
- # @return [Boolean, nil]
1197
- optional :create_mountpoint,
1198
- DockerEngineRuby::Internal::Type::Boolean,
1199
- api_name: :CreateMountpoint
1200
-
1201
- # @!attribute non_recursive
1202
- # Disable recursive bind mount.
1203
- #
1204
- # @return [Boolean, nil]
1205
- optional :non_recursive, DockerEngineRuby::Internal::Type::Boolean, api_name: :NonRecursive
1206
-
1207
- # @!attribute propagation
1208
- # A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
1209
- #
1210
- # @return [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::BindOptions::Propagation, nil]
1211
- optional :propagation,
1212
- enum: -> {
1213
- DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount::BindOptions::Propagation
1214
- },
1215
- api_name: :Propagation
1216
-
1217
- # @!attribute read_only_force_recursive
1218
- # Raise an error if the mount cannot be made recursively read-only.
1219
- #
1220
- # @return [Boolean, nil]
1221
- optional :read_only_force_recursive,
1222
- DockerEngineRuby::Internal::Type::Boolean,
1223
- api_name: :ReadOnlyForceRecursive
1224
-
1225
- # @!attribute read_only_non_recursive
1226
- # Make the mount non-recursively read-only, but still leave the mount recursive
1227
- # (unless NonRecursive is set to `true` in conjunction).
1228
- #
1229
- # Added in v1.44, before that version all read-only mounts were non-recursive by
1230
- # default. To match the previous behaviour this will default to `true` for clients
1231
- # on versions prior to v1.44.
1232
- #
1233
- # @return [Boolean, nil]
1234
- optional :read_only_non_recursive,
1235
- DockerEngineRuby::Internal::Type::Boolean,
1236
- api_name: :ReadOnlyNonRecursive
1237
-
1238
- # @!method initialize(create_mountpoint: nil, non_recursive: nil, propagation: nil, read_only_force_recursive: nil, read_only_non_recursive: nil)
1239
- # Some parameter documentations has been truncated, see
1240
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::BindOptions}
1241
- # for more details.
1242
- #
1243
- # Optional configuration for the `bind` type.
1244
- #
1245
- # @param create_mountpoint [Boolean] Create mount point on host if missing
1246
- #
1247
- # @param non_recursive [Boolean] Disable recursive bind mount.
1248
- #
1249
- # @param propagation [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::BindOptions::Propagation] A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
1250
- #
1251
- # @param read_only_force_recursive [Boolean] Raise an error if the mount cannot be made recursively read-only.
1252
- #
1253
- # @param read_only_non_recursive [Boolean] Make the mount non-recursively read-only, but still leave the mount recursive
1254
-
1255
- # A propagation mode with the value `[r]private`, `[r]shared`, or `[r]slave`.
1256
- #
1257
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::BindOptions#propagation
1258
- module Propagation
1259
- extend DockerEngineRuby::Internal::Type::Enum
1260
-
1261
- PRIVATE = :private
1262
- RPRIVATE = :rprivate
1263
- SHARED = :shared
1264
- RSHARED = :rshared
1265
- SLAVE = :slave
1266
- RSLAVE = :rslave
1267
-
1268
- # @!method self.values
1269
- # @return [Array<Symbol>]
1270
- end
1271
- end
1272
-
1273
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount#image_options
1274
- class ImageOptions < DockerEngineRuby::Internal::Type::BaseModel
1275
- # @!attribute subpath
1276
- # Source path inside the image. Must be relative without any back traversals.
1277
- #
1278
- # @return [String, nil]
1279
- optional :subpath, String, api_name: :Subpath
1280
-
1281
- # @!method initialize(subpath: nil)
1282
- # Optional configuration for the `image` type.
1283
- #
1284
- # @param subpath [String] Source path inside the image. Must be relative without any back traversals.
1285
- end
1286
-
1287
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount#tmpfs_options
1288
- class TmpfsOptions < DockerEngineRuby::Internal::Type::BaseModel
1289
- # @!attribute mode
1290
- # The permission mode for the tmpfs mount in an integer. The value must not be in
1291
- # octal format (e.g. 755) but rather the decimal representation of the octal value
1292
- # (e.g. 493).
1293
- #
1294
- # @return [Integer, nil]
1295
- optional :mode, Integer, api_name: :Mode
1296
-
1297
- # @!attribute options
1298
- # The options to be passed to the tmpfs mount. An array of arrays. Flag options
1299
- # should be provided as 1-length arrays. Other types should be provided as as
1300
- # 2-length arrays, where the first item is the key and the second the value.
1301
- #
1302
- # @return [Array<Array<String>>, nil]
1303
- optional :options,
1304
- DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Internal::Type::ArrayOf[String]],
1305
- api_name: :Options
1306
-
1307
- # @!attribute size_bytes
1308
- # The size for the tmpfs mount in bytes.
1309
- #
1310
- # @return [Integer, nil]
1311
- optional :size_bytes, Integer, api_name: :SizeBytes
1312
-
1313
- # @!method initialize(mode: nil, options: nil, size_bytes: nil)
1314
- # Some parameter documentations has been truncated, see
1315
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::TmpfsOptions}
1316
- # for more details.
1317
- #
1318
- # Optional configuration for the `tmpfs` type.
1319
- #
1320
- # @param mode [Integer] The permission mode for the tmpfs mount in an integer.
1321
- #
1322
- # @param options [Array<Array<String>>] The options to be passed to the tmpfs mount. An array of arrays.
1323
- #
1324
- # @param size_bytes [Integer] The size for the tmpfs mount in bytes.
1325
- end
1326
-
1327
- # The mount type. Available types:
1328
- #
1329
- # - `bind` a mount of a file or directory from the host into the container.
1330
- # - `cluster` a Swarm cluster volume.
1331
- # - `image` an OCI image.
1332
- # - `npipe` a named pipe from the host into the container.
1333
- # - `tmpfs` a `tmpfs`.
1334
- # - `volume` a docker volume with the given `Name`.
1335
- #
1336
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount#type
1337
- module Type
1338
- extend DockerEngineRuby::Internal::Type::Enum
1339
-
1340
- BIND = :bind
1341
- CLUSTER = :cluster
1342
- IMAGE = :image
1343
- NPIPE = :npipe
1344
- TMPFS = :tmpfs
1345
- VOLUME = :volume
1346
-
1347
- # @!method self.values
1348
- # @return [Array<Symbol>]
1349
- end
1350
-
1351
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount#volume_options
1352
- class VolumeOptions < DockerEngineRuby::Internal::Type::BaseModel
1353
- # @!attribute driver_config
1354
- # Map of driver specific options
1355
- #
1356
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions::DriverConfig, nil]
1357
- optional :driver_config,
1358
- -> {
1359
- DockerEngineRuby::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions::DriverConfig
1360
- },
1361
- api_name: :DriverConfig
1362
-
1363
- # @!attribute labels
1364
- # User-defined key/value metadata.
1365
- #
1366
- # @return [Hash{Symbol=>String}, nil]
1367
- optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
1368
-
1369
- # @!attribute no_copy
1370
- # Populate volume with data from the target.
1371
- #
1372
- # @return [Boolean, nil]
1373
- optional :no_copy, DockerEngineRuby::Internal::Type::Boolean, api_name: :NoCopy
1374
-
1375
- # @!attribute subpath
1376
- # Source path inside the volume. Must be relative without any back traversals.
1377
- #
1378
- # @return [String, nil]
1379
- optional :subpath, String, api_name: :Subpath
1380
-
1381
- # @!method initialize(driver_config: nil, labels: nil, no_copy: nil, subpath: nil)
1382
- # Optional configuration for the `volume` type.
1383
- #
1384
- # @param driver_config [DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions::DriverConfig] Map of driver specific options
1385
- #
1386
- # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
1387
- #
1388
- # @param no_copy [Boolean] Populate volume with data from the target.
1389
- #
1390
- # @param subpath [String] Source path inside the volume. Must be relative without any back traversals.
1391
-
1392
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions#driver_config
1393
- class DriverConfig < DockerEngineRuby::Internal::Type::BaseModel
1394
- # @!attribute name
1395
- # Name of the driver to use to create the volume.
1396
- #
1397
- # @return [String, nil]
1398
- optional :name, String, api_name: :Name
1399
-
1400
- # @!attribute options
1401
- # key/value map of driver specific options.
1402
- #
1403
- # @return [Hash{Symbol=>String}, nil]
1404
- optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
1405
-
1406
- # @!method initialize(name: nil, options: nil)
1407
- # Map of driver specific options
1408
- #
1409
- # @param name [String] Name of the driver to use to create the volume.
1410
- #
1411
- # @param options [Hash{Symbol=>String}] key/value map of driver specific options.
1412
- end
1413
- end
1414
- end
1415
-
1416
- class PortBinding < DockerEngineRuby::Internal::Type::BaseModel
1417
- # @!attribute host_ip
1418
- # Host IP address that the container's port is mapped to.
1419
- #
1420
- # @return [String, nil]
1421
- optional :host_ip, String, api_name: :HostIp
1422
-
1423
- # @!attribute host_port
1424
- # Host port number that the container's port is mapped to.
1425
- #
1426
- # @return [String, nil]
1427
- optional :host_port, String, api_name: :HostPort
1428
-
1429
- # @!method initialize(host_ip: nil, host_port: nil)
1430
- # PortBinding represents a binding between a host IP address and a host port.
1431
- #
1432
- # @param host_ip [String] Host IP address that the container's port is mapped to.
1433
- #
1434
- # @param host_port [String] Host port number that the container's port is mapped to.
1435
- end
1436
-
1437
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig#restart_policy
1438
- class RestartPolicy < DockerEngineRuby::Internal::Type::BaseModel
1439
- # @!attribute maximum_retry_count
1440
- # If `on-failure` is used, the number of times to retry before giving up.
1441
- #
1442
- # @return [Integer, nil]
1443
- optional :maximum_retry_count, Integer, api_name: :MaximumRetryCount
1444
-
1445
- # @!attribute name
1446
- # - Empty string means not to restart
1447
- # - `no` Do not automatically restart
1448
- # - `always` Always restart
1449
- # - `unless-stopped` Restart always except when the user has manually stopped the
1450
- # container
1451
- # - `on-failure` Restart only when the container exit code is non-zero
1452
- #
1453
- # @return [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::RestartPolicy::Name, nil]
1454
- optional :name,
1455
- enum: -> {
1456
- DockerEngineRuby::ContainerCreateParams::Config::HostConfig::RestartPolicy::Name
1457
- },
1458
- api_name: :Name
1459
-
1460
- # @!method initialize(maximum_retry_count: nil, name: nil)
1461
- # Some parameter documentations has been truncated, see
1462
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::RestartPolicy}
1463
- # for more details.
1464
- #
1465
- # The behavior to apply when the container exits. The default is not to restart.
1466
- #
1467
- # An ever increasing delay (double the previous delay, starting at 100ms) is added
1468
- # before each restart to prevent flooding the server.
1469
- #
1470
- # @param maximum_retry_count [Integer] If `on-failure` is used, the number of times to retry before giving up.
1471
- #
1472
- # @param name [Symbol, DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::RestartPolicy::Name] - Empty string means not to restart
1473
-
1474
- # - Empty string means not to restart
1475
- # - `no` Do not automatically restart
1476
- # - `always` Always restart
1477
- # - `unless-stopped` Restart always except when the user has manually stopped the
1478
- # container
1479
- # - `on-failure` Restart only when the container exit code is non-zero
1480
- #
1481
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::HostConfig::RestartPolicy#name
1482
- module Name
1483
- extend DockerEngineRuby::Internal::Type::Enum
1484
-
1485
- EMPTY = :""
1486
- NO = :no
1487
- ALWAYS = :always
1488
- UNLESS_STOPPED = :"unless-stopped"
1489
- ON_FAILURE = :"on-failure"
1490
-
1491
- # @!method self.values
1492
- # @return [Array<Symbol>]
1493
- end
1494
- end
1495
-
1496
- class Ulimit < DockerEngineRuby::Internal::Type::BaseModel
1497
- # @!attribute hard
1498
- # Hard limit
1499
- #
1500
- # @return [Integer, nil]
1501
- optional :hard, Integer, api_name: :Hard
1502
-
1503
- # @!attribute name
1504
- # Name of ulimit
1505
- #
1506
- # @return [String, nil]
1507
- optional :name, String, api_name: :Name
1508
-
1509
- # @!attribute soft
1510
- # Soft limit
1511
- #
1512
- # @return [Integer, nil]
1513
- optional :soft, Integer, api_name: :Soft
1514
-
1515
- # @!method initialize(hard: nil, name: nil, soft: nil)
1516
- # @param hard [Integer] Hard limit
1517
- #
1518
- # @param name [String] Name of ulimit
1519
- #
1520
- # @param soft [Integer] Soft limit
1521
- end
1522
- end
1523
-
1524
- class NetworkingConfig < DockerEngineRuby::Internal::Type::BaseModel
1525
- # @!attribute endpoints_config
1526
- # A mapping of network name to endpoint configuration for that network. The
1527
- # endpoint configuration can be left empty to connect to that network with no
1528
- # particular endpoint configuration.
1529
- #
1530
- # @return [Hash{Symbol=>DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig}, nil]
1531
- optional :endpoints_config,
1532
- -> {
1533
- DockerEngineRuby::Internal::Type::HashOf[DockerEngineRuby::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig]
1534
- },
1535
- api_name: :EndpointsConfig
1536
-
1537
- # @!method initialize(endpoints_config: nil)
1538
- # Some parameter documentations has been truncated, see
1539
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig} for
1540
- # more details.
1541
- #
1542
- # NetworkingConfig represents the container's networking configuration for each of
1543
- # its interfaces. It is used for the networking configs specified in the
1544
- # `docker create` and `docker network connect` commands.
1545
- #
1546
- # @param endpoints_config [Hash{Symbol=>DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig}] A mapping of network name to endpoint configuration for that network.
1547
-
1548
- class EndpointsConfig < DockerEngineRuby::Internal::Type::BaseModel
1549
- # @!attribute aliases
1550
- #
1551
- # @return [Array<String>, nil]
1552
- optional :aliases, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Aliases
1553
-
1554
- # @!attribute dns_names
1555
- # List of all DNS names an endpoint has on a specific network. This list is based
1556
- # on the container name, network aliases, container short ID, and hostname.
1557
- #
1558
- # These DNS names are non-fully qualified but can contain several dots. You can
1559
- # get fully qualified DNS names by appending `.<network-name>`. For instance, if
1560
- # container name is `my.ctr` and the network is named `testnet`, `DNSNames` will
1561
- # contain `my.ctr` and the FQDN will be `my.ctr.testnet`.
1562
- #
1563
- # @return [Array<String>, nil]
1564
- optional :dns_names, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :DNSNames
1565
-
1566
- # @!attribute driver_opts
1567
- # DriverOpts is a mapping of driver options and values. These options are passed
1568
- # directly to the driver and are driver specific.
1569
- #
1570
- # @return [Hash{Symbol=>String}, nil]
1571
- optional :driver_opts,
1572
- DockerEngineRuby::Internal::Type::HashOf[String],
1573
- api_name: :DriverOpts,
1574
- nil?: true
1575
-
1576
- # @!attribute endpoint_id
1577
- # Unique ID for the service endpoint in a Sandbox.
1578
- #
1579
- # @return [String, nil]
1580
- optional :endpoint_id, String, api_name: :EndpointID
1581
-
1582
- # @!attribute gateway
1583
- # Gateway address for this network.
1584
- #
1585
- # @return [String, nil]
1586
- optional :gateway, String, api_name: :Gateway
1587
-
1588
- # @!attribute global_i_pv6_address
1589
- # Global IPv6 address.
1590
- #
1591
- # @return [String, nil]
1592
- optional :global_i_pv6_address, String, api_name: :GlobalIPv6Address
1593
-
1594
- # @!attribute global_i_pv6_prefix_len
1595
- # Mask length of the global IPv6 address.
1596
- #
1597
- # @return [Integer, nil]
1598
- optional :global_i_pv6_prefix_len, Integer, api_name: :GlobalIPv6PrefixLen
1599
-
1600
- # @!attribute gw_priority
1601
- # This property determines which endpoint will provide the default gateway for a
1602
- # container. The endpoint with the highest priority will be used. If multiple
1603
- # endpoints have the same priority, endpoints are lexicographically sorted based
1604
- # on their network name, and the one that sorts first is picked.
1605
- #
1606
- # @return [Integer, nil]
1607
- optional :gw_priority, Integer, api_name: :GwPriority
1608
-
1609
- # @!attribute ip_address
1610
- # IPv4 address.
1611
- #
1612
- # @return [String, nil]
1613
- optional :ip_address, String, api_name: :IPAddress
1614
-
1615
- # @!attribute ipam_config
1616
- # EndpointIPAMConfig represents an endpoint's IPAM configuration.
1617
- #
1618
- # @return [DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig::IpamConfig, nil]
1619
- optional :ipam_config,
1620
- -> {
1621
- DockerEngineRuby::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig::IpamConfig
1622
- },
1623
- api_name: :IPAMConfig,
1624
- nil?: true
1625
-
1626
- # @!attribute ip_prefix_len
1627
- # Mask length of the IPv4 address.
1628
- #
1629
- # @return [Integer, nil]
1630
- optional :ip_prefix_len, Integer, api_name: :IPPrefixLen
1631
-
1632
- # @!attribute i_pv6_gateway
1633
- # IPv6 gateway address.
1634
- #
1635
- # @return [String, nil]
1636
- optional :i_pv6_gateway, String, api_name: :IPv6Gateway
1637
-
1638
- # @!attribute links
1639
- #
1640
- # @return [Array<String>, nil]
1641
- optional :links, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Links
1642
-
1643
- # @!attribute mac_address
1644
- # MAC address for the endpoint on this network. The network driver might ignore
1645
- # this parameter.
1646
- #
1647
- # @return [String, nil]
1648
- optional :mac_address, String, api_name: :MacAddress
1649
-
1650
- # @!attribute network_id
1651
- # Unique ID of the network.
1652
- #
1653
- # @return [String, nil]
1654
- optional :network_id, String, api_name: :NetworkID
1655
-
1656
- # @!method initialize(aliases: nil, dns_names: nil, driver_opts: nil, endpoint_id: nil, gateway: nil, global_i_pv6_address: nil, global_i_pv6_prefix_len: nil, gw_priority: nil, ip_address: nil, ipam_config: nil, ip_prefix_len: nil, i_pv6_gateway: nil, links: nil, mac_address: nil, network_id: nil)
1657
- # Some parameter documentations has been truncated, see
1658
- # {DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig}
1659
- # for more details.
1660
- #
1661
- # Configuration for a network endpoint.
1662
- #
1663
- # @param aliases [Array<String>]
1664
- #
1665
- # @param dns_names [Array<String>] List of all DNS names an endpoint has on a specific network. This
1666
- #
1667
- # @param driver_opts [Hash{Symbol=>String}, nil] DriverOpts is a mapping of driver options and values. These options
1668
- #
1669
- # @param endpoint_id [String] Unique ID for the service endpoint in a Sandbox.
1670
- #
1671
- # @param gateway [String] Gateway address for this network.
1672
- #
1673
- # @param global_i_pv6_address [String] Global IPv6 address.
1674
- #
1675
- # @param global_i_pv6_prefix_len [Integer] Mask length of the global IPv6 address.
1676
- #
1677
- # @param gw_priority [Integer] This property determines which endpoint will provide the default
1678
- #
1679
- # @param ip_address [String] IPv4 address.
1680
- #
1681
- # @param ipam_config [DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig::IpamConfig, nil] EndpointIPAMConfig represents an endpoint's IPAM configuration.
1682
- #
1683
- # @param ip_prefix_len [Integer] Mask length of the IPv4 address.
1684
- #
1685
- # @param i_pv6_gateway [String] IPv6 gateway address.
1686
- #
1687
- # @param links [Array<String>]
1688
- #
1689
- # @param mac_address [String] MAC address for the endpoint on this network. The network driver might ignore th
1690
- #
1691
- # @param network_id [String] Unique ID of the network.
1692
-
1693
- # @see DockerEngineRuby::Models::ContainerCreateParams::Config::NetworkingConfig::EndpointsConfig#ipam_config
1694
- class IpamConfig < DockerEngineRuby::Internal::Type::BaseModel
1695
- # @!attribute i_pv4_address
1696
- #
1697
- # @return [String, nil]
1698
- optional :i_pv4_address, String, api_name: :IPv4Address
1699
-
1700
- # @!attribute i_pv6_address
1701
- #
1702
- # @return [String, nil]
1703
- optional :i_pv6_address, String, api_name: :IPv6Address
1704
-
1705
- # @!attribute link_local_ips
1706
- #
1707
- # @return [Array<String>, nil]
1708
- optional :link_local_ips,
1709
- DockerEngineRuby::Internal::Type::ArrayOf[String],
1710
- api_name: :LinkLocalIPs
1711
-
1712
- # @!method initialize(i_pv4_address: nil, i_pv6_address: nil, link_local_ips: nil)
1713
- # EndpointIPAMConfig represents an endpoint's IPAM configuration.
1714
- #
1715
- # @param i_pv4_address [String]
1716
- # @param i_pv6_address [String]
1717
- # @param link_local_ips [Array<String>]
1718
- end
1719
- end
1720
- end
1721
- end
1722
24
  end
1723
25
  end
1724
26
  end