docker-engine-ruby 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +4 -2
- data/lib/docker_engine_ruby/client.rb +17 -1
- data/lib/docker_engine_ruby/models/config_list_response.rb +1 -1
- data/lib/docker_engine_ruby/models/config_object.rb +77 -0
- data/lib/docker_engine_ruby/models/config_spec.rb +68 -0
- data/lib/docker_engine_ruby/models/image_list_response.rb +1 -1
- data/lib/docker_engine_ruby/models/image_summary.rb +638 -0
- data/lib/docker_engine_ruby/models/info.rb +3 -3
- data/lib/docker_engine_ruby/models/network_create_response.rb +27 -0
- data/lib/docker_engine_ruby/models/network_list_response.rb +1 -1
- data/lib/docker_engine_ruby/models/network_summary.rb +260 -0
- data/lib/docker_engine_ruby/models/node.rb +3 -3
- data/lib/docker_engine_ruby/models/node_spec.rb +67 -0
- data/lib/docker_engine_ruby/models/secret.rb +3 -3
- data/lib/docker_engine_ruby/models/secret_spec.rb +99 -0
- data/lib/docker_engine_ruby/models/service.rb +3 -3
- data/lib/docker_engine_ruby/models/service_create_response.rb +32 -0
- data/lib/docker_engine_ruby/models/{spec.rb → service_spec.rb} +73 -67
- data/lib/docker_engine_ruby/models/service_update_response.rb +17 -0
- data/lib/docker_engine_ruby/models/swarm.rb +3 -3
- data/lib/docker_engine_ruby/models/swarm_init_params.rb +3 -3
- data/lib/docker_engine_ruby/models/swarm_spec.rb +270 -0
- data/lib/docker_engine_ruby/models/task.rb +3 -3
- data/lib/docker_engine_ruby/models/task_spec.rb +1439 -0
- data/lib/docker_engine_ruby/models.rb +23 -1
- data/lib/docker_engine_ruby/resources/configs.rb +6 -6
- data/lib/docker_engine_ruby/resources/images.rb +2 -2
- data/lib/docker_engine_ruby/resources/networks.rb +4 -4
- data/lib/docker_engine_ruby/resources/nodes.rb +1 -1
- data/lib/docker_engine_ruby/resources/secrets.rb +2 -2
- data/lib/docker_engine_ruby/resources/services.rb +6 -6
- data/lib/docker_engine_ruby/resources/swarm.rb +2 -2
- data/lib/docker_engine_ruby/version.rb +1 -1
- data/lib/docker_engine_ruby.rb +16 -5
- data/rbi/docker_engine_ruby/client.rbi +17 -0
- data/rbi/docker_engine_ruby/models/config_list_response.rbi +3 -1
- data/rbi/docker_engine_ruby/models/config_object.rbi +130 -0
- data/rbi/docker_engine_ruby/models/config_spec.rbi +127 -0
- data/rbi/docker_engine_ruby/models/image_list_response.rbi +3 -1
- data/rbi/docker_engine_ruby/models/image_summary.rbi +1073 -0
- data/rbi/docker_engine_ruby/models/info.rbi +4 -4
- data/rbi/docker_engine_ruby/models/network_create_response.rbi +37 -0
- data/rbi/docker_engine_ruby/models/network_list_response.rbi +3 -1
- data/rbi/docker_engine_ruby/models/network_summary.rbi +444 -0
- data/rbi/docker_engine_ruby/models/node.rbi +4 -4
- data/rbi/docker_engine_ruby/models/node_spec.rbi +126 -0
- data/rbi/docker_engine_ruby/models/secret.rbi +4 -4
- data/rbi/docker_engine_ruby/models/secret_spec.rbi +181 -0
- data/rbi/docker_engine_ruby/models/service.rbi +4 -4
- data/rbi/docker_engine_ruby/models/service_create_response.rbi +50 -0
- data/rbi/docker_engine_ruby/models/{spec.rbi → service_spec.rbi} +148 -104
- data/rbi/docker_engine_ruby/models/service_update_response.rbi +33 -0
- data/rbi/docker_engine_ruby/models/swarm.rbi +4 -4
- data/rbi/docker_engine_ruby/models/swarm_init_params.rbi +4 -4
- data/rbi/docker_engine_ruby/models/swarm_spec.rbi +568 -0
- data/rbi/docker_engine_ruby/models/task.rbi +4 -4
- data/rbi/docker_engine_ruby/models/task_spec.rbi +3011 -0
- data/rbi/docker_engine_ruby/models.rbi +23 -1
- data/rbi/docker_engine_ruby/resources/configs.rbi +4 -4
- data/rbi/docker_engine_ruby/resources/images.rbi +1 -1
- data/rbi/docker_engine_ruby/resources/networks.rbi +2 -2
- data/rbi/docker_engine_ruby/resources/nodes.rbi +1 -1
- data/rbi/docker_engine_ruby/resources/secrets.rbi +2 -2
- data/rbi/docker_engine_ruby/resources/services.rbi +4 -4
- data/rbi/docker_engine_ruby/resources/swarm.rbi +2 -2
- data/sig/docker_engine_ruby/client.rbs +6 -0
- data/sig/docker_engine_ruby/models/config_list_response.rbs +1 -1
- data/sig/docker_engine_ruby/models/config_object.rbs +64 -0
- data/sig/docker_engine_ruby/models/config_spec.rbs +59 -0
- data/sig/docker_engine_ruby/models/image_list_response.rbs +1 -1
- data/sig/docker_engine_ruby/models/image_summary.rbs +457 -0
- data/sig/docker_engine_ruby/models/info.rbs +7 -5
- data/sig/docker_engine_ruby/models/network_create_response.rbs +15 -0
- data/sig/docker_engine_ruby/models/network_list_response.rbs +1 -1
- data/sig/docker_engine_ruby/models/network_summary.rbs +238 -0
- data/sig/docker_engine_ruby/models/node.rbs +5 -5
- data/sig/docker_engine_ruby/models/node_spec.rbs +70 -0
- data/sig/docker_engine_ruby/models/secret.rbs +5 -5
- data/sig/docker_engine_ruby/models/secret_spec.rbs +82 -0
- data/sig/docker_engine_ruby/models/service.rbs +7 -5
- data/sig/docker_engine_ruby/models/service_create_response.rbs +17 -0
- data/sig/docker_engine_ruby/models/{spec.rbs → service_spec.rbs} +107 -103
- data/sig/docker_engine_ruby/models/service_update_response.rbs +15 -0
- data/sig/docker_engine_ruby/models/swarm.rbs +5 -5
- data/sig/docker_engine_ruby/models/swarm_init_params.rbs +5 -5
- data/sig/docker_engine_ruby/models/swarm_spec.rbs +293 -0
- data/sig/docker_engine_ruby/models/task.rbs +5 -5
- data/sig/docker_engine_ruby/models/task_spec.rbs +1480 -0
- data/sig/docker_engine_ruby/models.rbs +23 -1
- data/sig/docker_engine_ruby/resources/configs.rbs +3 -3
- data/sig/docker_engine_ruby/resources/networks.rbs +1 -1
- data/sig/docker_engine_ruby/resources/nodes.rbs +1 -1
- data/sig/docker_engine_ruby/resources/secrets.rbs +2 -2
- data/sig/docker_engine_ruby/resources/services.rbs +4 -4
- data/sig/docker_engine_ruby/resources/swarm.rbs +2 -2
- metadata +37 -4
|
@@ -0,0 +1,638 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module DockerEngineRuby
|
|
4
|
+
module Models
|
|
5
|
+
class ImageSummary < DockerEngineRuby::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute containers
|
|
7
|
+
# Number of containers using this image. Includes both stopped and running
|
|
8
|
+
# containers.
|
|
9
|
+
#
|
|
10
|
+
# `-1` indicates that the value has not been set / calculated.
|
|
11
|
+
#
|
|
12
|
+
# @return [Integer]
|
|
13
|
+
required :containers, Integer, api_name: :Containers
|
|
14
|
+
|
|
15
|
+
# @!attribute created
|
|
16
|
+
# Date and time at which the image was created as a Unix timestamp (number of
|
|
17
|
+
# seconds since EPOCH).
|
|
18
|
+
#
|
|
19
|
+
# @return [Integer]
|
|
20
|
+
required :created, Integer, api_name: :Created
|
|
21
|
+
|
|
22
|
+
# @!attribute id
|
|
23
|
+
# ID is the content-addressable ID of an image.
|
|
24
|
+
#
|
|
25
|
+
# This identifier is a content-addressable digest calculated from the image's
|
|
26
|
+
# configuration (which includes the digests of layers used by the image).
|
|
27
|
+
#
|
|
28
|
+
# Note that this digest differs from the `RepoDigests` below, which holds digests
|
|
29
|
+
# of image manifests that reference the image.
|
|
30
|
+
#
|
|
31
|
+
# @return [String]
|
|
32
|
+
required :id, String, api_name: :Id
|
|
33
|
+
|
|
34
|
+
# @!attribute labels
|
|
35
|
+
# User-defined key/value metadata.
|
|
36
|
+
#
|
|
37
|
+
# @return [Hash{Symbol=>String}]
|
|
38
|
+
required :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
|
|
39
|
+
|
|
40
|
+
# @!attribute parent_id
|
|
41
|
+
# ID of the parent image.
|
|
42
|
+
#
|
|
43
|
+
# Depending on how the image was created, this field may be empty and is only set
|
|
44
|
+
# for images that were built/created locally. This field is empty if the image was
|
|
45
|
+
# pulled from an image registry.
|
|
46
|
+
#
|
|
47
|
+
# @return [String]
|
|
48
|
+
required :parent_id, String, api_name: :ParentId
|
|
49
|
+
|
|
50
|
+
# @!attribute repo_digests
|
|
51
|
+
# List of content-addressable digests of locally available image manifests that
|
|
52
|
+
# the image is referenced from. Multiple manifests can refer to the same image.
|
|
53
|
+
#
|
|
54
|
+
# These digests are usually only available if the image was either pulled from a
|
|
55
|
+
# registry, or if the image was pushed to a registry, which is when the manifest
|
|
56
|
+
# is generated and its digest calculated.
|
|
57
|
+
#
|
|
58
|
+
# @return [Array<String>]
|
|
59
|
+
required :repo_digests, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :RepoDigests
|
|
60
|
+
|
|
61
|
+
# @!attribute repo_tags
|
|
62
|
+
# List of image names/tags in the local image cache that reference this image.
|
|
63
|
+
#
|
|
64
|
+
# Multiple image tags can refer to the same image, and this list may be empty if
|
|
65
|
+
# no tags reference the image, in which case the image is "untagged", in which
|
|
66
|
+
# case it can still be referenced by its ID.
|
|
67
|
+
#
|
|
68
|
+
# @return [Array<String>]
|
|
69
|
+
required :repo_tags, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :RepoTags
|
|
70
|
+
|
|
71
|
+
# @!attribute shared_size
|
|
72
|
+
# Total size of image layers that are shared between this image and other images.
|
|
73
|
+
#
|
|
74
|
+
# This size is not calculated by default. `-1` indicates that the value has not
|
|
75
|
+
# been set / calculated.
|
|
76
|
+
#
|
|
77
|
+
# @return [Integer]
|
|
78
|
+
required :shared_size, Integer, api_name: :SharedSize
|
|
79
|
+
|
|
80
|
+
# @!attribute size
|
|
81
|
+
# Total size of the image including all layers it is composed of.
|
|
82
|
+
#
|
|
83
|
+
# @return [Integer]
|
|
84
|
+
required :size, Integer, api_name: :Size
|
|
85
|
+
|
|
86
|
+
# @!attribute descriptor
|
|
87
|
+
# A descriptor struct containing digest, media type, and size, as defined in the
|
|
88
|
+
# [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
|
|
89
|
+
#
|
|
90
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Descriptor, nil]
|
|
91
|
+
optional :descriptor,
|
|
92
|
+
-> {
|
|
93
|
+
DockerEngineRuby::ImageSummary::Descriptor
|
|
94
|
+
},
|
|
95
|
+
api_name: :Descriptor,
|
|
96
|
+
nil?: true
|
|
97
|
+
|
|
98
|
+
# @!attribute manifests
|
|
99
|
+
# Manifests is a list of manifests available in this image. It provides a more
|
|
100
|
+
# detailed view of the platform-specific image manifests or other image-attached
|
|
101
|
+
# data like build attestations.
|
|
102
|
+
#
|
|
103
|
+
# WARNING: This is experimental and may change at any time without any backward
|
|
104
|
+
# compatibility.
|
|
105
|
+
#
|
|
106
|
+
# @return [Array<DockerEngineRuby::Models::ImageSummary::Manifest>, nil]
|
|
107
|
+
optional :manifests,
|
|
108
|
+
-> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::ImageSummary::Manifest] },
|
|
109
|
+
api_name: :Manifests
|
|
110
|
+
|
|
111
|
+
# @!method initialize(containers:, created:, id:, labels:, parent_id:, repo_digests:, repo_tags:, shared_size:, size:, descriptor: nil, manifests: nil)
|
|
112
|
+
# Some parameter documentations has been truncated, see
|
|
113
|
+
# {DockerEngineRuby::Models::ImageSummary} for more details.
|
|
114
|
+
#
|
|
115
|
+
# @param containers [Integer] Number of containers using this image. Includes both stopped and running
|
|
116
|
+
#
|
|
117
|
+
# @param created [Integer] Date and time at which the image was created as a Unix timestamp
|
|
118
|
+
#
|
|
119
|
+
# @param id [String] ID is the content-addressable ID of an image.
|
|
120
|
+
#
|
|
121
|
+
# @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
|
|
122
|
+
#
|
|
123
|
+
# @param parent_id [String] ID of the parent image.
|
|
124
|
+
#
|
|
125
|
+
# @param repo_digests [Array<String>] List of content-addressable digests of locally available image manifests
|
|
126
|
+
#
|
|
127
|
+
# @param repo_tags [Array<String>] List of image names/tags in the local image cache that reference this
|
|
128
|
+
#
|
|
129
|
+
# @param shared_size [Integer] Total size of image layers that are shared between this image and other
|
|
130
|
+
#
|
|
131
|
+
# @param size [Integer] Total size of the image including all layers it is composed of.
|
|
132
|
+
#
|
|
133
|
+
# @param descriptor [DockerEngineRuby::Models::ImageSummary::Descriptor, nil] A descriptor struct containing digest, media type, and size, as defined in
|
|
134
|
+
#
|
|
135
|
+
# @param manifests [Array<DockerEngineRuby::Models::ImageSummary::Manifest>] Manifests is a list of manifests available in this image.
|
|
136
|
+
|
|
137
|
+
# @see DockerEngineRuby::Models::ImageSummary#descriptor
|
|
138
|
+
class Descriptor < DockerEngineRuby::Internal::Type::BaseModel
|
|
139
|
+
# @!attribute annotations
|
|
140
|
+
# Arbitrary metadata relating to the targeted content.
|
|
141
|
+
#
|
|
142
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
143
|
+
optional :annotations, DockerEngineRuby::Internal::Type::HashOf[String], nil?: true
|
|
144
|
+
|
|
145
|
+
# @!attribute artifact_type
|
|
146
|
+
# ArtifactType is the IANA media type of this artifact.
|
|
147
|
+
#
|
|
148
|
+
# @return [String, nil]
|
|
149
|
+
optional :artifact_type, String, api_name: :artifactType, nil?: true
|
|
150
|
+
|
|
151
|
+
# @!attribute data
|
|
152
|
+
# Data is an embedding of the targeted content. This is encoded as a base64 string
|
|
153
|
+
# when marshalled to JSON (automatically, by encoding/json). If present, Data can
|
|
154
|
+
# be used directly to avoid fetching the targeted content.
|
|
155
|
+
#
|
|
156
|
+
# @return [String, nil]
|
|
157
|
+
optional :data, String, nil?: true
|
|
158
|
+
|
|
159
|
+
# @!attribute digest
|
|
160
|
+
# The digest of the targeted content.
|
|
161
|
+
#
|
|
162
|
+
# @return [String, nil]
|
|
163
|
+
optional :digest, String
|
|
164
|
+
|
|
165
|
+
# @!attribute media_type
|
|
166
|
+
# The media type of the object this schema refers to.
|
|
167
|
+
#
|
|
168
|
+
# @return [String, nil]
|
|
169
|
+
optional :media_type, String, api_name: :mediaType
|
|
170
|
+
|
|
171
|
+
# @!attribute platform
|
|
172
|
+
# Describes the platform which the image in the manifest runs on, as defined in
|
|
173
|
+
# the
|
|
174
|
+
# [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
|
|
175
|
+
#
|
|
176
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Descriptor::Platform, nil]
|
|
177
|
+
optional :platform, -> { DockerEngineRuby::ImageSummary::Descriptor::Platform }
|
|
178
|
+
|
|
179
|
+
# @!attribute size
|
|
180
|
+
# The size in bytes of the blob.
|
|
181
|
+
#
|
|
182
|
+
# @return [Integer, nil]
|
|
183
|
+
optional :size, Integer
|
|
184
|
+
|
|
185
|
+
# @!attribute urls
|
|
186
|
+
# List of URLs from which this object MAY be downloaded.
|
|
187
|
+
#
|
|
188
|
+
# @return [Array<String>, nil]
|
|
189
|
+
optional :urls, DockerEngineRuby::Internal::Type::ArrayOf[String], nil?: true
|
|
190
|
+
|
|
191
|
+
# @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
|
|
192
|
+
# Some parameter documentations has been truncated, see
|
|
193
|
+
# {DockerEngineRuby::Models::ImageSummary::Descriptor} for more details.
|
|
194
|
+
#
|
|
195
|
+
# A descriptor struct containing digest, media type, and size, as defined in the
|
|
196
|
+
# [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
|
|
197
|
+
#
|
|
198
|
+
# @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
|
|
199
|
+
#
|
|
200
|
+
# @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
|
|
201
|
+
#
|
|
202
|
+
# @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
|
|
203
|
+
#
|
|
204
|
+
# @param digest [String] The digest of the targeted content.
|
|
205
|
+
#
|
|
206
|
+
# @param media_type [String] The media type of the object this schema refers to.
|
|
207
|
+
#
|
|
208
|
+
# @param platform [DockerEngineRuby::Models::ImageSummary::Descriptor::Platform] Describes the platform which the image in the manifest runs on, as defined
|
|
209
|
+
#
|
|
210
|
+
# @param size [Integer] The size in bytes of the blob.
|
|
211
|
+
#
|
|
212
|
+
# @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
|
|
213
|
+
|
|
214
|
+
# @see DockerEngineRuby::Models::ImageSummary::Descriptor#platform
|
|
215
|
+
class Platform < DockerEngineRuby::Internal::Type::BaseModel
|
|
216
|
+
# @!attribute architecture
|
|
217
|
+
# The CPU architecture, for example `amd64` or `ppc64`.
|
|
218
|
+
#
|
|
219
|
+
# @return [String, nil]
|
|
220
|
+
optional :architecture, String
|
|
221
|
+
|
|
222
|
+
# @!attribute os
|
|
223
|
+
# The operating system, for example `linux` or `windows`.
|
|
224
|
+
#
|
|
225
|
+
# @return [String, nil]
|
|
226
|
+
optional :os, String
|
|
227
|
+
|
|
228
|
+
# @!attribute os_features
|
|
229
|
+
# Optional field specifying an array of strings, each listing a required OS
|
|
230
|
+
# feature (for example on Windows `win32k`).
|
|
231
|
+
#
|
|
232
|
+
# @return [Array<String>, nil]
|
|
233
|
+
optional :os_features, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :"os.features"
|
|
234
|
+
|
|
235
|
+
# @!attribute os_version
|
|
236
|
+
# Optional field specifying the operating system version, for example on Windows
|
|
237
|
+
# `10.0.19041.1165`.
|
|
238
|
+
#
|
|
239
|
+
# @return [String, nil]
|
|
240
|
+
optional :os_version, String, api_name: :"os.version"
|
|
241
|
+
|
|
242
|
+
# @!attribute variant
|
|
243
|
+
# Optional field specifying a variant of the CPU, for example `v7` to specify
|
|
244
|
+
# ARMv7 when architecture is `arm`.
|
|
245
|
+
#
|
|
246
|
+
# @return [String, nil]
|
|
247
|
+
optional :variant, String
|
|
248
|
+
|
|
249
|
+
# @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
|
|
250
|
+
# Some parameter documentations has been truncated, see
|
|
251
|
+
# {DockerEngineRuby::Models::ImageSummary::Descriptor::Platform} for more details.
|
|
252
|
+
#
|
|
253
|
+
# Describes the platform which the image in the manifest runs on, as defined in
|
|
254
|
+
# the
|
|
255
|
+
# [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
|
|
256
|
+
#
|
|
257
|
+
# @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
|
|
258
|
+
#
|
|
259
|
+
# @param os [String] The operating system, for example `linux` or `windows`.
|
|
260
|
+
#
|
|
261
|
+
# @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
|
|
262
|
+
#
|
|
263
|
+
# @param os_version [String] Optional field specifying the operating system version, for example on
|
|
264
|
+
#
|
|
265
|
+
# @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
|
|
266
|
+
end
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
class Manifest < DockerEngineRuby::Internal::Type::BaseModel
|
|
270
|
+
# @!attribute available
|
|
271
|
+
# Indicates whether all the child content (image config, layers) is fully
|
|
272
|
+
# available locally.
|
|
273
|
+
#
|
|
274
|
+
# @return [Boolean]
|
|
275
|
+
required :available, DockerEngineRuby::Internal::Type::Boolean, api_name: :Available
|
|
276
|
+
|
|
277
|
+
# @!attribute descriptor
|
|
278
|
+
# A descriptor struct containing digest, media type, and size, as defined in the
|
|
279
|
+
# [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
|
|
280
|
+
#
|
|
281
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Manifest::Descriptor]
|
|
282
|
+
required :descriptor,
|
|
283
|
+
-> {
|
|
284
|
+
DockerEngineRuby::ImageSummary::Manifest::Descriptor
|
|
285
|
+
},
|
|
286
|
+
api_name: :Descriptor
|
|
287
|
+
|
|
288
|
+
# @!attribute id
|
|
289
|
+
# ID is the content-addressable ID of an image and is the same as the digest of
|
|
290
|
+
# the image manifest.
|
|
291
|
+
#
|
|
292
|
+
# @return [String]
|
|
293
|
+
required :id, String, api_name: :ID
|
|
294
|
+
|
|
295
|
+
# @!attribute kind
|
|
296
|
+
# The kind of the manifest.
|
|
297
|
+
#
|
|
298
|
+
# | kind | description |
|
|
299
|
+
# | ----------- | ------------------------------------------------------------------------------------ |
|
|
300
|
+
# | image | Image manifest that can be used to start a container. |
|
|
301
|
+
# | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
|
|
302
|
+
#
|
|
303
|
+
# @return [Symbol, DockerEngineRuby::Models::ImageSummary::Manifest::Kind]
|
|
304
|
+
required :kind, enum: -> { DockerEngineRuby::ImageSummary::Manifest::Kind }, api_name: :Kind
|
|
305
|
+
|
|
306
|
+
# @!attribute size
|
|
307
|
+
#
|
|
308
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Manifest::Size]
|
|
309
|
+
required :size, -> { DockerEngineRuby::ImageSummary::Manifest::Size }, api_name: :Size
|
|
310
|
+
|
|
311
|
+
# @!attribute attestation_data
|
|
312
|
+
# The image data for the attestation manifest. This field is only populated when
|
|
313
|
+
# Kind is "attestation".
|
|
314
|
+
#
|
|
315
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Manifest::AttestationData, nil]
|
|
316
|
+
optional :attestation_data,
|
|
317
|
+
-> { DockerEngineRuby::ImageSummary::Manifest::AttestationData },
|
|
318
|
+
api_name: :AttestationData,
|
|
319
|
+
nil?: true
|
|
320
|
+
|
|
321
|
+
# @!attribute image_data
|
|
322
|
+
# The image data for the image manifest. This field is only populated when Kind is
|
|
323
|
+
# "image".
|
|
324
|
+
#
|
|
325
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Manifest::ImageData, nil]
|
|
326
|
+
optional :image_data,
|
|
327
|
+
-> { DockerEngineRuby::ImageSummary::Manifest::ImageData },
|
|
328
|
+
api_name: :ImageData,
|
|
329
|
+
nil?: true
|
|
330
|
+
|
|
331
|
+
# @!method initialize(available:, descriptor:, id:, kind:, size:, attestation_data: nil, image_data: nil)
|
|
332
|
+
# Some parameter documentations has been truncated, see
|
|
333
|
+
# {DockerEngineRuby::Models::ImageSummary::Manifest} for more details.
|
|
334
|
+
#
|
|
335
|
+
# ImageManifestSummary represents a summary of an image manifest.
|
|
336
|
+
#
|
|
337
|
+
# @param available [Boolean] Indicates whether all the child content (image config, layers) is fully availabl
|
|
338
|
+
#
|
|
339
|
+
# @param descriptor [DockerEngineRuby::Models::ImageSummary::Manifest::Descriptor] A descriptor struct containing digest, media type, and size, as defined in
|
|
340
|
+
#
|
|
341
|
+
# @param id [String] ID is the content-addressable ID of an image and is the same as the
|
|
342
|
+
#
|
|
343
|
+
# @param kind [Symbol, DockerEngineRuby::Models::ImageSummary::Manifest::Kind] The kind of the manifest.
|
|
344
|
+
#
|
|
345
|
+
# @param size [DockerEngineRuby::Models::ImageSummary::Manifest::Size]
|
|
346
|
+
#
|
|
347
|
+
# @param attestation_data [DockerEngineRuby::Models::ImageSummary::Manifest::AttestationData, nil] The image data for the attestation manifest.
|
|
348
|
+
#
|
|
349
|
+
# @param image_data [DockerEngineRuby::Models::ImageSummary::Manifest::ImageData, nil] The image data for the image manifest.
|
|
350
|
+
|
|
351
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest#descriptor
|
|
352
|
+
class Descriptor < DockerEngineRuby::Internal::Type::BaseModel
|
|
353
|
+
# @!attribute annotations
|
|
354
|
+
# Arbitrary metadata relating to the targeted content.
|
|
355
|
+
#
|
|
356
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
357
|
+
optional :annotations, DockerEngineRuby::Internal::Type::HashOf[String], nil?: true
|
|
358
|
+
|
|
359
|
+
# @!attribute artifact_type
|
|
360
|
+
# ArtifactType is the IANA media type of this artifact.
|
|
361
|
+
#
|
|
362
|
+
# @return [String, nil]
|
|
363
|
+
optional :artifact_type, String, api_name: :artifactType, nil?: true
|
|
364
|
+
|
|
365
|
+
# @!attribute data
|
|
366
|
+
# Data is an embedding of the targeted content. This is encoded as a base64 string
|
|
367
|
+
# when marshalled to JSON (automatically, by encoding/json). If present, Data can
|
|
368
|
+
# be used directly to avoid fetching the targeted content.
|
|
369
|
+
#
|
|
370
|
+
# @return [String, nil]
|
|
371
|
+
optional :data, String, nil?: true
|
|
372
|
+
|
|
373
|
+
# @!attribute digest
|
|
374
|
+
# The digest of the targeted content.
|
|
375
|
+
#
|
|
376
|
+
# @return [String, nil]
|
|
377
|
+
optional :digest, String
|
|
378
|
+
|
|
379
|
+
# @!attribute media_type
|
|
380
|
+
# The media type of the object this schema refers to.
|
|
381
|
+
#
|
|
382
|
+
# @return [String, nil]
|
|
383
|
+
optional :media_type, String, api_name: :mediaType
|
|
384
|
+
|
|
385
|
+
# @!attribute platform
|
|
386
|
+
# Describes the platform which the image in the manifest runs on, as defined in
|
|
387
|
+
# the
|
|
388
|
+
# [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
|
|
389
|
+
#
|
|
390
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Manifest::Descriptor::Platform, nil]
|
|
391
|
+
optional :platform, -> { DockerEngineRuby::ImageSummary::Manifest::Descriptor::Platform }
|
|
392
|
+
|
|
393
|
+
# @!attribute size
|
|
394
|
+
# The size in bytes of the blob.
|
|
395
|
+
#
|
|
396
|
+
# @return [Integer, nil]
|
|
397
|
+
optional :size, Integer
|
|
398
|
+
|
|
399
|
+
# @!attribute urls
|
|
400
|
+
# List of URLs from which this object MAY be downloaded.
|
|
401
|
+
#
|
|
402
|
+
# @return [Array<String>, nil]
|
|
403
|
+
optional :urls, DockerEngineRuby::Internal::Type::ArrayOf[String], nil?: true
|
|
404
|
+
|
|
405
|
+
# @!method initialize(annotations: nil, artifact_type: nil, data: nil, digest: nil, media_type: nil, platform: nil, size: nil, urls: nil)
|
|
406
|
+
# Some parameter documentations has been truncated, see
|
|
407
|
+
# {DockerEngineRuby::Models::ImageSummary::Manifest::Descriptor} for more details.
|
|
408
|
+
#
|
|
409
|
+
# A descriptor struct containing digest, media type, and size, as defined in the
|
|
410
|
+
# [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
|
|
411
|
+
#
|
|
412
|
+
# @param annotations [Hash{Symbol=>String}, nil] Arbitrary metadata relating to the targeted content.
|
|
413
|
+
#
|
|
414
|
+
# @param artifact_type [String, nil] ArtifactType is the IANA media type of this artifact.
|
|
415
|
+
#
|
|
416
|
+
# @param data [String, nil] Data is an embedding of the targeted content. This is encoded as a base64
|
|
417
|
+
#
|
|
418
|
+
# @param digest [String] The digest of the targeted content.
|
|
419
|
+
#
|
|
420
|
+
# @param media_type [String] The media type of the object this schema refers to.
|
|
421
|
+
#
|
|
422
|
+
# @param platform [DockerEngineRuby::Models::ImageSummary::Manifest::Descriptor::Platform] Describes the platform which the image in the manifest runs on, as defined
|
|
423
|
+
#
|
|
424
|
+
# @param size [Integer] The size in bytes of the blob.
|
|
425
|
+
#
|
|
426
|
+
# @param urls [Array<String>, nil] List of URLs from which this object MAY be downloaded.
|
|
427
|
+
|
|
428
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest::Descriptor#platform
|
|
429
|
+
class Platform < DockerEngineRuby::Internal::Type::BaseModel
|
|
430
|
+
# @!attribute architecture
|
|
431
|
+
# The CPU architecture, for example `amd64` or `ppc64`.
|
|
432
|
+
#
|
|
433
|
+
# @return [String, nil]
|
|
434
|
+
optional :architecture, String
|
|
435
|
+
|
|
436
|
+
# @!attribute os
|
|
437
|
+
# The operating system, for example `linux` or `windows`.
|
|
438
|
+
#
|
|
439
|
+
# @return [String, nil]
|
|
440
|
+
optional :os, String
|
|
441
|
+
|
|
442
|
+
# @!attribute os_features
|
|
443
|
+
# Optional field specifying an array of strings, each listing a required OS
|
|
444
|
+
# feature (for example on Windows `win32k`).
|
|
445
|
+
#
|
|
446
|
+
# @return [Array<String>, nil]
|
|
447
|
+
optional :os_features, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :"os.features"
|
|
448
|
+
|
|
449
|
+
# @!attribute os_version
|
|
450
|
+
# Optional field specifying the operating system version, for example on Windows
|
|
451
|
+
# `10.0.19041.1165`.
|
|
452
|
+
#
|
|
453
|
+
# @return [String, nil]
|
|
454
|
+
optional :os_version, String, api_name: :"os.version"
|
|
455
|
+
|
|
456
|
+
# @!attribute variant
|
|
457
|
+
# Optional field specifying a variant of the CPU, for example `v7` to specify
|
|
458
|
+
# ARMv7 when architecture is `arm`.
|
|
459
|
+
#
|
|
460
|
+
# @return [String, nil]
|
|
461
|
+
optional :variant, String
|
|
462
|
+
|
|
463
|
+
# @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
|
|
464
|
+
# Some parameter documentations has been truncated, see
|
|
465
|
+
# {DockerEngineRuby::Models::ImageSummary::Manifest::Descriptor::Platform} for
|
|
466
|
+
# more details.
|
|
467
|
+
#
|
|
468
|
+
# Describes the platform which the image in the manifest runs on, as defined in
|
|
469
|
+
# the
|
|
470
|
+
# [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
|
|
471
|
+
#
|
|
472
|
+
# @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
|
|
473
|
+
#
|
|
474
|
+
# @param os [String] The operating system, for example `linux` or `windows`.
|
|
475
|
+
#
|
|
476
|
+
# @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
|
|
477
|
+
#
|
|
478
|
+
# @param os_version [String] Optional field specifying the operating system version, for example on
|
|
479
|
+
#
|
|
480
|
+
# @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
|
|
481
|
+
end
|
|
482
|
+
end
|
|
483
|
+
|
|
484
|
+
# The kind of the manifest.
|
|
485
|
+
#
|
|
486
|
+
# | kind | description |
|
|
487
|
+
# | ----------- | ------------------------------------------------------------------------------------ |
|
|
488
|
+
# | image | Image manifest that can be used to start a container. |
|
|
489
|
+
# | attestation | Attestation manifest produced by the Buildkit builder for a specific image manifest. |
|
|
490
|
+
#
|
|
491
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest#kind
|
|
492
|
+
module Kind
|
|
493
|
+
extend DockerEngineRuby::Internal::Type::Enum
|
|
494
|
+
|
|
495
|
+
IMAGE = :image
|
|
496
|
+
ATTESTATION = :attestation
|
|
497
|
+
UNKNOWN = :unknown
|
|
498
|
+
|
|
499
|
+
# @!method self.values
|
|
500
|
+
# @return [Array<Symbol>]
|
|
501
|
+
end
|
|
502
|
+
|
|
503
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest#size
|
|
504
|
+
class Size < DockerEngineRuby::Internal::Type::BaseModel
|
|
505
|
+
# @!attribute content
|
|
506
|
+
#
|
|
507
|
+
# @return [Integer]
|
|
508
|
+
required :content, Integer, api_name: :Content
|
|
509
|
+
|
|
510
|
+
# @!attribute total
|
|
511
|
+
#
|
|
512
|
+
# @return [Integer]
|
|
513
|
+
required :total, Integer, api_name: :Total
|
|
514
|
+
|
|
515
|
+
# @!method initialize(content:, total:)
|
|
516
|
+
# @param content [Integer]
|
|
517
|
+
# @param total [Integer]
|
|
518
|
+
end
|
|
519
|
+
|
|
520
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest#attestation_data
|
|
521
|
+
class AttestationData < DockerEngineRuby::Internal::Type::BaseModel
|
|
522
|
+
# @!attribute for_
|
|
523
|
+
#
|
|
524
|
+
# @return [String]
|
|
525
|
+
required :for_, String, api_name: :For
|
|
526
|
+
|
|
527
|
+
# @!method initialize(for_:)
|
|
528
|
+
# The image data for the attestation manifest. This field is only populated when
|
|
529
|
+
# Kind is "attestation".
|
|
530
|
+
#
|
|
531
|
+
# @param for_ [String]
|
|
532
|
+
end
|
|
533
|
+
|
|
534
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest#image_data
|
|
535
|
+
class ImageData < DockerEngineRuby::Internal::Type::BaseModel
|
|
536
|
+
# @!attribute containers
|
|
537
|
+
#
|
|
538
|
+
# @return [Array<String>]
|
|
539
|
+
required :containers, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Containers
|
|
540
|
+
|
|
541
|
+
# @!attribute platform
|
|
542
|
+
# Describes the platform which the image in the manifest runs on, as defined in
|
|
543
|
+
# the
|
|
544
|
+
# [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
|
|
545
|
+
#
|
|
546
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Manifest::ImageData::Platform]
|
|
547
|
+
required :platform,
|
|
548
|
+
-> { DockerEngineRuby::ImageSummary::Manifest::ImageData::Platform },
|
|
549
|
+
api_name: :Platform
|
|
550
|
+
|
|
551
|
+
# @!attribute size
|
|
552
|
+
#
|
|
553
|
+
# @return [DockerEngineRuby::Models::ImageSummary::Manifest::ImageData::Size]
|
|
554
|
+
required :size, -> { DockerEngineRuby::ImageSummary::Manifest::ImageData::Size }, api_name: :Size
|
|
555
|
+
|
|
556
|
+
# @!method initialize(containers:, platform:, size:)
|
|
557
|
+
# Some parameter documentations has been truncated, see
|
|
558
|
+
# {DockerEngineRuby::Models::ImageSummary::Manifest::ImageData} for more details.
|
|
559
|
+
#
|
|
560
|
+
# The image data for the image manifest. This field is only populated when Kind is
|
|
561
|
+
# "image".
|
|
562
|
+
#
|
|
563
|
+
# @param containers [Array<String>]
|
|
564
|
+
#
|
|
565
|
+
# @param platform [DockerEngineRuby::Models::ImageSummary::Manifest::ImageData::Platform] Describes the platform which the image in the manifest runs on, as defined
|
|
566
|
+
#
|
|
567
|
+
# @param size [DockerEngineRuby::Models::ImageSummary::Manifest::ImageData::Size]
|
|
568
|
+
|
|
569
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest::ImageData#platform
|
|
570
|
+
class Platform < DockerEngineRuby::Internal::Type::BaseModel
|
|
571
|
+
# @!attribute architecture
|
|
572
|
+
# The CPU architecture, for example `amd64` or `ppc64`.
|
|
573
|
+
#
|
|
574
|
+
# @return [String, nil]
|
|
575
|
+
optional :architecture, String
|
|
576
|
+
|
|
577
|
+
# @!attribute os
|
|
578
|
+
# The operating system, for example `linux` or `windows`.
|
|
579
|
+
#
|
|
580
|
+
# @return [String, nil]
|
|
581
|
+
optional :os, String
|
|
582
|
+
|
|
583
|
+
# @!attribute os_features
|
|
584
|
+
# Optional field specifying an array of strings, each listing a required OS
|
|
585
|
+
# feature (for example on Windows `win32k`).
|
|
586
|
+
#
|
|
587
|
+
# @return [Array<String>, nil]
|
|
588
|
+
optional :os_features, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :"os.features"
|
|
589
|
+
|
|
590
|
+
# @!attribute os_version
|
|
591
|
+
# Optional field specifying the operating system version, for example on Windows
|
|
592
|
+
# `10.0.19041.1165`.
|
|
593
|
+
#
|
|
594
|
+
# @return [String, nil]
|
|
595
|
+
optional :os_version, String, api_name: :"os.version"
|
|
596
|
+
|
|
597
|
+
# @!attribute variant
|
|
598
|
+
# Optional field specifying a variant of the CPU, for example `v7` to specify
|
|
599
|
+
# ARMv7 when architecture is `arm`.
|
|
600
|
+
#
|
|
601
|
+
# @return [String, nil]
|
|
602
|
+
optional :variant, String
|
|
603
|
+
|
|
604
|
+
# @!method initialize(architecture: nil, os: nil, os_features: nil, os_version: nil, variant: nil)
|
|
605
|
+
# Some parameter documentations has been truncated, see
|
|
606
|
+
# {DockerEngineRuby::Models::ImageSummary::Manifest::ImageData::Platform} for more
|
|
607
|
+
# details.
|
|
608
|
+
#
|
|
609
|
+
# Describes the platform which the image in the manifest runs on, as defined in
|
|
610
|
+
# the
|
|
611
|
+
# [OCI Image Index Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/image-index.md).
|
|
612
|
+
#
|
|
613
|
+
# @param architecture [String] The CPU architecture, for example `amd64` or `ppc64`.
|
|
614
|
+
#
|
|
615
|
+
# @param os [String] The operating system, for example `linux` or `windows`.
|
|
616
|
+
#
|
|
617
|
+
# @param os_features [Array<String>] Optional field specifying an array of strings, each listing a required
|
|
618
|
+
#
|
|
619
|
+
# @param os_version [String] Optional field specifying the operating system version, for example on
|
|
620
|
+
#
|
|
621
|
+
# @param variant [String] Optional field specifying a variant of the CPU, for example `v7` to
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
# @see DockerEngineRuby::Models::ImageSummary::Manifest::ImageData#size
|
|
625
|
+
class Size < DockerEngineRuby::Internal::Type::BaseModel
|
|
626
|
+
# @!attribute unpacked
|
|
627
|
+
#
|
|
628
|
+
# @return [Integer]
|
|
629
|
+
required :unpacked, Integer, api_name: :Unpacked
|
|
630
|
+
|
|
631
|
+
# @!method initialize(unpacked:)
|
|
632
|
+
# @param unpacked [Integer]
|
|
633
|
+
end
|
|
634
|
+
end
|
|
635
|
+
end
|
|
636
|
+
end
|
|
637
|
+
end
|
|
638
|
+
end
|
|
@@ -1303,8 +1303,8 @@ module DockerEngineRuby
|
|
|
1303
1303
|
# @!attribute spec
|
|
1304
1304
|
# User modifiable swarm configuration.
|
|
1305
1305
|
#
|
|
1306
|
-
# @return [DockerEngineRuby::Models::
|
|
1307
|
-
optional :spec, -> { DockerEngineRuby::
|
|
1306
|
+
# @return [DockerEngineRuby::Models::SwarmSpec, nil]
|
|
1307
|
+
optional :spec, -> { DockerEngineRuby::SwarmSpec }, api_name: :Spec
|
|
1308
1308
|
|
|
1309
1309
|
# @!attribute subnet_size
|
|
1310
1310
|
# SubnetSize specifies the subnet size of the networks created from the default
|
|
@@ -1358,7 +1358,7 @@ module DockerEngineRuby
|
|
|
1358
1358
|
#
|
|
1359
1359
|
# @param root_rotation_in_progress [Boolean] Whether there is currently a root CA rotation in progress for the swarm
|
|
1360
1360
|
#
|
|
1361
|
-
# @param spec [DockerEngineRuby::Models::
|
|
1361
|
+
# @param spec [DockerEngineRuby::Models::SwarmSpec] User modifiable swarm configuration.
|
|
1362
1362
|
#
|
|
1363
1363
|
# @param subnet_size [Integer] SubnetSize specifies the subnet size of the networks created from the
|
|
1364
1364
|
#
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module DockerEngineRuby
|
|
4
|
+
module Models
|
|
5
|
+
# @see DockerEngineRuby::Resources::Networks#create
|
|
6
|
+
class NetworkCreateResponse < DockerEngineRuby::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute id
|
|
8
|
+
# The ID of the created network.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :id, String, api_name: :Id
|
|
12
|
+
|
|
13
|
+
# @!attribute warning
|
|
14
|
+
# Warnings encountered when creating the container
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :warning, String, api_name: :Warning
|
|
18
|
+
|
|
19
|
+
# @!method initialize(id:, warning:)
|
|
20
|
+
# OK response to NetworkCreate operation
|
|
21
|
+
#
|
|
22
|
+
# @param id [String] The ID of the created network.
|
|
23
|
+
#
|
|
24
|
+
# @param warning [String] Warnings encountered when creating the container
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|