VirtualNodePool¶

class oci.container_engine.models.VirtualNodePool(**kwargs)¶

Bases: object

A pool of virtual nodes attached to a cluster.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a VirtualNodePool.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a VirtualNodePool.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a VirtualNodePool.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a VirtualNodePool.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a VirtualNodePool.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a VirtualNodePool.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a VirtualNodePool.
`cluster_id`	[Required] Gets the cluster_id of this VirtualNodePool.
`compartment_id`	[Required] Gets the compartment_id of this VirtualNodePool.
`defined_tags`	Gets the defined_tags of this VirtualNodePool.
`display_name`	[Required] Gets the display_name of this VirtualNodePool.
`freeform_tags`	Gets the freeform_tags of this VirtualNodePool.
`id`	[Required] Gets the id of this VirtualNodePool.
`initial_virtual_node_labels`	Gets the initial_virtual_node_labels of this VirtualNodePool.
`kubernetes_version`	[Required] Gets the kubernetes_version of this VirtualNodePool.
`lifecycle_details`	Gets the lifecycle_details of this VirtualNodePool.
`lifecycle_state`	Gets the lifecycle_state of this VirtualNodePool.
`nsg_ids`	Gets the nsg_ids of this VirtualNodePool.
`placement_configurations`	[Required] Gets the placement_configurations of this VirtualNodePool.
`pod_configuration`	Gets the pod_configuration of this VirtualNodePool.
`size`	Gets the size of this VirtualNodePool.
`system_tags`	Gets the system_tags of this VirtualNodePool.
`taints`	Gets the taints of this VirtualNodePool.
`time_created`	Gets the time_created of this VirtualNodePool.
`time_updated`	Gets the time_updated of this VirtualNodePool.
`virtual_node_tags`	Gets the virtual_node_tags of this VirtualNodePool.

Methods

__init__(**kwargs) Initializes a new VirtualNodePool object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a VirtualNodePool. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a VirtualNodePool. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a VirtualNodePool. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a VirtualNodePool. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a VirtualNodePool. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a VirtualNodePool. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a VirtualNodePool. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new VirtualNodePool object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this VirtualNodePool.
compartment_id (str) – The value to assign to the compartment_id property of this VirtualNodePool.
cluster_id (str) – The value to assign to the cluster_id property of this VirtualNodePool.
display_name (str) – The value to assign to the display_name property of this VirtualNodePool.
kubernetes_version (str) – The value to assign to the kubernetes_version property of this VirtualNodePool.
initial_virtual_node_labels (list[oci.container_engine.models.InitialVirtualNodeLabel]) – The value to assign to the initial_virtual_node_labels property of this VirtualNodePool.
taints (list[oci.container_engine.models.Taint]) – The value to assign to the taints property of this VirtualNodePool.
size (int) – The value to assign to the size property of this VirtualNodePool.
placement_configurations (list[oci.container_engine.models.PlacementConfiguration]) – The value to assign to the placement_configurations property of this VirtualNodePool.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this VirtualNodePool.
pod_configuration (oci.container_engine.models.PodConfiguration) – The value to assign to the pod_configuration property of this VirtualNodePool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VirtualNodePool. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VirtualNodePool.
time_created (datetime) – The value to assign to the time_created property of this VirtualNodePool.
time_updated (datetime) – The value to assign to the time_updated property of this VirtualNodePool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VirtualNodePool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VirtualNodePool.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VirtualNodePool.
virtual_node_tags (oci.container_engine.models.VirtualNodeTags) – The value to assign to the virtual_node_tags property of this VirtualNodePool.

cluster_id¶

[Required] Gets the cluster_id of this VirtualNodePool. The cluster the virtual node pool is associated with. A virtual node pool can only be associated with one cluster.

Returns:	The cluster_id of this VirtualNodePool.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this VirtualNodePool. Compartment of the virtual node pool.

Returns:	The compartment_id of this VirtualNodePool.
Return type:	str

defined_tags¶

Gets the defined_tags of this VirtualNodePool. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this VirtualNodePool.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this VirtualNodePool. Display name of the virtual node pool. This is a non-unique value.

Returns:	The display_name of this VirtualNodePool.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this VirtualNodePool. Free-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. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this VirtualNodePool.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this VirtualNodePool. The OCID of the virtual node pool.

Returns:	The id of this VirtualNodePool.
Return type:	str

initial_virtual_node_labels¶

Gets the initial_virtual_node_labels of this VirtualNodePool. Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.

Returns:	The initial_virtual_node_labels of this VirtualNodePool.
Return type:	list[oci.container_engine.models.InitialVirtualNodeLabel]

kubernetes_version¶

[Required] Gets the kubernetes_version of this VirtualNodePool. The version of Kubernetes running on the nodes in the node pool.

Returns:	The kubernetes_version of this VirtualNodePool.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this VirtualNodePool. Details about the state of the Virtual Node Pool.

Returns:	The lifecycle_details of this VirtualNodePool.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this VirtualNodePool. The state of the Virtual Node Pool.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this VirtualNodePool.
Return type:	str

nsg_ids¶

Gets the nsg_ids of this VirtualNodePool. List of network security group id’s applied to the Virtual Node VNIC.

Returns:	The nsg_ids of this VirtualNodePool.
Return type:	list[str]

placement_configurations¶

[Required] Gets the placement_configurations of this VirtualNodePool. The 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

Returns:	The placement_configurations of this VirtualNodePool.
Return type:	list[oci.container_engine.models.PlacementConfiguration]

pod_configuration¶

Gets the pod_configuration of this VirtualNodePool. The pod configuration for pods run on virtual nodes of this virtual node pool.

Returns:	The pod_configuration of this VirtualNodePool.
Return type:	oci.container_engine.models.PodConfiguration

size¶

Gets the size of this VirtualNodePool. The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.

Returns:	The size of this VirtualNodePool.
Return type:	int

system_tags¶

Gets the system_tags of this VirtualNodePool. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this VirtualNodePool.
Return type:	dict(str, dict(str, object))

taints¶

Gets the taints of this VirtualNodePool. A 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.

Returns:	The taints of this VirtualNodePool.
Return type:	list[oci.container_engine.models.Taint]

time_created¶

Gets the time_created of this VirtualNodePool. The time the virtual node pool was created.

Returns:	The time_created of this VirtualNodePool.
Return type:	datetime

time_updated¶

Gets the time_updated of this VirtualNodePool. The time the virtual node pool was updated.

Returns:	The time_updated of this VirtualNodePool.
Return type:	datetime

virtual_node_tags¶

Gets the virtual_node_tags of this VirtualNodePool.

Returns:	The virtual_node_tags of this VirtualNodePool.
Return type:	oci.container_engine.models.VirtualNodeTags