docker-engine 0.1.1 → 0.2.0

data/lib/docker_engine/models/swarm.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#inspect_
+    class SwarmAPI < DockerEngine::Internal::Type::BaseModel
+      # @!attribute created_at
+      #   Date and time at which the swarm was initialised in
+      #   [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+      #
+      #   @return [String, nil]
+      optional :created_at, String, api_name: :CreatedAt
+
+      # @!attribute data_path_port
+      #   DataPathPort specifies the data path port number for data traffic. Acceptable
+      #   port range is 1024 to 49151. If no port is set or is set to 0, the default port
+      #   (4789) is used.
+      #
+      #   @return [Integer, nil]
+      optional :data_path_port, Integer, api_name: :DataPathPort
+
+      # @!attribute default_addr_pool
+      #   Default Address Pool specifies default subnet pools for global scope networks.
+      #
+      #   @return [Array<String>, nil]
+      optional :default_addr_pool, DockerEngine::Internal::Type::ArrayOf[String], api_name: :DefaultAddrPool
+
+      # @!attribute id
+      #   The ID of the swarm.
+      #
+      #   @return [String, nil]
+      optional :id, String, api_name: :ID
+
+      # @!attribute join_tokens
+      #   JoinTokens contains the tokens workers and managers need to join the swarm.
+      #
+      #   @return [DockerEngine::Models::SwarmAPI::JoinTokens, nil]
+      optional :join_tokens, -> { DockerEngine::SwarmAPI::JoinTokens }, api_name: :JoinTokens
+
+      # @!attribute root_rotation_in_progress
+      #   Whether there is currently a root CA rotation in progress for the swarm
+      #
+      #   @return [Boolean, nil]
+      optional :root_rotation_in_progress,
+               DockerEngine::Internal::Type::Boolean,
+               api_name: :RootRotationInProgress
+
+      # @!attribute spec
+      #   User modifiable swarm configuration.
+      #
+      #   @return [DockerEngine::Models::Spec, nil]
+      optional :spec, -> { DockerEngine::Spec }, api_name: :Spec
+
+      # @!attribute subnet_size
+      #   SubnetSize specifies the subnet size of the networks created from the default
+      #   subnet pool.
+      #
+      #   @return [Integer, nil]
+      optional :subnet_size, Integer, api_name: :SubnetSize
+
+      # @!attribute tls_info
+      #   Information about the issuer of leaf TLS certificates and the trusted root CA
+      #   certificate.
+      #
+      #   @return [DockerEngine::Models::SwarmAPI::TlsInfo, nil]
+      optional :tls_info, -> { DockerEngine::SwarmAPI::TlsInfo }, api_name: :TLSInfo
+
+      # @!attribute updated_at
+      #   Date and time at which the swarm was last updated in
+      #   [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
+      #
+      #   @return [String, nil]
+      optional :updated_at, String, api_name: :UpdatedAt
+
+      # @!attribute version
+      #   The version number of the object such as node, service, etc. This is needed to
+      #   avoid conflicting writes. The client must send the version number along with the
+      #   modified specification when updating these objects.
+      #
+      #   This approach ensures safe concurrency and determinism in that the change on the
+      #   object may not be applied if the version number has changed from the last read.
+      #   In other words, if two update requests specify the same base version, only one
+      #   of the requests can succeed. As a result, two separate update requests that
+      #   happen at the same time will not unintentionally overwrite each other.
+      #
+      #   @return [DockerEngine::Models::SwarmAPI::Version, nil]
+      optional :version, -> { DockerEngine::SwarmAPI::Version }, api_name: :Version
+
+      # @!method initialize(created_at: nil, data_path_port: nil, default_addr_pool: nil, id: nil, join_tokens: nil, root_rotation_in_progress: nil, spec: nil, subnet_size: nil, tls_info: nil, updated_at: nil, version: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SwarmAPI} for more details.
+      #
+      #   @param created_at [String] Date and time at which the swarm was initialised in
+      #
+      #   @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 scope
+      #
+      #   @param id [String] The ID of the swarm.
+      #
+      #   @param join_tokens [DockerEngine::Models::SwarmAPI::JoinTokens] JoinTokens contains the tokens workers and managers need to join the swarm.
+      #
+      #   @param root_rotation_in_progress [Boolean] Whether there is currently a root CA rotation in progress for the swarm
+      #
+      #   @param spec [DockerEngine::Models::Spec] User modifiable swarm configuration.
+      #
+      #   @param subnet_size [Integer] SubnetSize specifies the subnet size of the networks created from the
+      #
+      #   @param tls_info [DockerEngine::Models::SwarmAPI::TlsInfo] Information about the issuer of leaf TLS certificates and the trusted root
+      #
+      #   @param updated_at [String] Date and time at which the swarm was last updated in
+      #
+      #   @param version [DockerEngine::Models::SwarmAPI::Version] The version number of the object such as node, service, etc. This is needed
+
+      # @see DockerEngine::Models::SwarmAPI#join_tokens
+      class JoinTokens < DockerEngine::Internal::Type::BaseModel
+        # @!attribute manager
+        #   The token managers can use to join the swarm.
+        #
+        #   @return [String, nil]
+        optional :manager, String, api_name: :Manager
+
+        # @!attribute worker
+        #   The token workers can use to join the swarm.
+        #
+        #   @return [String, nil]
+        optional :worker, String, api_name: :Worker
+
+        # @!method initialize(manager: nil, worker: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::SwarmAPI::JoinTokens} for more details.
+        #
+        #   JoinTokens contains the tokens workers and managers need to join the swarm.
+        #
+        #   @param manager [String] The token managers can use to join the swarm.
+        #
+        #   @param worker [String] The token workers can use to join the swarm.
+      end
+
+      # @see DockerEngine::Models::SwarmAPI#tls_info
+      class TlsInfo < DockerEngine::Internal::Type::BaseModel
+        # @!attribute cert_issuer_public_key
+        #   The base64-url-safe-encoded raw public key bytes of the issuer.
+        #
+        #   @return [String, nil]
+        optional :cert_issuer_public_key, String, api_name: :CertIssuerPublicKey
+
+        # @!attribute cert_issuer_subject
+        #   The base64-url-safe-encoded raw subject bytes of the issuer.
+        #
+        #   @return [String, nil]
+        optional :cert_issuer_subject, String, api_name: :CertIssuerSubject
+
+        # @!attribute trust_root
+        #   The root CA certificate(s) that are used to validate leaf TLS certificates.
+        #
+        #   @return [String, nil]
+        optional :trust_root, String, api_name: :TrustRoot
+
+        # @!method initialize(cert_issuer_public_key: nil, cert_issuer_subject: nil, trust_root: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {DockerEngine::Models::SwarmAPI::TlsInfo} for more details.
+        #
+        #   Information about the issuer of leaf TLS certificates and the trusted root CA
+        #   certificate.
+        #
+        #   @param cert_issuer_public_key [String] The base64-url-safe-encoded raw public key bytes of the issuer.
+        #
+        #   @param cert_issuer_subject [String] The base64-url-safe-encoded raw subject bytes of the issuer.
+        #
+        #   @param trust_root [String] The root CA certificate(s) that are used to validate leaf TLS
+      end
+
+      # @see DockerEngine::Models::SwarmAPI#version
+      class Version < DockerEngine::Internal::Type::BaseModel
+        # @!attribute index
+        #
+        #   @return [Integer, nil]
+        optional :index, Integer, api_name: :Index
+
+        # @!method initialize(index: nil)
+        #   The version number of the object such as node, service, etc. This is needed to
+        #   avoid conflicting writes. The client must send the version number along with the
+        #   modified specification when updating these objects.
+        #
+        #   This approach ensures safe concurrency and determinism in that the change on the
+        #   object may not be applied if the version number has changed from the last read.
+        #   In other words, if two update requests specify the same base version, only one
+        #   of the requests can succeed. As a result, two separate update requests that
+        #   happen at the same time will not unintentionally overwrite each other.
+        #
+        #   @param index [Integer]
+      end
+    end
+  end
+end

data/lib/docker_engine/models/swarm_init_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#init
+    class SwarmInitParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute advertise_addr
+      #   Externally reachable address advertised to other nodes. This can either be an
+      #   address/port combination in the form `192.168.1.1:4567`, or an interface
+      #   followed by a port number, like `eth0:4567`. If the port number is omitted, the
+      #   port number from the listen address is used. If `AdvertiseAddr` is not
+      #   specified, it will be automatically detected when possible.
+      #
+      #   @return [String, nil]
+      optional :advertise_addr, String, api_name: :AdvertiseAddr
+
+      # @!attribute data_path_addr
+      #   Address or interface to use for data path traffic (format: `<ip|interface>`),
+      #   for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
+      #   unspecified, the same address as `AdvertiseAddr` is used.
+      #
+      #   The `DataPathAddr` specifies the address that global scope network drivers will
+      #   publish towards other nodes in order to reach the containers running on this
+      #   node. Using this parameter it is possible to separate the container data traffic
+      #   from the management traffic of the cluster.
+      #
+      #   @return [String, nil]
+      optional :data_path_addr, String, api_name: :DataPathAddr
+
+      # @!attribute data_path_port
+      #   DataPathPort specifies the data path port number for data traffic. Acceptable
+      #   port range is 1024 to 49151. if no port is set or is set to 0, default port 4789
+      #   will be used.
+      #
+      #   @return [Integer, nil]
+      optional :data_path_port, Integer, api_name: :DataPathPort
+
+      # @!attribute default_addr_pool
+      #   Default Address Pool specifies default subnet pools for global scope networks.
+      #
+      #   @return [Array<String>, nil]
+      optional :default_addr_pool, DockerEngine::Internal::Type::ArrayOf[String], api_name: :DefaultAddrPool
+
+      # @!attribute force_new_cluster
+      #   Force creation of a new swarm.
+      #
+      #   @return [Boolean, nil]
+      optional :force_new_cluster, DockerEngine::Internal::Type::Boolean, api_name: :ForceNewCluster
+
+      # @!attribute listen_addr
+      #   Listen address used for inter-manager communication, as well as determining the
+      #   networking interface used for the VXLAN Tunnel Endpoint (VTEP). This can either
+      #   be an address/port combination in the form `192.168.1.1:4567`, or an interface
+      #   followed by a port number, like `eth0:4567`. If the port number is omitted, the
+      #   default swarm listening port is used.
+      #
+      #   @return [String, nil]
+      optional :listen_addr, String, api_name: :ListenAddr
+
+      # @!attribute spec
+      #   User modifiable swarm configuration.
+      #
+      #   @return [DockerEngine::Models::Spec, nil]
+      optional :spec, -> { DockerEngine::Spec }, api_name: :Spec
+
+      # @!attribute subnet_size
+      #   SubnetSize specifies the subnet size of the networks created from the default
+      #   subnet pool.
+      #
+      #   @return [Integer, nil]
+      optional :subnet_size, Integer, api_name: :SubnetSize
+
+      # @!method initialize(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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SwarmInitParams} for more details.
+      #
+      #   @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 [DockerEngine::Models::Spec] User modifiable swarm configuration.
+      #
+      #   @param subnet_size [Integer] SubnetSize specifies the subnet size of the networks created
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/swarm_init_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    SwarmInitResponse = String
+  end
+end

data/lib/docker_engine/models/swarm_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#inspect_
+    class SwarmInspectParams < 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/swarm_join_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#join
+    class SwarmJoinParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute advertise_addr
+      #   Externally reachable address advertised to other nodes. This can either be an
+      #   address/port combination in the form `192.168.1.1:4567`, or an interface
+      #   followed by a port number, like `eth0:4567`. If the port number is omitted, the
+      #   port number from the listen address is used. If `AdvertiseAddr` is not
+      #   specified, it will be automatically detected when possible.
+      #
+      #   @return [String, nil]
+      optional :advertise_addr, String, api_name: :AdvertiseAddr
+
+      # @!attribute data_path_addr
+      #   Address or interface to use for data path traffic (format: `<ip|interface>`),
+      #   for example, `192.168.1.1`, or an interface, like `eth0`. If `DataPathAddr` is
+      #   unspecified, the same address as `AdvertiseAddr` is used.
+      #
+      #   The `DataPathAddr` specifies the address that global scope network drivers will
+      #   publish towards other nodes in order to reach the containers running on this
+      #   node. Using this parameter it is possible to separate the container data traffic
+      #   from the management traffic of the cluster.
+      #
+      #   @return [String, nil]
+      optional :data_path_addr, String, api_name: :DataPathAddr
+
+      # @!attribute join_token
+      #   Secret token for joining this swarm.
+      #
+      #   @return [String, nil]
+      optional :join_token, String, api_name: :JoinToken
+
+      # @!attribute listen_addr
+      #   Listen address used for inter-manager communication if the node gets promoted to
+      #   manager, as well as determining the networking interface used for the VXLAN
+      #   Tunnel Endpoint (VTEP).
+      #
+      #   @return [String, nil]
+      optional :listen_addr, String, api_name: :ListenAddr
+
+      # @!attribute remote_addrs
+      #   Addresses of manager nodes already participating in the swarm.
+      #
+      #   @return [Array<String>, nil]
+      optional :remote_addrs, DockerEngine::Internal::Type::ArrayOf[String], api_name: :RemoteAddrs
+
+      # @!method initialize(advertise_addr: nil, data_path_addr: nil, join_token: nil, listen_addr: nil, remote_addrs: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SwarmJoinParams} for more details.
+      #
+      #   @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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/swarm_leave_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#leave
+    class SwarmLeaveParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute force
+      #   Force leave swarm, even if this is the last manager or that it will break the
+      #   cluster.
+      #
+      #   @return [Boolean, nil]
+      optional :force, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(force: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SwarmLeaveParams} for more details.
+      #
+      #   @param force [Boolean] Force leave swarm, even if this is the last manager or that it will
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/swarm_unlock_key_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#unlock_key
+    class SwarmUnlockKeyParams < 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/swarm_unlock_key_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#unlock_key
+    class SwarmUnlockKeyResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute unlock_key
+      #   The swarm's unlock key.
+      #
+      #   @return [String, nil]
+      optional :unlock_key, String, api_name: :UnlockKey
+
+      # @!method initialize(unlock_key: nil)
+      #   @param unlock_key [String] The swarm's unlock key.
+    end
+  end
+end

data/lib/docker_engine/models/swarm_unlock_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#unlock
+    class SwarmUnlockParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute unlock_key
+      #   The swarm's unlock key.
+      #
+      #   @return [String, nil]
+      optional :unlock_key, String, api_name: :UnlockKey
+
+      # @!method initialize(unlock_key: nil, request_options: {})
+      #   @param unlock_key [String] The swarm's unlock key.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/swarm_update_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Swarm#update
+    class SwarmUpdateParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute version
+      #   The version number of the swarm object being updated. This is required to avoid
+      #   conflicting writes.
+      #
+      #   @return [Integer]
+      required :version, Integer
+
+      # @!attribute rotate_manager_token
+      #   Rotate the manager join token.
+      #
+      #   @return [Boolean, nil]
+      optional :rotate_manager_token, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute rotate_manager_unlock_key
+      #   Rotate the manager unlock key.
+      #
+      #   @return [Boolean, nil]
+      optional :rotate_manager_unlock_key, DockerEngine::Internal::Type::Boolean
+
+      # @!attribute rotate_worker_token
+      #   Rotate the worker join token.
+      #
+      #   @return [Boolean, nil]
+      optional :rotate_worker_token, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(version:, rotate_manager_token: nil, rotate_manager_unlock_key: nil, rotate_worker_token: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SwarmUpdateParams} for more details.
+      #
+      #   @param version [Integer] The version number of the swarm object being updated. This is
+      #
+      #   @param rotate_manager_token [Boolean] Rotate the manager join token.
+      #
+      #   @param rotate_manager_unlock_key [Boolean] Rotate the manager unlock key.
+      #
+      #   @param rotate_worker_token [Boolean] Rotate the worker join token.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/system_data_usage_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::System#data_usage
+    class SystemDataUsageParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute type
+      #   Object types, for which to compute and return data.
+      #
+      #   @return [Array<Symbol, DockerEngine::Models::SystemDataUsageParams::Type>, nil]
+      optional :type,
+               -> { DockerEngine::Internal::Type::ArrayOf[enum: DockerEngine::SystemDataUsageParams::Type] }
+
+      # @!attribute verbose
+      #   Show detailed information on space usage.
+      #
+      #   @return [Boolean, nil]
+      optional :verbose, DockerEngine::Internal::Type::Boolean
+
+      # @!method initialize(type: nil, verbose: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::SystemDataUsageParams} for more details.
+      #
+      #   @param type [Array<Symbol, DockerEngine::Models::SystemDataUsageParams::Type>] Object types, for which to compute and return data.
+      #
+      #   @param verbose [Boolean] Show detailed information on space usage.
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+
+      module Type
+        extend DockerEngine::Internal::Type::Enum
+
+        CONTAINER = :container
+        IMAGE = :image
+        VOLUME = :volume
+        BUILD_CACHE = :"build-cache"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end