Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace NodePool

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

Properties

Optional clusterId

clusterId: undefined | string

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

Optional compartmentId

compartmentId: undefined | 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 id

id: undefined | string

The OCID of the node pool.

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 running on the nodes in the node pool.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Details about the state of the nodepool.

Optional lifecycleState

lifecycleState: model.NodePoolLifecycleState

The state of the nodepool.

Optional name

name: undefined | string

The name of the node pool.

Optional nodeConfigDetails

nodeConfigDetails: model.NodePoolNodeConfigDetails

The configuration of nodes in the node pool.

Optional nodeEvictionNodePoolSettings

nodeEvictionNodePoolSettings: model.NodeEvictionNodePoolSettings

Optional nodeImageId

nodeImageId: undefined | string

Deprecated. see {@code nodeSource}. The OCID of the image running on the nodes in the node pool.

Optional nodeImageName

nodeImageName: undefined | string

Deprecated. see {@code nodeSource}. 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

Optional nodeShape

nodeShape: undefined | string

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

Optional nodeShapeConfig

nodeShapeConfig: model.NodeShapeConfig

The shape configuration of the nodes.

Optional nodeSource

nodeSource: model.NodeSourceViaImageOption

Deprecated. see {@code nodeSourceDetails}. Source running on the nodes in the node pool.

Optional nodeSourceDetails

nodeSourceDetails: model.NodeSourceViaImageDetails

Source running on the nodes in the node pool.

Optional nodes

nodes: Array<Node>

The nodes in the node pool.

Optional quantityPerSubnet

quantityPerSubnet: undefined | number

The number of nodes in each subnet. 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.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: NodePool): object

getJsonObj