Skip to main content

reference_managed_kubernetes_plans

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

Overview​

Namereference_managed_kubernetes_plans
TypeResource
Idovh.public_cloud.reference_managed_kubernetes_plans

Fields​

The following fields are returned by SELECT queries:

A plan available for managed Kubernetes clusters, with its control plane characteristics and limits

NameDatatypeDescription
namestringPlan name (FREE, STANDARD)
control_planeobjectControl plane characteristics of the plan (wire: controlPlane)
limitsobjectLimits enforced by the plan
statusstringAvailability of the plan for cluster creation (AVAILABLE, UNAVAILABLE)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectregion, project_idx_pagination_cursor, x_pagination_sizeReturns the plans available for cluster creation in a region, with their control plane characteristics and limits. Requires a region. (Beta version)

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.

NameDatatypeDescription
api_hoststringThe 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"}})
project_idstringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
regionstringRegion to list plans for. Plan availability varies by region. An unknown region returns 404.
x_pagination_cursorstringPagination cursor (wire: X-Pagination-Cursor)
x_pagination_sizeintegerPagination size (wire: X-Pagination-Size)

SELECT examples​

Returns the plans available for cluster creation in a region, with their control plane characteristics and limits. Requires a region. (Beta version)

SELECT
name,
control_plane,
limits,
status
FROM ovh.public_cloud.reference_managed_kubernetes_plans
WHERE region = '{{ region }}' -- required
AND project_id = '{{ project_id }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;