CreateNodePoolDetails

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

Bases: object

The properties that define a request to create a node pool.

Attributes:

NETWORK_LAUNCH_TYPE_E1000

A constant which can be used with the network_launch_type property of a CreateNodePoolDetails.

NETWORK_LAUNCH_TYPE_PARAVIRTUALIZED

A constant which can be used with the network_launch_type property of a CreateNodePoolDetails.

NETWORK_LAUNCH_TYPE_VFIO

A constant which can be used with the network_launch_type property of a CreateNodePoolDetails.

cluster_id

[Required] Gets the cluster_id of this CreateNodePoolDetails.

compartment_id

[Required] Gets the compartment_id of this CreateNodePoolDetails.

defined_tags

Gets the defined_tags of this CreateNodePoolDetails.

freeform_tags

Gets the freeform_tags of this CreateNodePoolDetails.

initial_node_labels

Gets the initial_node_labels of this CreateNodePoolDetails.

kubernetes_version

Gets the kubernetes_version of this CreateNodePoolDetails.

name

[Required] Gets the name of this CreateNodePoolDetails.

network_launch_type

Gets the network_launch_type of this CreateNodePoolDetails.

node_config_details

Gets the node_config_details of this CreateNodePoolDetails.

node_eviction_node_pool_settings

Gets the node_eviction_node_pool_settings of this CreateNodePoolDetails.

node_image_name

Gets the node_image_name of this CreateNodePoolDetails.

node_metadata

Gets the node_metadata of this CreateNodePoolDetails.

node_pool_cycling_details

Gets the node_pool_cycling_details of this CreateNodePoolDetails.

node_shape

[Required] Gets the node_shape of this CreateNodePoolDetails.

node_shape_config

Gets the node_shape_config of this CreateNodePoolDetails.

node_source_details

Gets the node_source_details of this CreateNodePoolDetails.

primary_vnic

Gets the primary_vnic of this CreateNodePoolDetails.

quantity_per_subnet

Gets the quantity_per_subnet of this CreateNodePoolDetails.

secondary_vnics

Gets the secondary_vnics of this CreateNodePoolDetails.

ssh_public_key

Gets the ssh_public_key of this CreateNodePoolDetails.

subnet_ids

Gets the subnet_ids of this CreateNodePoolDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateNodePoolDetails object with values from keyword arguments.

NETWORK_LAUNCH_TYPE_E1000 = 'E1000'

A constant which can be used with the network_launch_type property of a CreateNodePoolDetails. This constant has a value of “E1000”

NETWORK_LAUNCH_TYPE_PARAVIRTUALIZED = 'PARAVIRTUALIZED'

A constant which can be used with the network_launch_type property of a CreateNodePoolDetails. This constant has a value of “PARAVIRTUALIZED”

NETWORK_LAUNCH_TYPE_VFIO = 'VFIO'

A constant which can be used with the network_launch_type property of a CreateNodePoolDetails. This constant has a value of “VFIO”

__init__(**kwargs)

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

Parameters
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateNodePoolDetails.

  • cluster_id (str) – The value to assign to the cluster_id property of this CreateNodePoolDetails.

  • name (str) – The value to assign to the name property of this CreateNodePoolDetails.

  • kubernetes_version (str) – The value to assign to the kubernetes_version property of this CreateNodePoolDetails.

  • node_metadata (dict(str, str)) – The value to assign to the node_metadata property of this CreateNodePoolDetails.

  • node_image_name (str) – The value to assign to the node_image_name property of this CreateNodePoolDetails.

  • node_source_details (oci.container_engine.models.NodeSourceDetails) – The value to assign to the node_source_details property of this CreateNodePoolDetails.

  • node_shape (str) – The value to assign to the node_shape property of this CreateNodePoolDetails.

  • node_shape_config (oci.container_engine.models.CreateNodeShapeConfigDetails) – The value to assign to the node_shape_config property of this CreateNodePoolDetails.

  • initial_node_labels (list[oci.container_engine.models.KeyValue]) – The value to assign to the initial_node_labels property of this CreateNodePoolDetails.

  • ssh_public_key (str) – The value to assign to the ssh_public_key property of this CreateNodePoolDetails.

  • quantity_per_subnet (int) – The value to assign to the quantity_per_subnet property of this CreateNodePoolDetails.

  • subnet_ids (list[str]) – The value to assign to the subnet_ids property of this CreateNodePoolDetails.

  • node_config_details (oci.container_engine.models.CreateNodePoolNodeConfigDetails) – The value to assign to the node_config_details property of this CreateNodePoolDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateNodePoolDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateNodePoolDetails.

  • node_eviction_node_pool_settings (oci.container_engine.models.NodeEvictionNodePoolSettings) – The value to assign to the node_eviction_node_pool_settings property of this CreateNodePoolDetails.

  • node_pool_cycling_details (oci.container_engine.models.NodePoolCyclingDetails) – The value to assign to the node_pool_cycling_details property of this CreateNodePoolDetails.

  • secondary_vnics (list[oci.container_engine.models.NodePoolSecondaryVnicDetails]) – The value to assign to the secondary_vnics property of this CreateNodePoolDetails.

  • network_launch_type (str) – The value to assign to the network_launch_type property of this CreateNodePoolDetails. Allowed values for this property are: “VFIO”, “E1000”, “PARAVIRTUALIZED”

  • primary_vnic (oci.container_engine.models.NodePoolPrimaryVnicDetails) – The value to assign to the primary_vnic property of this CreateNodePoolDetails.

property cluster_id

[Required] Gets the cluster_id of this CreateNodePoolDetails. The OCID of the cluster to which this node pool is attached.

Returns

The cluster_id of this CreateNodePoolDetails.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this CreateNodePoolDetails. The OCID of the compartment in which the node pool exists.

Returns

The compartment_id of this CreateNodePoolDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateNodePoolDetails. 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 CreateNodePoolDetails.

Return type

dict(str, dict(str, object))

property freeform_tags

Gets the freeform_tags of this CreateNodePoolDetails. 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 CreateNodePoolDetails.

Return type

dict(str, str)

property initial_node_labels

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

Returns

The initial_node_labels of this CreateNodePoolDetails.

Return type

list[oci.container_engine.models.KeyValue]

property kubernetes_version

Gets the kubernetes_version of this CreateNodePoolDetails. The version of Kubernetes to install on the nodes in the node pool.

Returns

The kubernetes_version of this CreateNodePoolDetails.

Return type

str

property name

[Required] Gets the name of this CreateNodePoolDetails. The name of the node pool. Avoid entering confidential information.

Returns

The name of this CreateNodePoolDetails.

Return type

str

property network_launch_type

Gets the network_launch_type of this CreateNodePoolDetails. Emulation type for the physical network interface card (NIC) for nodes

Allowed values for this property are: “VFIO”, “E1000”, “PARAVIRTUALIZED”

Returns

The network_launch_type of this CreateNodePoolDetails.

Return type

str

property node_config_details

Gets the node_config_details of this CreateNodePoolDetails. The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

Returns

The node_config_details of this CreateNodePoolDetails.

Return type

oci.container_engine.models.CreateNodePoolNodeConfigDetails

property node_eviction_node_pool_settings

Gets the node_eviction_node_pool_settings of this CreateNodePoolDetails.

Returns

The node_eviction_node_pool_settings of this CreateNodePoolDetails.

Return type

oci.container_engine.models.NodeEvictionNodePoolSettings

property node_image_name

Gets the node_image_name of this CreateNodePoolDetails. Deprecated. Use nodeSourceDetails instead. If you specify values for both, this value is ignored. The name of the image running on the nodes in the node pool.

Returns

The node_image_name of this CreateNodePoolDetails.

Return type

str

property node_metadata

Gets the node_metadata of this CreateNodePoolDetails. 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 CreateNodePoolDetails.

Return type

dict(str, str)

property node_pool_cycling_details

Gets the node_pool_cycling_details of this CreateNodePoolDetails.

Returns

The node_pool_cycling_details of this CreateNodePoolDetails.

Return type

oci.container_engine.models.NodePoolCyclingDetails

property node_shape

[Required] Gets the node_shape of this CreateNodePoolDetails. The name of the node shape of the nodes in the node pool.

Returns

The node_shape of this CreateNodePoolDetails.

Return type

str

property node_shape_config

Gets the node_shape_config of this CreateNodePoolDetails. Specify the configuration of the shape to launch nodes in the node pool.

Returns

The node_shape_config of this CreateNodePoolDetails.

Return type

oci.container_engine.models.CreateNodeShapeConfigDetails

property node_source_details

Gets the node_source_details of this CreateNodePoolDetails. Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.

Returns

The node_source_details of this CreateNodePoolDetails.

Return type

oci.container_engine.models.NodeSourceDetails

property primary_vnic

Gets the primary_vnic of this CreateNodePoolDetails.

Returns

The primary_vnic of this CreateNodePoolDetails.

Return type

oci.container_engine.models.NodePoolPrimaryVnicDetails

property quantity_per_subnet

Gets the quantity_per_subnet of this CreateNodePoolDetails. Optional, default to 1. The number of nodes to create in each subnet specified in subnetIds property. When used, subnetIds is required. This property is deprecated, use nodeConfigDetails instead.

Returns

The quantity_per_subnet of this CreateNodePoolDetails.

Return type

int

property secondary_vnics

Gets the secondary_vnics of this CreateNodePoolDetails. A list of secondary vnics to attach to nodes

Returns

The secondary_vnics of this CreateNodePoolDetails.

Return type

list[oci.container_engine.models.NodePoolSecondaryVnicDetails]

property ssh_public_key

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

Returns

The ssh_public_key of this CreateNodePoolDetails.

Return type

str

property subnet_ids

Gets the subnet_ids of this CreateNodePoolDetails. The OCIDs of the subnets in which to place nodes for this node pool. When used, quantityPerSubnet can be provided. This property is deprecated, use nodeConfigDetails. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.

Returns

The subnet_ids of this CreateNodePoolDetails.

Return type

list[str]