Container Engine for Kubernetes: NodePool¶
Manage OCI Container Engine for Kubernetes node pools. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | containerengine |
| Resource | NodePool |
| API Version | containerengine.oracle.com/v1beta1 |
| Package | Container Engine for Kubernetes |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-containerengine-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/containerengine_v1beta1_nodepool.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
clusterId |
The OCID of the cluster to which this node pool is attached. | string |
Yes |
compartmentId |
The OCID of the compartment in which the node pool exists. | string |
Yes |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
initialNodeLabels |
A list of key/value pairs to add to nodes after they join the Kubernetes cluster. | list[object] |
No |
kubernetesVersion |
The version of Kubernetes to install on the nodes in the node pool. | string |
No |
name |
The name of the node pool. Avoid entering confidential information. | string |
Yes |
nodeConfigDetails |
The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified. | object |
No |
nodeEvictionNodePoolSettings |
NodePoolNodeEvictionNodePoolSettings defines nested fields for NodePool.NodeEvictionNodePoolSettings. | object |
No |
nodeImageName |
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. |
string |
No |
nodeMetadata |
A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. | map[string, string] |
No |
nodePoolCyclingDetails |
NodePoolCyclingDetails defines nested fields for NodePool.NodePoolCyclingDetails. | object |
No |
nodeShape |
The name of the node shape of the nodes in the node pool. | string |
Yes |
nodeShapeConfig |
Specify the configuration of the shape to launch nodes in the node pool. | object |
No |
nodeSourceDetails |
Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source. | object |
No |
quantityPerSubnet |
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. | integer |
No |
sshPublicKey |
The SSH public key on each node in the node pool on launch. | string |
No |
subnetIds |
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. | list[string] |
No |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
clusterId |
The OCID of the cluster to which this node pool is attached. | string |
No |
compartmentId |
The OCID of the compartment in which the node pool exists. | string |
No |
definedTags |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
freeformTags |
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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} |
map[string, string] |
No |
id |
The OCID of the node pool. | string |
No |
initialNodeLabels |
A list of key/value pairs to add to nodes after they join the Kubernetes cluster. | list[object] |
No |
kubernetesVersion |
The version of Kubernetes running on the nodes in the node pool. | string |
No |
lifecycleDetails |
Details about the state of the nodepool. | string |
No |
lifecycleState |
The state of the nodepool. For more information, see Monitoring Clusters (https://docs.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm) | string |
No |
name |
The name of the node pool. | string |
No |
nodeConfigDetails |
The configuration of nodes in the node pool. | object |
No |
nodeEvictionNodePoolSettings |
NodePoolNodeEvictionNodePoolSettings defines nested fields for NodePool.NodeEvictionNodePoolSettings. | object |
No |
nodeImageId |
Deprecated. see nodeSource. The OCID of the image running on the nodes in the node pool. |
string |
No |
nodeImageName |
Deprecated. see nodeSource. The name of the image running on the nodes in the node pool. |
string |
No |
nodeMetadata |
A list of key/value pairs to add to each underlying OCI instance in the node pool on launch. | map[string, string] |
No |
nodePoolCyclingDetails |
NodePoolCyclingDetails defines nested fields for NodePool.NodePoolCyclingDetails. | object |
No |
nodeShape |
The name of the node shape of the nodes in the node pool. | string |
No |
nodeShapeConfig |
The shape configuration of the nodes. | object |
No |
nodeSource |
Deprecated. see nodeSourceDetails. Source running on the nodes in the node pool. |
object |
No |
nodeSourceDetails |
Source running on the nodes in the node pool. | object |
No |
nodes |
The nodes in the node pool. | list[object] |
No |
quantityPerSubnet |
The number of nodes in each subnet. | integer |
No |
sshPublicKey |
The SSH public key on each node in the node pool on launch. | string |
No |
status |
- | object |
Yes |
subnetIds |
The OCIDs of the subnets in which to place nodes for this node pool. | list[string] |
No |
systemTags |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
map[string, map[string, string]] |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/containerengine_v1beta1_nodepool.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
apiVersion: containerengine.oracle.com/v1beta1
kind: NodePool
metadata:
name: nodepool-sample
spec: {}