clickhouse_prometheuses

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

Overview

Name	clickhouse_prometheuses
Type	Resource
Id	ovh.cloud_database.clickhouse_prometheuses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
targets	array	Endpoint target for Prometheus
username	string	Name of the Prometheus access

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cluster_id, service_name		Get the endpoint for clickhouse cluster Prometheus
credentials_reset	exec	clusterId, service_name		Reset the password of a Prometheus

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"}})
clusterId	string (uuid)	Cluster ID
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get the endpoint for clickhouse cluster Prometheus

SELECT
targets,
username
FROM ovh.cloud_database.clickhouse_prometheuses
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

Lifecycle Methods

EXEC variables use wire (API) names.

credentials_reset

Reset the password of a Prometheus

EXEC ovh.cloud_database.clickhouse_prometheuses.credentials_reset 
@clusterId='{{ clusterId }}' --required, 
@service_name='{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;