clusters

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

Overview

Name	clusters
Type	Resource
Id	ovh.dedicated_ceph.clusters

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
service_name	string	ID of cluster (wire: serviceName)
ceph_mons	array	List of CEPH monitor IPs (wire: cephMons)
ceph_version	string	Used version of ceph (wire: cephVersion)
create_date	string	Creation date (wire: createDate)
crush_tunables	string	Tunables of cluster (ARGONAUT, BOBTAIL, DEFAULT, FIREFLY, HAMMER, JEWEL, LEGACY, OPTIMAL) (wire: crushTunables)
iam	object	IAM resource metadata
label	string	Name of cluster
region	string	Name of region where cluster is located
size	integer	Size of cluster in TB
state	string	State of cluster (ACTIVE, SUSPENDED)
status	string	Status of cluster (CREATING, DELETED, DELETING, INSTALLED, TASK_IN_PROGRESS)
update_date	string	Last update date (wire: updateDate)

list

Details about ceph cluster

Name	Datatype	Description
service_name	string	ID of cluster (wire: serviceName)
ceph_mons	array	List of CEPH monitor IPs (wire: cephMons)
ceph_version	string	Used version of ceph (wire: cephVersion)
create_date	string	Creation date (wire: createDate)
crush_tunables	string	Tunables of cluster (ARGONAUT, BOBTAIL, DEFAULT, FIREFLY, HAMMER, JEWEL, LEGACY, OPTIMAL) (wire: crushTunables)
iam	object	IAM resource metadata
label	string	Name of cluster
region	string	Name of region where cluster is located
size	integer	Size of cluster in TB
state	string	State of cluster (ACTIVE, SUSPENDED)
status	string	Status of cluster (CREATING, DELETED, DELETING, INSTALLED, TASK_IN_PROGRESS)
update_date	string	Last update date (wire: updateDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Returns the configuration and the current state of the cluster. The status is INSTALLED once all requested tasks are done.
list	select		iam_tags, x_pagination_mode	Returns the service names of the clusters, which are also their Ceph fsid.
update	update	service_name, crush_tunables, label		Updates the label and the CRUSH tunables of the cluster.
change_contact	exec	serviceName		Starts the change of the admin, tech or billing contact and returns the request IDs.
confirm_termination	exec	serviceName, token		Confirms the termination with the token sent by email. The reason and comments are optional.
terminate	exec	serviceName		Emails a termination token to the admin contact, to use with Confirm termination.

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	Service name
service_name	string	Service name (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

Returns the configuration and the current state of the cluster. The status is INSTALLED once all requested tasks are done.

SELECT
service_name,
ceph_mons,
ceph_version,
create_date,
crush_tunables,
iam,
label,
region,
size,
state,
status,
update_date
FROM ovh.dedicated_ceph.clusters
WHERE service_name = '{{ service_name }}' -- required
;

list

Returns the service names of the clusters, which are also their Ceph fsid.

SELECT
service_name,
ceph_mons,
ceph_version,
create_date,
crush_tunables,
iam,
label,
region,
size,
state,
status,
update_date
FROM ovh.dedicated_ceph.clusters
WHERE iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Updates the label and the CRUSH tunables of the cluster.

UPDATE ovh.dedicated_ceph.clusters
SET 
crush_tunables = '{{ crush_tunables }}',
label = '{{ label }}'
WHERE 
service_name = '{{ service_name }}' --required
AND crush_tunables = '{{ crush_tunables }}' --required
AND label = '{{ label }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

change_contact

Starts the change of the admin, tech or billing contact and returns the request IDs.

EXEC ovh.dedicated_ceph.clusters.change_contact 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"contactAdmin": "{{ contactAdmin }}", 
"contactBilling": "{{ contactBilling }}", 
"contactTech": "{{ contactTech }}"
}'
;

confirm_termination

Confirms the termination with the token sent by email. The reason and comments are optional.

EXEC ovh.dedicated_ceph.clusters.confirm_termination 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"commentary": "{{ commentary }}", 
"commentaryFutureUse": "{{ commentaryFutureUse }}", 
"commentaryReason": "{{ commentaryReason }}", 
"futureUse": "{{ futureUse }}", 
"reason": "{{ reason }}", 
"token": "{{ token }}"
}'
;

terminate

Emails a termination token to the admin contact, to use with Confirm termination.

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