Class: RancherApi::ClustersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pnap_rancher_api/api/clusters_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ClustersApi

Returns a new instance of ClustersApi.



19
20
21
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#clusters_get(opts = {}) ⇒ Array<Cluster>

Cluster list. Cluster list.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 26

def clusters_get(opts = {})
  data, _status_code, _headers = clusters_get_with_http_info(opts)
  data
end

#clusters_get_with_http_info(opts = {}) ⇒ Array<(Array<Cluster>, Integer, Hash)>

Cluster list. Cluster list.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<Cluster>, Integer, Hash)>) —

    Array<Cluster> data, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 35

def clusters_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_get ...'
  end
  # resource path
  local_var_path = '/clusters'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Cluster>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"ClustersApi.clusters_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClustersApi#clusters_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#clusters_id_delete(id, opts = {}) ⇒ DeleteResult

Delete a cluster. Delete a cluster.

Parameters:

  • id (String) —

    The Cluster identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



84
85
86
87
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 84

def clusters_id_delete(id, opts = {})
  data, _status_code, _headers = clusters_id_delete_with_http_info(id, opts)
  data
end

#clusters_id_delete_with_http_info(id, opts = {}) ⇒ Array<(DeleteResult, Integer, Hash)>

Delete a cluster. Delete a cluster.

Parameters:

  • id (String) —

    The Cluster identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DeleteResult, Integer, Hash)>) —

    DeleteResult data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 94

def clusters_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ClustersApi.clusters_id_delete"
  end
  # resource path
  local_var_path = '/clusters/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteResult'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"ClustersApi.clusters_id_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClustersApi#clusters_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#clusters_id_get(id, opts = {}) ⇒ Cluster

Retrieve a Cluster Retrieve a Cluster

Parameters:

  • id (String) —

    The Cluster identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 147

def clusters_id_get(id, opts = {})
  data, _status_code, _headers = clusters_id_get_with_http_info(id, opts)
  data
end

#clusters_id_get_with_http_info(id, opts = {}) ⇒ Array<(Cluster, Integer, Hash)>

Retrieve a Cluster Retrieve a Cluster

Parameters:

  • id (String) —

    The Cluster identifier.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Cluster, Integer, Hash)>) —

    Cluster data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 157

def clusters_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ClustersApi.clusters_id_get"
  end
  # resource path
  local_var_path = '/clusters/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Cluster'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"ClustersApi.clusters_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClustersApi#clusters_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#clusters_post(cluster, opts = {}) ⇒ Cluster

Create a Rancher Server Deployment. Create a Rancher Server Deployment as described in <a href=‘rancher.com/docs/rancher/v2.5/en/overview/architecture/#rancher-server-architecture’ target=‘_blank’>Rancher Docs Architecture</a>. Rancher Server allows the creation, import and management of multiple Downstream User Kubernetes Clusters. This is not a Downstream User Cluster. Knowledge base article to help you can be found <a href=‘phoenixnap.com/kb/bmc-rancher-workload-cluster#ftoc-heading-5’ target=‘_blank’>here</a>.

Parameters:

  • cluster (Cluster)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



210
211
212
213
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 210

def clusters_post(cluster, opts = {})
  data, _status_code, _headers = clusters_post_with_http_info(cluster, opts)
  data
end

#clusters_post_with_http_info(cluster, opts = {}) ⇒ Array<(Cluster, Integer, Hash)>

Create a Rancher Server Deployment. Create a Rancher Server Deployment as described in &lt;a href&#x3D;&#39;rancher.com/docs/rancher/v2.5/en/overview/architecture/#rancher-server-architecture&#39; target&#x3D;&#39;_blank&#39;&gt;Rancher Docs Architecture&lt;/a&gt;. Rancher Server allows the creation, import and management of multiple Downstream User Kubernetes Clusters. &lt;b&gt;This is not a Downstream User Cluster&lt;/b&gt;. Knowledge base article to help you can be found &lt;a href&#x3D;&#39;phoenixnap.com/kb/bmc-rancher-workload-cluster#ftoc-heading-5&#39; target&#x3D;&#39;_blank&#39;&gt;here&lt;/a&gt;.

Parameters:

  • cluster (Cluster)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Cluster, Integer, Hash)>) —

    Cluster data, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/pnap_rancher_api/api/clusters_api.rb', line 220

def clusters_post_with_http_info(cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClustersApi.clusters_post ...'
  end
  # verify the required parameter 'cluster' is set
  if @api_client.config.client_side_validation && cluster.nil?
    fail ArgumentError, "Missing the required parameter 'cluster' when calling ClustersApi.clusters_post"
  end
  # resource path
  local_var_path = '/clusters'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(cluster)

  # return_type
  return_type = opts[:debug_return_type] || 'Cluster'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OAuth2']

  new_options = opts.merge(
    :operation => :"ClustersApi.clusters_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClustersApi#clusters_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end