clusters

Creates, updates, deletes, gets or lists a clusters resource.

Overview

Name	clusters
Type	Resource
Id	ovh.cluster_hadoop.clusters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Service name of your Cluster
cloudera_version	string	CDH and Cloudera Manager version (wire: clouderaVersion)
iam	object	IAM resource metadata
max_orderable_nodes	integer	Maximum quantity of nodes allowed to be ordered in the cluster (wire: maxOrderableNodes)
state	string	State of the Hadoop Cluster (created, creating, deleted, deleting, delivered, delivering, toDeliver)

list

Managed Hadoop Cluster

Name	Datatype	Description
name	string	Service name of your Cluster
cloudera_version	string	CDH and Cloudera Manager version (wire: clouderaVersion)
iam	object	IAM resource metadata
max_orderable_nodes	integer	Maximum quantity of nodes allowed to be ordered in the cluster (wire: maxOrderableNodes)
state	string	State of the Hadoop Cluster (created, creating, deleted, deleting, delivered, delivering, toDeliver)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get this object properties
list	select		iam_tags, x_pagination_mode	List available services
order_new_node_hourly	exec	serviceName, nodeProfile		Order a new node in the cluster
restart	exec	serviceName		Restart the Cloudera Manager Hadoop Cluster (THIS ACTION WILL RESTART EVERY SERVICE)
service_restart	exec	serviceName, service		Restart a Cloudera Manager service (THIS ACTION WILL RESTART OTHER DEPENDANT SERVICES)
service_start	exec	serviceName, service		Start a Cloudera Manager service
service_stop	exec	serviceName, service		Stop a Cloudera Manager service (THIS ACTION WILL STOP OTHER DEPENDANT SERVICES)
start	exec	serviceName		Start the Cloudera Manager Hadoop Cluster
stop	exec	serviceName		Stop a Cloudera Manager Hadoop Cluster (THIS ACTION WILL STOP EVERY SERVICE)
terminate	exec	serviceName		Terminate your service. THE CLUSTER WILL BE DELETED. ALL YOUR DATA WILL BE LOST

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
serviceName	string	The internal name of your cluster
service_name	string	The internal name of your cluster (wire: serviceName)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get this object properties

SELECT
name,
cloudera_version,
iam,
max_orderable_nodes,
state
FROM ovh.cluster_hadoop.clusters
WHERE service_name = '{{ service_name }}' -- required
;

list

List available services

SELECT
name,
cloudera_version,
iam,
max_orderable_nodes,
state
FROM ovh.cluster_hadoop.clusters
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

order_new_node_hourly

Order a new node in the cluster

EXEC ovh.cluster_hadoop.clusters.order_new_node_hourly 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"nodeProfile": "{{ nodeProfile }}"
}'
;

restart

Restart the Cloudera Manager Hadoop Cluster (THIS ACTION WILL RESTART EVERY SERVICE)

EXEC ovh.cluster_hadoop.clusters.restart 
@serviceName='{{ serviceName }}' --required
;

service_restart

Restart a Cloudera Manager service (THIS ACTION WILL RESTART OTHER DEPENDANT SERVICES)

EXEC ovh.cluster_hadoop.clusters.service_restart 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"service": "{{ service }}"
}'
;

service_start

Start a Cloudera Manager service

EXEC ovh.cluster_hadoop.clusters.service_start 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"service": "{{ service }}"
}'
;

service_stop

Stop a Cloudera Manager service (THIS ACTION WILL STOP OTHER DEPENDANT SERVICES)

EXEC ovh.cluster_hadoop.clusters.service_stop 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"service": "{{ service }}"
}'
;

start

Start the Cloudera Manager Hadoop Cluster

EXEC ovh.cluster_hadoop.clusters.start 
@serviceName='{{ serviceName }}' --required
;

stop

Stop a Cloudera Manager Hadoop Cluster (THIS ACTION WILL STOP EVERY SERVICE)

EXEC ovh.cluster_hadoop.clusters.stop 
@serviceName='{{ serviceName }}' --required
;

terminate

Terminate your service. THE CLUSTER WILL BE DELETED. ALL YOUR DATA WILL BE LOST

EXEC ovh.cluster_hadoop.clusters.terminate 
@serviceName='{{ serviceName }}' --required
;