pools

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

Overview

Name	pools
Type	Resource
Id	ovh.dedicated_ceph.pools

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string	Name of the pool
service_name	string	ID of cluster (wire: serviceName)
backup	boolean	Determine if pool should be backuped
min_active_replicas	integer	Minimum active replicas (wire: minActiveReplicas)
pool_type	string	Type of pool (ERASURE_CODED, REPLICATED) (wire: poolType)
replica_count	integer	Number of replica (wire: replicaCount)

list

Ceph pool

Name	Datatype	Description
name	string	Name of the pool
service_name	string	ID of cluster (wire: serviceName)
backup	boolean	Determine if pool should be backuped
min_active_replicas	integer	Minimum active replicas (wire: minActiveReplicas)
pool_type	string	Type of pool (ERASURE_CODED, REPLICATED) (wire: poolType)
replica_count	integer	Number of replica (wire: replicaCount)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pool_name, service_name		Returns a pool of the cluster.
list	select	service_name		Returns the pools of the cluster.
create	insert	service_name, pool_name		Creates a pool whose data is replicated three times. The name must contain at least three characters.
delete	delete	pool_name, service_name		Deletes the pool from the cluster.
allow_deletion	exec	poolName, serviceName		Opens a 5-minute window for deleting the pool. This window is not enforced yet: a pool can currently be deleted at any time.

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"}})
poolName	string	Pool name
pool_name	string	Pool name (wire: poolName)
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns a pool of the cluster.

SELECT
name,
service_name,
backup,
min_active_replicas,
pool_type,
replica_count
FROM ovh.dedicated_ceph.pools
WHERE pool_name = '{{ pool_name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the pools of the cluster.

SELECT
name,
service_name,
backup,
min_active_replicas,
pool_type,
replica_count
FROM ovh.dedicated_ceph.pools
WHERE service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Creates a pool whose data is replicated three times. The name must contain at least three characters.

INSERT INTO ovh.dedicated_ceph.pools (
pool_name,
service_name
)
SELECT 
'{{ pool_name }}' /* required */,
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: pools
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the pools resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: |
      Name of the new pool

DELETE examples

delete

Deletes the pool from the cluster.

DELETE FROM ovh.dedicated_ceph.pools
WHERE pool_name = '{{ pool_name }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

allow_deletion

Opens a 5-minute window for deleting the pool. This window is not enforced yet: a pool can currently be deleted at any time.

EXEC ovh.dedicated_ceph.pools.allow_deletion 
@poolName='{{ poolName }}' --required, 
@serviceName='{{ serviceName }}' --required
;