docker-engine-api 0.2.1
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.
- checksums.yaml +7 -0
- data/.ignore +2 -0
- data/CHANGELOG.md +33 -0
- data/README.md +232 -0
- data/SECURITY.md +27 -0
- data/lib/docker_engine_api/client.rb +109 -0
- data/lib/docker_engine_api/errors.rb +228 -0
- data/lib/docker_engine_api/file_part.rb +58 -0
- data/lib/docker_engine_api/internal/transport/base_client.rb +571 -0
- data/lib/docker_engine_api/internal/transport/pooled_net_requester.rb +210 -0
- data/lib/docker_engine_api/internal/type/array_of.rb +168 -0
- data/lib/docker_engine_api/internal/type/base_model.rb +534 -0
- data/lib/docker_engine_api/internal/type/base_page.rb +55 -0
- data/lib/docker_engine_api/internal/type/boolean.rb +77 -0
- data/lib/docker_engine_api/internal/type/converter.rb +327 -0
- data/lib/docker_engine_api/internal/type/enum.rb +131 -0
- data/lib/docker_engine_api/internal/type/file_input.rb +111 -0
- data/lib/docker_engine_api/internal/type/hash_of.rb +188 -0
- data/lib/docker_engine_api/internal/type/request_parameters.rb +42 -0
- data/lib/docker_engine_api/internal/type/union.rb +245 -0
- data/lib/docker_engine_api/internal/type/unknown.rb +81 -0
- data/lib/docker_engine_api/internal/util.rb +920 -0
- data/lib/docker_engine_api/internal.rb +20 -0
- data/lib/docker_engine_api/models/auth_login_params.rb +32 -0
- data/lib/docker_engine_api/models/auth_response.rb +27 -0
- data/lib/docker_engine_api/models/config.rb +307 -0
- data/lib/docker_engine_api/models/config_create_params.rb +24 -0
- data/lib/docker_engine_api/models/config_create_response.rb +19 -0
- data/lib/docker_engine_api/models/config_delete_params.rb +14 -0
- data/lib/docker_engine_api/models/config_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/config_list_params.rb +33 -0
- data/lib/docker_engine_api/models/config_list_response.rb +8 -0
- data/lib/docker_engine_api/models/config_update_params.rb +26 -0
- data/lib/docker_engine_api/models/connect_request.rb +198 -0
- data/lib/docker_engine_api/models/container.rb +2515 -0
- data/lib/docker_engine_api/models/container_archive_params.rb +22 -0
- data/lib/docker_engine_api/models/container_attach_params.rb +73 -0
- data/lib/docker_engine_api/models/container_changes_params.rb +14 -0
- data/lib/docker_engine_api/models/container_changes_response.rb +9 -0
- data/lib/docker_engine_api/models/container_create_params.rb +1720 -0
- data/lib/docker_engine_api/models/container_delete_params.rb +38 -0
- data/lib/docker_engine_api/models/container_exec_params.rb +111 -0
- data/lib/docker_engine_api/models/container_exec_response.rb +19 -0
- data/lib/docker_engine_api/models/container_export_params.rb +14 -0
- data/lib/docker_engine_api/models/container_inspect_params.rb +22 -0
- data/lib/docker_engine_api/models/container_kill_params.rb +25 -0
- data/lib/docker_engine_api/models/container_list_params.rb +70 -0
- data/lib/docker_engine_api/models/container_list_response.rb +8 -0
- data/lib/docker_engine_api/models/container_logs_params.rb +74 -0
- data/lib/docker_engine_api/models/container_pause_params.rb +14 -0
- data/lib/docker_engine_api/models/container_prune_params.rb +35 -0
- data/lib/docker_engine_api/models/container_prune_response.rb +27 -0
- data/lib/docker_engine_api/models/container_rename_params.rb +22 -0
- data/lib/docker_engine_api/models/container_resize_params.rb +30 -0
- data/lib/docker_engine_api/models/container_restart_params.rb +33 -0
- data/lib/docker_engine_api/models/container_start_params.rb +27 -0
- data/lib/docker_engine_api/models/container_stats_params.rb +35 -0
- data/lib/docker_engine_api/models/container_stop_params.rb +33 -0
- data/lib/docker_engine_api/models/container_top_params.rb +22 -0
- data/lib/docker_engine_api/models/container_unpause_params.rb +14 -0
- data/lib/docker_engine_api/models/container_update_params.rb +606 -0
- data/lib/docker_engine_api/models/container_wait_params.rb +41 -0
- data/lib/docker_engine_api/models/create_request.rb +348 -0
- data/lib/docker_engine_api/models/create_response.rb +27 -0
- data/lib/docker_engine_api/models/delete_item.rb +24 -0
- data/lib/docker_engine_api/models/disconnect_request.rb +27 -0
- data/lib/docker_engine_api/models/distribution_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/error.rb +18 -0
- data/lib/docker_engine_api/models/exec_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/exec_inspect_response.rb +87 -0
- data/lib/docker_engine_api/models/exec_resize_params.rb +30 -0
- data/lib/docker_engine_api/models/exec_start_params.rb +41 -0
- data/lib/docker_engine_api/models/filesystem_change.rb +55 -0
- data/lib/docker_engine_api/models/history_item.rb +47 -0
- data/lib/docker_engine_api/models/image.rb +1395 -0
- data/lib/docker_engine_api/models/image_build_params.rb +283 -0
- data/lib/docker_engine_api/models/image_build_prune_params.rb +71 -0
- data/lib/docker_engine_api/models/image_build_prune_response.rb +24 -0
- data/lib/docker_engine_api/models/image_commit_params.rb +70 -0
- data/lib/docker_engine_api/models/image_commit_response.rb +19 -0
- data/lib/docker_engine_api/models/image_delete_params.rb +43 -0
- data/lib/docker_engine_api/models/image_delete_response.rb +8 -0
- data/lib/docker_engine_api/models/image_get_all_params.rb +37 -0
- data/lib/docker_engine_api/models/image_get_params.rb +29 -0
- data/lib/docker_engine_api/models/image_history_params.rb +34 -0
- data/lib/docker_engine_api/models/image_history_response.rb +8 -0
- data/lib/docker_engine_api/models/image_inspect_params.rb +22 -0
- data/lib/docker_engine_api/models/image_list_params.rb +68 -0
- data/lib/docker_engine_api/models/image_list_response.rb +8 -0
- data/lib/docker_engine_api/models/image_load_params.rb +44 -0
- data/lib/docker_engine_api/models/image_prune_params.rb +35 -0
- data/lib/docker_engine_api/models/image_prune_response.rb +27 -0
- data/lib/docker_engine_api/models/image_pull_params.rb +115 -0
- data/lib/docker_engine_api/models/image_push_params.rb +49 -0
- data/lib/docker_engine_api/models/image_search_params.rb +45 -0
- data/lib/docker_engine_api/models/image_search_response.rb +55 -0
- data/lib/docker_engine_api/models/image_tag_params.rb +30 -0
- data/lib/docker_engine_api/models/info.rb +1488 -0
- data/lib/docker_engine_api/models/inspect.rb +221 -0
- data/lib/docker_engine_api/models/inspect_response.rb +39 -0
- data/lib/docker_engine_api/models/list_response.rb +32 -0
- data/lib/docker_engine_api/models/network.rb +253 -0
- data/lib/docker_engine_api/models/network_connect_params.rb +14 -0
- data/lib/docker_engine_api/models/network_create_params.rb +210 -0
- data/lib/docker_engine_api/models/network_delete_params.rb +14 -0
- data/lib/docker_engine_api/models/network_disconnect_params.rb +14 -0
- data/lib/docker_engine_api/models/network_inspect_params.rb +30 -0
- data/lib/docker_engine_api/models/network_inspect_response.rb +131 -0
- data/lib/docker_engine_api/models/network_list_params.rb +40 -0
- data/lib/docker_engine_api/models/network_list_response.rb +8 -0
- data/lib/docker_engine_api/models/network_prune_params.rb +35 -0
- data/lib/docker_engine_api/models/network_prune_response.rb +17 -0
- data/lib/docker_engine_api/models/node.rb +459 -0
- data/lib/docker_engine_api/models/node_delete_params.rb +22 -0
- data/lib/docker_engine_api/models/node_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/node_list_params.rb +34 -0
- data/lib/docker_engine_api/models/node_list_response.rb +8 -0
- data/lib/docker_engine_api/models/node_update_params.rb +26 -0
- data/lib/docker_engine_api/models/plugin.rb +532 -0
- data/lib/docker_engine_api/models/plugin_create_params.rb +33 -0
- data/lib/docker_engine_api/models/plugin_delete_params.rb +26 -0
- data/lib/docker_engine_api/models/plugin_disable_params.rb +25 -0
- data/lib/docker_engine_api/models/plugin_enable_params.rb +22 -0
- data/lib/docker_engine_api/models/plugin_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/plugin_list_params.rb +31 -0
- data/lib/docker_engine_api/models/plugin_list_response.rb +8 -0
- data/lib/docker_engine_api/models/plugin_privileges_params.rb +26 -0
- data/lib/docker_engine_api/models/plugin_privileges_response.rb +8 -0
- data/lib/docker_engine_api/models/plugin_pull_params.rb +51 -0
- data/lib/docker_engine_api/models/plugin_push_params.rb +14 -0
- data/lib/docker_engine_api/models/plugin_set_params.rb +20 -0
- data/lib/docker_engine_api/models/plugin_upgrade_params.rb +41 -0
- data/lib/docker_engine_api/models/privilege.rb +29 -0
- data/lib/docker_engine_api/models/secret.rb +77 -0
- data/lib/docker_engine_api/models/secret_create_params.rb +24 -0
- data/lib/docker_engine_api/models/secret_create_response.rb +19 -0
- data/lib/docker_engine_api/models/secret_delete_params.rb +14 -0
- data/lib/docker_engine_api/models/secret_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/secret_list_params.rb +33 -0
- data/lib/docker_engine_api/models/secret_list_response.rb +8 -0
- data/lib/docker_engine_api/models/secret_update_params.rb +26 -0
- data/lib/docker_engine_api/models/service.rb +524 -0
- data/lib/docker_engine_api/models/service_create_params.rb +34 -0
- data/lib/docker_engine_api/models/service_delete_params.rb +14 -0
- data/lib/docker_engine_api/models/service_inspect_params.rb +22 -0
- data/lib/docker_engine_api/models/service_list_params.rb +41 -0
- data/lib/docker_engine_api/models/service_list_response.rb +8 -0
- data/lib/docker_engine_api/models/service_logs_params.rb +74 -0
- data/lib/docker_engine_api/models/service_update_params.rb +78 -0
- data/lib/docker_engine_api/models/spec.rb +510 -0
- data/lib/docker_engine_api/models/stats_response.rb +950 -0
- data/lib/docker_engine_api/models/summary.rb +767 -0
- data/lib/docker_engine_api/models/swarm.rb +198 -0
- data/lib/docker_engine_api/models/swarm_init_params.rb +101 -0
- data/lib/docker_engine_api/models/swarm_init_response.rb +7 -0
- data/lib/docker_engine_api/models/swarm_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/swarm_join_params.rb +70 -0
- data/lib/docker_engine_api/models/swarm_leave_params.rb +26 -0
- data/lib/docker_engine_api/models/swarm_unlock_key_params.rb +14 -0
- data/lib/docker_engine_api/models/swarm_unlock_key_response.rb +17 -0
- data/lib/docker_engine_api/models/swarm_unlock_params.rb +22 -0
- data/lib/docker_engine_api/models/swarm_update_params.rb +50 -0
- data/lib/docker_engine_api/models/system_data_usage_params.rb +46 -0
- data/lib/docker_engine_api/models/system_data_usage_response.rb +260 -0
- data/lib/docker_engine_api/models/system_events_params.rb +58 -0
- data/lib/docker_engine_api/models/system_events_response.rb +126 -0
- data/lib/docker_engine_api/models/system_info_params.rb +14 -0
- data/lib/docker_engine_api/models/system_ping_params.rb +14 -0
- data/lib/docker_engine_api/models/system_ping_response.rb +7 -0
- data/lib/docker_engine_api/models/system_version_params.rb +14 -0
- data/lib/docker_engine_api/models/task.rb +471 -0
- data/lib/docker_engine_api/models/task_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/task_list_params.rb +35 -0
- data/lib/docker_engine_api/models/task_list_response.rb +8 -0
- data/lib/docker_engine_api/models/task_logs_params.rb +74 -0
- data/lib/docker_engine_api/models/top_response.rb +33 -0
- data/lib/docker_engine_api/models/update_response.rb +19 -0
- data/lib/docker_engine_api/models/version.rb +164 -0
- data/lib/docker_engine_api/models/volume.rb +651 -0
- data/lib/docker_engine_api/models/volume_create_params.rb +14 -0
- data/lib/docker_engine_api/models/volume_delete_params.rb +22 -0
- data/lib/docker_engine_api/models/volume_inspect_params.rb +14 -0
- data/lib/docker_engine_api/models/volume_list_params.rb +34 -0
- data/lib/docker_engine_api/models/volume_prune_params.rb +33 -0
- data/lib/docker_engine_api/models/volume_prune_response.rb +25 -0
- data/lib/docker_engine_api/models/volume_update_params.rb +325 -0
- data/lib/docker_engine_api/models/wait_response.rb +41 -0
- data/lib/docker_engine_api/models.rb +312 -0
- data/lib/docker_engine_api/request_options.rb +78 -0
- data/lib/docker_engine_api/resources/auth.rb +38 -0
- data/lib/docker_engine_api/resources/configs.rb +130 -0
- data/lib/docker_engine_api/resources/containers.rb +854 -0
- data/lib/docker_engine_api/resources/distribution.rb +34 -0
- data/lib/docker_engine_api/resources/exec.rb +91 -0
- data/lib/docker_engine_api/resources/images.rb +676 -0
- data/lib/docker_engine_api/resources/networks.rb +218 -0
- data/lib/docker_engine_api/resources/nodes.rb +113 -0
- data/lib/docker_engine_api/resources/plugins.rb +317 -0
- data/lib/docker_engine_api/resources/secrets.rb +130 -0
- data/lib/docker_engine_api/resources/services.rb +195 -0
- data/lib/docker_engine_api/resources/swarm.rb +183 -0
- data/lib/docker_engine_api/resources/system.rb +155 -0
- data/lib/docker_engine_api/resources/tasks.rb +103 -0
- data/lib/docker_engine_api/resources/volumes.rb +161 -0
- data/lib/docker_engine_api/version.rb +5 -0
- data/lib/docker_engine_api.rb +234 -0
- data/manifest.yaml +17 -0
- data/rbi/docker_engine_api/client.rbi +80 -0
- data/rbi/docker_engine_api/errors.rbi +205 -0
- data/rbi/docker_engine_api/file_part.rbi +37 -0
- data/rbi/docker_engine_api/internal/transport/base_client.rbi +304 -0
- data/rbi/docker_engine_api/internal/transport/pooled_net_requester.rbi +84 -0
- data/rbi/docker_engine_api/internal/type/array_of.rbi +108 -0
- data/rbi/docker_engine_api/internal/type/base_model.rbi +314 -0
- data/rbi/docker_engine_api/internal/type/base_page.rbi +43 -0
- data/rbi/docker_engine_api/internal/type/boolean.rbi +58 -0
- data/rbi/docker_engine_api/internal/type/converter.rbi +225 -0
- data/rbi/docker_engine_api/internal/type/enum.rbi +82 -0
- data/rbi/docker_engine_api/internal/type/file_input.rbi +59 -0
- data/rbi/docker_engine_api/internal/type/hash_of.rbi +108 -0
- data/rbi/docker_engine_api/internal/type/request_parameters.rbi +31 -0
- data/rbi/docker_engine_api/internal/type/union.rbi +134 -0
- data/rbi/docker_engine_api/internal/type/unknown.rbi +58 -0
- data/rbi/docker_engine_api/internal/util.rbi +487 -0
- data/rbi/docker_engine_api/internal.rbi +18 -0
- data/rbi/docker_engine_api/models/auth_login_params.rbi +65 -0
- data/rbi/docker_engine_api/models/auth_response.rbi +42 -0
- data/rbi/docker_engine_api/models/config.rbi +442 -0
- data/rbi/docker_engine_api/models/config_create_params.rbi +64 -0
- data/rbi/docker_engine_api/models/config_create_response.rbi +31 -0
- data/rbi/docker_engine_api/models/config_delete_params.rbi +32 -0
- data/rbi/docker_engine_api/models/config_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/config_list_params.rbi +62 -0
- data/rbi/docker_engine_api/models/config_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/config_update_params.rbi +45 -0
- data/rbi/docker_engine_api/models/connect_request.rbi +343 -0
- data/rbi/docker_engine_api/models/container.rbi +4645 -0
- data/rbi/docker_engine_api/models/container_archive_params.rbi +43 -0
- data/rbi/docker_engine_api/models/container_attach_params.rbi +120 -0
- data/rbi/docker_engine_api/models/container_changes_params.rbi +32 -0
- data/rbi/docker_engine_api/models/container_changes_response.rbi +13 -0
- data/rbi/docker_engine_api/models/container_create_params.rbi +3301 -0
- data/rbi/docker_engine_api/models/container_delete_params.rbi +71 -0
- data/rbi/docker_engine_api/models/container_exec_params.rbi +162 -0
- data/rbi/docker_engine_api/models/container_exec_response.rbi +31 -0
- data/rbi/docker_engine_api/models/container_export_params.rbi +32 -0
- data/rbi/docker_engine_api/models/container_inspect_params.rbi +46 -0
- data/rbi/docker_engine_api/models/container_kill_params.rbi +46 -0
- data/rbi/docker_engine_api/models/container_list_params.rbi +124 -0
- data/rbi/docker_engine_api/models/container_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/container_logs_params.rbi +117 -0
- data/rbi/docker_engine_api/models/container_pause_params.rbi +32 -0
- data/rbi/docker_engine_api/models/container_prune_params.rbi +66 -0
- data/rbi/docker_engine_api/models/container_prune_response.rbi +51 -0
- data/rbi/docker_engine_api/models/container_rename_params.rbi +43 -0
- data/rbi/docker_engine_api/models/container_resize_params.rbi +54 -0
- data/rbi/docker_engine_api/models/container_restart_params.rbi +60 -0
- data/rbi/docker_engine_api/models/container_start_params.rbi +53 -0
- data/rbi/docker_engine_api/models/container_stats_params.rbi +64 -0
- data/rbi/docker_engine_api/models/container_stop_params.rbi +60 -0
- data/rbi/docker_engine_api/models/container_top_params.rbi +46 -0
- data/rbi/docker_engine_api/models/container_unpause_params.rbi +32 -0
- data/rbi/docker_engine_api/models/container_update_params.rbi +1121 -0
- data/rbi/docker_engine_api/models/container_wait_params.rbi +101 -0
- data/rbi/docker_engine_api/models/create_request.rbi +708 -0
- data/rbi/docker_engine_api/models/create_response.rbi +39 -0
- data/rbi/docker_engine_api/models/delete_item.rbi +41 -0
- data/rbi/docker_engine_api/models/disconnect_request.rbi +43 -0
- data/rbi/docker_engine_api/models/distribution_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/error.rbi +28 -0
- data/rbi/docker_engine_api/models/exec_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/exec_inspect_response.rbi +135 -0
- data/rbi/docker_engine_api/models/exec_resize_params.rbi +54 -0
- data/rbi/docker_engine_api/models/exec_start_params.rbi +68 -0
- data/rbi/docker_engine_api/models/filesystem_change.rbi +93 -0
- data/rbi/docker_engine_api/models/history_item.rbi +62 -0
- data/rbi/docker_engine_api/models/image.rbi +2353 -0
- data/rbi/docker_engine_api/models/image_build_params.rbi +434 -0
- data/rbi/docker_engine_api/models/image_build_prune_params.rbi +121 -0
- data/rbi/docker_engine_api/models/image_build_prune_response.rbi +49 -0
- data/rbi/docker_engine_api/models/image_commit_params.rbi +115 -0
- data/rbi/docker_engine_api/models/image_commit_response.rbi +31 -0
- data/rbi/docker_engine_api/models/image_delete_params.rbi +75 -0
- data/rbi/docker_engine_api/models/image_delete_response.rbi +11 -0
- data/rbi/docker_engine_api/models/image_get_all_params.rbi +68 -0
- data/rbi/docker_engine_api/models/image_get_params.rbi +57 -0
- data/rbi/docker_engine_api/models/image_history_params.rbi +64 -0
- data/rbi/docker_engine_api/models/image_history_response.rbi +11 -0
- data/rbi/docker_engine_api/models/image_inspect_params.rbi +49 -0
- data/rbi/docker_engine_api/models/image_list_params.rbi +115 -0
- data/rbi/docker_engine_api/models/image_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/image_load_params.rbi +74 -0
- data/rbi/docker_engine_api/models/image_prune_params.rbi +66 -0
- data/rbi/docker_engine_api/models/image_prune_response.rbi +58 -0
- data/rbi/docker_engine_api/models/image_pull_params.rbi +189 -0
- data/rbi/docker_engine_api/models/image_push_params.rbi +84 -0
- data/rbi/docker_engine_api/models/image_search_params.rbi +76 -0
- data/rbi/docker_engine_api/models/image_search_response.rbi +95 -0
- data/rbi/docker_engine_api/models/image_tag_params.rbi +60 -0
- data/rbi/docker_engine_api/models/info.rbi +2564 -0
- data/rbi/docker_engine_api/models/inspect.rbi +359 -0
- data/rbi/docker_engine_api/models/inspect_response.rbi +77 -0
- data/rbi/docker_engine_api/models/list_response.rbi +55 -0
- data/rbi/docker_engine_api/models/network.rbi +427 -0
- data/rbi/docker_engine_api/models/network_connect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/network_create_params.rbi +373 -0
- data/rbi/docker_engine_api/models/network_delete_params.rbi +32 -0
- data/rbi/docker_engine_api/models/network_disconnect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/network_inspect_params.rbi +60 -0
- data/rbi/docker_engine_api/models/network_inspect_response.rbi +336 -0
- data/rbi/docker_engine_api/models/network_list_params.rbi +76 -0
- data/rbi/docker_engine_api/models/network_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/network_prune_params.rbi +66 -0
- data/rbi/docker_engine_api/models/network_prune_response.rbi +35 -0
- data/rbi/docker_engine_api/models/node.rbi +909 -0
- data/rbi/docker_engine_api/models/node_delete_params.rbi +49 -0
- data/rbi/docker_engine_api/models/node_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/node_list_params.rbi +64 -0
- data/rbi/docker_engine_api/models/node_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/node_update_params.rbi +45 -0
- data/rbi/docker_engine_api/models/plugin.rbi +835 -0
- data/rbi/docker_engine_api/models/plugin_create_params.rbi +54 -0
- data/rbi/docker_engine_api/models/plugin_delete_params.rbi +51 -0
- data/rbi/docker_engine_api/models/plugin_disable_params.rbi +49 -0
- data/rbi/docker_engine_api/models/plugin_enable_params.rbi +46 -0
- data/rbi/docker_engine_api/models/plugin_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/plugin_list_params.rbi +58 -0
- data/rbi/docker_engine_api/models/plugin_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/plugin_privileges_params.rbi +45 -0
- data/rbi/docker_engine_api/models/plugin_privileges_response.rbi +11 -0
- data/rbi/docker_engine_api/models/plugin_pull_params.rbi +83 -0
- data/rbi/docker_engine_api/models/plugin_push_params.rbi +32 -0
- data/rbi/docker_engine_api/models/plugin_set_params.rbi +44 -0
- data/rbi/docker_engine_api/models/plugin_upgrade_params.rbi +68 -0
- data/rbi/docker_engine_api/models/privilege.rbi +49 -0
- data/rbi/docker_engine_api/models/secret.rbi +125 -0
- data/rbi/docker_engine_api/models/secret_create_params.rbi +64 -0
- data/rbi/docker_engine_api/models/secret_create_response.rbi +31 -0
- data/rbi/docker_engine_api/models/secret_delete_params.rbi +32 -0
- data/rbi/docker_engine_api/models/secret_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/secret_list_params.rbi +62 -0
- data/rbi/docker_engine_api/models/secret_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/secret_update_params.rbi +45 -0
- data/rbi/docker_engine_api/models/service.rbi +1093 -0
- data/rbi/docker_engine_api/models/service_create_params.rbi +79 -0
- data/rbi/docker_engine_api/models/service_delete_params.rbi +32 -0
- data/rbi/docker_engine_api/models/service_inspect_params.rbi +49 -0
- data/rbi/docker_engine_api/models/service_list_params.rbi +76 -0
- data/rbi/docker_engine_api/models/service_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/service_logs_params.rbi +117 -0
- data/rbi/docker_engine_api/models/service_update_params.rbi +168 -0
- data/rbi/docker_engine_api/models/spec.rbi +1030 -0
- data/rbi/docker_engine_api/models/stats_response.rbi +1772 -0
- data/rbi/docker_engine_api/models/summary.rbi +1332 -0
- data/rbi/docker_engine_api/models/swarm.rbi +315 -0
- data/rbi/docker_engine_api/models/swarm_init_params.rbi +162 -0
- data/rbi/docker_engine_api/models/swarm_init_response.rbi +7 -0
- data/rbi/docker_engine_api/models/swarm_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/swarm_join_params.rbi +119 -0
- data/rbi/docker_engine_api/models/swarm_leave_params.rbi +51 -0
- data/rbi/docker_engine_api/models/swarm_unlock_key_params.rbi +32 -0
- data/rbi/docker_engine_api/models/swarm_unlock_key_response.rbi +33 -0
- data/rbi/docker_engine_api/models/swarm_unlock_params.rbi +49 -0
- data/rbi/docker_engine_api/models/swarm_update_params.rbi +81 -0
- data/rbi/docker_engine_api/models/system_data_usage_params.rbi +111 -0
- data/rbi/docker_engine_api/models/system_data_usage_response.rbi +460 -0
- data/rbi/docker_engine_api/models/system_events_params.rbi +105 -0
- data/rbi/docker_engine_api/models/system_events_response.rbi +286 -0
- data/rbi/docker_engine_api/models/system_info_params.rbi +32 -0
- data/rbi/docker_engine_api/models/system_ping_params.rbi +32 -0
- data/rbi/docker_engine_api/models/system_ping_response.rbi +7 -0
- data/rbi/docker_engine_api/models/system_version_params.rbi +32 -0
- data/rbi/docker_engine_api/models/task.rbi +921 -0
- data/rbi/docker_engine_api/models/task_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/task_list_params.rbi +66 -0
- data/rbi/docker_engine_api/models/task_list_response.rbi +11 -0
- data/rbi/docker_engine_api/models/task_logs_params.rbi +117 -0
- data/rbi/docker_engine_api/models/top_response.rbi +54 -0
- data/rbi/docker_engine_api/models/update_response.rbi +34 -0
- data/rbi/docker_engine_api/models/version.rbi +256 -0
- data/rbi/docker_engine_api/models/volume.rbi +1230 -0
- data/rbi/docker_engine_api/models/volume_create_params.rbi +32 -0
- data/rbi/docker_engine_api/models/volume_delete_params.rbi +49 -0
- data/rbi/docker_engine_api/models/volume_inspect_params.rbi +32 -0
- data/rbi/docker_engine_api/models/volume_list_params.rbi +64 -0
- data/rbi/docker_engine_api/models/volume_prune_params.rbi +62 -0
- data/rbi/docker_engine_api/models/volume_prune_response.rbi +51 -0
- data/rbi/docker_engine_api/models/volume_update_params.rbi +668 -0
- data/rbi/docker_engine_api/models/wait_response.rbi +78 -0
- data/rbi/docker_engine_api/models.rbi +271 -0
- data/rbi/docker_engine_api/request_options.rbi +64 -0
- data/rbi/docker_engine_api/resources/auth.rbi +30 -0
- data/rbi/docker_engine_api/resources/configs.rbi +93 -0
- data/rbi/docker_engine_api/resources/containers.rbi +843 -0
- data/rbi/docker_engine_api/resources/distribution.rbi +26 -0
- data/rbi/docker_engine_api/resources/exec.rbi +72 -0
- data/rbi/docker_engine_api/resources/images.rbi +739 -0
- data/rbi/docker_engine_api/resources/networks.rbi +200 -0
- data/rbi/docker_engine_api/resources/nodes.rbi +87 -0
- data/rbi/docker_engine_api/resources/plugins.rbi +228 -0
- data/rbi/docker_engine_api/resources/secrets.rbi +93 -0
- data/rbi/docker_engine_api/resources/services.rbi +166 -0
- data/rbi/docker_engine_api/resources/swarm.rbi +178 -0
- data/rbi/docker_engine_api/resources/system.rbi +123 -0
- data/rbi/docker_engine_api/resources/tasks.rbi +90 -0
- data/rbi/docker_engine_api/resources/volumes.rbi +123 -0
- data/rbi/docker_engine_api/version.rbi +5 -0
- data/sig/docker_engine_api/client.rbs +49 -0
- data/sig/docker_engine_api/errors.rbs +117 -0
- data/sig/docker_engine_api/file_part.rbs +21 -0
- data/sig/docker_engine_api/internal/transport/base_client.rbs +131 -0
- data/sig/docker_engine_api/internal/transport/pooled_net_requester.rbs +48 -0
- data/sig/docker_engine_api/internal/type/array_of.rbs +48 -0
- data/sig/docker_engine_api/internal/type/base_model.rbs +104 -0
- data/sig/docker_engine_api/internal/type/base_page.rbs +24 -0
- data/sig/docker_engine_api/internal/type/boolean.rbs +26 -0
- data/sig/docker_engine_api/internal/type/converter.rbs +79 -0
- data/sig/docker_engine_api/internal/type/enum.rbs +32 -0
- data/sig/docker_engine_api/internal/type/file_input.rbs +25 -0
- data/sig/docker_engine_api/internal/type/hash_of.rbs +48 -0
- data/sig/docker_engine_api/internal/type/request_parameters.rbs +20 -0
- data/sig/docker_engine_api/internal/type/union.rbs +52 -0
- data/sig/docker_engine_api/internal/type/unknown.rbs +26 -0
- data/sig/docker_engine_api/internal/util.rbs +185 -0
- data/sig/docker_engine_api/internal.rbs +10 -0
- data/sig/docker_engine_api/models/auth_login_params.rbs +38 -0
- data/sig/docker_engine_api/models/auth_response.rbs +17 -0
- data/sig/docker_engine_api/models/config.rbs +225 -0
- data/sig/docker_engine_api/models/config_create_params.rbs +36 -0
- data/sig/docker_engine_api/models/config_create_response.rbs +13 -0
- data/sig/docker_engine_api/models/config_delete_params.rbs +15 -0
- data/sig/docker_engine_api/models/config_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/config_list_params.rbs +25 -0
- data/sig/docker_engine_api/models/config_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/config_update_params.rbs +23 -0
- data/sig/docker_engine_api/models/connect_request.rbs +175 -0
- data/sig/docker_engine_api/models/container.rbs +1973 -0
- data/sig/docker_engine_api/models/container_archive_params.rbs +23 -0
- data/sig/docker_engine_api/models/container_attach_params.rbs +63 -0
- data/sig/docker_engine_api/models/container_changes_params.rbs +15 -0
- data/sig/docker_engine_api/models/container_changes_response.rbs +7 -0
- data/sig/docker_engine_api/models/container_create_params.rbs +1352 -0
- data/sig/docker_engine_api/models/container_delete_params.rbs +38 -0
- data/sig/docker_engine_api/models/container_exec_params.rbs +96 -0
- data/sig/docker_engine_api/models/container_exec_response.rbs +13 -0
- data/sig/docker_engine_api/models/container_export_params.rbs +15 -0
- data/sig/docker_engine_api/models/container_inspect_params.rbs +25 -0
- data/sig/docker_engine_api/models/container_kill_params.rbs +25 -0
- data/sig/docker_engine_api/models/container_list_params.rbs +44 -0
- data/sig/docker_engine_api/models/container_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/container_logs_params.rbs +70 -0
- data/sig/docker_engine_api/models/container_pause_params.rbs +15 -0
- data/sig/docker_engine_api/models/container_prune_params.rbs +25 -0
- data/sig/docker_engine_api/models/container_prune_response.rbs +26 -0
- data/sig/docker_engine_api/models/container_rename_params.rbs +23 -0
- data/sig/docker_engine_api/models/container_resize_params.rbs +28 -0
- data/sig/docker_engine_api/models/container_restart_params.rbs +32 -0
- data/sig/docker_engine_api/models/container_start_params.rbs +26 -0
- data/sig/docker_engine_api/models/container_stats_params.rbs +32 -0
- data/sig/docker_engine_api/models/container_stop_params.rbs +32 -0
- data/sig/docker_engine_api/models/container_top_params.rbs +25 -0
- data/sig/docker_engine_api/models/container_unpause_params.rbs +15 -0
- data/sig/docker_engine_api/models/container_update_params.rbs +476 -0
- data/sig/docker_engine_api/models/container_wait_params.rbs +40 -0
- data/sig/docker_engine_api/models/create_request.rbs +255 -0
- data/sig/docker_engine_api/models/create_response.rbs +15 -0
- data/sig/docker_engine_api/models/delete_item.rbs +19 -0
- data/sig/docker_engine_api/models/disconnect_request.rbs +17 -0
- data/sig/docker_engine_api/models/distribution_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/error.rbs +13 -0
- data/sig/docker_engine_api/models/exec_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/exec_inspect_response.rbs +94 -0
- data/sig/docker_engine_api/models/exec_resize_params.rbs +28 -0
- data/sig/docker_engine_api/models/exec_start_params.rbs +36 -0
- data/sig/docker_engine_api/models/filesystem_change.rbs +34 -0
- data/sig/docker_engine_api/models/history_item.rbs +45 -0
- data/sig/docker_engine_api/models/image.rbs +1042 -0
- data/sig/docker_engine_api/models/image_build_params.rbs +221 -0
- data/sig/docker_engine_api/models/image_build_prune_params.rbs +56 -0
- data/sig/docker_engine_api/models/image_build_prune_response.rbs +26 -0
- data/sig/docker_engine_api/models/image_commit_params.rbs +70 -0
- data/sig/docker_engine_api/models/image_commit_response.rbs +13 -0
- data/sig/docker_engine_api/models/image_delete_params.rbs +38 -0
- data/sig/docker_engine_api/models/image_delete_response.rbs +7 -0
- data/sig/docker_engine_api/models/image_get_all_params.rbs +32 -0
- data/sig/docker_engine_api/models/image_get_params.rbs +26 -0
- data/sig/docker_engine_api/models/image_history_params.rbs +25 -0
- data/sig/docker_engine_api/models/image_history_response.rbs +7 -0
- data/sig/docker_engine_api/models/image_inspect_params.rbs +25 -0
- data/sig/docker_engine_api/models/image_list_params.rbs +56 -0
- data/sig/docker_engine_api/models/image_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/image_load_params.rbs +40 -0
- data/sig/docker_engine_api/models/image_prune_params.rbs +25 -0
- data/sig/docker_engine_api/models/image_prune_response.rbs +31 -0
- data/sig/docker_engine_api/models/image_pull_params.rbs +84 -0
- data/sig/docker_engine_api/models/image_push_params.rbs +36 -0
- data/sig/docker_engine_api/models/image_search_params.rbs +36 -0
- data/sig/docker_engine_api/models/image_search_response.rbs +55 -0
- data/sig/docker_engine_api/models/image_tag_params.rbs +32 -0
- data/sig/docker_engine_api/models/info.rbs +1080 -0
- data/sig/docker_engine_api/models/inspect.rbs +177 -0
- data/sig/docker_engine_api/models/inspect_response.rbs +50 -0
- data/sig/docker_engine_api/models/list_response.rbs +28 -0
- data/sig/docker_engine_api/models/network.rbs +238 -0
- data/sig/docker_engine_api/models/network_connect_params.rbs +15 -0
- data/sig/docker_engine_api/models/network_create_params.rbs +203 -0
- data/sig/docker_engine_api/models/network_delete_params.rbs +15 -0
- data/sig/docker_engine_api/models/network_disconnect_params.rbs +15 -0
- data/sig/docker_engine_api/models/network_inspect_params.rbs +32 -0
- data/sig/docker_engine_api/models/network_inspect_response.rbs +149 -0
- data/sig/docker_engine_api/models/network_list_params.rbs +25 -0
- data/sig/docker_engine_api/models/network_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/network_prune_params.rbs +25 -0
- data/sig/docker_engine_api/models/network_prune_response.rbs +15 -0
- data/sig/docker_engine_api/models/node.rbs +434 -0
- data/sig/docker_engine_api/models/node_delete_params.rbs +25 -0
- data/sig/docker_engine_api/models/node_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/node_list_params.rbs +25 -0
- data/sig/docker_engine_api/models/node_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/node_update_params.rbs +23 -0
- data/sig/docker_engine_api/models/plugin.rbs +509 -0
- data/sig/docker_engine_api/models/plugin_create_params.rbs +28 -0
- data/sig/docker_engine_api/models/plugin_delete_params.rbs +25 -0
- data/sig/docker_engine_api/models/plugin_disable_params.rbs +25 -0
- data/sig/docker_engine_api/models/plugin_enable_params.rbs +25 -0
- data/sig/docker_engine_api/models/plugin_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/plugin_list_params.rbs +25 -0
- data/sig/docker_engine_api/models/plugin_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/plugin_privileges_params.rbs +23 -0
- data/sig/docker_engine_api/models/plugin_privileges_response.rbs +7 -0
- data/sig/docker_engine_api/models/plugin_pull_params.rbs +49 -0
- data/sig/docker_engine_api/models/plugin_push_params.rbs +15 -0
- data/sig/docker_engine_api/models/plugin_set_params.rbs +26 -0
- data/sig/docker_engine_api/models/plugin_upgrade_params.rbs +42 -0
- data/sig/docker_engine_api/models/privilege.rbs +32 -0
- data/sig/docker_engine_api/models/secret.rbs +64 -0
- data/sig/docker_engine_api/models/secret_create_params.rbs +36 -0
- data/sig/docker_engine_api/models/secret_create_response.rbs +13 -0
- data/sig/docker_engine_api/models/secret_delete_params.rbs +15 -0
- data/sig/docker_engine_api/models/secret_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/secret_list_params.rbs +25 -0
- data/sig/docker_engine_api/models/secret_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/secret_update_params.rbs +23 -0
- data/sig/docker_engine_api/models/service.rbs +471 -0
- data/sig/docker_engine_api/models/service_create_params.rbs +41 -0
- data/sig/docker_engine_api/models/service_delete_params.rbs +15 -0
- data/sig/docker_engine_api/models/service_inspect_params.rbs +26 -0
- data/sig/docker_engine_api/models/service_list_params.rbs +32 -0
- data/sig/docker_engine_api/models/service_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/service_logs_params.rbs +70 -0
- data/sig/docker_engine_api/models/service_update_params.rbs +73 -0
- data/sig/docker_engine_api/models/spec.rbs +467 -0
- data/sig/docker_engine_api/models/stats_response.rbs +730 -0
- data/sig/docker_engine_api/models/summary.rbs +634 -0
- data/sig/docker_engine_api/models/swarm.rbs +159 -0
- data/sig/docker_engine_api/models/swarm_init_params.rbs +77 -0
- data/sig/docker_engine_api/models/swarm_init_response.rbs +5 -0
- data/sig/docker_engine_api/models/swarm_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/swarm_join_params.rbs +56 -0
- data/sig/docker_engine_api/models/swarm_leave_params.rbs +25 -0
- data/sig/docker_engine_api/models/swarm_unlock_key_params.rbs +15 -0
- data/sig/docker_engine_api/models/swarm_unlock_key_response.rbs +15 -0
- data/sig/docker_engine_api/models/swarm_unlock_params.rbs +26 -0
- data/sig/docker_engine_api/models/swarm_update_params.rbs +47 -0
- data/sig/docker_engine_api/models/system_data_usage_params.rbs +50 -0
- data/sig/docker_engine_api/models/system_data_usage_response.rbs +239 -0
- data/sig/docker_engine_api/models/system_events_params.rbs +38 -0
- data/sig/docker_engine_api/models/system_events_response.rbs +124 -0
- data/sig/docker_engine_api/models/system_info_params.rbs +15 -0
- data/sig/docker_engine_api/models/system_ping_params.rbs +15 -0
- data/sig/docker_engine_api/models/system_ping_response.rbs +5 -0
- data/sig/docker_engine_api/models/system_version_params.rbs +15 -0
- data/sig/docker_engine_api/models/task.rbs +469 -0
- data/sig/docker_engine_api/models/task_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/task_list_params.rbs +25 -0
- data/sig/docker_engine_api/models/task_list_response.rbs +7 -0
- data/sig/docker_engine_api/models/task_logs_params.rbs +70 -0
- data/sig/docker_engine_api/models/top_response.rbs +26 -0
- data/sig/docker_engine_api/models/update_response.rbs +15 -0
- data/sig/docker_engine_api/models/version.rbs +127 -0
- data/sig/docker_engine_api/models/volume.rbs +478 -0
- data/sig/docker_engine_api/models/volume_create_params.rbs +15 -0
- data/sig/docker_engine_api/models/volume_delete_params.rbs +25 -0
- data/sig/docker_engine_api/models/volume_inspect_params.rbs +15 -0
- data/sig/docker_engine_api/models/volume_list_params.rbs +25 -0
- data/sig/docker_engine_api/models/volume_prune_params.rbs +25 -0
- data/sig/docker_engine_api/models/volume_prune_response.rbs +26 -0
- data/sig/docker_engine_api/models/volume_update_params.rbs +235 -0
- data/sig/docker_engine_api/models/wait_response.rbs +38 -0
- data/sig/docker_engine_api/models.rbs +269 -0
- data/sig/docker_engine_api/request_options.rbs +36 -0
- data/sig/docker_engine_api/resources/auth.rbs +14 -0
- data/sig/docker_engine_api/resources/configs.rbs +34 -0
- data/sig/docker_engine_api/resources/containers.rbs +200 -0
- data/sig/docker_engine_api/resources/distribution.rbs +12 -0
- data/sig/docker_engine_api/resources/exec.rbs +27 -0
- data/sig/docker_engine_api/resources/images.rbs +170 -0
- data/sig/docker_engine_api/resources/networks.rbs +60 -0
- data/sig/docker_engine_api/resources/nodes.rbs +30 -0
- data/sig/docker_engine_api/resources/plugins.rbs +73 -0
- data/sig/docker_engine_api/resources/secrets.rbs +34 -0
- data/sig/docker_engine_api/resources/services.rbs +52 -0
- data/sig/docker_engine_api/resources/swarm.rbs +55 -0
- data/sig/docker_engine_api/resources/system.rbs +30 -0
- data/sig/docker_engine_api/resources/tasks.rbs +29 -0
- data/sig/docker_engine_api/resources/volumes.rbs +40 -0
- data/sig/docker_engine_api/version.rbs +3 -0
- metadata +679 -0
|
@@ -0,0 +1,1030 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module DockerEngineAPI
|
|
4
|
+
module Models
|
|
5
|
+
class Spec < DockerEngineAPI::Internal::Type::BaseModel
|
|
6
|
+
OrHash =
|
|
7
|
+
T.type_alias do
|
|
8
|
+
T.any(DockerEngineAPI::Spec, DockerEngineAPI::Internal::AnyHash)
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Properties that can be configured to access and load balance a service.
|
|
12
|
+
sig { returns(T.nilable(DockerEngineAPI::Spec::EndpointSpec)) }
|
|
13
|
+
attr_reader :endpoint_spec
|
|
14
|
+
|
|
15
|
+
sig do
|
|
16
|
+
params(endpoint_spec: DockerEngineAPI::Spec::EndpointSpec::OrHash).void
|
|
17
|
+
end
|
|
18
|
+
attr_writer :endpoint_spec
|
|
19
|
+
|
|
20
|
+
# User-defined key/value metadata.
|
|
21
|
+
sig { returns(T.nilable(T::Hash[Symbol, String])) }
|
|
22
|
+
attr_reader :labels
|
|
23
|
+
|
|
24
|
+
sig { params(labels: T::Hash[Symbol, String]).void }
|
|
25
|
+
attr_writer :labels
|
|
26
|
+
|
|
27
|
+
# Scheduling mode for the service.
|
|
28
|
+
sig { returns(T.nilable(DockerEngineAPI::Spec::Mode)) }
|
|
29
|
+
attr_reader :mode
|
|
30
|
+
|
|
31
|
+
sig { params(mode: DockerEngineAPI::Spec::Mode::OrHash).void }
|
|
32
|
+
attr_writer :mode
|
|
33
|
+
|
|
34
|
+
# Name of the service.
|
|
35
|
+
sig { returns(T.nilable(String)) }
|
|
36
|
+
attr_reader :name
|
|
37
|
+
|
|
38
|
+
sig { params(name: String).void }
|
|
39
|
+
attr_writer :name
|
|
40
|
+
|
|
41
|
+
# Specifies which networks the service should attach to.
|
|
42
|
+
#
|
|
43
|
+
# Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec
|
|
44
|
+
# should be used instead.
|
|
45
|
+
sig { returns(T.nilable(T::Array[DockerEngineAPI::Spec::Network])) }
|
|
46
|
+
attr_reader :networks
|
|
47
|
+
|
|
48
|
+
sig do
|
|
49
|
+
params(networks: T::Array[DockerEngineAPI::Spec::Network::OrHash]).void
|
|
50
|
+
end
|
|
51
|
+
attr_writer :networks
|
|
52
|
+
|
|
53
|
+
# Specification for the rollback strategy of the service.
|
|
54
|
+
sig { returns(T.nilable(DockerEngineAPI::Spec::RollbackConfig)) }
|
|
55
|
+
attr_reader :rollback_config
|
|
56
|
+
|
|
57
|
+
sig do
|
|
58
|
+
params(
|
|
59
|
+
rollback_config: DockerEngineAPI::Spec::RollbackConfig::OrHash
|
|
60
|
+
).void
|
|
61
|
+
end
|
|
62
|
+
attr_writer :rollback_config
|
|
63
|
+
|
|
64
|
+
# User modifiable task configuration.
|
|
65
|
+
sig { returns(T.nilable(DockerEngineAPI::Spec)) }
|
|
66
|
+
attr_reader :task_template
|
|
67
|
+
|
|
68
|
+
sig { params(task_template: DockerEngineAPI::Spec::OrHash).void }
|
|
69
|
+
attr_writer :task_template
|
|
70
|
+
|
|
71
|
+
# Specification for the update strategy of the service.
|
|
72
|
+
sig { returns(T.nilable(DockerEngineAPI::Spec::UpdateConfig)) }
|
|
73
|
+
attr_reader :update_config
|
|
74
|
+
|
|
75
|
+
sig do
|
|
76
|
+
params(update_config: DockerEngineAPI::Spec::UpdateConfig::OrHash).void
|
|
77
|
+
end
|
|
78
|
+
attr_writer :update_config
|
|
79
|
+
|
|
80
|
+
# User modifiable configuration for a service.
|
|
81
|
+
sig do
|
|
82
|
+
params(
|
|
83
|
+
endpoint_spec: DockerEngineAPI::Spec::EndpointSpec::OrHash,
|
|
84
|
+
labels: T::Hash[Symbol, String],
|
|
85
|
+
mode: DockerEngineAPI::Spec::Mode::OrHash,
|
|
86
|
+
name: String,
|
|
87
|
+
networks: T::Array[DockerEngineAPI::Spec::Network::OrHash],
|
|
88
|
+
rollback_config: DockerEngineAPI::Spec::RollbackConfig::OrHash,
|
|
89
|
+
task_template: DockerEngineAPI::Spec::OrHash,
|
|
90
|
+
update_config: DockerEngineAPI::Spec::UpdateConfig::OrHash
|
|
91
|
+
).returns(T.attached_class)
|
|
92
|
+
end
|
|
93
|
+
def self.new(
|
|
94
|
+
# Properties that can be configured to access and load balance a service.
|
|
95
|
+
endpoint_spec: nil,
|
|
96
|
+
# User-defined key/value metadata.
|
|
97
|
+
labels: nil,
|
|
98
|
+
# Scheduling mode for the service.
|
|
99
|
+
mode: nil,
|
|
100
|
+
# Name of the service.
|
|
101
|
+
name: nil,
|
|
102
|
+
# Specifies which networks the service should attach to.
|
|
103
|
+
#
|
|
104
|
+
# Deprecated: This field is deprecated since v1.44. The Networks field in TaskSpec
|
|
105
|
+
# should be used instead.
|
|
106
|
+
networks: nil,
|
|
107
|
+
# Specification for the rollback strategy of the service.
|
|
108
|
+
rollback_config: nil,
|
|
109
|
+
# User modifiable task configuration.
|
|
110
|
+
task_template: nil,
|
|
111
|
+
# Specification for the update strategy of the service.
|
|
112
|
+
update_config: nil
|
|
113
|
+
)
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
sig do
|
|
117
|
+
override.returns(
|
|
118
|
+
{
|
|
119
|
+
endpoint_spec: DockerEngineAPI::Spec::EndpointSpec,
|
|
120
|
+
labels: T::Hash[Symbol, String],
|
|
121
|
+
mode: DockerEngineAPI::Spec::Mode,
|
|
122
|
+
name: String,
|
|
123
|
+
networks: T::Array[DockerEngineAPI::Spec::Network],
|
|
124
|
+
rollback_config: DockerEngineAPI::Spec::RollbackConfig,
|
|
125
|
+
task_template: DockerEngineAPI::Spec,
|
|
126
|
+
update_config: DockerEngineAPI::Spec::UpdateConfig
|
|
127
|
+
}
|
|
128
|
+
)
|
|
129
|
+
end
|
|
130
|
+
def to_hash
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
class EndpointSpec < DockerEngineAPI::Internal::Type::BaseModel
|
|
134
|
+
OrHash =
|
|
135
|
+
T.type_alias do
|
|
136
|
+
T.any(
|
|
137
|
+
DockerEngineAPI::Spec::EndpointSpec,
|
|
138
|
+
DockerEngineAPI::Internal::AnyHash
|
|
139
|
+
)
|
|
140
|
+
end
|
|
141
|
+
|
|
142
|
+
# The mode of resolution to use for internal load balancing between tasks.
|
|
143
|
+
sig do
|
|
144
|
+
returns(
|
|
145
|
+
T.nilable(DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol)
|
|
146
|
+
)
|
|
147
|
+
end
|
|
148
|
+
attr_reader :mode
|
|
149
|
+
|
|
150
|
+
sig do
|
|
151
|
+
params(mode: DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol).void
|
|
152
|
+
end
|
|
153
|
+
attr_writer :mode
|
|
154
|
+
|
|
155
|
+
# List of exposed ports that this service is accessible on from the outside. Ports
|
|
156
|
+
# can only be provided if `vip` resolution mode is used.
|
|
157
|
+
sig do
|
|
158
|
+
returns(
|
|
159
|
+
T.nilable(T::Array[DockerEngineAPI::Spec::EndpointSpec::Port])
|
|
160
|
+
)
|
|
161
|
+
end
|
|
162
|
+
attr_reader :ports
|
|
163
|
+
|
|
164
|
+
sig do
|
|
165
|
+
params(
|
|
166
|
+
ports: T::Array[DockerEngineAPI::Spec::EndpointSpec::Port::OrHash]
|
|
167
|
+
).void
|
|
168
|
+
end
|
|
169
|
+
attr_writer :ports
|
|
170
|
+
|
|
171
|
+
# Properties that can be configured to access and load balance a service.
|
|
172
|
+
sig do
|
|
173
|
+
params(
|
|
174
|
+
mode: DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol,
|
|
175
|
+
ports: T::Array[DockerEngineAPI::Spec::EndpointSpec::Port::OrHash]
|
|
176
|
+
).returns(T.attached_class)
|
|
177
|
+
end
|
|
178
|
+
def self.new(
|
|
179
|
+
# The mode of resolution to use for internal load balancing between tasks.
|
|
180
|
+
mode: nil,
|
|
181
|
+
# List of exposed ports that this service is accessible on from the outside. Ports
|
|
182
|
+
# can only be provided if `vip` resolution mode is used.
|
|
183
|
+
ports: nil
|
|
184
|
+
)
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
sig do
|
|
188
|
+
override.returns(
|
|
189
|
+
{
|
|
190
|
+
mode: DockerEngineAPI::Spec::EndpointSpec::Mode::OrSymbol,
|
|
191
|
+
ports: T::Array[DockerEngineAPI::Spec::EndpointSpec::Port]
|
|
192
|
+
}
|
|
193
|
+
)
|
|
194
|
+
end
|
|
195
|
+
def to_hash
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# The mode of resolution to use for internal load balancing between tasks.
|
|
199
|
+
module Mode
|
|
200
|
+
extend DockerEngineAPI::Internal::Type::Enum
|
|
201
|
+
|
|
202
|
+
TaggedSymbol =
|
|
203
|
+
T.type_alias do
|
|
204
|
+
T.all(Symbol, DockerEngineAPI::Spec::EndpointSpec::Mode)
|
|
205
|
+
end
|
|
206
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
207
|
+
|
|
208
|
+
VIP =
|
|
209
|
+
T.let(:vip, DockerEngineAPI::Spec::EndpointSpec::Mode::TaggedSymbol)
|
|
210
|
+
DNSRR =
|
|
211
|
+
T.let(
|
|
212
|
+
:dnsrr,
|
|
213
|
+
DockerEngineAPI::Spec::EndpointSpec::Mode::TaggedSymbol
|
|
214
|
+
)
|
|
215
|
+
|
|
216
|
+
sig do
|
|
217
|
+
override.returns(
|
|
218
|
+
T::Array[DockerEngineAPI::Spec::EndpointSpec::Mode::TaggedSymbol]
|
|
219
|
+
)
|
|
220
|
+
end
|
|
221
|
+
def self.values
|
|
222
|
+
end
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
class Port < DockerEngineAPI::Internal::Type::BaseModel
|
|
226
|
+
OrHash =
|
|
227
|
+
T.type_alias do
|
|
228
|
+
T.any(
|
|
229
|
+
DockerEngineAPI::Spec::EndpointSpec::Port,
|
|
230
|
+
DockerEngineAPI::Internal::AnyHash
|
|
231
|
+
)
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
sig { returns(T.nilable(String)) }
|
|
235
|
+
attr_reader :name
|
|
236
|
+
|
|
237
|
+
sig { params(name: String).void }
|
|
238
|
+
attr_writer :name
|
|
239
|
+
|
|
240
|
+
sig do
|
|
241
|
+
returns(
|
|
242
|
+
T.nilable(
|
|
243
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol
|
|
244
|
+
)
|
|
245
|
+
)
|
|
246
|
+
end
|
|
247
|
+
attr_reader :protocol
|
|
248
|
+
|
|
249
|
+
sig do
|
|
250
|
+
params(
|
|
251
|
+
protocol:
|
|
252
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol
|
|
253
|
+
).void
|
|
254
|
+
end
|
|
255
|
+
attr_writer :protocol
|
|
256
|
+
|
|
257
|
+
# The port on the swarm hosts.
|
|
258
|
+
sig { returns(T.nilable(Integer)) }
|
|
259
|
+
attr_reader :published_port
|
|
260
|
+
|
|
261
|
+
sig { params(published_port: Integer).void }
|
|
262
|
+
attr_writer :published_port
|
|
263
|
+
|
|
264
|
+
# The mode in which port is published.
|
|
265
|
+
#
|
|
266
|
+
# <p><br /></p>
|
|
267
|
+
#
|
|
268
|
+
# - "ingress" makes the target port accessible on every node, regardless of
|
|
269
|
+
# whether there is a task for the service running on that node or not.
|
|
270
|
+
# - "host" bypasses the routing mesh and publish the port directly on the swarm
|
|
271
|
+
# node where that service is running.
|
|
272
|
+
sig do
|
|
273
|
+
returns(
|
|
274
|
+
T.nilable(
|
|
275
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol
|
|
276
|
+
)
|
|
277
|
+
)
|
|
278
|
+
end
|
|
279
|
+
attr_reader :publish_mode
|
|
280
|
+
|
|
281
|
+
sig do
|
|
282
|
+
params(
|
|
283
|
+
publish_mode:
|
|
284
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol
|
|
285
|
+
).void
|
|
286
|
+
end
|
|
287
|
+
attr_writer :publish_mode
|
|
288
|
+
|
|
289
|
+
# The port inside the container.
|
|
290
|
+
sig { returns(T.nilable(Integer)) }
|
|
291
|
+
attr_reader :target_port
|
|
292
|
+
|
|
293
|
+
sig { params(target_port: Integer).void }
|
|
294
|
+
attr_writer :target_port
|
|
295
|
+
|
|
296
|
+
sig do
|
|
297
|
+
params(
|
|
298
|
+
name: String,
|
|
299
|
+
protocol:
|
|
300
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol,
|
|
301
|
+
published_port: Integer,
|
|
302
|
+
publish_mode:
|
|
303
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol,
|
|
304
|
+
target_port: Integer
|
|
305
|
+
).returns(T.attached_class)
|
|
306
|
+
end
|
|
307
|
+
def self.new(
|
|
308
|
+
name: nil,
|
|
309
|
+
protocol: nil,
|
|
310
|
+
# The port on the swarm hosts.
|
|
311
|
+
published_port: nil,
|
|
312
|
+
# The mode in which port is published.
|
|
313
|
+
#
|
|
314
|
+
# <p><br /></p>
|
|
315
|
+
#
|
|
316
|
+
# - "ingress" makes the target port accessible on every node, regardless of
|
|
317
|
+
# whether there is a task for the service running on that node or not.
|
|
318
|
+
# - "host" bypasses the routing mesh and publish the port directly on the swarm
|
|
319
|
+
# node where that service is running.
|
|
320
|
+
publish_mode: nil,
|
|
321
|
+
# The port inside the container.
|
|
322
|
+
target_port: nil
|
|
323
|
+
)
|
|
324
|
+
end
|
|
325
|
+
|
|
326
|
+
sig do
|
|
327
|
+
override.returns(
|
|
328
|
+
{
|
|
329
|
+
name: String,
|
|
330
|
+
protocol:
|
|
331
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::OrSymbol,
|
|
332
|
+
published_port: Integer,
|
|
333
|
+
publish_mode:
|
|
334
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::OrSymbol,
|
|
335
|
+
target_port: Integer
|
|
336
|
+
}
|
|
337
|
+
)
|
|
338
|
+
end
|
|
339
|
+
def to_hash
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
module Protocol
|
|
343
|
+
extend DockerEngineAPI::Internal::Type::Enum
|
|
344
|
+
|
|
345
|
+
TaggedSymbol =
|
|
346
|
+
T.type_alias do
|
|
347
|
+
T.all(
|
|
348
|
+
Symbol,
|
|
349
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol
|
|
350
|
+
)
|
|
351
|
+
end
|
|
352
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
353
|
+
|
|
354
|
+
TCP =
|
|
355
|
+
T.let(
|
|
356
|
+
:tcp,
|
|
357
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
|
|
358
|
+
)
|
|
359
|
+
UDP =
|
|
360
|
+
T.let(
|
|
361
|
+
:udp,
|
|
362
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
|
|
363
|
+
)
|
|
364
|
+
SCTP =
|
|
365
|
+
T.let(
|
|
366
|
+
:sctp,
|
|
367
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
|
|
368
|
+
)
|
|
369
|
+
|
|
370
|
+
sig do
|
|
371
|
+
override.returns(
|
|
372
|
+
T::Array[
|
|
373
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::Protocol::TaggedSymbol
|
|
374
|
+
]
|
|
375
|
+
)
|
|
376
|
+
end
|
|
377
|
+
def self.values
|
|
378
|
+
end
|
|
379
|
+
end
|
|
380
|
+
|
|
381
|
+
# The mode in which port is published.
|
|
382
|
+
#
|
|
383
|
+
# <p><br /></p>
|
|
384
|
+
#
|
|
385
|
+
# - "ingress" makes the target port accessible on every node, regardless of
|
|
386
|
+
# whether there is a task for the service running on that node or not.
|
|
387
|
+
# - "host" bypasses the routing mesh and publish the port directly on the swarm
|
|
388
|
+
# node where that service is running.
|
|
389
|
+
module PublishMode
|
|
390
|
+
extend DockerEngineAPI::Internal::Type::Enum
|
|
391
|
+
|
|
392
|
+
TaggedSymbol =
|
|
393
|
+
T.type_alias do
|
|
394
|
+
T.all(
|
|
395
|
+
Symbol,
|
|
396
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode
|
|
397
|
+
)
|
|
398
|
+
end
|
|
399
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
400
|
+
|
|
401
|
+
INGRESS =
|
|
402
|
+
T.let(
|
|
403
|
+
:ingress,
|
|
404
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::TaggedSymbol
|
|
405
|
+
)
|
|
406
|
+
HOST =
|
|
407
|
+
T.let(
|
|
408
|
+
:host,
|
|
409
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::TaggedSymbol
|
|
410
|
+
)
|
|
411
|
+
|
|
412
|
+
sig do
|
|
413
|
+
override.returns(
|
|
414
|
+
T::Array[
|
|
415
|
+
DockerEngineAPI::Spec::EndpointSpec::Port::PublishMode::TaggedSymbol
|
|
416
|
+
]
|
|
417
|
+
)
|
|
418
|
+
end
|
|
419
|
+
def self.values
|
|
420
|
+
end
|
|
421
|
+
end
|
|
422
|
+
end
|
|
423
|
+
end
|
|
424
|
+
|
|
425
|
+
class Mode < DockerEngineAPI::Internal::Type::BaseModel
|
|
426
|
+
OrHash =
|
|
427
|
+
T.type_alias do
|
|
428
|
+
T.any(
|
|
429
|
+
DockerEngineAPI::Spec::Mode,
|
|
430
|
+
DockerEngineAPI::Internal::AnyHash
|
|
431
|
+
)
|
|
432
|
+
end
|
|
433
|
+
|
|
434
|
+
sig { returns(T.nilable(T.anything)) }
|
|
435
|
+
attr_reader :global
|
|
436
|
+
|
|
437
|
+
sig { params(global: T.anything).void }
|
|
438
|
+
attr_writer :global
|
|
439
|
+
|
|
440
|
+
# The mode used for services which run a task to the completed state on each valid
|
|
441
|
+
# node.
|
|
442
|
+
sig { returns(T.nilable(T.anything)) }
|
|
443
|
+
attr_reader :global_job
|
|
444
|
+
|
|
445
|
+
sig { params(global_job: T.anything).void }
|
|
446
|
+
attr_writer :global_job
|
|
447
|
+
|
|
448
|
+
sig { returns(T.nilable(DockerEngineAPI::Spec::Mode::Replicated)) }
|
|
449
|
+
attr_reader :replicated
|
|
450
|
+
|
|
451
|
+
sig do
|
|
452
|
+
params(
|
|
453
|
+
replicated: DockerEngineAPI::Spec::Mode::Replicated::OrHash
|
|
454
|
+
).void
|
|
455
|
+
end
|
|
456
|
+
attr_writer :replicated
|
|
457
|
+
|
|
458
|
+
# The mode used for services with a finite number of tasks that run to a completed
|
|
459
|
+
# state.
|
|
460
|
+
sig { returns(T.nilable(DockerEngineAPI::Spec::Mode::ReplicatedJob)) }
|
|
461
|
+
attr_reader :replicated_job
|
|
462
|
+
|
|
463
|
+
sig do
|
|
464
|
+
params(
|
|
465
|
+
replicated_job: DockerEngineAPI::Spec::Mode::ReplicatedJob::OrHash
|
|
466
|
+
).void
|
|
467
|
+
end
|
|
468
|
+
attr_writer :replicated_job
|
|
469
|
+
|
|
470
|
+
# Scheduling mode for the service.
|
|
471
|
+
sig do
|
|
472
|
+
params(
|
|
473
|
+
global: T.anything,
|
|
474
|
+
global_job: T.anything,
|
|
475
|
+
replicated: DockerEngineAPI::Spec::Mode::Replicated::OrHash,
|
|
476
|
+
replicated_job: DockerEngineAPI::Spec::Mode::ReplicatedJob::OrHash
|
|
477
|
+
).returns(T.attached_class)
|
|
478
|
+
end
|
|
479
|
+
def self.new(
|
|
480
|
+
global: nil,
|
|
481
|
+
# The mode used for services which run a task to the completed state on each valid
|
|
482
|
+
# node.
|
|
483
|
+
global_job: nil,
|
|
484
|
+
replicated: nil,
|
|
485
|
+
# The mode used for services with a finite number of tasks that run to a completed
|
|
486
|
+
# state.
|
|
487
|
+
replicated_job: nil
|
|
488
|
+
)
|
|
489
|
+
end
|
|
490
|
+
|
|
491
|
+
sig do
|
|
492
|
+
override.returns(
|
|
493
|
+
{
|
|
494
|
+
global: T.anything,
|
|
495
|
+
global_job: T.anything,
|
|
496
|
+
replicated: DockerEngineAPI::Spec::Mode::Replicated,
|
|
497
|
+
replicated_job: DockerEngineAPI::Spec::Mode::ReplicatedJob
|
|
498
|
+
}
|
|
499
|
+
)
|
|
500
|
+
end
|
|
501
|
+
def to_hash
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
class Replicated < DockerEngineAPI::Internal::Type::BaseModel
|
|
505
|
+
OrHash =
|
|
506
|
+
T.type_alias do
|
|
507
|
+
T.any(
|
|
508
|
+
DockerEngineAPI::Spec::Mode::Replicated,
|
|
509
|
+
DockerEngineAPI::Internal::AnyHash
|
|
510
|
+
)
|
|
511
|
+
end
|
|
512
|
+
|
|
513
|
+
sig { returns(T.nilable(Integer)) }
|
|
514
|
+
attr_reader :replicas
|
|
515
|
+
|
|
516
|
+
sig { params(replicas: Integer).void }
|
|
517
|
+
attr_writer :replicas
|
|
518
|
+
|
|
519
|
+
sig { params(replicas: Integer).returns(T.attached_class) }
|
|
520
|
+
def self.new(replicas: nil)
|
|
521
|
+
end
|
|
522
|
+
|
|
523
|
+
sig { override.returns({ replicas: Integer }) }
|
|
524
|
+
def to_hash
|
|
525
|
+
end
|
|
526
|
+
end
|
|
527
|
+
|
|
528
|
+
class ReplicatedJob < DockerEngineAPI::Internal::Type::BaseModel
|
|
529
|
+
OrHash =
|
|
530
|
+
T.type_alias do
|
|
531
|
+
T.any(
|
|
532
|
+
DockerEngineAPI::Spec::Mode::ReplicatedJob,
|
|
533
|
+
DockerEngineAPI::Internal::AnyHash
|
|
534
|
+
)
|
|
535
|
+
end
|
|
536
|
+
|
|
537
|
+
# The maximum number of replicas to run simultaneously.
|
|
538
|
+
sig { returns(T.nilable(Integer)) }
|
|
539
|
+
attr_reader :max_concurrent
|
|
540
|
+
|
|
541
|
+
sig { params(max_concurrent: Integer).void }
|
|
542
|
+
attr_writer :max_concurrent
|
|
543
|
+
|
|
544
|
+
# The total number of replicas desired to reach the Completed state. If unset,
|
|
545
|
+
# will default to the value of `MaxConcurrent`
|
|
546
|
+
sig { returns(T.nilable(Integer)) }
|
|
547
|
+
attr_reader :total_completions
|
|
548
|
+
|
|
549
|
+
sig { params(total_completions: Integer).void }
|
|
550
|
+
attr_writer :total_completions
|
|
551
|
+
|
|
552
|
+
# The mode used for services with a finite number of tasks that run to a completed
|
|
553
|
+
# state.
|
|
554
|
+
sig do
|
|
555
|
+
params(max_concurrent: Integer, total_completions: Integer).returns(
|
|
556
|
+
T.attached_class
|
|
557
|
+
)
|
|
558
|
+
end
|
|
559
|
+
def self.new(
|
|
560
|
+
# The maximum number of replicas to run simultaneously.
|
|
561
|
+
max_concurrent: nil,
|
|
562
|
+
# The total number of replicas desired to reach the Completed state. If unset,
|
|
563
|
+
# will default to the value of `MaxConcurrent`
|
|
564
|
+
total_completions: nil
|
|
565
|
+
)
|
|
566
|
+
end
|
|
567
|
+
|
|
568
|
+
sig do
|
|
569
|
+
override.returns(
|
|
570
|
+
{ max_concurrent: Integer, total_completions: Integer }
|
|
571
|
+
)
|
|
572
|
+
end
|
|
573
|
+
def to_hash
|
|
574
|
+
end
|
|
575
|
+
end
|
|
576
|
+
end
|
|
577
|
+
|
|
578
|
+
class Network < DockerEngineAPI::Internal::Type::BaseModel
|
|
579
|
+
OrHash =
|
|
580
|
+
T.type_alias do
|
|
581
|
+
T.any(
|
|
582
|
+
DockerEngineAPI::Spec::Network,
|
|
583
|
+
DockerEngineAPI::Internal::AnyHash
|
|
584
|
+
)
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
# Discoverable alternate names for the service on this network.
|
|
588
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
589
|
+
attr_reader :aliases
|
|
590
|
+
|
|
591
|
+
sig { params(aliases: T::Array[String]).void }
|
|
592
|
+
attr_writer :aliases
|
|
593
|
+
|
|
594
|
+
# Driver attachment options for the network target.
|
|
595
|
+
sig { returns(T.nilable(T::Hash[Symbol, String])) }
|
|
596
|
+
attr_reader :driver_opts
|
|
597
|
+
|
|
598
|
+
sig { params(driver_opts: T::Hash[Symbol, String]).void }
|
|
599
|
+
attr_writer :driver_opts
|
|
600
|
+
|
|
601
|
+
# The target network for attachment. Must be a network name or ID.
|
|
602
|
+
sig { returns(T.nilable(String)) }
|
|
603
|
+
attr_reader :target
|
|
604
|
+
|
|
605
|
+
sig { params(target: String).void }
|
|
606
|
+
attr_writer :target
|
|
607
|
+
|
|
608
|
+
# Specifies how a service should be attached to a particular network.
|
|
609
|
+
sig do
|
|
610
|
+
params(
|
|
611
|
+
aliases: T::Array[String],
|
|
612
|
+
driver_opts: T::Hash[Symbol, String],
|
|
613
|
+
target: String
|
|
614
|
+
).returns(T.attached_class)
|
|
615
|
+
end
|
|
616
|
+
def self.new(
|
|
617
|
+
# Discoverable alternate names for the service on this network.
|
|
618
|
+
aliases: nil,
|
|
619
|
+
# Driver attachment options for the network target.
|
|
620
|
+
driver_opts: nil,
|
|
621
|
+
# The target network for attachment. Must be a network name or ID.
|
|
622
|
+
target: nil
|
|
623
|
+
)
|
|
624
|
+
end
|
|
625
|
+
|
|
626
|
+
sig do
|
|
627
|
+
override.returns(
|
|
628
|
+
{
|
|
629
|
+
aliases: T::Array[String],
|
|
630
|
+
driver_opts: T::Hash[Symbol, String],
|
|
631
|
+
target: String
|
|
632
|
+
}
|
|
633
|
+
)
|
|
634
|
+
end
|
|
635
|
+
def to_hash
|
|
636
|
+
end
|
|
637
|
+
end
|
|
638
|
+
|
|
639
|
+
class RollbackConfig < DockerEngineAPI::Internal::Type::BaseModel
|
|
640
|
+
OrHash =
|
|
641
|
+
T.type_alias do
|
|
642
|
+
T.any(
|
|
643
|
+
DockerEngineAPI::Spec::RollbackConfig,
|
|
644
|
+
DockerEngineAPI::Internal::AnyHash
|
|
645
|
+
)
|
|
646
|
+
end
|
|
647
|
+
|
|
648
|
+
# Amount of time between rollback iterations, in nanoseconds.
|
|
649
|
+
sig { returns(T.nilable(Integer)) }
|
|
650
|
+
attr_reader :delay
|
|
651
|
+
|
|
652
|
+
sig { params(delay: Integer).void }
|
|
653
|
+
attr_writer :delay
|
|
654
|
+
|
|
655
|
+
# Action to take if an rolled back task fails to run, or stops running during the
|
|
656
|
+
# rollback.
|
|
657
|
+
sig do
|
|
658
|
+
returns(
|
|
659
|
+
T.nilable(
|
|
660
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol
|
|
661
|
+
)
|
|
662
|
+
)
|
|
663
|
+
end
|
|
664
|
+
attr_reader :failure_action
|
|
665
|
+
|
|
666
|
+
sig do
|
|
667
|
+
params(
|
|
668
|
+
failure_action:
|
|
669
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol
|
|
670
|
+
).void
|
|
671
|
+
end
|
|
672
|
+
attr_writer :failure_action
|
|
673
|
+
|
|
674
|
+
# The fraction of tasks that may fail during a rollback before the failure action
|
|
675
|
+
# is invoked, specified as a floating point number between 0 and 1.
|
|
676
|
+
sig { returns(T.nilable(Float)) }
|
|
677
|
+
attr_reader :max_failure_ratio
|
|
678
|
+
|
|
679
|
+
sig { params(max_failure_ratio: Float).void }
|
|
680
|
+
attr_writer :max_failure_ratio
|
|
681
|
+
|
|
682
|
+
# Amount of time to monitor each rolled back task for failures, in nanoseconds.
|
|
683
|
+
sig { returns(T.nilable(Integer)) }
|
|
684
|
+
attr_reader :monitor
|
|
685
|
+
|
|
686
|
+
sig { params(monitor: Integer).void }
|
|
687
|
+
attr_writer :monitor
|
|
688
|
+
|
|
689
|
+
# The order of operations when rolling back a task. Either the old task is shut
|
|
690
|
+
# down before the new task is started, or the new task is started before the old
|
|
691
|
+
# task is shut down.
|
|
692
|
+
sig do
|
|
693
|
+
returns(
|
|
694
|
+
T.nilable(DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol)
|
|
695
|
+
)
|
|
696
|
+
end
|
|
697
|
+
attr_reader :order
|
|
698
|
+
|
|
699
|
+
sig do
|
|
700
|
+
params(
|
|
701
|
+
order: DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol
|
|
702
|
+
).void
|
|
703
|
+
end
|
|
704
|
+
attr_writer :order
|
|
705
|
+
|
|
706
|
+
# Maximum number of tasks to be rolled back in one iteration (0 means unlimited
|
|
707
|
+
# parallelism).
|
|
708
|
+
sig { returns(T.nilable(Integer)) }
|
|
709
|
+
attr_reader :parallelism
|
|
710
|
+
|
|
711
|
+
sig { params(parallelism: Integer).void }
|
|
712
|
+
attr_writer :parallelism
|
|
713
|
+
|
|
714
|
+
# Specification for the rollback strategy of the service.
|
|
715
|
+
sig do
|
|
716
|
+
params(
|
|
717
|
+
delay: Integer,
|
|
718
|
+
failure_action:
|
|
719
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol,
|
|
720
|
+
max_failure_ratio: Float,
|
|
721
|
+
monitor: Integer,
|
|
722
|
+
order: DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol,
|
|
723
|
+
parallelism: Integer
|
|
724
|
+
).returns(T.attached_class)
|
|
725
|
+
end
|
|
726
|
+
def self.new(
|
|
727
|
+
# Amount of time between rollback iterations, in nanoseconds.
|
|
728
|
+
delay: nil,
|
|
729
|
+
# Action to take if an rolled back task fails to run, or stops running during the
|
|
730
|
+
# rollback.
|
|
731
|
+
failure_action: nil,
|
|
732
|
+
# The fraction of tasks that may fail during a rollback before the failure action
|
|
733
|
+
# is invoked, specified as a floating point number between 0 and 1.
|
|
734
|
+
max_failure_ratio: nil,
|
|
735
|
+
# Amount of time to monitor each rolled back task for failures, in nanoseconds.
|
|
736
|
+
monitor: nil,
|
|
737
|
+
# The order of operations when rolling back a task. Either the old task is shut
|
|
738
|
+
# down before the new task is started, or the new task is started before the old
|
|
739
|
+
# task is shut down.
|
|
740
|
+
order: nil,
|
|
741
|
+
# Maximum number of tasks to be rolled back in one iteration (0 means unlimited
|
|
742
|
+
# parallelism).
|
|
743
|
+
parallelism: nil
|
|
744
|
+
)
|
|
745
|
+
end
|
|
746
|
+
|
|
747
|
+
sig do
|
|
748
|
+
override.returns(
|
|
749
|
+
{
|
|
750
|
+
delay: Integer,
|
|
751
|
+
failure_action:
|
|
752
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction::OrSymbol,
|
|
753
|
+
max_failure_ratio: Float,
|
|
754
|
+
monitor: Integer,
|
|
755
|
+
order: DockerEngineAPI::Spec::RollbackConfig::Order::OrSymbol,
|
|
756
|
+
parallelism: Integer
|
|
757
|
+
}
|
|
758
|
+
)
|
|
759
|
+
end
|
|
760
|
+
def to_hash
|
|
761
|
+
end
|
|
762
|
+
|
|
763
|
+
# Action to take if an rolled back task fails to run, or stops running during the
|
|
764
|
+
# rollback.
|
|
765
|
+
module FailureAction
|
|
766
|
+
extend DockerEngineAPI::Internal::Type::Enum
|
|
767
|
+
|
|
768
|
+
TaggedSymbol =
|
|
769
|
+
T.type_alias do
|
|
770
|
+
T.all(
|
|
771
|
+
Symbol,
|
|
772
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction
|
|
773
|
+
)
|
|
774
|
+
end
|
|
775
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
776
|
+
|
|
777
|
+
CONTINUE =
|
|
778
|
+
T.let(
|
|
779
|
+
:continue,
|
|
780
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction::TaggedSymbol
|
|
781
|
+
)
|
|
782
|
+
PAUSE =
|
|
783
|
+
T.let(
|
|
784
|
+
:pause,
|
|
785
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction::TaggedSymbol
|
|
786
|
+
)
|
|
787
|
+
|
|
788
|
+
sig do
|
|
789
|
+
override.returns(
|
|
790
|
+
T::Array[
|
|
791
|
+
DockerEngineAPI::Spec::RollbackConfig::FailureAction::TaggedSymbol
|
|
792
|
+
]
|
|
793
|
+
)
|
|
794
|
+
end
|
|
795
|
+
def self.values
|
|
796
|
+
end
|
|
797
|
+
end
|
|
798
|
+
|
|
799
|
+
# The order of operations when rolling back a task. Either the old task is shut
|
|
800
|
+
# down before the new task is started, or the new task is started before the old
|
|
801
|
+
# task is shut down.
|
|
802
|
+
module Order
|
|
803
|
+
extend DockerEngineAPI::Internal::Type::Enum
|
|
804
|
+
|
|
805
|
+
TaggedSymbol =
|
|
806
|
+
T.type_alias do
|
|
807
|
+
T.all(Symbol, DockerEngineAPI::Spec::RollbackConfig::Order)
|
|
808
|
+
end
|
|
809
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
810
|
+
|
|
811
|
+
STOP_FIRST =
|
|
812
|
+
T.let(
|
|
813
|
+
:"stop-first",
|
|
814
|
+
DockerEngineAPI::Spec::RollbackConfig::Order::TaggedSymbol
|
|
815
|
+
)
|
|
816
|
+
START_FIRST =
|
|
817
|
+
T.let(
|
|
818
|
+
:"start-first",
|
|
819
|
+
DockerEngineAPI::Spec::RollbackConfig::Order::TaggedSymbol
|
|
820
|
+
)
|
|
821
|
+
|
|
822
|
+
sig do
|
|
823
|
+
override.returns(
|
|
824
|
+
T::Array[
|
|
825
|
+
DockerEngineAPI::Spec::RollbackConfig::Order::TaggedSymbol
|
|
826
|
+
]
|
|
827
|
+
)
|
|
828
|
+
end
|
|
829
|
+
def self.values
|
|
830
|
+
end
|
|
831
|
+
end
|
|
832
|
+
end
|
|
833
|
+
|
|
834
|
+
class UpdateConfig < DockerEngineAPI::Internal::Type::BaseModel
|
|
835
|
+
OrHash =
|
|
836
|
+
T.type_alias do
|
|
837
|
+
T.any(
|
|
838
|
+
DockerEngineAPI::Spec::UpdateConfig,
|
|
839
|
+
DockerEngineAPI::Internal::AnyHash
|
|
840
|
+
)
|
|
841
|
+
end
|
|
842
|
+
|
|
843
|
+
# Amount of time between updates, in nanoseconds.
|
|
844
|
+
sig { returns(T.nilable(Integer)) }
|
|
845
|
+
attr_reader :delay
|
|
846
|
+
|
|
847
|
+
sig { params(delay: Integer).void }
|
|
848
|
+
attr_writer :delay
|
|
849
|
+
|
|
850
|
+
# Action to take if an updated task fails to run, or stops running during the
|
|
851
|
+
# update.
|
|
852
|
+
sig do
|
|
853
|
+
returns(
|
|
854
|
+
T.nilable(
|
|
855
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol
|
|
856
|
+
)
|
|
857
|
+
)
|
|
858
|
+
end
|
|
859
|
+
attr_reader :failure_action
|
|
860
|
+
|
|
861
|
+
sig do
|
|
862
|
+
params(
|
|
863
|
+
failure_action:
|
|
864
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol
|
|
865
|
+
).void
|
|
866
|
+
end
|
|
867
|
+
attr_writer :failure_action
|
|
868
|
+
|
|
869
|
+
# The fraction of tasks that may fail during an update before the failure action
|
|
870
|
+
# is invoked, specified as a floating point number between 0 and 1.
|
|
871
|
+
sig { returns(T.nilable(Float)) }
|
|
872
|
+
attr_reader :max_failure_ratio
|
|
873
|
+
|
|
874
|
+
sig { params(max_failure_ratio: Float).void }
|
|
875
|
+
attr_writer :max_failure_ratio
|
|
876
|
+
|
|
877
|
+
# Amount of time to monitor each updated task for failures, in nanoseconds.
|
|
878
|
+
sig { returns(T.nilable(Integer)) }
|
|
879
|
+
attr_reader :monitor
|
|
880
|
+
|
|
881
|
+
sig { params(monitor: Integer).void }
|
|
882
|
+
attr_writer :monitor
|
|
883
|
+
|
|
884
|
+
# The order of operations when rolling out an updated task. Either the old task is
|
|
885
|
+
# shut down before the new task is started, or the new task is started before the
|
|
886
|
+
# old task is shut down.
|
|
887
|
+
sig do
|
|
888
|
+
returns(
|
|
889
|
+
T.nilable(DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol)
|
|
890
|
+
)
|
|
891
|
+
end
|
|
892
|
+
attr_reader :order
|
|
893
|
+
|
|
894
|
+
sig do
|
|
895
|
+
params(
|
|
896
|
+
order: DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol
|
|
897
|
+
).void
|
|
898
|
+
end
|
|
899
|
+
attr_writer :order
|
|
900
|
+
|
|
901
|
+
# Maximum number of tasks to be updated in one iteration (0 means unlimited
|
|
902
|
+
# parallelism).
|
|
903
|
+
sig { returns(T.nilable(Integer)) }
|
|
904
|
+
attr_reader :parallelism
|
|
905
|
+
|
|
906
|
+
sig { params(parallelism: Integer).void }
|
|
907
|
+
attr_writer :parallelism
|
|
908
|
+
|
|
909
|
+
# Specification for the update strategy of the service.
|
|
910
|
+
sig do
|
|
911
|
+
params(
|
|
912
|
+
delay: Integer,
|
|
913
|
+
failure_action:
|
|
914
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol,
|
|
915
|
+
max_failure_ratio: Float,
|
|
916
|
+
monitor: Integer,
|
|
917
|
+
order: DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol,
|
|
918
|
+
parallelism: Integer
|
|
919
|
+
).returns(T.attached_class)
|
|
920
|
+
end
|
|
921
|
+
def self.new(
|
|
922
|
+
# Amount of time between updates, in nanoseconds.
|
|
923
|
+
delay: nil,
|
|
924
|
+
# Action to take if an updated task fails to run, or stops running during the
|
|
925
|
+
# update.
|
|
926
|
+
failure_action: nil,
|
|
927
|
+
# The fraction of tasks that may fail during an update before the failure action
|
|
928
|
+
# is invoked, specified as a floating point number between 0 and 1.
|
|
929
|
+
max_failure_ratio: nil,
|
|
930
|
+
# Amount of time to monitor each updated task for failures, in nanoseconds.
|
|
931
|
+
monitor: nil,
|
|
932
|
+
# The order of operations when rolling out an updated task. Either the old task is
|
|
933
|
+
# shut down before the new task is started, or the new task is started before the
|
|
934
|
+
# old task is shut down.
|
|
935
|
+
order: nil,
|
|
936
|
+
# Maximum number of tasks to be updated in one iteration (0 means unlimited
|
|
937
|
+
# parallelism).
|
|
938
|
+
parallelism: nil
|
|
939
|
+
)
|
|
940
|
+
end
|
|
941
|
+
|
|
942
|
+
sig do
|
|
943
|
+
override.returns(
|
|
944
|
+
{
|
|
945
|
+
delay: Integer,
|
|
946
|
+
failure_action:
|
|
947
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::OrSymbol,
|
|
948
|
+
max_failure_ratio: Float,
|
|
949
|
+
monitor: Integer,
|
|
950
|
+
order: DockerEngineAPI::Spec::UpdateConfig::Order::OrSymbol,
|
|
951
|
+
parallelism: Integer
|
|
952
|
+
}
|
|
953
|
+
)
|
|
954
|
+
end
|
|
955
|
+
def to_hash
|
|
956
|
+
end
|
|
957
|
+
|
|
958
|
+
# Action to take if an updated task fails to run, or stops running during the
|
|
959
|
+
# update.
|
|
960
|
+
module FailureAction
|
|
961
|
+
extend DockerEngineAPI::Internal::Type::Enum
|
|
962
|
+
|
|
963
|
+
TaggedSymbol =
|
|
964
|
+
T.type_alias do
|
|
965
|
+
T.all(Symbol, DockerEngineAPI::Spec::UpdateConfig::FailureAction)
|
|
966
|
+
end
|
|
967
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
968
|
+
|
|
969
|
+
CONTINUE =
|
|
970
|
+
T.let(
|
|
971
|
+
:continue,
|
|
972
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
|
|
973
|
+
)
|
|
974
|
+
PAUSE =
|
|
975
|
+
T.let(
|
|
976
|
+
:pause,
|
|
977
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
|
|
978
|
+
)
|
|
979
|
+
ROLLBACK =
|
|
980
|
+
T.let(
|
|
981
|
+
:rollback,
|
|
982
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
|
|
983
|
+
)
|
|
984
|
+
|
|
985
|
+
sig do
|
|
986
|
+
override.returns(
|
|
987
|
+
T::Array[
|
|
988
|
+
DockerEngineAPI::Spec::UpdateConfig::FailureAction::TaggedSymbol
|
|
989
|
+
]
|
|
990
|
+
)
|
|
991
|
+
end
|
|
992
|
+
def self.values
|
|
993
|
+
end
|
|
994
|
+
end
|
|
995
|
+
|
|
996
|
+
# The order of operations when rolling out an updated task. Either the old task is
|
|
997
|
+
# shut down before the new task is started, or the new task is started before the
|
|
998
|
+
# old task is shut down.
|
|
999
|
+
module Order
|
|
1000
|
+
extend DockerEngineAPI::Internal::Type::Enum
|
|
1001
|
+
|
|
1002
|
+
TaggedSymbol =
|
|
1003
|
+
T.type_alias do
|
|
1004
|
+
T.all(Symbol, DockerEngineAPI::Spec::UpdateConfig::Order)
|
|
1005
|
+
end
|
|
1006
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
1007
|
+
|
|
1008
|
+
STOP_FIRST =
|
|
1009
|
+
T.let(
|
|
1010
|
+
:"stop-first",
|
|
1011
|
+
DockerEngineAPI::Spec::UpdateConfig::Order::TaggedSymbol
|
|
1012
|
+
)
|
|
1013
|
+
START_FIRST =
|
|
1014
|
+
T.let(
|
|
1015
|
+
:"start-first",
|
|
1016
|
+
DockerEngineAPI::Spec::UpdateConfig::Order::TaggedSymbol
|
|
1017
|
+
)
|
|
1018
|
+
|
|
1019
|
+
sig do
|
|
1020
|
+
override.returns(
|
|
1021
|
+
T::Array[DockerEngineAPI::Spec::UpdateConfig::Order::TaggedSymbol]
|
|
1022
|
+
)
|
|
1023
|
+
end
|
|
1024
|
+
def self.values
|
|
1025
|
+
end
|
|
1026
|
+
end
|
|
1027
|
+
end
|
|
1028
|
+
end
|
|
1029
|
+
end
|
|
1030
|
+
end
|