Class: DockerEngineRuby::Resources::Swarm

Inherits:
Object
  • Object
show all
Defined in:
lib/docker_engine_ruby/resources/swarm.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Swarm

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Swarm.

Parameters:



164
165
166
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 164

def initialize(client:)
  @client = client
end

Instance Method Details

#init(advertise_addr: nil, data_path_addr: nil, data_path_port: nil, default_addr_pool: nil, force_new_cluster: nil, listen_addr: nil, spec: nil, subnet_size: nil, request_options: {}) ⇒ String

Initialize a new swarm

Parameters:

  • advertise_addr (String)
  • data_path_addr (String)
  • data_path_port (Integer)
  • default_addr_pool (Array<String>)
  • force_new_cluster (Boolean)
  • listen_addr (String)
  • spec (DockerEngineRuby::Models::SwarmSpec) —

    User modifiable swarm configuration.

  • subnet_size (Integer)
  • request_options (DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (String)

See Also:



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 63

def init(params = {})
  parsed, options = DockerEngineRuby::SwarmInitParams.dump_request(params)
  @client.request(
    method: :post,
    path: "swarm/init",
    headers: {"accept" => "text/plain"},
    body: parsed,
    model: String,
    options: options
  )
end

#inspect_(request_options: {}) ⇒ DockerEngineRuby::Models::SwarmAPI

Inspect swarm

Parameters:

Returns:

See Also:



84
85
86
87
88
89
90
91
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 84

def inspect_(params = {})
  @client.request(
    method: :get,
    path: "swarm",
    model: DockerEngineRuby::SwarmAPI,
    options: params[:request_options]
  )
end

#join(advertise_addr: nil, data_path_addr: nil, join_token: nil, listen_addr: nil, remote_addrs: nil, request_options: {}) ⇒ nil

Join an existing swarm

Parameters:

  • advertise_addr (String)
  • data_path_addr (String)
  • join_token (String)
  • listen_addr (String)
  • remote_addrs (Array<String>)
  • request_options (DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



107
108
109
110
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 107

def join(params = {})
  parsed, options = DockerEngineRuby::SwarmJoinParams.dump_request(params)
  @client.request(method: :post, path: "swarm/join", body: parsed, model: NilClass, options: options)
end

#leave(force: nil, request_options: {}) ⇒ nil

Leave a swarm

Parameters:

Returns:

  • (nil)

See Also:



122
123
124
125
126
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 122

def leave(params = {})
  parsed, options = DockerEngineRuby::SwarmLeaveParams.dump_request(params)
  query = DockerEngineRuby::Internal::Util.encode_query_params(parsed)
  @client.request(method: :post, path: "swarm/leave", query: query, model: NilClass, options: options)
end

#unlock(unlock_key: nil, request_options: {}) ⇒ nil

Unlock a locked manager

Parameters:

Returns:

  • (nil)

See Also:



138
139
140
141
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 138

def unlock(params = {})
  parsed, options = DockerEngineRuby::SwarmUnlockParams.dump_request(params)
  @client.request(method: :post, path: "swarm/unlock", body: parsed, model: NilClass, options: options)
end

#unlock_key(request_options: {}) ⇒ DockerEngineRuby::Models::SwarmUnlockKeyResponse

Get the unlock key

Parameters:

Returns:

See Also:



152
153
154
155
156
157
158
159
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 152

def unlock_key(params = {})
  @client.request(
    method: :get,
    path: "swarm/unlockkey",
    model: DockerEngineRuby::Models::SwarmUnlockKeyResponse,
    options: params[:request_options]
  )
end

#update(version:, spec:, rotate_manager_token: nil, rotate_manager_unlock_key: nil, rotate_worker_token: nil, request_options: {}) ⇒ nil

Update a swarm

Parameters:

  • version (Integer) —

    Query param

  • spec (DockerEngineRuby::Models::SwarmSpec) —

    Body param: User modifiable swarm configuration.

  • rotate_manager_token (Boolean) —

    Query param

  • rotate_manager_unlock_key (Boolean) —

    Query param

  • rotate_worker_token (Boolean) —

    Query param

  • request_options (DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/docker_engine_ruby/resources/swarm.rb', line 25

def update(params)
  parsed, options = DockerEngineRuby::SwarmUpdateParams.dump_request(params)
  query = DockerEngineRuby::Internal::Util.encode_query_params(parsed.except(:spec))
  @client.request(
    method: :post,
    path: "swarm/update",
    query: query,
    body: parsed[:spec],
    model: NilClass,
    options: options
  )
end