ip_restrictions

Creates, updates, deletes, gets or lists an ip_restrictions resource.

Overview

Name	ip_restrictions
Type	Resource
Id	ovh.cloud_kube.ip_restrictions

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	kube_id, service_name		List your ip restrictions on your cluster
create	insert	kube_id, service_name		Append a list of ip restrictions on your cluster
update	update	kube_id, service_name		Remove the current list and add a list of ip restrictions on your cluster
delete	delete	ip, kube_id, service_name		Delete an ip restriction from your cluster

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"}})
ip	string (ip-block)	Ip
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

list

List your ip restrictions on your cluster

SELECT
value
FROM ovh.cloud_kube.ip_restrictions
WHERE kube_id = '{{ kube_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Append a list of ip restrictions on your cluster

INSERT INTO ovh.cloud_kube.ip_restrictions (
ips,
kube_id,
service_name
)
SELECT 
'{{ ips }}',
'{{ kube_id }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: ip_restrictions
props:
  - name: kube_id
    value: "{{ kube_id }}"
    description: Required parameter for the ip_restrictions resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the ip_restrictions resource.
  - name: ips
    value:
      - "{{ ips }}"
    description: |
      List of ips to add to the cluster api-server restrictions (format with /subnet available)

UPDATE examples

update

Remove the current list and add a list of ip restrictions on your cluster

UPDATE ovh.cloud_kube.ip_restrictions
SET 
ips = '{{ ips }}'
WHERE 
kube_id = '{{ kube_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set;

DELETE examples

delete

Delete an ip restriction from your cluster

DELETE FROM ovh.cloud_kube.ip_restrictions
WHERE ip = '{{ ip }}' --required
AND kube_id = '{{ kube_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;