Skip to main content

virtual_node_pools

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

Overview​

Namevirtual_node_pools
TypeResource
Idoci.container_engine.virtual_node_pools

Fields​

The following fields are returned by SELECT queries:

The virtual node pool.

NameDatatypeDescription
idstringThe OCID of the virtual node pool. (example: ocid1.virtualnodepool.oc1.iad.aaaaaaaanifpelnyzmkvnepohbz4ntswkpl35syzzsugdxceth3oihe8hcfq)
clusterIdstringThe cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster. (example: ocid1.cluster.oc1.iad.aaaaaaaaga3tombrmq3wgyrvmi3gcn3bmfsdizjwgy4wgyldmy3dcmtcmmyw)
compartmentIdstringCompartment of the virtual node pool. (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"}}
displayNamestringDisplay name of the virtual node pool. This is a non-unique value. (example: My Virtual Node Pool)
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"}
initialVirtualNodeLabelsarrayInitial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.
kubernetesVersionstringThe version of Kubernetes running on the nodes in the node pool. (example: v1.9.4)
lifecycleDetailsstringDetails about the state of the Virtual Node Pool. (example: updating.)
lifecycleStatestringThe state of the Virtual Node Pool. (CREATING, ACTIVE, UPDATING, DELETING, DELETED, FAILED, NEEDS_ATTENTION) (x-obmcs-top-level-enum: #/definitions/VirtualNodePoolLifecycleState)
nsgIdsarrayList of network security group id's applied to the Virtual Node VNIC.
placementConfigurationsarrayThe list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations
podConfigurationobjectThe pod configuration for pods run on virtual nodes of this virtual node pool.
sizeinteger (int32)The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.
systemTagsobjectUsage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
taintsarrayA taint is a collection of <key, value, effect>. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.
timeCreatedstring (date-time)The time the virtual node pool was created. (example: 2017-07-21T16:11:29Z)
timeUpdatedstring (date-time)The time the virtual node pool was updated. (example: 2017-07-21T16:11:29Z)
virtualNodePoolCyclingDetailsobjectVirtual Node Pool Cycling Details
virtualNodeTagsobjectThe tags associated to the virtual nodes in this virtual node pool.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectvirtualNodePoolId, regionopc-request-idGet the details of a virtual node pool.
listselectcompartmentId, regionopc-request-id, clusterId, name, limit, page, sortOrder, sortBy, lifecycleStateList all the virtual node pools in a compartment, and optionally filter by cluster.
createinsertregion, compartmentId, clusterId, displayName, placementConfigurations, podConfiguration, sizeopc-retry-token, opc-request-idCreate a new virtual node pool.
updateupdatevirtualNodePoolId, regionif-match, opc-request-idUpdate the details of a virtual node pool.
deletedeletevirtualNodePoolId, regionif-match, opc-request-id, overrideEvictionGraceDurationVnp, isForceDeletionAfterOverrideGraceDurationVnpDelete a virtual 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.
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)
virtualNodePoolIdstringThe OCID of the virtual node pool.
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.
isForceDeletionAfterOverrideGraceDurationVnpbooleanIf the underlying virtual node should be force deleted if all the pods are not evicted in the evictionGraceDuration.
lifecycleStatearrayA virtual node pool lifecycle state to filter on. Can have multiple parameters of this name.
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.
overrideEvictionGraceDurationVnpstring (x-obmcs-duration)Duration after which SKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the virtual 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 virtual node pool.

SELECT
id,
clusterId,
compartmentId,
definedTags,
displayName,
freeformTags,
initialVirtualNodeLabels,
kubernetesVersion,
lifecycleDetails,
lifecycleState,
nsgIds,
placementConfigurations,
podConfiguration,
size,
systemTags,
taints,
timeCreated,
timeUpdated,
virtualNodePoolCyclingDetails,
virtualNodeTags
FROM oci.container_engine.virtual_node_pools
WHERE virtualNodePoolId = '{{ virtualNodePoolId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Create a new virtual node pool.

INSERT INTO oci.container_engine.virtual_node_pools (
clusterId,
compartmentId,
definedTags,
displayName,
freeformTags,
initialVirtualNodeLabels,
nsgIds,
placementConfigurations,
podConfiguration,
size,
taints,
virtualNodePoolCyclingDetails,
virtualNodeTags,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ clusterId }}' /* required */,
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ initialVirtualNodeLabels }}',
'{{ nsgIds }}',
'{{ placementConfigurations }}' /* required */,
'{{ podConfiguration }}' /* required */,
{{ size }} /* required */,
'{{ taints }}',
'{{ virtualNodePoolCyclingDetails }}',
'{{ virtualNodeTags }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
;

UPDATE examples​

Update the details of a virtual node pool.

UPDATE oci.container_engine.virtual_node_pools
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
initialVirtualNodeLabels = '{{ initialVirtualNodeLabels }}',
nsgIds = '{{ nsgIds }}',
placementConfigurations = '{{ placementConfigurations }}',
podConfiguration = '{{ podConfiguration }}',
size = {{ size }},
taints = '{{ taints }}',
virtualNodePoolCyclingDetails = '{{ virtualNodePoolCyclingDetails }}',
virtualNodeTags = '{{ virtualNodeTags }}'
WHERE 
virtualNodePoolId = '{{ virtualNodePoolId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}';

DELETE examples​

Delete a virtual node pool.

DELETE FROM oci.container_engine.virtual_node_pools
WHERE virtualNodePoolId = '{{ virtualNodePoolId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
AND overrideEvictionGraceDurationVnp = '{{ overrideEvictionGraceDurationVnp }}'
AND isForceDeletionAfterOverrideGraceDurationVnp = '{{ isForceDeletionAfterOverrideGraceDurationVnp }}'
;