docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/distribution_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Distribution#inspect_
+    class DistributionInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/exec_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Exec#inspect_
+    class ExecInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/exec_inspect_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Exec#inspect_
+    class ExecInspectResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute can_remove
+      #
+      #   @return [Boolean, nil]
+      optional :can_remove, DockerEngine::Internal::Type::Boolean, api_name: :CanRemove
+
+      # @!attribute container_id
+      #
+      #   @return [String, nil]
+      optional :container_id, String, api_name: :ContainerID
+
+      # @!attribute detach_keys
+      #
+      #   @return [String, nil]
+      optional :detach_keys, String, api_name: :DetachKeys
+
+      # @!attribute exit_code
+      #
+      #   @return [Integer, nil]
+      optional :exit_code, Integer, api_name: :ExitCode
+
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute open_stderr
+      #
+      #   @return [Boolean, nil]
+      optional :open_stderr, DockerEngine::Internal::Type::Boolean, api_name: :OpenStderr
+
+      # @!attribute open_stdin
+      #
+      #   @return [Boolean, nil]
+      optional :open_stdin, DockerEngine::Internal::Type::Boolean, api_name: :OpenStdin
+
+      # @!attribute open_stdout
+      #
+      #   @return [Boolean, nil]
+      optional :open_stdout, DockerEngine::Internal::Type::Boolean, api_name: :OpenStdout
+
+      # @!attribute pid
+      #   The system process ID for the exec process.
+      #
+      #   @return [Integer, nil]
+      optional :pid, Integer, api_name: :Pid
+
+      # @!attribute process_config
+      #
+      #   @return [DockerEngine::Models::InspectResponse, nil]
+      optional :process_config, -> { DockerEngine::InspectResponse }, api_name: :ProcessConfig
+
+      # @!attribute running
+      #
+      #   @return [Boolean, nil]
+      optional :running, DockerEngine::Internal::Type::Boolean, api_name: :Running
+
+      # @!method initialize(can_remove: nil, container_id: nil, detach_keys: nil, exit_code: nil, id: nil, open_stderr: nil, open_stdin: nil, open_stdout: nil, pid: nil, process_config: nil, running: nil)
+      #   @param can_remove [Boolean]
+      #
+      #   @param container_id [String]
+      #
+      #   @param detach_keys [String]
+      #
+      #   @param exit_code [Integer]
+      #
+      #   @param id [String]
+      #
+      #   @param open_stderr [Boolean]
+      #
+      #   @param open_stdin [Boolean]
+      #
+      #   @param open_stdout [Boolean]
+      #
+      #   @param pid [Integer] The system process ID for the exec process.
+      #
+      #   @param process_config [DockerEngine::Models::InspectResponse]
+      #
+      #   @param running [Boolean]
+    end
+  end
+end

data/lib/docker_engine/models/exec_resize_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Exec#resize
+    class ExecResizeParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute h
+      #   Height of the TTY session in characters
+      #
+      #   @return [Integer]
+      required :h, Integer
+
+      # @!attribute w
+      #   Width of the TTY session in characters
+      #
+      #   @return [Integer]
+      required :w, Integer
+
+      # @!method initialize(h:, w:, request_options: {})
+      #   @param h [Integer] Height of the TTY session in characters
+      #
+      #   @param w [Integer] Width of the TTY session in characters
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/exec_start_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Exec#start
+    class ExecStartParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute console_size
+      #   Initial console size, as an `[height, width]` array.
+      #
+      #   @return [Array<Integer>, nil]
+      optional :console_size,
+               DockerEngine::Internal::Type::ArrayOf[Integer],
+               api_name: :ConsoleSize,
+               nil?: true
+
+      # @!attribute detach
+      #   Detach from the command.
+      #
+      #   @return [Boolean, nil]
+      optional :detach, DockerEngine::Internal::Type::Boolean, api_name: :Detach
+
+      # @!attribute tty
+      #   Allocate a pseudo-TTY.
+      #
+      #   @return [Boolean, nil]
+      optional :tty, DockerEngine::Internal::Type::Boolean, api_name: :Tty
+
+      # @!method initialize(console_size: nil, detach: nil, tty: nil, request_options: {})
+      #   @param console_size [Array<Integer>, nil] Initial console size, as an `[height, width]` array.
+      #
+      #   @param detach [Boolean] Detach from the command.
+      #
+      #   @param tty [Boolean] Allocate a pseudo-TTY.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/filesystem_change.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class FilesystemChange < DockerEngine::Internal::Type::BaseModel
+      # @!attribute kind
+      #   Kind of change
+      #
+      #   Can be one of:
+      #
+      #   - `0`: Modified ("C")
+      #   - `1`: Added ("A")
+      #   - `2`: Deleted ("D")
+      #
+      #   @return [Integer, DockerEngine::Models::FilesystemChange::Kind]
+      required :kind, enum: -> { DockerEngine::FilesystemChange::Kind }, api_name: :Kind
+
+      # @!attribute path
+      #   Path to file or directory that has changed.
+      #
+      #   @return [String]
+      required :path, String, api_name: :Path
+
+      # @!method initialize(kind:, path:)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::FilesystemChange} for more details.
+      #
+      #   Change in the container's filesystem.
+      #
+      #   @param kind [Integer, DockerEngine::Models::FilesystemChange::Kind] Kind of change
+      #
+      #   @param path [String] Path to file or directory that has changed.
+
+      # Kind of change
+      #
+      # Can be one of:
+      #
+      # - `0`: Modified ("C")
+      # - `1`: Added ("A")
+      # - `2`: Deleted ("D")
+      #
+      # @see DockerEngine::Models::FilesystemChange#kind
+      module Kind
+        extend DockerEngine::Internal::Type::Enum
+
+        KIND_0 = 0
+        KIND_1 = 1
+        KIND_2 = 2
+
+        # @!method self.values
+        #   @return [Array<Integer>]
+      end
+    end
+  end
+end

data/lib/docker_engine/models/history_item.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    class HistoryItem < DockerEngine::Internal::Type::BaseModel
+      # @!attribute comment
+      #
+      #   @return [String]
+      required :comment, String, api_name: :Comment
+
+      # @!attribute created
+      #
+      #   @return [Integer]
+      required :created, Integer, api_name: :Created
+
+      # @!attribute created_by
+      #
+      #   @return [String]
+      required :created_by, String, api_name: :CreatedBy
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String, api_name: :Id
+
+      # @!attribute size
+      #
+      #   @return [Integer]
+      required :size, Integer, api_name: :Size
+
+      # @!attribute tags
+      #
+      #   @return [Array<String>]
+      required :tags, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Tags
+
+      # @!method initialize(comment:, created:, created_by:, id:, size:, tags:)
+      #   individual image layer information in response to ImageHistory operation
+      #
+      #   @param comment [String]
+      #   @param created [Integer]
+      #   @param created_by [String]
+      #   @param id [String]
+      #   @param size [Integer]
+      #   @param tags [Array<String>]
+    end
+  end
+end

data/lib/docker_engine/models/image_build_params.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#build
+    class ImageBuildParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute body
+      #
+      #   @return [Pathname, StringIO, IO, String, DockerEngine::FilePart]
+      required :body, DockerEngine::Internal::Type::FileInput
+
+      # @!attribute buildargs
+      #   JSON map of string pairs for build-time variables. Users pass these values at
+      #   build-time. Docker uses the buildargs as the environment context for commands
+      #   run via the `Dockerfile` RUN instruction, or for variable expansion in other
+      #   `Dockerfile` instructions. This is not meant for passing secret values.
+      #
+      #   For example, the build arg `FOO=bar` would become `{"FOO":"bar"}` in JSON. This
+      #   would result in the query parameter `buildargs={"FOO":"bar"}`. Note that
+      #   `{"FOO":"bar"}` should be URI component encoded.
+      #
+      #   [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
+      #
+      #   @return [String, nil]
+      optional :buildargs, String
+
+      # @!attribute cachefrom
+      #   JSON array of images used for build cache resolution.
+      #
+      #   @return [String, nil]
+      optional :cachefrom, String
+
+      # @!attribute cpuperiod
+      #   The length of a CPU period in microseconds.
+      #
+      #   @return [Integer, nil]
+      optional :cpuperiod, Integer
+
+      # @!attribute cpuquota
+      #   Microseconds of CPU time that the container can get in a CPU period.
+      #
+      #   @return [Integer, nil]
+      optional :cpuquota, Integer
+
+      # @!attribute cpusetcpus
+      #   CPUs in which to allow execution (e.g., `0-3`, `0,1`).
+      #
+      #   @return [String, nil]
+      optional :cpusetcpus, String
+
+      # @!attribute cpushares
+      #   CPU shares (relative weight).
+      #
+      #   @return [Integer, nil]
+      optional :cpushares, Integer
+
+      # @!attribute dockerfile
+      #   Path within the build context to the `Dockerfile`. This is ignored if `remote`
+      #   is specified and points to an external `Dockerfile`.
+      #
+      #   @return [String, nil]
+      optional :dockerfile, String
+
+      # @!attribute extrahosts
+      #   Extra hosts to add to /etc/hosts
+      #
+      #   @return [String, nil]
+      optional :extrahosts, String
+
+      # @!attribute forcerm
+      #   Always remove intermediate containers, even upon failure.
+      #
+      #   @return [Boolean, nil]
+      optional :forcerm, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute labels
+      #   Arbitrary key/value labels to set on the image, as a JSON map of string pairs.
+      #
+      #   @return [String, nil]
+      optional :labels, String
+
+      # @!attribute memory
+      #   Set memory limit for build.
+      #
+      #   @return [Integer, nil]
+      optional :memory, Integer
+
+      # @!attribute memswap
+      #   Total memory (memory + swap). Set as `-1` to disable swap.
+      #
+      #   @return [Integer, nil]
+      optional :memswap, Integer
+
+      # @!attribute networkmode
+      #   Sets the networking mode for the run commands during build. Supported standard
+      #   values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value
+      #   is taken as a custom network's name or ID to which this container should connect
+      #   to.
+      #
+      #   @return [String, nil]
+      optional :networkmode, String
+
+      # @!attribute nocache
+      #   Do not use the cache when building the image.
+      #
+      #   @return [Boolean, nil]
+      optional :nocache, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute outputs
+      #   BuildKit output configuration in the format of a stringified JSON array of
+      #   objects. Each object must have two top-level properties: `Type` and `Attrs`. The
+      #   `Type` property must be set to 'moby'. The `Attrs` property is a map of
+      #   attributes for the BuildKit output configuration. See
+      #   https://docs.docker.com/build/exporters/oci-docker/ for more information.
+      #
+      #   Example:
+      #
+      #   ```
+      #   [{"Type":"moby","Attrs":{"type":"image","force-compression":"true","compression":"zstd"}}]
+      #   ```
+      #
+      #   @return [String, nil]
+      optional :outputs, String
+
+      # @!attribute platform
+      #   Platform in the format os[/arch[/variant]]
+      #
+      #   @return [String, nil]
+      optional :platform, String
+
+      # @!attribute pull
+      #   Attempt to pull the image even if an older image exists locally.
+      #
+      #   @return [String, nil]
+      optional :pull, String
+
+      # @!attribute q
+      #   Suppress verbose build output.
+      #
+      #   @return [Boolean, nil]
+      optional :q, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute remote
+      #   A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single
+      #   text file, the file’s contents are placed into a file called `Dockerfile` and
+      #   the image is built from that file. If the URI points to a tarball, the file is
+      #   downloaded by the daemon and the contents therein used as the context for the
+      #   build. If the URI points to a tarball and the `dockerfile` parameter is also
+      #   specified, there must be a file with the corresponding path inside the tarball.
+      #
+      #   @return [String, nil]
+      optional :remote, String
+
+      # @!attribute rm
+      #   Remove intermediate containers after a successful build.
+      #
+      #   @return [Boolean, nil]
+      optional :rm, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute shmsize
+      #   Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the
+      #   system uses 64MB.
+      #
+      #   @return [Integer, nil]
+      optional :shmsize, Integer
+
+      # @!attribute squash
+      #   Squash the resulting images layers into a single layer. _(Experimental release
+      #   only.)_
+      #
+      #   @return [Boolean, nil]
+      optional :squash, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute t
+      #   A name and optional tag to apply to the image in the `name:tag` format. If you
+      #   omit the tag the default `latest` value is assumed. You can provide several `t`
+      #   parameters.
+      #
+      #   @return [String, nil]
+      optional :t, String
+
+      # @!attribute target
+      #   Target build stage
+      #
+      #   @return [String, nil]
+      optional :target, String
+
+      # @!attribute version
+      #   Version of the builder backend to use.
+      #
+      #   - `1` is the first generation classic (deprecated) builder in the Docker daemon
+      #     (default)
+      #   - `2` is [BuildKit](https://github.com/moby/buildkit)
+      #
+      #   @return [Symbol, DockerEngine::Models::ImageBuildParams::Version, nil]
+      optional :version, enum: -> { DockerEngine::ImageBuildParams::Version }
+
+      # @!attribute x_registry_config
+      #
+      #   @return [String, nil]
+      optional :x_registry_config, String
+
+      # @!method initialize(body:, buildargs: nil, cachefrom: nil, cpuperiod: nil, cpuquota: nil, cpusetcpus: nil, cpushares: nil, dockerfile: nil, extrahosts: nil, forcerm: nil, labels: nil, memory: nil, memswap: nil, networkmode: nil, nocache: nil, outputs: nil, platform: nil, pull: nil, q: nil, remote: nil, rm: nil, shmsize: nil, squash: nil, t: nil, target: nil, version: nil, x_registry_config: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageBuildParams} for more details.
+      #
+      #   @param body [Pathname, StringIO, IO, String, DockerEngine::FilePart]
+      #
+      #   @param buildargs [String] JSON map of string pairs for build-time variables. Users pass these values at bu
+      #
+      #   @param cachefrom [String] JSON array of images used for build cache resolution.
+      #
+      #   @param cpuperiod [Integer] The length of a CPU period in microseconds.
+      #
+      #   @param cpuquota [Integer] Microseconds of CPU time that the container can get in a CPU period.
+      #
+      #   @param cpusetcpus [String] CPUs in which to allow execution (e.g., `0-3`, `0,1`).
+      #
+      #   @param cpushares [Integer] CPU shares (relative weight).
+      #
+      #   @param dockerfile [String] Path within the build context to the `Dockerfile`. This is ignored if `remote` i
+      #
+      #   @param extrahosts [String] Extra hosts to add to /etc/hosts
+      #
+      #   @param forcerm [Boolean] Always remove intermediate containers, even upon failure.
+      #
+      #   @param labels [String] Arbitrary key/value labels to set on the image, as a JSON map of string pairs.
+      #
+      #   @param memory [Integer] Set memory limit for build.
+      #
+      #   @param memswap [Integer] Total memory (memory + swap). Set as `-1` to disable swap.
+      #
+      #   @param networkmode [String] Sets the networking mode for the run commands during build. Supported
+      #
+      #   @param nocache [Boolean] Do not use the cache when building the image.
+      #
+      #   @param outputs [String] BuildKit output configuration in the format of a stringified JSON array of objec
+      #
+      #   @param platform [String] Platform in the format os[/arch[/variant]]
+      #
+      #   @param pull [String] Attempt to pull the image even if an older image exists locally.
+      #
+      #   @param q [Boolean] Suppress verbose build output.
+      #
+      #   @param remote [String] A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single te
+      #
+      #   @param rm [Boolean] Remove intermediate containers after a successful build.
+      #
+      #   @param shmsize [Integer] Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the sys
+      #
+      #   @param squash [Boolean] Squash the resulting images layers into a single layer. \*(Experimental release
+      #   o
+      #
+      #   @param t [String] A name and optional tag to apply to the image in the `name:tag` format. If you o
+      #
+      #   @param target [String] Target build stage
+      #
+      #   @param version [Symbol, DockerEngine::Models::ImageBuildParams::Version] Version of the builder backend to use.
+      #
+      #   @param x_registry_config [String]
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+
+      # Version of the builder backend to use.
+      #
+      # - `1` is the first generation classic (deprecated) builder in the Docker daemon
+      #   (default)
+      # - `2` is [BuildKit](https://github.com/moby/buildkit)
+      module Version
+        extend DockerEngine::Internal::Type::Enum
+
+        VERSION_1 = :"1"
+        VERSION_2 = :"2"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/docker_engine/models/image_build_prune_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#build_prune
+    class ImageBuildPruneParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute all
+      #   Remove all types of build cache
+      #
+      #   @return [Boolean, nil]
+      optional :all, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute filters
+      #   A JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #   list of build cache objects.
+      #
+      #   Available filters:
+      #
+      #   - `until=<timestamp>` remove cache older than `<timestamp>`. The `<timestamp>`
+      #     can be Unix timestamps, date formatted timestamps, or Go duration strings
+      #     (e.g. `10m`, `1h30m`) computed relative to the daemon's local time.
+      #   - `id=<id>`
+      #   - `parent=<id>`
+      #   - `type=<string>`
+      #   - `description=<string>`
+      #   - `inuse`
+      #   - `shared`
+      #   - `private`
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!attribute max_used_space
+      #   Maximum amount of disk space allowed to keep for cache
+      #
+      #   @return [Integer, nil]
+      optional :max_used_space, Integer
+
+      # @!attribute min_free_space
+      #   Target amount of free disk space after pruning
+      #
+      #   @return [Integer, nil]
+      optional :min_free_space, Integer
+
+      # @!attribute reserved_space
+      #   Amount of disk space in bytes to keep for cache
+      #
+      #   @return [Integer, nil]
+      optional :reserved_space, Integer
+
+      # @!method initialize(all: nil, filters: nil, max_used_space: nil, min_free_space: nil, reserved_space: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::ImageBuildPruneParams} for more details.
+      #
+      #   @param all [Boolean] Remove all types of build cache
+      #
+      #   @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param max_used_space [Integer] Maximum amount of disk space allowed to keep for cache
+      #
+      #   @param min_free_space [Integer] Target amount of free disk space after pruning
+      #
+      #   @param reserved_space [Integer] Amount of disk space in bytes to keep for cache
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/image_build_prune_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Images#build_prune
+    class ImageBuildPruneResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute caches_deleted
+      #
+      #   @return [Array<String>, nil]
+      optional :caches_deleted, DockerEngine::Internal::Type::ArrayOf[String], api_name: :CachesDeleted
+
+      # @!attribute space_reclaimed
+      #   Disk space reclaimed in bytes
+      #
+      #   @return [Integer, nil]
+      optional :space_reclaimed, Integer, api_name: :SpaceReclaimed
+
+      # @!method initialize(caches_deleted: nil, space_reclaimed: nil)
+      #   @param caches_deleted [Array<String>]
+      #
+      #   @param space_reclaimed [Integer] Disk space reclaimed in bytes
+    end
+  end
+end