docker-engine-ruby 0.3.0 → 0.5.0

data/lib/docker_engine_ruby/models/network_list_response.rb

@@ -3,6 +3,6 @@
 module DockerEngineRuby
   module Models
     # @type [DockerEngineRuby::Internal::Type::Converter]
-    NetworkListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::Summary }]
+    NetworkListResponse = DockerEngineRuby::Internal::Type::ArrayOf[-> { DockerEngineRuby::NetworkSummary }]
   end
 end

data/lib/docker_engine_ruby/models/network_summary.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    class NetworkSummary < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute attachable
+      #   Whether a global / swarm scope network is manually attachable by regular
+      #   containers from workers in swarm mode.
+      #
+      #   @return [Boolean, nil]
+      optional :attachable, DockerEngineRuby::Internal::Type::Boolean, api_name: :Attachable
+
+      # @!attribute config_from
+      #   The config-only network source to provide the configuration for this network.
+      #
+      #   @return [DockerEngineRuby::Models::NetworkSummary::ConfigFrom, nil]
+      optional :config_from, -> { DockerEngineRuby::NetworkSummary::ConfigFrom }, api_name: :ConfigFrom
+
+      # @!attribute config_only
+      #   Whether the network is a config-only network. Config-only networks are
+      #   placeholder networks for network configurations to be used by other networks.
+      #   Config-only networks cannot be used directly to run containers or services.
+      #
+      #   @return [Boolean, nil]
+      optional :config_only, DockerEngineRuby::Internal::Type::Boolean, api_name: :ConfigOnly
+
+      # @!attribute created
+      #   Date and time at which the network was created in
+      #   [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+      #
+      #   @return [Time, nil]
+      optional :created, Time, api_name: :Created
+
+      # @!attribute driver
+      #   The name of the driver used to create the network (e.g. `bridge`, `overlay`).
+      #
+      #   @return [String, nil]
+      optional :driver, String, api_name: :Driver
+
+      # @!attribute enable_i_pv4
+      #   Whether the network was created with IPv4 enabled.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv4, DockerEngineRuby::Internal::Type::Boolean, api_name: :EnableIPv4
+
+      # @!attribute enable_i_pv6
+      #   Whether the network was created with IPv6 enabled.
+      #
+      #   @return [Boolean, nil]
+      optional :enable_i_pv6, DockerEngineRuby::Internal::Type::Boolean, api_name: :EnableIPv6
+
+      # @!attribute id
+      #   ID that uniquely identifies a network on a single machine.
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :Id
+
+      # @!attribute ingress
+      #   Whether the network is providing the routing-mesh for the swarm cluster.
+      #
+      #   @return [Boolean, nil]
+      optional :ingress, DockerEngineRuby::Internal::Type::Boolean, api_name: :Ingress
+
+      # @!attribute internal
+      #   Whether the network is created to only allow internal networking connectivity.
+      #
+      #   @return [Boolean, nil]
+      optional :internal, DockerEngineRuby::Internal::Type::Boolean, api_name: :Internal
+
+      # @!attribute ipam
+      #   The network's IP Address Management.
+      #
+      #   @return [DockerEngineRuby::Models::NetworkSummary::Ipam, nil]
+      optional :ipam, -> { DockerEngineRuby::NetworkSummary::Ipam }, api_name: :IPAM
+
+      # @!attribute labels
+      #   Metadata specific to the network being created.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   Name of the network.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute options
+      #   Network-specific options uses when creating the network.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+      # @!attribute peers
+      #   List of peer nodes for an overlay network. This field is only present for
+      #   overlay networks, and omitted for other network types.
+      #
+      #   @return [Array<DockerEngineRuby::Models::NetworkSummary::Peer>, nil]
+      optional :peers,
+               -> { DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::NetworkSummary::Peer] },
+               api_name: :Peers
+
+      # @!attribute scope
+      #   The level at which the network exists (e.g. `swarm` for cluster-wide or `local`
+      #   for machine level)
+      #
+      #   @return [String, nil]
+      optional :scope, String, api_name: :Scope
+
+      # @!method initialize(attachable: nil, config_from: nil, config_only: nil, created: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, id: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, name: nil, options: nil, peers: nil, scope: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineRuby::Models::NetworkSummary} for more details.
+      #
+      #   Network list response item
+      #
+      #   @param attachable [Boolean] Whether a global / swarm scope network is manually attachable by regular
+      #
+      #   @param config_from [DockerEngineRuby::Models::NetworkSummary::ConfigFrom] The config-only network source to provide the configuration for
+      #
+      #   @param config_only [Boolean] Whether the network is a config-only network. Config-only networks are
+      #
+      #   @param created [Time] Date and time at which the network was created in
+      #
+      #   @param driver [String] The name of the driver used to create the network (e.g. `bridge`,
+      #
+      #   @param enable_i_pv4 [Boolean] Whether the network was created with IPv4 enabled.
+      #
+      #   @param enable_i_pv6 [Boolean] Whether the network was created with IPv6 enabled.
+      #
+      #   @param id [String] ID that uniquely identifies a network on a single machine.
+      #
+      #   @param ingress [Boolean] Whether the network is providing the routing-mesh for the swarm cluster.
+      #
+      #   @param internal [Boolean] Whether the network is created to only allow internal networking
+      #
+      #   @param ipam [DockerEngineRuby::Models::NetworkSummary::Ipam] The network's IP Address Management.
+      #
+      #   @param labels [Hash{Symbol=>String}] Metadata specific to the network being created.
+      #
+      #   @param name [String] Name of the network.
+      #
+      #   @param options [Hash{Symbol=>String}] Network-specific options uses when creating the network.
+      #
+      #   @param peers [Array<DockerEngineRuby::Models::NetworkSummary::Peer>] List of peer nodes for an overlay network. This field is only present
+      #
+      #   @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
+
+      # @see DockerEngineRuby::Models::NetworkSummary#config_from
+      class ConfigFrom < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute network
+        #   The name of the config-only network that provides the network's configuration.
+        #   The specified network must be an existing config-only network. Only network
+        #   names are allowed, not network IDs.
+        #
+        #   @return [String, nil]
+        optional :network, String, api_name: :Network
+
+        # @!method initialize(network: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineRuby::Models::NetworkSummary::ConfigFrom} for more details.
+        #
+        #   The config-only network source to provide the configuration for this network.
+        #
+        #   @param network [String] The name of the config-only network that provides the network's
+      end
+
+      # @see DockerEngineRuby::Models::NetworkSummary#ipam
+      class Ipam < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute config
+        #   List of IPAM configuration options, specified as a map:
+        #
+        #   ```
+        #   {"Subnet": <CIDR>, "IPRange": <CIDR>, "Gateway": <IP address>, "AuxAddress": <device_name:IP address>}
+        #   ```
+        #
+        #   @return [Array<DockerEngineRuby::Models::NetworkSummary::Ipam::Config>, nil]
+        optional :config,
+                 -> {
+                   DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::NetworkSummary::Ipam::Config]
+                 },
+                 api_name: :Config
+
+        # @!attribute driver
+        #   Name of the IPAM driver to use.
+        #
+        #   @return [String, nil]
+        optional :driver, String, api_name: :Driver
+
+        # @!attribute options
+        #   Driver-specific options, specified as a map.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(config: nil, driver: nil, options: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngineRuby::Models::NetworkSummary::Ipam} for more details.
+        #
+        #   The network's IP Address Management.
+        #
+        #   @param config [Array<DockerEngineRuby::Models::NetworkSummary::Ipam::Config>] List of IPAM configuration options, specified as a map:
+        #
+        #   @param driver [String] Name of the IPAM driver to use.
+        #
+        #   @param options [Hash{Symbol=>String}] Driver-specific options, specified as a map.
+
+        class Config < DockerEngineRuby::Internal::Type::BaseModel
+          # @!attribute auxiliary_addresses
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :auxiliary_addresses,
+                   DockerEngineRuby::Internal::Type::HashOf[String],
+                   api_name: :AuxiliaryAddresses
+
+          # @!attribute gateway
+          #
+          #   @return [String, nil]
+          optional :gateway, String, api_name: :Gateway
+
+          # @!attribute ip_range
+          #
+          #   @return [String, nil]
+          optional :ip_range, String, api_name: :IPRange
+
+          # @!attribute subnet
+          #
+          #   @return [String, nil]
+          optional :subnet, String, api_name: :Subnet
+
+          # @!method initialize(auxiliary_addresses: nil, gateway: nil, ip_range: nil, subnet: nil)
+          #   @param auxiliary_addresses [Hash{Symbol=>String}]
+          #   @param gateway [String]
+          #   @param ip_range [String]
+          #   @param subnet [String]
+        end
+      end
+
+      class Peer < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute ip
+        #   IP-address of the peer-node in the Swarm cluster.
+        #
+        #   @return [String, nil]
+        optional :ip, String, api_name: :IP
+
+        # @!attribute name
+        #   ID of the peer-node in the Swarm cluster.
+        #
+        #   @return [String, nil]
+        optional :name, String, api_name: :Name
+
+        # @!method initialize(ip: nil, name: nil)
+        #   represents one peer of an overlay network.
+        #
+        #   @param ip [String] IP-address of the peer-node in the Swarm cluster.
+        #
+        #   @param name [String] ID of the peer-node in the Swarm cluster.
+      end
+    end
+  end
+end

data/lib/docker_engine_ruby/models/node.rb

@@ -34,8 +34,8 @@ module DockerEngineRuby
 
       # @!attribute spec
       #
-      #   @return [DockerEngineRuby::Models::Spec, nil]
-      optional :spec, -> { DockerEngineRuby::Spec }, api_name: :Spec
+      #   @return [DockerEngineRuby::Models::NodeSpec, nil]
+      optional :spec, -> { DockerEngineRuby::NodeSpec }, api_name: :Spec
 
       # @!attribute status
       #   NodeStatus represents the status of a node.
@@ -78,7 +78,7 @@ module DockerEngineRuby
       #
       #   @param manager_status [DockerEngineRuby::Models::Node::ManagerStatus] ManagerStatus represents the status of a manager.
       #
-      #   @param spec [DockerEngineRuby::Models::Spec]
+      #   @param spec [DockerEngineRuby::Models::NodeSpec]
       #
       #   @param status [DockerEngineRuby::Models::Node::Status] NodeStatus represents the status of a node.
       #

data/lib/docker_engine_ruby/models/node_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    class NodeSpec < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute availability
+      #   Availability of the node.
+      #
+      #   @return [Symbol, DockerEngineRuby::Models::NodeSpec::Availability, nil]
+      optional :availability, enum: -> { DockerEngineRuby::NodeSpec::Availability }, api_name: :Availability
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   Name for the node.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute role
+      #   Role of the node.
+      #
+      #   @return [Symbol, DockerEngineRuby::Models::NodeSpec::Role, nil]
+      optional :role, enum: -> { DockerEngineRuby::NodeSpec::Role }, api_name: :Role
+
+      # @!method initialize(availability: nil, labels: nil, name: nil, role: nil)
+      #   @param availability [Symbol, DockerEngineRuby::Models::NodeSpec::Availability] Availability of the node.
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param name [String] Name for the node.
+      #
+      #   @param role [Symbol, DockerEngineRuby::Models::NodeSpec::Role] Role of the node.
+
+      # Availability of the node.
+      #
+      # @see DockerEngineRuby::Models::NodeSpec#availability
+      module Availability
+        extend DockerEngineRuby::Internal::Type::Enum
+
+        ACTIVE = :active
+        PAUSE = :pause
+        DRAIN = :drain
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Role of the node.
+      #
+      # @see DockerEngineRuby::Models::NodeSpec#role
+      module Role
+        extend DockerEngineRuby::Internal::Type::Enum
+
+        WORKER = :worker
+        MANAGER = :manager
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/docker_engine_ruby/models/secret.rb

@@ -16,8 +16,8 @@ module DockerEngineRuby
 
       # @!attribute spec
       #
-      #   @return [DockerEngineRuby::Models::Spec, nil]
-      optional :spec, -> { DockerEngineRuby::Spec }, api_name: :Spec
+      #   @return [DockerEngineRuby::Models::SecretSpec, nil]
+      optional :spec, -> { DockerEngineRuby::SecretSpec }, api_name: :Spec
 
       # @!attribute updated_at
       #
@@ -46,7 +46,7 @@ module DockerEngineRuby
       #
       #   @param id [String]
       #
-      #   @param spec [DockerEngineRuby::Models::Spec]
+      #   @param spec [DockerEngineRuby::Models::SecretSpec]
       #
       #   @param updated_at [Time]
       #

data/lib/docker_engine_ruby/models/secret_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    class SecretSpec < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute data
+      #   Data is the data to store as a secret, formatted as a standard base64-encoded
+      #   ([RFC 4648](https://tools.ietf.org/html/rfc4648#section-4)) string. It must be
+      #   empty if the Driver field is set, in which case the data is loaded from an
+      #   external secret store. The maximum allowed size is 500KB, as defined in
+      #   [MaxSecretSize](https://pkg.go.dev/github.com/moby/swarmkit/v2
+      #
+      #   @return [String, nil]
+      optional :data, String, api_name: :Data
+
+      # @!attribute driver
+      #   Driver represents a driver (network, logging, secrets).
+      #
+      #   @return [DockerEngineRuby::Models::SecretSpec::Driver, nil]
+      optional :driver, -> { DockerEngineRuby::SecretSpec::Driver }, api_name: :Driver
+
+      # @!attribute labels
+      #   User-defined key/value metadata.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels
+
+      # @!attribute name
+      #   User-defined name of the secret.
+      #
+      #   @return [String, nil]
+      optional :name, String, api_name: :Name
+
+      # @!attribute templating
+      #   Driver represents a driver (network, logging, secrets).
+      #
+      #   @return [DockerEngineRuby::Models::SecretSpec::Templating, nil]
+      optional :templating, -> { DockerEngineRuby::SecretSpec::Templating }, api_name: :Templating
+
+      # @!method initialize(data: nil, driver: nil, labels: nil, name: nil, templating: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineRuby::Models::SecretSpec} for more details.
+      #
+      #   @param data [String] Data is the data to store as a secret, formatted as a standard base64-encoded
+      #
+      #   @param driver [DockerEngineRuby::Models::SecretSpec::Driver] Driver represents a driver (network, logging, secrets).
+      #
+      #   @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      #   @param name [String] User-defined name of the secret.
+      #
+      #   @param templating [DockerEngineRuby::Models::SecretSpec::Templating] Driver represents a driver (network, logging, secrets).
+
+      # @see DockerEngineRuby::Models::SecretSpec#driver
+      class Driver < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the driver.
+        #
+        #   @return [String]
+        required :name, String, api_name: :Name
+
+        # @!attribute options
+        #   Key/value map of driver-specific options.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(name:, options: nil)
+        #   Driver represents a driver (network, logging, secrets).
+        #
+        #   @param name [String] Name of the driver.
+        #
+        #   @param options [Hash{Symbol=>String}] Key/value map of driver-specific options.
+      end
+
+      # @see DockerEngineRuby::Models::SecretSpec#templating
+      class Templating < DockerEngineRuby::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the driver.
+        #
+        #   @return [String]
+        required :name, String, api_name: :Name
+
+        # @!attribute options
+        #   Key/value map of driver-specific options.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :options, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Options
+
+        # @!method initialize(name:, options: nil)
+        #   Driver represents a driver (network, logging, secrets).
+        #
+        #   @param name [String] Name of the driver.
+        #
+        #   @param options [Hash{Symbol=>String}] Key/value map of driver-specific options.
+      end
+    end
+  end
+end

data/lib/docker_engine_ruby/models/service.rb

@@ -38,8 +38,8 @@ module DockerEngineRuby
       # @!attribute spec
       #   User modifiable configuration for a service.
       #
-      #   @return [DockerEngineRuby::Models::Spec, nil]
-      optional :spec, -> { DockerEngineRuby::Spec }, api_name: :Spec
+      #   @return [DockerEngineRuby::Models::ServiceSpec, nil]
+      optional :spec, -> { DockerEngineRuby::ServiceSpec }, api_name: :Spec
 
       # @!attribute updated_at
       #
@@ -80,7 +80,7 @@ module DockerEngineRuby
       #
       #   @param service_status [DockerEngineRuby::Models::Service::ServiceStatus] The status of the service's tasks. Provided only when requested as
       #
-      #   @param spec [DockerEngineRuby::Models::Spec] User modifiable configuration for a service.
+      #   @param spec [DockerEngineRuby::Models::ServiceSpec] User modifiable configuration for a service.
       #
       #   @param updated_at [Time]
       #

data/lib/docker_engine_ruby/models/service_create_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DockerEngineRuby
+  module Models
+    # @see DockerEngineRuby::Resources::Services#create
+    class ServiceCreateResponse < DockerEngineRuby::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the created service.
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute warnings
+      #   Optional warning message.
+      #
+      #   FIXME(thaJeztah): this should have "omitempty" in the generated type.
+      #
+      #   @return [Array<String>, nil]
+      optional :warnings, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Warnings, nil?: true
+
+      # @!method initialize(id: nil, warnings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngineRuby::Models::ServiceCreateResponse} for more details.
+      #
+      #   contains the information returned to a client on the creation of a new service.
+      #
+      #   @param id [String] The ID of the created service.
+      #
+      #   @param warnings [Array<String>, nil] Optional warning message.
+    end
+  end
+end