oci_node_pool_facts - Retrieve facts of node pools in OCI Container Engine for Kubernetes Service¶
New in version 2.5.
Synopsis¶
- This module retrieves information of a specific node pool or of all the node pools in OCI Container Engine for Kubernetes Service.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
- Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_user |
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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 |
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 |
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 |
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 |
|
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.
|
|
| compartment_id |
The OCID of the compartment. compartment_id is required to list all the node pools in a compartment.
|
|
| config_file_location |
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 |
Default: DEFAULT
|
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. |
| name |
Use name along with the other options to return only resources that match the given name exactly.
|
|
| node_pool_id |
The OCID of the node pool. node_pool_id is required to get the details of a node pool.
aliases: id |
|
| region |
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. |
|
| tenancy |
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 |
Notes¶
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get all the node pools in a compartment
oci_node_pool_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
- name: Get all the node pools in a compartment and filter by cluster
oci_node_pool_facts:
compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
cluster_id: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
- name: Get a specific node pool
oci_node_pool_facts:
id: ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|
node_pools
complex
|
always |
List of node pool details
Sample:
[{'node_shape': 'VM.Standard1.1', 'name': 'test_node_pool', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'initial_node_labels': [{'key': 'type', 'value': 'standard'}, {'key': 'stage', 'value': 'prod'}], 'node_image_id': 'ocid1.image.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx', 'cluster_id': 'ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'quantity_per_subnet': 1, 'node_image_name': 'Oracle-Linux-7.4', 'ssh_public_key': '', 'subnet_ids': ['ocid1.subnet..xxxxxEXAMPLExxxxx'], 'kubernetes_version': 'v1.9.7', 'nodes': [{'lifecycle_state': 'UPDATING', 'availability_domain': 'IwGV:US-ASHBURN-AD-1', 'name': 'oke-c3dsodfgezw-n3wiztggrrt-st2au5vefpq-0', 'subnet_id': 'ocid1.subnet.oc1..xxxxxEXAMPLExxxxx', 'public_ip': '129.213.129.26', 'node_pool_id': 'ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx', 'node_error': None, 'lifecycle_details': 'waiting for running compute instance', 'id': 'ocid1.instance.oc1..xxxxxEXAMPLExxxxx'}]}]
|
|
|
node_shape
string
|
always |
The name of the node shape of the nodes in the node pool.
Sample:
VM.Standard1.1
|
|
|
name
string
|
always |
The name of the node pool.
Sample:
sample_node_pool
|
|
|
compartment_id
string
|
always |
The OCID of the compartment in which the node pool exists.
Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
|
|
|
initial_node_labels
list
|
always |
A list of key/value pairs to add to nodes after they join the Kubernetes cluster.
Sample:
[{'key': 'type', 'value': 'standard'}, {'key': 'stage', 'value': 'prod'}]
|
|
|
id
string
|
always |
The OCID of the node pool.
Sample:
ocid1.nodepool.oc1..xxxxxEXAMPLExxxxx
|
|
|
cluster_id
list
|
always |
The OCID of the cluster to which this node pool is attached.
Sample:
ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
|
|
|
quantity_per_subnet
int
|
always |
The number of nodes in each subnet.
Sample:
1
|
|
|
node_image_id
string
|
always |
The OCID of the image running on the nodes in the node pool.
Sample:
ocid1.image.oc1..xxxxxEXAMPLExxxxx
|
|
|
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.
|
|
|
kubernetes_version
string
|
always |
The version of Kubernetes running on the nodes in the node pool.
Sample:
v1.9.7
|
|
|
nodes
string
|
when retrieving a specific node pool |
The nodes in the node pool.
|
|
|
lifecycle_details
string
|
always |
Details about the state of the cluster masters.
|
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author¶
- Rohit Chaware (@rohitChaware)
Hint
If you notice any issues in this documentation you can edit this document to improve it.