private_network_configurations
Creates, updates, deletes, gets or lists a private_network_configurations resource.
Overview​
| Name | private_network_configurations |
| Type | Resource |
| Id | ovh.cloud_kube.private_network_configurations |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
default_vrack_gateway | string | If defined, all egress traffic will be routed towards this IP address, which should belong to the private network. Empty string means disabled. (wire: defaultVrackGateway) |
private_network_routing_as_default | boolean | Defines whether routing should default to using the nodes' private interface, instead of their public interface. Default is false. (wire: privateNetworkRoutingAsDefault) |
use_user_gateway | boolean | When enabled, skips the prerequisite check for a router/gateway on the OpenStack subnet/network. By default (value false or not set), an OpenStack router/gateway is mandatory. (wire: useUserGateway) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | kube_id, service_name | Get private network configuration | |
update | update | kube_id, service_name | Update private network configuration |
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"}}) |
kube_id | string | Kube ID (wire: kubeId) |
service_name | string | The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set. |
SELECT examples​
- get
Get private network configuration
SELECT
default_vrack_gateway,
private_network_routing_as_default,
use_user_gateway
FROM ovh.cloud_kube.private_network_configurations
WHERE kube_id = '{{ kube_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;
UPDATE examples​
- update
Update private network configuration
UPDATE ovh.cloud_kube.private_network_configurations
SET
default_vrack_gateway = '{{ default_vrack_gateway }}',
private_network_routing_as_default = {{ private_network_routing_as_default }},
use_user_gateway = {{ use_user_gateway }}
WHERE
kube_id = '{{ kube_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
RETURNING
message;