Class: Morpheus::ClustersInterface
Constant Summary
Constants inherited
from APIClient
APIClient::CLIENT_ID
Instance Attribute Summary
Attributes inherited from APIClient
#client_id
Instance Method Summary
collapse
-
#add_server(id, payload) ⇒ Object
-
#api_config(id, params = {}) ⇒ Object
-
#cluster_types(params = {}) ⇒ Object
-
#create(payload) ⇒ Object
-
#create_namespace(id, payload) ⇒ Object
-
#destroy(id, params = {}) ⇒ Object
(also: #delete)
-
#destroy_container(id, container_id, params = {}) ⇒ Object
-
#destroy_container_group(id, container_group_id, resource_type, params = {}) ⇒ Object
-
#destroy_job(id, job_id = nil, params = {}, payload = {}) ⇒ Object
-
#destroy_namespace(id, namespace_id, params = {}) ⇒ Object
(also: #delete_namespace)
-
#destroy_service(id, service_id = nil, params = {}, payload = {}) ⇒ Object
this supports multiple ids.
-
#destroy_volume(id, volume_id = nil, params = {}, payload = {}) ⇒ Object
(also: #delete_volume)
this supports multiple ids.
-
#get(params = {}) ⇒ Object
-
#get_datastore(id, datastore_id, params = {}) ⇒ Object
-
#get_namespace(id, namespace_id, params = {}) ⇒ Object
-
#history(id, params = {}) ⇒ Object
-
#history_details(id, process_id, params = {}) ⇒ Object
-
#history_event_details(id, process_event_id, params = {}) ⇒ Object
-
#initialize(access_token, refresh_token, expires_at = nil, base_url = nil, api = 'clusters') ⇒ ClustersInterface
constructor
A new instance of ClustersInterface.
-
#list(params = {}) ⇒ Object
-
#list_container_groups(id, resource_type, params = {}) ⇒ Object
-
#list_containers(id, params = {}) ⇒ Object
-
#list_datastores(id, params = {}) ⇒ Object
-
#list_jobs(id, params = {}) ⇒ Object
-
#list_masters(id, params = {}) ⇒ Object
-
#list_namespaces(id, params = {}) ⇒ Object
-
#list_services(id, params = {}) ⇒ Object
-
#list_volumes(id, params = {}) ⇒ Object
-
#list_workers(id, params = {}) ⇒ Object
-
#restart_container(id, container_id, params = {}) ⇒ Object
-
#restart_container_group(id, container_group_id, resource_type, params = {}) ⇒ Object
-
#update(id, payload) ⇒ Object
-
#update_datastore(id, datastore_id, payload) ⇒ Object
-
#update_namespace(id, namespace_id, payload) ⇒ Object
-
#update_permissions(id, payload) ⇒ Object
-
#update_wiki(id, payload) ⇒ Object
-
#wiki(id, params) ⇒ Object
Methods inherited from APIClient
#account_groups, #accounts, #activity, #appliance_settings, #approvals, #apps, #archive_buckets, #archive_files, #auth, #authorization_required?, #backup_jobs, #backup_settings, #backups, #billing, #blueprints, #budgets, #catalog, #catalog_item_types, #cloud_datastores, #cloud_folders, #cloud_policies, #cloud_resource_pools, #clouds, #clusters, #common_interface_options, #containers, #custom_instance_types, #cypher, #dashboard, #datastores, #default_content_type, #default_timeout, #deploy, #deployments, #doc, #dry, #dry_run, #environments, #execute, #execute_schedules, #execution_request, #file_copy_request, #forgot, #group_policies, #groups, #guidance, #health, #image_builder, #inspect, #instance_types, #instances, #integrations, #invoice_line_items, #invoices, #jobs, #key_pairs, #library_cluster_layouts, #library_container_scripts, #library_container_templates, #library_container_types, #library_container_upgrades, #library_instance_types, #library_layouts, #library_spec_template_types, #library_spec_templates, #license, #load_balancers, #log_settings, #logged_in?, #login, #logout, #logs, #monitoring, #network_domain_records, #network_domains, #network_groups, #network_pool_ips, #network_pool_servers, #network_pools, #network_proxies, #network_routers, #network_security_servers, #network_services, #network_types, #networks, #old_cypher, #option_type_lists, #option_types, #options, #packages, #ping, #policies, #power_schedules, #price_sets, #prices, #processes, #projects, #provision_types, #provisioning_license_types, #provisioning_licenses, #provisioning_settings, #reports, #roles, #search, #security_group_rules, #security_groups, #server_types, #servers, #service_plans, #set_ssl_verification_enabled, #setopts, #setup, #ssl_verification_enabled?, #storage_providers, #subnet_types, #subnets, #task_sets, #tasks, #to_s, #url, #usage, #use_refresh_token, #user_groups, #user_settings, #user_sources, #users, #virtual_images, #whitelabel_settings, #whoami, #withopts
Constructor Details
#initialize(access_token, refresh_token, expires_at = nil, base_url = nil, api = 'clusters') ⇒ ClustersInterface
Returns a new instance of ClustersInterface.
4
5
6
7
8
9
10
|
# File 'lib/morpheus/api/clusters_interface.rb', line 4
def initialize(access_token, refresh_token,expires_at = nil, base_url=nil, api='clusters')
@access_token = access_token
@refresh_token = refresh_token
@base_url = base_url
@api_url = "#{base_url}/api/#{api}"
@expires_at = expires_at
end
|
Instance Method Details
#add_server(id, payload) ⇒ Object
118
119
120
121
122
|
# File 'lib/morpheus/api/clusters_interface.rb', line 118
def add_server(id, payload)
url = "#{@api_url}/#{id}/servers"
= { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :post, url: url, headers: , payload: payload.to_json)
end
|
#api_config(id, params = {}) ⇒ Object
261
262
263
264
265
|
# File 'lib/morpheus/api/clusters_interface.rb', line 261
def api_config(id, params={})
url = "#{@api_url}/#{id}/api-config"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#cluster_types(params = {}) ⇒ Object
52
53
54
55
56
57
|
# File 'lib/morpheus/api/clusters_interface.rb', line 52
def cluster_types(params={})
url = "#{@base_url}/api/cluster-types"
= { params: params, authorization: "Bearer #{@access_token}" }
opts = {method: :get, url: url, headers: }
execute(opts)
end
|
#create(payload) ⇒ Object
32
33
34
35
36
|
# File 'lib/morpheus/api/clusters_interface.rb', line 32
def create(payload)
url = @api_url
= { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :post, url: url, headers: , payload: payload.to_json)
end
|
#create_namespace(id, payload) ⇒ Object
159
160
161
162
163
|
# File 'lib/morpheus/api/clusters_interface.rb', line 159
def create_namespace(id, payload)
url = "#{@api_url}/#{id}/namespaces"
= { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :post, url: url, headers: , payload: payload.to_json)
end
|
#destroy(id, params = {}) ⇒ Object
Also known as:
delete
44
45
46
47
48
|
# File 'lib/morpheus/api/clusters_interface.rb', line 44
def destroy(id, params={})
url = "#{@api_url}/#{id}"
= { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :delete, url: url, headers: )
end
|
#destroy_container(id, container_id, params = {}) ⇒ Object
191
192
193
194
195
196
197
198
199
200
201
202
|
# File 'lib/morpheus/api/clusters_interface.rb', line 191
def destroy_container(id, container_id, params={})
if container_id.is_a?(Array)
url = "#{@api_url}/#{id}/containers"
params['containerId'] = container_id
elsif container_id.is_a?(Numeric) || container_id.is_a?(String)
url = "#{@api_url}/#{id}/containers/#{container_id}"
else
raise "passed a bad container_id: #{container_id || '(none)'}" end
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :delete, url: url, headers: )
end
|
#destroy_container_group(id, container_group_id, resource_type, params = {}) ⇒ Object
216
217
218
219
220
221
222
223
224
225
226
227
|
# File 'lib/morpheus/api/clusters_interface.rb', line 216
def destroy_container_group(id, container_group_id, resource_type, params={})
if container_group_id.is_a?(Array)
url = "#{@api_url}/#{id}/#{resource_type}s"
params['containerGroupId'] = container_group_id
elsif container_group_id.is_a?(Numeric) || container_group_id.is_a?(String)
url = "#{@api_url}/#{id}/#{resource_type}s/#{container_group_id}"
else
raise "passed a bad container_group_id: #{container_group_id || '(none)'}" end
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :delete, url: url, headers: )
end
|
#destroy_job(id, job_id = nil, params = {}, payload = {}) ⇒ Object
71
72
73
74
75
76
77
78
79
80
81
82
83
|
# File 'lib/morpheus/api/clusters_interface.rb', line 71
def destroy_job(id, job_id=nil, params={}, payload={})
url = nil
if job_id.is_a?(Array)
url = "#{@api_url}/#{id}/jobs"
params['jobId'] = job_id
elsif job_id.is_a?(Numeric) || job_id.is_a?(String)
url = "#{@api_url}/#{id}/jobs/#{job_id}"
else
raise "passed a bad volume_id: #{job_id || '(none)'}" end
= { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :delete, url: url, headers: , payload: payload.to_json)
end
|
#destroy_namespace(id, namespace_id, params = {}) ⇒ Object
Also known as:
delete_namespace
171
172
173
174
175
|
# File 'lib/morpheus/api/clusters_interface.rb', line 171
def destroy_namespace(id, namespace_id, params={})
url = "#{@api_url}/#{id}/namespaces/#{namespace_id}"
= { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :delete, url: url, headers: )
end
|
#destroy_service(id, service_id = nil, params = {}, payload = {}) ⇒ Object
this supports multiple ids
104
105
106
107
108
109
110
111
112
113
114
115
116
|
# File 'lib/morpheus/api/clusters_interface.rb', line 104
def destroy_service(id, service_id=nil, params={}, payload={})
url = nil
if service_id.is_a?(Array)
url = "#{@api_url}/#{id}/services"
params['serviceId'] = service_id
elsif service_id.is_a?(Numeric) || service_id.is_a?(String)
url = "#{@api_url}/#{id}/services/#{service_id}"
else
raise "passed a bad volume_id: #{service_id || '(none)'}" end
= { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :delete, url: url, headers: , payload: payload.to_json)
end
|
#destroy_volume(id, volume_id = nil, params = {}, payload = {}) ⇒ Object
Also known as:
delete_volume
this supports multiple ids
131
132
133
134
135
136
137
138
139
140
141
142
143
|
# File 'lib/morpheus/api/clusters_interface.rb', line 131
def destroy_volume(id, volume_id=nil, params={}, payload={})
url = nil
if volume_id.is_a?(Array)
url = "#{@api_url}/#{id}/volumes"
params['volumeId'] = volume_id
elsif volume_id.is_a?(Numeric) || volume_id.is_a?(String)
url = "#{@api_url}/#{id}/volumes/#{volume_id}"
else
raise "passed a bad volume_id: #{volume_id || '(none)'}" end
= { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :delete, url: url, headers: , payload: payload.to_json)
end
|
#get(params = {}) ⇒ Object
18
19
20
21
22
23
24
25
26
27
28
29
30
|
# File 'lib/morpheus/api/clusters_interface.rb', line 18
def get(params={})
url = @api_url
= { params: {}, authorization: "Bearer #{@access_token}" }
if params.is_a?(Hash)
[:params].merge!(params)
elsif params.is_a?(Numeric)
url = "#{@api_url}/#{params}"
elsif params.is_a?(String)
[:params]['name'] = params
end
execute(method: :get, url: url, headers: )
end
|
#get_datastore(id, datastore_id, params = {}) ⇒ Object
235
236
237
238
239
|
# File 'lib/morpheus/api/clusters_interface.rb', line 235
def get_datastore(id, datastore_id, params={})
url = "#{@api_url}/#{id}/datastores/#{datastore_id}"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#get_namespace(id, namespace_id, params = {}) ⇒ Object
153
154
155
156
157
|
# File 'lib/morpheus/api/clusters_interface.rb', line 153
def get_namespace(id, namespace_id, params={})
url = "#{@api_url}/#{id}/namespaces/#{namespace_id}"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#history(id, params = {}) ⇒ Object
267
268
269
270
271
272
|
# File 'lib/morpheus/api/clusters_interface.rb', line 267
def history(id, params={})
url = "#{@base_url}/api/clusters/#{id}/history"
= { params: params, authorization: "Bearer #{@access_token}" }
opts = {method: :get, url: url, headers: }
execute(opts)
end
|
#history_details(id, process_id, params = {}) ⇒ Object
274
275
276
277
278
279
|
# File 'lib/morpheus/api/clusters_interface.rb', line 274
def history_details(id, process_id, params={})
url = "#{@base_url}/api/clusters/#{id}/history/#{process_id}"
= { params: params, authorization: "Bearer #{@access_token}" }
opts = {method: :get, url: url, headers: }
execute(opts)
end
|
#history_event_details(id, process_event_id, params = {}) ⇒ Object
281
282
283
284
285
286
|
# File 'lib/morpheus/api/clusters_interface.rb', line 281
def history_event_details(id, process_event_id, params={})
url = "#{@base_url}/api/clusters/#{id}/history/events/#{process_event_id}"
= { params: params, authorization: "Bearer #{@access_token}" }
opts = {method: :get, url: url, headers: }
execute(opts)
end
|
#list(params = {}) ⇒ Object
12
13
14
15
16
|
# File 'lib/morpheus/api/clusters_interface.rb', line 12
def list(params={})
url = @api_url
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_container_groups(id, resource_type, params = {}) ⇒ Object
204
205
206
207
208
|
# File 'lib/morpheus/api/clusters_interface.rb', line 204
def list_container_groups(id, resource_type, params={})
url = "#{@api_url}/#{id}/#{resource_type}s"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_containers(id, params = {}) ⇒ Object
179
180
181
182
183
|
# File 'lib/morpheus/api/clusters_interface.rb', line 179
def list_containers(id, params={})
url = "#{@api_url}/#{id}/containers"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_datastores(id, params = {}) ⇒ Object
229
230
231
232
233
|
# File 'lib/morpheus/api/clusters_interface.rb', line 229
def list_datastores(id, params={})
url = "#{@api_url}/#{id}/datastores"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_jobs(id, params = {}) ⇒ Object
65
66
67
68
69
|
# File 'lib/morpheus/api/clusters_interface.rb', line 65
def list_jobs(id, params={})
url = "#{@api_url}/#{id}/jobs"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_masters(id, params = {}) ⇒ Object
85
86
87
88
89
|
# File 'lib/morpheus/api/clusters_interface.rb', line 85
def list_masters(id, params={})
url = "#{@api_url}/#{id}/masters"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_namespaces(id, params = {}) ⇒ Object
147
148
149
150
151
|
# File 'lib/morpheus/api/clusters_interface.rb', line 147
def list_namespaces(id, params={})
url = "#{@api_url}/#{id}/namespaces"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_services(id, params = {}) ⇒ Object
97
98
99
100
101
|
# File 'lib/morpheus/api/clusters_interface.rb', line 97
def list_services(id, params={})
url = "#{@api_url}/#{id}/services"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_volumes(id, params = {}) ⇒ Object
124
125
126
127
128
|
# File 'lib/morpheus/api/clusters_interface.rb', line 124
def list_volumes(id, params={})
url = "#{@api_url}/#{id}/volumes"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#list_workers(id, params = {}) ⇒ Object
91
92
93
94
95
|
# File 'lib/morpheus/api/clusters_interface.rb', line 91
def list_workers(id, params={})
url = "#{@api_url}/#{id}/workers"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :get, url: url, headers: )
end
|
#restart_container(id, container_id, params = {}) ⇒ Object
185
186
187
188
189
|
# File 'lib/morpheus/api/clusters_interface.rb', line 185
def restart_container(id, container_id, params={})
url = "#{@api_url}/#{id}/containers/#{container_id}/restart"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :put, url: url, headers: )
end
|
#restart_container_group(id, container_group_id, resource_type, params = {}) ⇒ Object
210
211
212
213
214
|
# File 'lib/morpheus/api/clusters_interface.rb', line 210
def restart_container_group(id, container_group_id, resource_type, params={})
url = "#{@api_url}/#{id}/#{resource_type}s/#{container_group_id}/restart"
= { params: params, authorization: "Bearer #{@access_token}" }
execute(method: :put, url: url, headers: )
end
|
#update(id, payload) ⇒ Object
38
39
40
41
42
|
# File 'lib/morpheus/api/clusters_interface.rb', line 38
def update(id, payload)
url = "#{@api_url}/#{id}"
= { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :put, url: url, headers: , payload: payload.to_json)
end
|
#update_datastore(id, datastore_id, payload) ⇒ Object
241
242
243
244
245
|
# File 'lib/morpheus/api/clusters_interface.rb', line 241
def update_datastore(id, datastore_id, payload)
url = "#{@api_url}/#{id}/datastores/#{datastore_id}"
= { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :put, url: url, headers: , payload: payload.to_json)
end
|
#update_namespace(id, namespace_id, payload) ⇒ Object
165
166
167
168
169
|
# File 'lib/morpheus/api/clusters_interface.rb', line 165
def update_namespace(id, namespace_id, payload)
url = "#{@api_url}/#{id}/namespaces/#{namespace_id}"
= { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :put, url: url, headers: , payload: payload.to_json)
end
|
#update_permissions(id, payload) ⇒ Object
59
60
61
62
63
|
# File 'lib/morpheus/api/clusters_interface.rb', line 59
def update_permissions(id, payload)
url = "#{@api_url}/#{id}/permissions"
= { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
execute(method: :put, url: url, headers: , payload: payload.to_json)
end
|
#update_wiki(id, payload) ⇒ Object
254
255
256
257
258
259
|
# File 'lib/morpheus/api/clusters_interface.rb', line 254
def update_wiki(id, payload)
url = "#{@base_url}/api/clusters/#{id}/wiki"
= {authorization: "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
opts = {method: :put, url: url, headers: , payload: payload.to_json}
execute(opts)
end
|
#wiki(id, params) ⇒ Object
247
248
249
250
251
252
|
# File 'lib/morpheus/api/clusters_interface.rb', line 247
def wiki(id, params)
url = "#{@base_url}/api/clusters/#{id}/wiki"
= { params: params, authorization: "Bearer #{@access_token}" }
opts = {method: :get, url: url, headers: }
execute(opts)
end
|