NodePool

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

Bases: object

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

__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.
  • 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 (str) -- The value to assign to the node_shape property of this NodePool.
  • initial_node_labels (list[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[Node]) -- The value to assign to the nodes property of this NodePool.
  • node_config_details (NodePoolNodeConfigDetails) -- The value to assign to the node_config_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
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[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
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:NodePoolNodeConfigDetails
node_image_id

Gets the node_image_id of this NodePool. 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. 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.

Returns:The node_metadata of this NodePool.
Return type:dict(str, str)
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
nodes

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

Returns:The nodes of this NodePool.
Return type:list[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.

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]