docker-engine-api 0.2.1

data/lib/docker_engine_api/resources/secrets.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Secrets
+      # Create a secret
+      #
+      # @overload create(spec: nil, request_options: {})
+      #
+      # @param spec [DockerEngineAPI::Models::SecretCreateParams::Spec]
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::SecretCreateResponse]
+      #
+      # @see DockerEngineAPI::Models::SecretCreateParams
+      def create(params = {})
+        parsed, options = DockerEngineAPI::SecretCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "secrets/create",
+          body: parsed[:spec],
+          model: DockerEngineAPI::Models::SecretCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::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 [DockerEngineAPI::Models::Spec] Body param
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::SecretUpdateParams
+      def update(id, params)
+        parsed, options = DockerEngineAPI::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
+      # {DockerEngineAPI::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 [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngineAPI::Models::Secret>]
+      #
+      # @see DockerEngineAPI::Models::SecretListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::SecretListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "secrets",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Secret],
+          options: options
+        )
+      end
+
+      # Delete a secret
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] ID of the secret
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::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 [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Secret]
+      #
+      # @see DockerEngineAPI::Models::SecretInspectParams
+      def inspect_(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["secrets/%1$s", id],
+          model: DockerEngineAPI::Secret,
+          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/services.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Services
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::ServiceCreateParams} for more details.
+      #
+      # Create a service
+      #
+      # @overload create(spec:, x_registry_auth: nil, request_options: {})
+      #
+      # @param spec [DockerEngineAPI::Models::ServiceCreateParams::Spec] Body param: User modifiable configuration for a service.
+      #
+      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration for pulling from private
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::CreateResponse]
+      #
+      # @see DockerEngineAPI::Models::ServiceCreateParams
+      def create(params)
+        parsed, options = DockerEngineAPI::ServiceCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "services/create",
+          headers: parsed.except(:spec).transform_keys(x_registry_auth: "x-registry-auth"),
+          body: parsed[:spec],
+          model: DockerEngineAPI::CreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::ServiceUpdateParams} for more details.
+      #
+      # Update a service
+      #
+      # @overload update(id, version:, spec:, registry_auth_from: nil, rollback: nil, x_registry_auth: nil, request_options: {})
+      #
+      # @param id [String] Path param: ID or name of service.
+      #
+      # @param version [Integer] Query param: The version number of the service object being updated. This is
+      #
+      # @param spec [DockerEngineAPI::Models::ServiceUpdateParams::Spec] Body param: User modifiable configuration for a service.
+      #
+      # @param registry_auth_from [Symbol, DockerEngineAPI::Models::ServiceUpdateParams::RegistryAuthFrom] Query param: If the `X-Registry-Auth` header is not specified, this parameter
+      #
+      # @param rollback [String] Query param: Set to this parameter to `previous` to cause a server-side rollback
+      #
+      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration for pulling from private
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::UpdateResponse]
+      #
+      # @see DockerEngineAPI::Models::ServiceUpdateParams
+      def update(id, params)
+        parsed, options = DockerEngineAPI::ServiceUpdateParams.dump_request(params)
+        query_params = [:version, :registry_auth_from, :rollback]
+        @client.request(
+          method: :post,
+          path: ["services/%1$s/update", id],
+          query: parsed.slice(*query_params).transform_keys(registry_auth_from: "registryAuthFrom"),
+          headers: parsed.except(:spec, *query_params).transform_keys(x_registry_auth: "x-registry-auth"),
+          body: parsed[:spec],
+          model: DockerEngineAPI::UpdateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::ServiceListParams} for more details.
+      #
+      # List services
+      #
+      # @overload list(filters: nil, status: nil, request_options: {})
+      #
+      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      # @param status [Boolean] Include service status, with count of running and desired tasks.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngineAPI::Models::Service>]
+      #
+      # @see DockerEngineAPI::Models::ServiceListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::ServiceListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "services",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Service],
+          options: options
+        )
+      end
+
+      # Delete a service
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] ID or name of service.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::ServiceDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["services/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Inspect a service
+      #
+      # @overload inspect_(id, insert_defaults: nil, request_options: {})
+      #
+      # @param id [String] ID or name of service.
+      #
+      # @param insert_defaults [Boolean] Fill empty fields with default values.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Service]
+      #
+      # @see DockerEngineAPI::Models::ServiceInspectParams
+      def inspect_(id, params = {})
+        parsed, options = DockerEngineAPI::ServiceInspectParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["services/%1$s", id],
+          query: parsed.transform_keys(insert_defaults: "insertDefaults"),
+          model: DockerEngineAPI::Service,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::ServiceLogsParams} for more details.
+      #
+      # Get `stdout` and `stderr` logs from a service. See also
+      # [`/containers/{id}/logs`](#operation/ContainerLogs).
+      #
+      # **Note**: This endpoint works only for services with the `local`, `json-file` or
+      # `journald` logging drivers.
+      #
+      # @overload logs(id, details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {})
+      #
+      # @param id [String] ID or name of the service
+      #
+      # @param details [Boolean] Show service context and extra details provided to logs.
+      #
+      # @param follow [Boolean] Keep connection after returning logs.
+      #
+      # @param since [Integer] Only return logs since this time, as a UNIX timestamp
+      #
+      # @param stderr [Boolean] Return logs from `stderr`
+      #
+      # @param stdout [Boolean] Return logs from `stdout`
+      #
+      # @param tail [String] Only return this number of log lines from the end of the logs.
+      #
+      # @param timestamps [Boolean] Add timestamps to every log line
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [StringIO]
+      #
+      # @see DockerEngineAPI::Models::ServiceLogsParams
+      def logs(id, params = {})
+        parsed, options = DockerEngineAPI::ServiceLogsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["services/%1$s/logs", id],
+          query: parsed,
+          headers: {"accept" => "application/vnd.docker.multiplexed-stream"},
+          model: StringIO,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine_api/resources/swarm.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Swarm
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::SwarmUpdateParams} for more details.
+      #
+      # Update a swarm
+      #
+      # @overload update(version:, spec:, rotate_manager_token: nil, rotate_manager_unlock_key: nil, rotate_worker_token: nil, request_options: {})
+      #
+      # @param version [Integer] Query param: The version number of the swarm object being updated. This is
+      #
+      # @param spec [DockerEngineAPI::Models::Spec] Body param: User modifiable swarm configuration.
+      #
+      # @param rotate_manager_token [Boolean] Query param: Rotate the manager join token.
+      #
+      # @param rotate_manager_unlock_key [Boolean] Query param: Rotate the manager unlock key.
+      #
+      # @param rotate_worker_token [Boolean] Query param: Rotate the worker join token.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::SwarmUpdateParams
+      def update(params)
+        parsed, options = DockerEngineAPI::SwarmUpdateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "swarm/update",
+          query: parsed.except(:spec).transform_keys(
+            rotate_manager_token: "rotateManagerToken",
+            rotate_manager_unlock_key: "rotateManagerUnlockKey",
+            rotate_worker_token: "rotateWorkerToken"
+          ),
+          body: parsed[:spec],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::SwarmInitParams} for more details.
+      #
+      # Initialize a new swarm
+      #
+      # @overload init(advertise_addr: nil, data_path_addr: nil, data_path_port: nil, default_addr_pool: nil, force_new_cluster: nil, listen_addr: nil, spec: nil, subnet_size: nil, request_options: {})
+      #
+      # @param advertise_addr [String] Externally reachable address advertised to other nodes. This
+      #
+      # @param data_path_addr [String] Address or interface to use for data path traffic (format:
+      #
+      # @param data_path_port [Integer] DataPathPort specifies the data path port number for data traffic.
+      #
+      # @param default_addr_pool [Array<String>] Default Address Pool specifies default subnet pools for global
+      #
+      # @param force_new_cluster [Boolean] Force creation of a new swarm.
+      #
+      # @param listen_addr [String] Listen address used for inter-manager communication, as well
+      #
+      # @param spec [DockerEngineAPI::Models::Spec] User modifiable swarm configuration.
+      #
+      # @param subnet_size [Integer] SubnetSize specifies the subnet size of the networks created
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see DockerEngineAPI::Models::SwarmInitParams
+      def init(params = {})
+        parsed, options = DockerEngineAPI::SwarmInitParams.dump_request(params)
+        @client.request(method: :post, path: "swarm/init", body: parsed, model: String, options: options)
+      end
+
+      # Inspect swarm
+      #
+      # @overload inspect_(request_options: {})
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::SwarmAPI]
+      #
+      # @see DockerEngineAPI::Models::SwarmInspectParams
+      def inspect_(params = {})
+        @client.request(
+          method: :get,
+          path: "swarm",
+          model: DockerEngineAPI::SwarmAPI,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::SwarmJoinParams} for more details.
+      #
+      # Join an existing swarm
+      #
+      # @overload join(advertise_addr: nil, data_path_addr: nil, join_token: nil, listen_addr: nil, remote_addrs: nil, request_options: {})
+      #
+      # @param advertise_addr [String] Externally reachable address advertised to other nodes. This
+      #
+      # @param data_path_addr [String] Address or interface to use for data path traffic (format:
+      #
+      # @param join_token [String] Secret token for joining this swarm.
+      #
+      # @param listen_addr [String] Listen address used for inter-manager communication if the node
+      #
+      # @param remote_addrs [Array<String>] Addresses of manager nodes already participating in the swarm.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::SwarmJoinParams
+      def join(params = {})
+        parsed, options = DockerEngineAPI::SwarmJoinParams.dump_request(params)
+        @client.request(method: :post, path: "swarm/join", body: parsed, model: NilClass, options: options)
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::SwarmLeaveParams} for more details.
+      #
+      # Leave a swarm
+      #
+      # @overload leave(force: nil, request_options: {})
+      #
+      # @param force [Boolean] Force leave swarm, even if this is the last manager or that it will
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::SwarmLeaveParams
+      def leave(params = {})
+        parsed, options = DockerEngineAPI::SwarmLeaveParams.dump_request(params)
+        @client.request(method: :post, path: "swarm/leave", query: parsed, model: NilClass, options: options)
+      end
+
+      # Unlock a locked manager
+      #
+      # @overload unlock(unlock_key: nil, request_options: {})
+      #
+      # @param unlock_key [String] The swarm's unlock key.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::SwarmUnlockParams
+      def unlock(params = {})
+        parsed, options = DockerEngineAPI::SwarmUnlockParams.dump_request(params)
+        @client.request(method: :post, path: "swarm/unlock", body: parsed, model: NilClass, options: options)
+      end
+
+      # Get the unlock key
+      #
+      # @overload unlock_key(request_options: {})
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::SwarmUnlockKeyResponse]
+      #
+      # @see DockerEngineAPI::Models::SwarmUnlockKeyParams
+      def unlock_key(params = {})
+        @client.request(
+          method: :get,
+          path: "swarm/unlockkey",
+          model: DockerEngineAPI::Models::SwarmUnlockKeyResponse,
+          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/system.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class System
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::SystemDataUsageParams} for more details.
+      #
+      # Get data usage information
+      #
+      # @overload data_usage(type: nil, verbose: nil, request_options: {})
+      #
+      # @param type [Array<Symbol, DockerEngineAPI::Models::SystemDataUsageParams::Type>] Object types, for which to compute and return data.
+      #
+      # @param verbose [Boolean] Show detailed information on space usage.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::SystemDataUsageResponse]
+      #
+      # @see DockerEngineAPI::Models::SystemDataUsageParams
+      def data_usage(params = {})
+        parsed, options = DockerEngineAPI::SystemDataUsageParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "system/df",
+          query: parsed,
+          model: DockerEngineAPI::Models::SystemDataUsageResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::SystemEventsParams} for more details.
+      #
+      # Stream real-time events from the server.
+      #
+      # Various objects within Docker report events when something happens to them.
+      #
+      # Containers report these events: `attach`, `commit`, `copy`, `create`, `destroy`,
+      # `detach`, `die`, `exec_create`, `exec_detach`, `exec_start`, `exec_die`,
+      # `export`, `health_status`, `kill`, `oom`, `pause`, `rename`, `resize`,
+      # `restart`, `start`, `stop`, `top`, `unpause`, `update`, and `prune`
+      #
+      # Images report these events: `create`, `delete`, `import`, `load`, `pull`,
+      # `push`, `save`, `tag`, `untag`, and `prune`
+      #
+      # Volumes report these events: `create`, `mount`, `unmount`, `destroy`, and
+      # `prune`
+      #
+      # Networks report these events: `create`, `connect`, `disconnect`, `destroy`,
+      # `update`, `remove`, and `prune`
+      #
+      # The Docker daemon reports these events: `reload`
+      #
+      # Services report these events: `create`, `update`, and `remove`
+      #
+      # Nodes report these events: `create`, `update`, and `remove`
+      #
+      # Secrets report these events: `create`, `update`, and `remove`
+      #
+      # Configs report these events: `create`, `update`, and `remove`
+      #
+      # The Builder reports `prune` events
+      #
+      # @overload events(filters: nil, since: nil, until_: nil, request_options: {})
+      #
+      # @param filters [String] A JSON encoded value of filters (a `map[string][]string`) to process on the even
+      #
+      # @param since [String] Show events created since this timestamp then stream new events.
+      #
+      # @param until_ [String] Show events created until this timestamp then stop streaming.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::SystemEventsResponse]
+      #
+      # @see DockerEngineAPI::Models::SystemEventsParams
+      def events(params = {})
+        parsed, options = DockerEngineAPI::SystemEventsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "events",
+          query: parsed.transform_keys(until_: "until"),
+          headers: {"accept" => "application/json-seq"},
+          model: DockerEngineAPI::Models::SystemEventsResponse,
+          options: options
+        )
+      end
+
+      # Get system information
+      #
+      # @overload info(request_options: {})
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Info]
+      #
+      # @see DockerEngineAPI::Models::SystemInfoParams
+      def info(params = {})
+        @client.request(
+          method: :get,
+          path: "info",
+          model: DockerEngineAPI::Info,
+          options: params[:request_options]
+        )
+      end
+
+      # This is a dummy endpoint you can use to test if the server is accessible.
+      #
+      # @overload ping(request_options: {})
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see DockerEngineAPI::Models::SystemPingParams
+      def ping(params = {})
+        @client.request(
+          method: :get,
+          path: "_ping",
+          headers: {"accept" => "text/plain"},
+          model: String,
+          options: params[:request_options]
+        )
+      end
+
+      # Returns the version of Docker that is running and various information about the
+      # system that Docker is running on.
+      #
+      # @overload version(request_options: {})
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Version]
+      #
+      # @see DockerEngineAPI::Models::SystemVersionParams
+      def version(params = {})
+        @client.request(
+          method: :get,
+          path: "version",
+          model: DockerEngineAPI::Version,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end