nodes

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

Overview

Name	nodes
Type	Resource
Id	oci.container_engine.nodes

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
delete	delete	nodePoolId, nodeId, region	isDecrementSize, if-match, opc-request-id, overrideEvictionGraceDuration, isForceDeletionAfterOverrideGraceDuration	Delete node.
reboot_cluster_node	exec	clusterId, nodeId, region	opc-request-id, opc-retry-token	perform reboot action to node in cluster
replace_boot_volume_cluster_node	exec	clusterId, nodeId, region	opc-request-id, opc-retry-token	perform cycle action to node in 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
clusterId	string	The OCID of the cluster.
nodeId	string	The OCID of the compute instance.
nodePoolId	string	The OCID of the node pool.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
isDecrementSize	boolean	If the nodepool should be scaled down after the node is deleted.
isForceDeletionAfterOverrideGraceDuration	boolean	If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
opc-request-id	string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
overrideEvictionGraceDuration	string (x-obmcs-duration)	Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M

DELETE examples

delete

Delete node.

DELETE FROM oci.container_engine.nodes
WHERE nodePoolId = '{{ nodePoolId }}' --required
AND nodeId = '{{ nodeId }}' --required
AND region = '{{ region }}' --required
AND isDecrementSize = '{{ isDecrementSize }}'
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
AND overrideEvictionGraceDuration = '{{ overrideEvictionGraceDuration }}'
AND isForceDeletionAfterOverrideGraceDuration = '{{ isForceDeletionAfterOverrideGraceDuration }}'
;

Lifecycle Methods

reboot_cluster_node

perform reboot action to node in cluster

EXEC oci.container_engine.nodes.reboot_cluster_node 
@clusterId='{{ clusterId }}' --required, 
@nodeId='{{ nodeId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"nodeEvictionSettings": "{{ nodeEvictionSettings }}"
}'
;

replace_boot_volume_cluster_node

perform cycle action to node in cluster

EXEC oci.container_engine.nodes.replace_boot_volume_cluster_node 
@clusterId='{{ clusterId }}' --required, 
@nodeId='{{ nodeId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"nodeEvictionSettings": "{{ nodeEvictionSettings }}"
}'
;