docker-engine-api 0.2.1

data/lib/docker_engine_api/resources/networks.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Networks
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::NetworkCreateParams} for more details.
+      #
+      # Create a network
+      #
+      # @overload create(name:, attachable: nil, config_from: nil, config_only: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, options: nil, scope: nil, request_options: {})
+      #
+      # @param name [String] The network's name.
+      #
+      # @param attachable [Boolean] Globally scoped network is manually attachable by regular
+      #
+      # @param config_from [DockerEngineAPI::Models::NetworkCreateParams::ConfigFrom] The config-only network source to provide the configuration for
+      #
+      # @param config_only [Boolean] Creates a config-only network. Config-only networks are placeholder
+      #
+      # @param driver [String] Name of the network driver plugin to use.
+      #
+      # @param enable_i_pv4 [Boolean] Enable IPv4 on the network.
+      #
+      # @param enable_i_pv6 [Boolean] Enable IPv6 on the network.
+      #
+      # @param ingress [Boolean] Ingress network is the network which provides the routing-mesh
+      #
+      # @param internal [Boolean] Restrict external access to the network.
+      #
+      # @param ipam [DockerEngineAPI::Models::NetworkCreateParams::Ipam]
+      #
+      # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      # @param options [Hash{Symbol=>String}] Network specific options to be used by the drivers.
+      #
+      # @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::CreateResponse]
+      #
+      # @see DockerEngineAPI::Models::NetworkCreateParams
+      def create(params)
+        parsed, options = DockerEngineAPI::NetworkCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "networks/create",
+          body: parsed,
+          model: DockerEngineAPI::CreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::NetworkListParams} for more details.
+      #
+      # Returns a list of networks. For details on the format, see the
+      # [network inspect endpoint](#operation/NetworkInspect).
+      #
+      # Note that it uses a different, smaller representation of a network than
+      # inspecting a single network. For example, the list of containers attached to the
+      # network is not propagated in API versions 1.28 and up.
+      #
+      # @overload list(filters: nil, request_options: {})
+      #
+      # @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to process
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngineAPI::Models::Summary>]
+      #
+      # @see DockerEngineAPI::Models::NetworkListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::NetworkListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "networks",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Summary],
+          options: options
+        )
+      end
+
+      # Remove a network
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Network ID or name
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::NetworkDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["networks/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # The network must be either a local-scoped network or a swarm-scoped network with
+      # the `attachable` option set. A network cannot be re-attached to a running
+      # container
+      #
+      # @overload connect(id, container:, endpoint_config: nil, request_options: {})
+      #
+      # @param id [String] Network ID or name
+      #
+      # @param container [String] The ID or name of the container to connect to the network.
+      #
+      # @param endpoint_config [DockerEngineAPI::Models::ConnectRequest::EndpointConfig] Configuration for a network endpoint.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::NetworkConnectParams
+      def connect(id, params)
+        parsed, options = DockerEngineAPI::NetworkConnectParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["networks/%1$s/connect", id],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Disconnect a container from a network
+      #
+      # @overload disconnect(id, container:, force: nil, request_options: {})
+      #
+      # @param id [String] Network ID or name
+      #
+      # @param container [String] The ID or name of the container to disconnect from the network.
+      #
+      # @param force [Boolean] Force the container to disconnect from the network.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::NetworkDisconnectParams
+      def disconnect(id, params)
+        parsed, options = DockerEngineAPI::NetworkDisconnectParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["networks/%1$s/disconnect", id],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Inspect a network
+      #
+      # @overload inspect_(id, scope: nil, verbose: nil, request_options: {})
+      #
+      # @param id [String] Network ID or name
+      #
+      # @param scope [String] Filter the network by scope (swarm, global, or local)
+      #
+      # @param verbose [Boolean] Detailed inspect output for troubleshooting
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::NetworkInspectResponse]
+      #
+      # @see DockerEngineAPI::Models::NetworkInspectParams
+      def inspect_(id, params = {})
+        parsed, options = DockerEngineAPI::NetworkInspectParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["networks/%1$s", id],
+          query: parsed,
+          model: DockerEngineAPI::Models::NetworkInspectResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::NetworkPruneParams} for more details.
+      #
+      # Delete unused networks
+      #
+      # @overload prune(filters: nil, request_options: {})
+      #
+      # @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::NetworkPruneResponse]
+      #
+      # @see DockerEngineAPI::Models::NetworkPruneParams
+      def prune(params = {})
+        parsed, options = DockerEngineAPI::NetworkPruneParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "networks/prune",
+          query: parsed,
+          model: DockerEngineAPI::Models::NetworkPruneResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine_api/resources/nodes.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Nodes
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::NodeUpdateParams} for more details.
+      #
+      # Update a node
+      #
+      # @overload update(id, version:, spec: nil, request_options: {})
+      #
+      # @param id [String] Path param: The ID of the node
+      #
+      # @param version [Integer] Query param: The version number of the node object being updated. This is requir
+      #
+      # @param spec [DockerEngineAPI::Models::Spec] Body param
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::NodeUpdateParams
+      def update(id, params)
+        parsed, options = DockerEngineAPI::NodeUpdateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["nodes/%1$s/update", id],
+          query: parsed.except(:spec),
+          body: parsed[:spec],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::NodeListParams} for more details.
+      #
+      # List nodes
+      #
+      # @overload list(filters: nil, request_options: {})
+      #
+      # @param filters [String] Filters to process on the nodes list, encoded as JSON (a `map[string][]string`).
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngineAPI::Models::Node>]
+      #
+      # @see DockerEngineAPI::Models::NodeListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::NodeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "nodes",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Node],
+          options: options
+        )
+      end
+
+      # Delete a node
+      #
+      # @overload delete(id, force: nil, request_options: {})
+      #
+      # @param id [String] The ID or name of the node
+      #
+      # @param force [Boolean] Force remove a node from the swarm
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::NodeDeleteParams
+      def delete(id, params = {})
+        parsed, options = DockerEngineAPI::NodeDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["nodes/%1$s", id],
+          query: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Inspect a node
+      #
+      # @overload inspect_(id, request_options: {})
+      #
+      # @param id [String] The ID or name of the node
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Node]
+      #
+      # @see DockerEngineAPI::Models::NodeInspectParams
+      def inspect_(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["nodes/%1$s", id],
+          model: DockerEngineAPI::Node,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine_api/resources/plugins.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Plugins
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginCreateParams} for more details.
+      #
+      # Create a plugin
+      #
+      # @overload create(name:, body:, request_options: {})
+      #
+      # @param name [String] Query param: The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param body [Pathname, StringIO, IO, String, DockerEngineAPI::FilePart] Body param
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::PluginCreateParams
+      def create(params)
+        parsed, options = DockerEngineAPI::PluginCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "plugins/create",
+          query: parsed.except(:body),
+          headers: {"content-type" => "application/x-tar"},
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginListParams} for more details.
+      #
+      # Returns information about installed plugins.
+      #
+      # @overload list(filters: nil, request_options: {})
+      #
+      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngineAPI::Models::Plugin>]
+      #
+      # @see DockerEngineAPI::Models::PluginListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::PluginListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "plugins",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Plugin],
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginDeleteParams} for more details.
+      #
+      # Remove a plugin
+      #
+      # @overload delete(name, force: nil, request_options: {})
+      #
+      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param force [Boolean] Disable the plugin before removing. This may result in issues if the
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Plugin]
+      #
+      # @see DockerEngineAPI::Models::PluginDeleteParams
+      def delete(name, params = {})
+        parsed, options = DockerEngineAPI::PluginDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["plugins/%1$s", name],
+          query: parsed,
+          model: DockerEngineAPI::Plugin,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginDisableParams} for more details.
+      #
+      # Disable a plugin
+      #
+      # @overload disable(name, force: nil, request_options: {})
+      #
+      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param force [Boolean] Force disable a plugin even if still in use.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::PluginDisableParams
+      def disable(name, params = {})
+        parsed, options = DockerEngineAPI::PluginDisableParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["plugins/%1$s/disable", name],
+          query: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginEnableParams} for more details.
+      #
+      # Enable a plugin
+      #
+      # @overload enable(name, timeout: nil, request_options: {})
+      #
+      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param timeout [Integer] Set the HTTP client timeout (in seconds)
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::PluginEnableParams
+      def enable(name, params = {})
+        parsed, options = DockerEngineAPI::PluginEnableParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["plugins/%1$s/enable", name],
+          query: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginInspectParams} for more details.
+      #
+      # Inspect a plugin
+      #
+      # @overload inspect_(name, request_options: {})
+      #
+      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Plugin]
+      #
+      # @see DockerEngineAPI::Models::PluginInspectParams
+      def inspect_(name, params = {})
+        @client.request(
+          method: :get,
+          path: ["plugins/%1$s/json", name],
+          model: DockerEngineAPI::Plugin,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginPrivilegesParams} for more details.
+      #
+      # Get plugin privileges
+      #
+      # @overload privileges(remote:, request_options: {})
+      #
+      # @param remote [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngineAPI::Models::Privilege>]
+      #
+      # @see DockerEngineAPI::Models::PluginPrivilegesParams
+      def privileges(params)
+        parsed, options = DockerEngineAPI::PluginPrivilegesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "plugins/privileges",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Privilege],
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginPullParams} for more details.
+      #
+      # Pulls and installs a plugin. After the plugin is installed, it can be enabled
+      # using the
+      # [`POST /plugins/{name}/enable` endpoint](#operation/PostPluginsEnable).
+      #
+      # @overload pull(remote:, name: nil, body: nil, x_registry_auth: nil, request_options: {})
+      #
+      # @param remote [String] Query param: Remote reference for plugin to install.
+      #
+      # @param name [String] Query param: Local name for the pulled plugin.
+      #
+      # @param body [Array<DockerEngineAPI::Models::Privilege>] Body param
+      #
+      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration to use when pulling a plugi
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::PluginPullParams
+      def pull(params)
+        parsed, options = DockerEngineAPI::PluginPullParams.dump_request(params)
+        query_params = [:remote, :name]
+        @client.request(
+          method: :post,
+          path: "plugins/pull",
+          query: parsed.slice(*query_params),
+          headers: parsed.except(:body, *query_params).transform_keys(x_registry_auth: "x-registry-auth"),
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginPushParams} for more details.
+      #
+      # Push a plugin to the registry.
+      #
+      # @overload push(name, request_options: {})
+      #
+      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::PluginPushParams
+      def push(name, params = {})
+        @client.request(
+          method: :post,
+          path: ["plugins/%1$s/push", name],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginSetParams} for more details.
+      #
+      # Configure a plugin
+      #
+      # @overload set(name, body: nil, request_options: {})
+      #
+      # @param name [String] The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param body [Array<String>]
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::PluginSetParams
+      def set(name, params = {})
+        parsed, options = DockerEngineAPI::PluginSetParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["plugins/%1$s/set", name],
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::PluginUpgradeParams} for more details.
+      #
+      # Upgrade a plugin
+      #
+      # @overload upgrade(name, remote:, body: nil, x_registry_auth: nil, request_options: {})
+      #
+      # @param name [String] Path param: The name of the plugin. The `:latest` tag is optional, and is the
+      #
+      # @param remote [String] Query param: Remote reference to upgrade to.
+      #
+      # @param body [Array<DockerEngineAPI::Models::Privilege>] Body param
+      #
+      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration to use when pulling a plugi
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::PluginUpgradeParams
+      def upgrade(name, params)
+        parsed, options = DockerEngineAPI::PluginUpgradeParams.dump_request(params)
+        query_params = [:remote]
+        @client.request(
+          method: :post,
+          path: ["plugins/%1$s/upgrade", name],
+          query: parsed.slice(*query_params),
+          headers: parsed.except(:body, *query_params).transform_keys(x_registry_auth: "x-registry-auth"),
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end