oracle.oci.oci_container_engine_node_pool – Manage a NodePool resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_container_engine_node_pool
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a NodePool resource in Oracle Cloud Infrastructure
For state=present, create a new node pool.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | ||||
---|---|---|---|---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||||
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
|||||
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
|||||
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
|||||
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
||||
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
||||
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|||||
cluster_id
string
|
The OCID of the cluster to which this node pool is attached.
Required for create using state=present.
|
|||||
compartment_id
string
|
The OCID of the compartment in which the node pool exists.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|||||
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
|||||
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
|||||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|||||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
||||
freeform_tags
dictionary
|
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"}`
This parameter is updatable.
|
|||||
initial_node_labels
list
/ elements=dictionary
|
A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
This parameter is updatable.
|
|||||
key
string
|
The key of the pair.
|
|||||
value
string
|
The value of the pair.
|
|||||
is_force_deletion_after_override_grace_duration
boolean
|
|
If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
This parameter is updatable.
|
||||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|||||
kubernetes_version
string
|
The version of Kubernetes to install on the nodes in the node pool.
This parameter is updatable.
|
|||||
name
string
|
The name of the node pool. Avoid entering confidential information.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set. |
|||||
node_config_details
dictionary
|
The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified.
This parameter is updatable.
|
|||||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|||||
freeform_tags
dictionary
|
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"}`
This parameter is updatable.
|
|||||
is_pv_encryption_in_transit_enabled
boolean
|
|
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
This parameter is updatable.
|
||||
kms_key_id
string
|
The OCID of the Key Management Service key assigned to the boot volume.
This parameter is updatable.
|
|||||
node_pool_pod_network_option_details
dictionary
|
The CNI related configuration of pods in the node pool.
|
|||||
cni_type
string
/ required
|
|
The CNI plugin used by this node pool
|
||||
max_pods_per_node
integer
|
The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape
Applicable when cni_type is 'OCI_VCN_IP_NATIVE'
|
|||||
pod_nsg_ids
list
/ elements=string
|
The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
Applicable when cni_type is 'OCI_VCN_IP_NATIVE'
|
|||||
pod_subnet_ids
list
/ elements=string
|
The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs
Required when cni_type is 'OCI_VCN_IP_NATIVE'
|
|||||
nsg_ids
list
/ elements=string
|
The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
This parameter is updatable.
|
|||||
placement_configs
list
/ elements=dictionary
|
The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node.
To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.
|
|||||
availability_domain
string
/ required
|
The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1`
|
|||||
capacity_reservation_id
string
|
The OCID of the compute capacity reservation in which to place the compute instance.
|
|||||
fault_domains
list
/ elements=string
|
A list of fault domains in which to place nodes.
|
|||||
preemptible_node_config
dictionary
|
||||||
preemption_action
dictionary
/ required
|
||||||
is_preserve_boot_volume
boolean
|
|
Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
|
||||
type
string
/ required
|
|
The type of action to run when the instance is interrupted for eviction.
|
||||
subnet_id
string
/ required
|
The OCID of the subnet in which to place nodes.
|
|||||
size
integer
|
The number of nodes that should be in the node pool.
This parameter is updatable.
|
|||||
node_eviction_node_pool_settings
dictionary
|
This parameter is updatable.
|
|||||
eviction_grace_duration
string
|
Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
|
|||||
is_force_delete_after_grace_duration
boolean
|
|
If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
|
||||
node_image_name
string
|
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.
|
|||||
node_metadata
dictionary
|
A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
This parameter is updatable.
|
|||||
node_pool_cycling_details
dictionary
|
This parameter is updatable.
|
|||||
is_node_cycling_enabled
boolean
|
|
If nodes in the nodepool will be cycled to have new changes.
|
||||
maximum_surge
string
|
Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100%
|
|||||
maximum_unavailable
string
|
Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100%
|
|||||
node_pool_id
string
|
The OCID of the node pool.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|||||
node_shape
string
|
The name of the node shape of the nodes in the node pool.
Required for create using state=present.
This parameter is updatable.
|
|||||
node_shape_config
dictionary
|
Specify the configuration of the shape to launch nodes in the node pool.
This parameter is updatable.
|
|||||
memory_in_gbs
float
|
The total amount of memory available to each node, in gigabytes.
This parameter is updatable.
|
|||||
ocpus
float
|
The total number of OCPUs available to each node in the node pool. See here for details.
This parameter is updatable.
|
|||||
node_source_details
dictionary
|
Specify the source to use to launch nodes in the node pool. Currently, image is the only supported source.
This parameter is updatable.
|
|||||
boot_volume_size_in_gbs
integer
|
The size of the boot volume in GBs. Minimum value is 50 GB. See here for max custom boot volume sizing and OS-specific requirements.
|
|||||
image_id
string
/ required
|
The OCID of the image used to boot the node.
|
|||||
source_type
string
/ required
|
|
The source type for the node. Use `IMAGE` when specifying an OCID of an image.
|
||||
override_eviction_grace_duration
string
|
Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
This parameter is updatable.
|
|||||
quantity_per_subnet
integer
|
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.
This parameter is updatable.
|
|||||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
||||
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
|||||
ssh_public_key
string
|
The SSH public key on each node in the node pool on launch.
This parameter is updatable.
|
|||||
state
string
|
|
The state of the NodePool.
Use state=present to create or update a NodePool.
Use state=absent to delete a NodePool.
|
||||
subnet_ids
list
/ elements=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.
This parameter is updatable.
|
|||||
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
|||||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
||||
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create node_pool
oci_container_engine_node_pool:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
cluster_id: "ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
node_shape: node_shape_example
# optional
node_image_name: node_image_name_example
kubernetes_version: kubernetes_version_example
initial_node_labels:
- # optional
key: key_example
value: value_example
quantity_per_subnet: 56
subnet_ids: [ "subnet_ids_example" ]
node_config_details:
# optional
size: 56
nsg_ids: [ "nsg_ids_example" ]
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
is_pv_encryption_in_transit_enabled: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
placement_configs:
- # required
availability_domain: Uocm:PHX-AD-1
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
# optional
capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx"
preemptible_node_config:
# required
preemption_action:
# required
type: TERMINATE
# optional
is_preserve_boot_volume: true
fault_domains: [ "fault_domains_example" ]
node_pool_pod_network_option_details:
# required
pod_subnet_ids: [ "pod_subnet_ids_example" ]
cni_type: OCI_VCN_IP_NATIVE
# optional
max_pods_per_node: 56
pod_nsg_ids: [ "pod_nsg_ids_example" ]
node_metadata: null
node_source_details:
# required
source_type: IMAGE
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
# optional
boot_volume_size_in_gbs: 56
ssh_public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..."
node_shape_config:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
node_eviction_node_pool_settings:
# optional
eviction_grace_duration: eviction_grace_duration_example
is_force_delete_after_grace_duration: true
node_pool_cycling_details:
# optional
maximum_unavailable: maximum_unavailable_example
maximum_surge: maximum_surge_example
is_node_cycling_enabled: true
- name: Update node_pool
oci_container_engine_node_pool:
# required
node_pool_id: "ocid1.nodepool.oc1..xxxxxxEXAMPLExxxxxx"
# optional
name: name_example
kubernetes_version: kubernetes_version_example
initial_node_labels:
- # optional
key: key_example
value: value_example
quantity_per_subnet: 56
subnet_ids: [ "subnet_ids_example" ]
node_config_details:
# optional
size: 56
nsg_ids: [ "nsg_ids_example" ]
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
is_pv_encryption_in_transit_enabled: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
placement_configs:
- # required
availability_domain: Uocm:PHX-AD-1
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
# optional
capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx"
preemptible_node_config:
# required
preemption_action:
# required
type: TERMINATE
# optional
is_preserve_boot_volume: true
fault_domains: [ "fault_domains_example" ]
node_pool_pod_network_option_details:
# required
pod_subnet_ids: [ "pod_subnet_ids_example" ]
cni_type: OCI_VCN_IP_NATIVE
# optional
max_pods_per_node: 56
pod_nsg_ids: [ "pod_nsg_ids_example" ]
node_metadata: null
node_source_details:
# required
source_type: IMAGE
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
# optional
boot_volume_size_in_gbs: 56
ssh_public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..."
node_shape: node_shape_example
node_shape_config:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
node_eviction_node_pool_settings:
# optional
eviction_grace_duration: eviction_grace_duration_example
is_force_delete_after_grace_duration: true
node_pool_cycling_details:
# optional
maximum_unavailable: maximum_unavailable_example
maximum_surge: maximum_surge_example
is_node_cycling_enabled: true
override_eviction_grace_duration: override_eviction_grace_duration_example
is_force_deletion_after_override_grace_duration: true
- name: Update node_pool using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_container_engine_node_pool:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
# optional
kubernetes_version: kubernetes_version_example
initial_node_labels:
- # optional
key: key_example
value: value_example
quantity_per_subnet: 56
subnet_ids: [ "subnet_ids_example" ]
node_config_details:
# optional
size: 56
nsg_ids: [ "nsg_ids_example" ]
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
is_pv_encryption_in_transit_enabled: true
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
placement_configs:
- # required
availability_domain: Uocm:PHX-AD-1
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
# optional
capacity_reservation_id: "ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx"
preemptible_node_config:
# required
preemption_action:
# required
type: TERMINATE
# optional
is_preserve_boot_volume: true
fault_domains: [ "fault_domains_example" ]
node_pool_pod_network_option_details:
# required
pod_subnet_ids: [ "pod_subnet_ids_example" ]
cni_type: OCI_VCN_IP_NATIVE
# optional
max_pods_per_node: 56
pod_nsg_ids: [ "pod_nsg_ids_example" ]
node_metadata: null
node_source_details:
# required
source_type: IMAGE
image_id: "ocid1.image.oc1..xxxxxxEXAMPLExxxxxx"
# optional
boot_volume_size_in_gbs: 56
ssh_public_key: "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz..."
node_shape: node_shape_example
node_shape_config:
# optional
ocpus: 3.4
memory_in_gbs: 3.4
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
node_eviction_node_pool_settings:
# optional
eviction_grace_duration: eviction_grace_duration_example
is_force_delete_after_grace_duration: true
node_pool_cycling_details:
# optional
maximum_unavailable: maximum_unavailable_example
maximum_surge: maximum_surge_example
is_node_cycling_enabled: true
override_eviction_grace_duration: override_eviction_grace_duration_example
is_force_deletion_after_override_grace_duration: true
- name: Delete node_pool
oci_container_engine_node_pool:
# required
node_pool_id: "ocid1.nodepool.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
# optional
override_eviction_grace_duration: override_eviction_grace_duration_example
is_force_deletion_after_override_grace_duration: true
- name: Delete node_pool using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_container_engine_node_pool:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
name: name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||||
---|---|---|---|---|---|---|---|
node_pool
complex
|
on success |
Details of the NodePool resource acted upon by the current operation
Sample:
{'cluster_id': 'ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'initial_node_labels': [{'key': 'key_example', 'value': 'value_example'}], 'kubernetes_version': 'kubernetes_version_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'DELETED', 'name': 'name_example', 'node_config_details': {'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'is_pv_encryption_in_transit_enabled': True, 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'node_pool_pod_network_option_details': {'cni_type': 'OCI_VCN_IP_NATIVE', 'max_pods_per_node': 56, 'pod_nsg_ids': [], 'pod_subnet_ids': []}, 'nsg_ids': [], 'placement_configs': [{'availability_domain': 'Uocm:PHX-AD-1', 'capacity_reservation_id': 'ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx', 'fault_domains': [], 'preemptible_node_config': {'preemption_action': {'is_preserve_boot_volume': True, 'type': 'TERMINATE'}}, 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}], 'size': 56}, 'node_eviction_node_pool_settings': {'eviction_grace_duration': 'eviction_grace_duration_example', 'is_force_delete_after_grace_duration': True}, 'node_image_id': 'ocid1.nodeimage.oc1..xxxxxxEXAMPLExxxxxx', 'node_image_name': 'node_image_name_example', 'node_metadata': {}, 'node_pool_cycling_details': {'is_node_cycling_enabled': True, 'maximum_surge': 'maximum_surge_example', 'maximum_unavailable': 'maximum_unavailable_example'}, 'node_shape': 'node_shape_example', 'node_shape_config': {'memory_in_gbs': 3.4, 'ocpus': 3.4}, 'node_source': {'image_id': 'ocid1.image.oc1..xxxxxxEXAMPLExxxxxx', 'source_name': 'source_name_example', 'source_type': 'IMAGE'}, 'node_source_details': {'boot_volume_size_in_gbs': 56, 'image_id': 'ocid1.image.oc1..xxxxxxEXAMPLExxxxxx', 'source_type': 'IMAGE'}, 'nodes': [{'availability_domain': 'Uocm:PHX-AD-1', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'fault_domain': 'FAULT-DOMAIN-1', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'kubernetes_version': 'kubernetes_version_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'name': 'name_example', 'node_error': {'code': 'code_example', 'message': 'message_example', 'opc_request_id': 'ocid1.opcrequest.oc1..xxxxxxEXAMPLExxxxxx', 'status': 'status_example'}, 'node_pool_id': 'ocid1.nodepool.oc1..xxxxxxEXAMPLExxxxxx', 'private_ip': 'private_ip_example', 'public_ip': 'public_ip_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}}], 'quantity_per_subnet': 56, 'ssh_public_key': 'ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...', 'subnet_ids': [], 'system_tags': {}}
|
|||||
cluster_id
string
|
on success |
The OCID of the cluster to which this node pool is attached.
Sample:
ocid1.cluster.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
compartment_id
string
|
on success |
The OCID of the compartment in which the node pool exists.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||||
freeform_tags
dictionary
|
on success |
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"}`
Sample:
{'Department': 'Finance'}
|
|||||
id
string
|
on success |
The OCID of the node pool.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
initial_node_labels
complex
|
on success |
A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
|
|||||
key
string
|
on success |
The key of the pair.
Sample:
key_example
|
|||||
value
string
|
on success |
The value of the pair.
Sample:
value_example
|
|||||
kubernetes_version
string
|
on success |
The version of Kubernetes running on the nodes in the node pool.
Sample:
kubernetes_version_example
|
|||||
lifecycle_details
string
|
on success |
Details about the state of the nodepool.
Sample:
lifecycle_details_example
|
|||||
lifecycle_state
string
|
on success |
The state of the nodepool.
Sample:
DELETED
|
|||||
name
string
|
on success |
The name of the node pool.
Sample:
name_example
|
|||||
node_config_details
complex
|
on success |
The configuration of nodes in the node pool.
|
|||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||||
freeform_tags
dictionary
|
on success |
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"}`
Sample:
{'Department': 'Finance'}
|
|||||
is_pv_encryption_in_transit_enabled
boolean
|
on success |
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
Sample:
True
|
|||||
kms_key_id
string
|
on success |
The OCID of the Key Management Service key assigned to the boot volume.
Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
node_pool_pod_network_option_details
complex
|
on success |
The CNI related configuration of pods in the node pool.
|
|||||
cni_type
string
|
on success |
The CNI plugin used by this node pool
Sample:
OCI_VCN_IP_NATIVE
|
|||||
max_pods_per_node
integer
|
on success |
The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape
Sample:
56
|
|||||
pod_nsg_ids
list
/ elements=string
|
on success |
The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
|
|||||
pod_subnet_ids
list
/ elements=string
|
on success |
The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs
|
|||||
nsg_ids
list
/ elements=string
|
on success |
The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see NetworkSecurityGroup.
|
|||||
placement_configs
complex
|
on success |
The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node.
To use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.
|
|||||
availability_domain
string
|
on success |
The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
|||||
capacity_reservation_id
string
|
on success |
The OCID of the compute capacity reservation in which to place the compute instance.
Sample:
ocid1.capacityreservation.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
fault_domains
list
/ elements=string
|
on success |
A list of fault domains in which to place nodes.
|
|||||
preemptible_node_config
complex
|
on success |
|
|||||
preemption_action
complex
|
on success |
|
|||||
is_preserve_boot_volume
boolean
|
on success |
Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
Sample:
True
|
|||||
type
string
|
on success |
The type of action to run when the instance is interrupted for eviction.
Sample:
TERMINATE
|
|||||
subnet_id
string
|
on success |
The OCID of the subnet in which to place nodes.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
size
integer
|
on success |
The number of nodes in the node pool.
Sample:
56
|
|||||
node_eviction_node_pool_settings
complex
|
on success |
|
|||||
eviction_grace_duration
string
|
on success |
Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
Sample:
eviction_grace_duration_example
|
|||||
is_force_delete_after_grace_duration
boolean
|
on success |
If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
Sample:
True
|
|||||
node_image_id
string
|
on success |
Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool.
Sample:
ocid1.nodeimage.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
node_image_name
string
|
on success |
Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool.
Sample:
node_image_name_example
|
|||||
node_metadata
dictionary
|
on success |
A list of key/value pairs to add to each underlying OCI instance in the node pool on launch.
|
|||||
node_pool_cycling_details
complex
|
on success |
|
|||||
is_node_cycling_enabled
boolean
|
on success |
If nodes in the nodepool will be cycled to have new changes.
Sample:
True
|
|||||
maximum_surge
string
|
on success |
Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100%
Sample:
maximum_surge_example
|
|||||
maximum_unavailable
string
|
on success |
Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100%
Sample:
maximum_unavailable_example
|
|||||
node_shape
string
|
on success |
The name of the node shape of the nodes in the node pool.
Sample:
node_shape_example
|
|||||
node_shape_config
complex
|
on success |
The shape configuration of the nodes.
|
|||||
memory_in_gbs
float
|
on success |
The total amount of memory available to each node, in gigabytes.
Sample:
3.4
|
|||||
ocpus
float
|
on success |
The total number of OCPUs available to each node in the node pool. See here for details.
Sample:
3.4
|
|||||
node_source
complex
|
on success |
Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool.
|
|||||
image_id
string
|
on success |
The OCID of the image.
Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
source_name
string
|
on success |
The user-friendly name of the entity corresponding to the OCID.
Sample:
source_name_example
|
|||||
source_type
string
|
on success |
The source type of this option. `IMAGE` means the OCID is of an image.
Sample:
IMAGE
|
|||||
node_source_details
complex
|
on success |
Source running on the nodes in the node pool.
|
|||||
boot_volume_size_in_gbs
integer
|
on success |
The size of the boot volume in GBs. Minimum value is 50 GB. See here for max custom boot volume sizing and OS-specific requirements.
Sample:
56
|
|||||
image_id
string
|
on success |
The OCID of the image used to boot the node.
Sample:
ocid1.image.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
source_type
string
|
on success |
The source type for the node. Use `IMAGE` when specifying an OCID of an image.
Sample:
IMAGE
|
|||||
nodes
complex
|
on success |
The nodes in the node pool.
|
|||||
availability_domain
string
|
on success |
The name of the availability domain in which this node is placed.
Sample:
Uocm:PHX-AD-1
|
|||||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|||||
fault_domain
string
|
on success |
The fault domain of this node.
Sample:
FAULT-DOMAIN-1
|
|||||
freeform_tags
dictionary
|
on success |
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"}`
Sample:
{'Department': 'Finance'}
|
|||||
id
string
|
on success |
The OCID of the compute instance backing this node.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
kubernetes_version
string
|
on success |
The version of Kubernetes this node is running.
Sample:
kubernetes_version_example
|
|||||
lifecycle_details
string
|
on success |
Details about the state of the node.
Sample:
lifecycle_details_example
|
|||||
lifecycle_state
string
|
on success |
The state of the node.
Sample:
CREATING
|
|||||
name
string
|
on success |
The name of the node.
Sample:
name_example
|
|||||
node_error
complex
|
on success |
An error that may be associated with the node.
|
|||||
code
string
|
on success |
A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.
Sample:
code_example
|
|||||
message
string
|
on success |
A human-readable error string of the upstream error.
Sample:
message_example
|
|||||
opc_request_id
string
|
on success |
Unique Oracle-assigned identifier for the upstream request. If you need to contact Oracle about a particular upstream request, please provide the request ID.
Sample:
ocid1.opcrequest.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
status
string
|
on success |
The status of the HTTP response encountered in the upstream error.
Sample:
status_example
|
|||||
node_pool_id
string
|
on success |
The OCID of the node pool to which this node belongs.
Sample:
ocid1.nodepool.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
private_ip
string
|
on success |
The private IP address of this node.
Sample:
private_ip_example
|
|||||
public_ip
string
|
on success |
The public IP address of this node.
Sample:
public_ip_example
|
|||||
subnet_id
string
|
on success |
The OCID of the subnet in which this node is placed.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|||||
quantity_per_subnet
integer
|
on success |
The number of nodes in each subnet.
Sample:
56
|
|||||
ssh_public_key
string
|
on success |
The SSH public key on each node in the node pool on launch.
Sample:
ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAz...
|
|||||
subnet_ids
list
/ elements=string
|
on success |
The OCIDs of the subnets in which to place nodes for this node pool.
|
|||||
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
Authors¶
Oracle (@oracle)