NodePool¶

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

Bases: object

A pool of compute nodes attached to a cluster. Avoid entering confidential information.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a NodePool.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a NodePool.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a NodePool.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a NodePool.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a NodePool.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a NodePool.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a NodePool.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a NodePool.
`cluster_id`	Gets the cluster_id of this NodePool.
`compartment_id`	Gets the compartment_id of this NodePool.
`defined_tags`	Gets the defined_tags of this NodePool.
`freeform_tags`	Gets the freeform_tags of this NodePool.
`id`	Gets the id of this NodePool.
`initial_node_labels`	Gets the initial_node_labels of this NodePool.
`kubernetes_version`	Gets the kubernetes_version of this NodePool.
`lifecycle_details`	Gets the lifecycle_details of this NodePool.
`lifecycle_state`	Gets the lifecycle_state of this NodePool.
`name`	Gets the name of this NodePool.
`node_config_details`	Gets the node_config_details of this NodePool.
`node_eviction_node_pool_settings`	Gets the node_eviction_node_pool_settings of this NodePool.
`node_image_id`	Gets the node_image_id of this NodePool.
`node_image_name`	Gets the node_image_name of this NodePool.
`node_metadata`	Gets the node_metadata of this NodePool.
`node_pool_cycling_details`	Gets the node_pool_cycling_details of this NodePool.
`node_shape`	Gets the node_shape of this NodePool.
`node_shape_config`	Gets the node_shape_config of this NodePool.
`node_source`	Gets the node_source of this NodePool.
`node_source_details`	Gets the node_source_details of this NodePool.
`nodes`	Gets the nodes of this NodePool.
`quantity_per_subnet`	Gets the quantity_per_subnet of this NodePool.
`ssh_public_key`	Gets the ssh_public_key of this NodePool.
`subnet_ids`	Gets the subnet_ids of this NodePool.
`system_tags`	Gets the system_tags of this NodePool.

Methods

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

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

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a NodePool. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a NodePool. 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 NodePool. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new NodePool 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 NodePool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this NodePool. Allowed values for this property are: “DELETED”, “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “FAILED”, “INACTIVE”, “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 NodePool.
compartment_id (str) – The value to assign to the compartment_id property of this NodePool.
cluster_id (str) – The value to assign to the cluster_id property of this NodePool.
name (str) – The value to assign to the name property of this NodePool.
kubernetes_version (str) – The value to assign to the kubernetes_version property of this NodePool.
node_metadata (dict(str, str)) – The value to assign to the node_metadata property of this NodePool.
node_image_id (str) – The value to assign to the node_image_id property of this NodePool.
node_image_name (str) – The value to assign to the node_image_name property of this NodePool.
node_shape_config (oci.container_engine.models.NodeShapeConfig) – The value to assign to the node_shape_config property of this NodePool.
node_source (oci.container_engine.models.NodeSourceOption) – The value to assign to the node_source property of this NodePool.
node_source_details (oci.container_engine.models.NodeSourceDetails) – The value to assign to the node_source_details property of this NodePool.
node_shape (str) – The value to assign to the node_shape property of this NodePool.
initial_node_labels (list[oci.container_engine.models.KeyValue]) – The value to assign to the initial_node_labels property of this NodePool.
ssh_public_key (str) – The value to assign to the ssh_public_key property of this NodePool.
quantity_per_subnet (int) – The value to assign to the quantity_per_subnet property of this NodePool.
subnet_ids (list[str]) – The value to assign to the subnet_ids property of this NodePool.
nodes (list[oci.container_engine.models.Node]) – The value to assign to the nodes property of this NodePool.
node_config_details (oci.container_engine.models.NodePoolNodeConfigDetails) – The value to assign to the node_config_details property of this NodePool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this NodePool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this NodePool.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this NodePool.
node_eviction_node_pool_settings (oci.container_engine.models.NodeEvictionNodePoolSettings) – The value to assign to the node_eviction_node_pool_settings property of this NodePool.
node_pool_cycling_details (oci.container_engine.models.NodePoolCyclingDetails) – The value to assign to the node_pool_cycling_details property of this NodePool.

cluster_id¶

Gets the cluster_id of this NodePool. The OCID of the cluster to which this node pool is attached.

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

compartment_id¶

Gets the compartment_id of this NodePool. The OCID of the compartment in which the node pool exists.

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

defined_tags¶

Gets the defined_tags of this NodePool. 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 NodePool.
Return type:	dict(str, dict(str, object))

freeform_tags¶

Gets the freeform_tags of this NodePool. 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 NodePool.
Return type:	dict(str, str)

id¶

Gets the id of this NodePool. The OCID of the node pool.

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

initial_node_labels¶

Gets the initial_node_labels of this NodePool. A list of key/value pairs to add to nodes after they join the Kubernetes cluster.

Returns:	The initial_node_labels of this NodePool.
Return type:	list[oci.container_engine.models.KeyValue]

kubernetes_version¶

Gets the kubernetes_version of this NodePool. The version of Kubernetes running on the nodes in the node pool.

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

lifecycle_details¶

Gets the lifecycle_details of this NodePool. Details about the state of the nodepool.

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

lifecycle_state¶

Gets the lifecycle_state of this NodePool. The state of the nodepool.

Allowed values for this property are: “DELETED”, “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “FAILED”, “INACTIVE”, “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 NodePool.
Return type:	str

name¶

Gets the name of this NodePool. The name of the node pool.

Returns:	The name of this NodePool.
Return type:	str

node_config_details¶

Gets the node_config_details of this NodePool. The configuration of nodes in the node pool.

Returns:	The node_config_details of this NodePool.
Return type:	oci.container_engine.models.NodePoolNodeConfigDetails

node_eviction_node_pool_settings¶

Gets the node_eviction_node_pool_settings of this NodePool.

Returns:	The node_eviction_node_pool_settings of this NodePool.
Return type:	oci.container_engine.models.NodeEvictionNodePoolSettings

node_image_id¶

Gets the node_image_id of this NodePool. Deprecated. see nodeSource. The OCID of the image running on the nodes in the node pool.

Returns:	The node_image_id of this NodePool.
Return type:	str

node_image_name¶

Gets the node_image_name of this NodePool. Deprecated. see nodeSource. The name of the image running on the nodes in the node pool.

Returns:	The node_image_name of this NodePool.
Return type:	str

node_metadata¶

Gets the node_metadata of this NodePool. A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.

Returns:	The node_metadata of this NodePool.
Return type:	dict(str, str)

node_pool_cycling_details¶

Gets the node_pool_cycling_details of this NodePool.

Returns:	The node_pool_cycling_details of this NodePool.
Return type:	oci.container_engine.models.NodePoolCyclingDetails

node_shape¶

Gets the node_shape of this NodePool. The name of the node shape of the nodes in the node pool.

Returns:	The node_shape of this NodePool.
Return type:	str

node_shape_config¶

Gets the node_shape_config of this NodePool. The shape configuration of the nodes.

Returns:	The node_shape_config of this NodePool.
Return type:	oci.container_engine.models.NodeShapeConfig

node_source¶

Gets the node_source of this NodePool. Deprecated. see nodeSourceDetails. Source running on the nodes in the node pool.

Returns:	The node_source of this NodePool.
Return type:	oci.container_engine.models.NodeSourceOption

node_source_details¶

Gets the node_source_details of this NodePool. Source running on the nodes in the node pool.

Returns:	The node_source_details of this NodePool.
Return type:	oci.container_engine.models.NodeSourceDetails

nodes¶

Gets the nodes of this NodePool. The nodes in the node pool.

Returns:	The nodes of this NodePool.
Return type:	list[oci.container_engine.models.Node]

quantity_per_subnet¶

Gets the quantity_per_subnet of this NodePool. The number of nodes in each subnet.

Returns:	The quantity_per_subnet of this NodePool.
Return type:	int

ssh_public_key¶

Gets the ssh_public_key of this NodePool. The SSH public key on each node in the node pool on launch.

Returns:	The ssh_public_key of this NodePool.
Return type:	str

subnet_ids¶

Gets the subnet_ids of this NodePool. The OCIDs of the subnets in which to place nodes for this node pool.

Returns:	The subnet_ids of this NodePool.
Return type:	list[str]

system_tags¶

Gets the system_tags of this NodePool. 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 NodePool.
Return type:	dict(str, dict(str, object))