docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/resources/networks.rb

@@ -38,7 +38,7 @@ module DockerEngine
       #
       # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [DockerEngine::Models::NetworkCreateResponse]
+      # @return [DockerEngine::Models::CreateResponse]
       #
       # @see DockerEngine::Models::NetworkCreateParams
       def create(params)
@@ -47,7 +47,7 @@ module DockerEngine
           method: :post,
           path: "networks/create",
           body: parsed,
-          model: DockerEngine::Models::NetworkCreateResponse,
+          model: DockerEngine::CreateResponse,
           options: options
         )
       end
@@ -102,6 +102,60 @@ module DockerEngine
         )
       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 [DockerEngine::Models::ConnectRequest::EndpointConfig] Configuration for a network endpoint.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::NetworkConnectParams
+      def connect(id, params)
+        parsed, options = DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::NetworkDisconnectParams
+      def disconnect(id, params)
+        parsed, options = DockerEngine::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: {})
@@ -128,6 +182,31 @@ module DockerEngine
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::NetworkPruneResponse]
+      #
+      # @see DockerEngine::Models::NetworkPruneParams
+      def prune(params = {})
+        parsed, options = DockerEngine::NetworkPruneParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "networks/prune",
+          query: parsed,
+          model: DockerEngine::Models::NetworkPruneResponse,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [DockerEngine::Client]

data/lib/docker_engine/resources/nodes.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Nodes
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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 [DockerEngine::Models::Spec] Body param
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::NodeUpdateParams
+      def update(id, params)
+        parsed, options = DockerEngine::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
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Node>]
+      #
+      # @see DockerEngine::Models::NodeListParams
+      def list(params = {})
+        parsed, options = DockerEngine::NodeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "nodes",
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::NodeDeleteParams
+      def delete(id, params = {})
+        parsed, options = DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Node]
+      #
+      # @see DockerEngine::Models::NodeInspectParams
+      def inspect_(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["nodes/%1$s", id],
+          model: DockerEngine::Node,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/resources/plugins.rb

@@ -0,0 +1,317 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Plugins
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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, DockerEngine::FilePart] Body param
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::PluginCreateParams
+      def create(params)
+        parsed, options = DockerEngine::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
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Plugin>]
+      #
+      # @see DockerEngine::Models::PluginListParams
+      def list(params = {})
+        parsed, options = DockerEngine::PluginListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "plugins",
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Plugin],
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Plugin]
+      #
+      # @see DockerEngine::Models::PluginDeleteParams
+      def delete(name, params = {})
+        parsed, options = DockerEngine::PluginDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["plugins/%1$s", name],
+          query: parsed,
+          model: DockerEngine::Plugin,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::PluginDisableParams
+      def disable(name, params = {})
+        parsed, options = DockerEngine::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
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::PluginEnableParams
+      def enable(name, params = {})
+        parsed, options = DockerEngine::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
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Plugin]
+      #
+      # @see DockerEngine::Models::PluginInspectParams
+      def inspect_(name, params = {})
+        @client.request(
+          method: :get,
+          path: ["plugins/%1$s/json", name],
+          model: DockerEngine::Plugin,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Privilege>]
+      #
+      # @see DockerEngine::Models::PluginPrivilegesParams
+      def privileges(params)
+        parsed, options = DockerEngine::PluginPrivilegesParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "plugins/privileges",
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Privilege],
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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<DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::PluginPullParams
+      def pull(params)
+        parsed, options = DockerEngine::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
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::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
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::PluginSetParams
+      def set(name, params = {})
+        parsed, options = DockerEngine::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
+      # {DockerEngine::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<DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::PluginUpgradeParams
+      def upgrade(name, params)
+        parsed, options = DockerEngine::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 [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/resources/secrets.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Secrets
+      # Create a secret
+      #
+      # @overload create(spec: nil, request_options: {})
+      #
+      # @param spec [DockerEngine::Models::SecretCreateParams::Spec]
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::SecretCreateResponse]
+      #
+      # @see DockerEngine::Models::SecretCreateParams
+      def create(params = {})
+        parsed, options = DockerEngine::SecretCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "secrets/create",
+          body: parsed[:spec],
+          model: DockerEngine::Models::SecretCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::SecretUpdateParams} for more details.
+      #
+      # Update a Secret
+      #
+      # @overload update(id, version:, spec: nil, request_options: {})
+      #
+      # @param id [String] Path param: The ID or name of the secret
+      #
+      # @param version [Integer] Query param: The version number of the secret object being updated. This is
+      #
+      # @param spec [DockerEngine::Models::Spec] Body param
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::SecretUpdateParams
+      def update(id, params)
+        parsed, options = DockerEngine::SecretUpdateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["secrets/%1$s/update", id],
+          query: parsed.except(:spec),
+          body: parsed[:spec],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::SecretListParams} for more details.
+      #
+      # List secrets
+      #
+      # @overload list(filters: nil, request_options: {})
+      #
+      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Secret>]
+      #
+      # @see DockerEngine::Models::SecretListParams
+      def list(params = {})
+        parsed, options = DockerEngine::SecretListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "secrets",
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Secret],
+          options: options
+        )
+      end
+
+      # Delete a secret
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] ID of the secret
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::SecretDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["secrets/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Inspect a secret
+      #
+      # @overload inspect_(id, request_options: {})
+      #
+      # @param id [String] ID of the secret
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Secret]
+      #
+      # @see DockerEngine::Models::SecretInspectParams
+      def inspect_(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["secrets/%1$s", id],
+          model: DockerEngine::Secret,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end