Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateNodePoolDetails

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

Properties

clusterId

clusterId: string

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

compartmentId

compartmentId: string

The OCID of the compartment in which the node pool exists.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

Optional initialNodeLabels

initialNodeLabels: Array<KeyValue>

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

Optional kubernetesVersion

kubernetesVersion: undefined | string

The version of Kubernetes to install on the nodes in the node pool.

name

name: string

The name of the node pool. Avoid entering confidential information.

Optional nodeConfigDetails

nodeConfigDetails: model.CreateNodePoolNodeConfigDetails

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

Optional nodeEvictionNodePoolSettings

nodeEvictionNodePoolSettings: model.NodeEvictionNodePoolSettings

Optional nodeImageName

nodeImageName: undefined | string

Deprecated. Use {@code 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.

Optional nodeMetadata

nodeMetadata: undefined | object

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

Optional nodePoolCyclingDetails

nodePoolCyclingDetails: model.NodePoolCyclingDetails

nodeShape

nodeShape: string

The name of the node shape of the nodes in the node pool.

Optional nodeShapeConfig

nodeShapeConfig: model.CreateNodeShapeConfigDetails

Specify the configuration of the shape to launch nodes in the node pool.

Optional nodeSourceDetails

nodeSourceDetails: model.NodeSourceViaImageDetails

Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.

Optional quantityPerSubnet

quantityPerSubnet: undefined | number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional sshPublicKey

sshPublicKey: undefined | string

The SSH public key on each node in the node pool on launch.

Optional subnetIds

subnetIds: Array<string>

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.

Functions

getDeserializedJsonObj

getJsonObj