Skip to main content

node_pools

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

Overview​

Namenode_pools
TypeResource
Idoci.container_engine.node_pools

Fields​

The following fields are returned by SELECT queries:

The node pool.

NameDatatypeDescription
idstringThe OCID of the node pool. (example: ocid1.nodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq)
namestringThe name of the node pool. (example: My Node Pool)
clusterIdstringThe OCID of the cluster to which this node pool is attached. (example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw)
compartmentIdstringThe OCID of the compartment in which the node pool exists. (example: ocid1.compartment.oc1..aaaaaaaafqm2df7ckwmmbtdsl2bgxsw4fcpvkoojytxrqst24yww2tdmtqcq)
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
initialNodeLabelsarrayA list of key/value pairs to add to nodes after they join the Kubernetes cluster.
kubernetesVersionstringThe version of Kubernetes running on the nodes in the node pool. (example: v1.9.4)
lifecycleDetailsstringDetails about the state of the nodepool.
lifecycleStatestringThe state of the nodepool. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm) (DELETED, CREATING, ACTIVE, UPDATING, DELETING, FAILED, INACTIVE, NEEDS_ATTENTION) (example: ACTIVE, x-obmcs-top-level-enum: #/definitions/NodePoolLifecycleState)
networkLaunchTypestringEmulation type for the physical network interface card (NIC) for nodes (VFIO, E1000, PARAVIRTUALIZED) (x-obmcs-top-level-enum: #/definitions/NetworkLaunchType)
nodeConfigDetailsobjectThe size and placement configuration of nodes in the node pool.
nodeEvictionNodePoolSettingsobjectNode Eviction Details configuration
nodeImageIdstringDeprecated. see nodeSource. The OCID of the image running on the nodes in the node pool. (example: ocid1.image.oc1.phx.aaaaaaaanclh465xnfvajjojj5bbjzqytunslgvnyvf3fepiiltalnglekoa)
nodeImageNamestringDeprecated. see nodeSource. The name of the image running on the nodes in the node pool. (example: Oracle-Linux-7.4)
nodeMetadataobjectA list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
nodePoolCyclingDetailsobjectNode Pool Cycling Details
nodeShapestringThe name of the node shape of the nodes in the node pool. (example: VM.Standard2.4)
nodeShapeConfigobjectThe shape configuration of the nodes.
nodeSourceobjectThe source option for the node.
nodeSourceDetailsobjectThe details of the node's source.
nodesarrayThe nodes in the node pool.
primaryVnicobjectDetails for node's primary VNIC
quantityPerSubnetinteger (int32)The number of nodes in each subnet.
secondaryVnicsarrayA list of secondary vnics to attach to nodes
sshPublicKeystringThe SSH public key on each node in the node pool on launch. (example: ssh-rsa AAAAB3NzaC1yc2abc123...)
subnetIdsarrayThe OCIDs of the subnets in which to place nodes for this node pool.
systemTagsobjectUsage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectnodePoolId, regionopc-request-idGet the details of a node pool.
listselectcompartmentId, regionclusterId, name, limit, page, sortOrder, sortBy, opc-request-id, lifecycleStateList all the node pools in a compartment, and optionally filter by cluster.
createinsertregion, compartmentId, clusterId, name, nodeShapeopc-retry-token, opc-request-idCreate a new node pool.
updateupdatenodePoolId, regionif-match, opc-request-id, overrideEvictionGraceDuration, isForceDeletionAfterOverrideGraceDurationUpdate the details of a node pool.
deletedeletenodePoolId, regionif-match, opc-request-id, overrideEvictionGraceDuration, isForceDeletionAfterOverrideGraceDurationDelete a node pool.

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
compartmentIdstringThe OCID of the compartment.
nodePoolIdstringThe OCID of the node pool.
regionstringOCI 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)
clusterIdstringThe OCID of the cluster.
if-matchstringFor 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.
isForceDeletionAfterOverrideGraceDurationbooleanIf the underlying compute instance should be deleted if you cannot evict all the pods in grace period
lifecycleStatearrayA list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING]. For more information, see [Monitoring Clusters](/Content/ContEng/Tasks/contengmonitoringclusters.htm)
limitintegerFor list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
namestringThe name to filter on.
opc-request-idstringUnique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-tokenstringA token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
overrideEvictionGraceDurationstring (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
pagestringFor list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBystringThe optional field to sort the results by.
sortOrderstringThe optional order in which to sort the results.

SELECT examples​

Get the details of a node pool.

SELECT
id,
name,
clusterId,
compartmentId,
definedTags,
freeformTags,
initialNodeLabels,
kubernetesVersion,
lifecycleDetails,
lifecycleState,
networkLaunchType,
nodeConfigDetails,
nodeEvictionNodePoolSettings,
nodeImageId,
nodeImageName,
nodeMetadata,
nodePoolCyclingDetails,
nodeShape,
nodeShapeConfig,
nodeSource,
nodeSourceDetails,
nodes,
primaryVnic,
quantityPerSubnet,
secondaryVnics,
sshPublicKey,
subnetIds,
systemTags
FROM oci.container_engine.node_pools
WHERE nodePoolId = '{{ nodePoolId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Create a new node pool.

INSERT INTO oci.container_engine.node_pools (
clusterId,
compartmentId,
definedTags,
freeformTags,
initialNodeLabels,
kubernetesVersion,
name,
networkLaunchType,
nodeConfigDetails,
nodeEvictionNodePoolSettings,
nodeImageName,
nodeMetadata,
nodePoolCyclingDetails,
nodeShape,
nodeShapeConfig,
nodeSourceDetails,
primaryVnic,
quantityPerSubnet,
secondaryVnics,
sshPublicKey,
subnetIds,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ clusterId }}' /* required */,
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ freeformTags }}',
'{{ initialNodeLabels }}',
'{{ kubernetesVersion }}',
'{{ name }}' /* required */,
'{{ networkLaunchType }}',
'{{ nodeConfigDetails }}',
'{{ nodeEvictionNodePoolSettings }}',
'{{ nodeImageName }}',
'{{ nodeMetadata }}',
'{{ nodePoolCyclingDetails }}',
'{{ nodeShape }}' /* required */,
'{{ nodeShapeConfig }}',
'{{ nodeSourceDetails }}',
'{{ primaryVnic }}',
{{ quantityPerSubnet }},
'{{ secondaryVnics }}',
'{{ sshPublicKey }}',
'{{ subnetIds }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
;

UPDATE examples​

Update the details of a node pool.

UPDATE oci.container_engine.node_pools
SET 
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}',
initialNodeLabels = '{{ initialNodeLabels }}',
kubernetesVersion = '{{ kubernetesVersion }}',
name = '{{ name }}',
networkLaunchType = '{{ networkLaunchType }}',
nodeConfigDetails = '{{ nodeConfigDetails }}',
nodeEvictionNodePoolSettings = '{{ nodeEvictionNodePoolSettings }}',
nodeMetadata = '{{ nodeMetadata }}',
nodePoolCyclingDetails = '{{ nodePoolCyclingDetails }}',
nodeShape = '{{ nodeShape }}',
nodeShapeConfig = '{{ nodeShapeConfig }}',
nodeSourceDetails = '{{ nodeSourceDetails }}',
primaryVnic = '{{ primaryVnic }}',
quantityPerSubnet = {{ quantityPerSubnet }},
secondaryVnics = '{{ secondaryVnics }}',
sshPublicKey = '{{ sshPublicKey }}',
subnetIds = '{{ subnetIds }}'
WHERE 
nodePoolId = '{{ nodePoolId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
AND overrideEvictionGraceDuration = '{{ overrideEvictionGraceDuration}}'
AND isForceDeletionAfterOverrideGraceDuration = {{ isForceDeletionAfterOverrideGraceDuration}};

DELETE examples​

Delete a node pool.

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