oci_node_pool – Manage node pools in OCI Container Engine for Kubernetes Service

New in version 2.5.

Synopsis

• This module allows the user to create, delete and update node pools in OCI Container Engine for Kubernetes Service.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7
• 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_type string			Choices: api_key ← instance_principal instance_obo_user	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.
cluster_id -				The OCID of the cluster to which this node pool is attached. Required to create a node pool.
compartment_id -				The OCID of the compartment in which the node pool exists. Required to create a node pool.
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.
count_of_nodes_to_wait -			Default: 1	Number of nodes in the node pool to wait for getting into a lifecycle state specified using wait_until when wait=yes and state=present.
force_create boolean			Choices: no ← yes	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.
initial_node_labels -				A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
	key - / required			The key of the pair.
	value - / required			The value of the pair.
key_by list				The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
kubernetes_version -				The version of Kubernetes to install on the nodes in the node pool. Required to create a node pool.
name -				The name of the node pool. Avoid entering confidential information. Required to create a node pool.
node_config_details dictionary				The configuration of nodes in the node pool. Exactly one of the subnetIds or nodeConfigDetails properties must be specified. Note, when performing an update using this field the operation may return after the update has been accepted, but before it has completed. You can use the oci_node_pool facts module to confirm that the relevant configuration has been updated and wait accordingly.
	placement_configs list			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 - / required		The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1`
		subnet_id - / required		The OCID of the subnet in which to place nodes.
	size integer			The number of nodes that should be in the node pool.
node_image_name -				The name of the image running on the nodes in the node pool. Required to create a node pool.
node_pool_id -				The OCID of the node pool. Required to update or delete a node pool. aliases: id
node_shape -				The name of the node shape of the nodes in the node pool. Required to create a node pool.
quantity_per_subnet -				The number of nodes to create in each subnet.
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 -				The SSH public key to add to each node in the node pool.
state -			Choices: present ← absent	Create or update a node pool with state=present. Use state=absent to delete a node pool.
subnet_ids -				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.
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			Choices: no yes ←	While creating or updating a node pool, whether to wait for a number of nodes specified using count_of_nodes_to_wait to be in a state specified using wait_until. While deleting a node pool, whether to wait for the associated work request to get into SUCCEEDED state.
wait_timeout -			Default: 2000	Time, in seconds, to wait when wait=yes.
wait_until -			Default: "ACTIVE"	The lifecycle state of a node in node pool to wait for while creating or updating a node pool with wait=yes.

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 a node pool and wait for atleast two nodes in the node pool to reach ACTIVE state before returning
  oci_node_pool:
    cluster_id: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    name: test_node_pool
    kubernetes_version: "v1.9.7"
    node_image_name: "Oracle-Linux-7.4"
    node_shape: "VM.Standard2.1"
    quantity_per_subnet: 1
    subnet_ids:
        - "ocid1.subnet.oc1..xxxxxEXAMPLExxxxx...abcd"
        - "ocid1.subnet.oc1..xxxxxEXAMPLExxxxx...efgh"
        - "ocid1.subnet.oc1..xxxxxEXAMPLExxxxx...ijkl"
    initial_node_labels:
      - key: "vm_type"
        value: "standard"
      - key: "stage"
        value: "dev"
    count_of_nodes_to_wait: 2

- name: Update node pool
  oci_node_pool:
    id: ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx
    name: ansible_node_pool
    kubernetes_version: "v1.10.3"
    initial_node_labels:
      - key: "vm_type"
        value: "standard"
      - key: "stage"
        value: "prod"

- name: Delete node pool
  oci_node_pool:
    id: ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx
    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 successful create, delete & update operations on node pool	Information about the node pool Sample: {'id': 'ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx', 'name': 'test_node_pool', 'nodes': [{'lifecycle_details': 'waiting for running compute instance', 'id': 'ocid1.instance.oc1..xxxxxEXAMPLExxxxx', 'name': 'oke-c3dsodfgezw-n3wiztggrrt-st2au5vefpq-0', 'availability_domain': 'IwGV:US-ASHBURN-AD-1', 'subnet_id': 'ocid1.subnet.oc1..xxxxxEXAMPLExxxxx', 'node_pool_id': 'ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx', 'public_ip': '129.213.129.26', 'lifecycle_state': 'UPDATING', 'node_error': None}], 'subnet_ids': ['ocid1.subnet..xxxxxEXAMPLExxxxx'], 'node_image_name': 'Oracle-Linux-7.4', 'ssh_public_key': '', 'kubernetes_version': 'v1.9.7', 'node_image_id': 'ocid1.image.oc1..xxxxxEXAMPLExxxxx', 'quantity_per_subnet': 1, 'node_shape': 'VM.Standard2.1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'initial_node_labels': [{'value': 'standard', 'key': 'vm_type'}, {'value': 'prod', 'key': 'stage'}], 'cluster_id': 'ocid1.cluster.oc1..xxxxxEXAMPLExxxxx'}
	cluster_id list			always	The OCID of the cluster to which this node pool is attached. Sample: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
	compartment_id string			always	The OCID of the compartment in which the node pool exists. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	id string			always	The OCID of the node pool. Sample: ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx
	initial_node_labels list			always	A list of key/value pairs to add to nodes after they join the Kubernetes cluster. Sample: [{'value': 'standard', 'key': 'vm_type'}, {'value': 'prod', 'key': 'stage'}]
	kubernetes_version string			always	The version of Kubernetes running on the nodes in the node pool. Sample: v1.9.7
	lifecycle_details string			always	Details about the state of the cluster masters.
	name string			always	The name of the node pool. Sample: sample_node_pool
	node_config_details complex			on success	The configuration of nodes in the node pool.
		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
			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_image_id string			always	The OCID of the image running on the nodes in the node pool. Sample: ocid1.image.oc1..xxxxxEXAMPLExxxxx
	node_shape string			always	The name of the node shape of the nodes in the node pool. Sample: VM.Standard2.1
	nodes string			always	The nodes in the node pool.
	quantity_per_subnet integer			always	The number of nodes in each subnet. Sample: 1
	ssh_public_key string			always	The SSH public key on each node in the node pool.
	subnet_ids list			always	The OCIDs of the subnets in which to place nodes for this node pool.
work_request complex				When a new work request is created	Information of work request Sample: {'time_finished': '2018-08-02T10:24:13+00:00', 'resources': [{'entity_uri': '/nodePools/ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx', 'identifier': 'ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx', 'action_type': 'UPDATED', 'entity_type': 'nodepool'}, {'entity_uri': '/clusters/ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'identifier': 'ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'action_type': 'RELATED', 'entity_type': 'cluster'}], 'status': 'SUCCEEDED', 'time_started': '2018-08-02T10:24:09+00:00', 'operation_type': 'NODEPOOL_UPDATE', 'time_accepted': '2018-08-02T10:22:22+00:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.clustersworkrequest.oc1..xxxxxEXAMPLExxxxx'}
	compartment_id string			always	The OCID of the compartment in which the work request exists.
	id string			always	The OCID of the work request.
	operation_type string			always	The type of work the work request is doing.
	resources list			always	The resources this work request affects.
	status string			always	The current status of the work request.
	time_accepted datetime			always	The time the work request was accepted.
	time_finished datetime			always	The time the work request was finished.
	time_started datetime			always	The time the work request was started.

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Rohit Chaware (@rohitChaware)

Hint

If you notice any issues in this documentation you can edit this document to improve it.