oci_cluster_facts – Retrieve facts of clusters in OCI Container Engine for Kubernetes Service

New in version 2.5.

Synopsis

  • This module retrieves information of a specific cluster or of all the clusters in OCI Container Engine for Kubernetes Service.

Requirements

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

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_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
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
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. cluster_id is required to get the details of a cluster.

aliases: id
compartment_id
-
The OCID of the compartment. compartment_id is required to list all the cluster objects in a compartment.
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.
lifecycle_state
list
    Choices:
  • CREATING
  • ACTIVE
  • FAILED
  • DELETING
  • DELETED
  • UPDATING
A cluster lifecycle state to filter on. Can have multiple parameters of this name. Allowed values are "CREATING", "ACTIVE", "FAILED", "DELETING", "DELETED", "UPDATING".
name
string
Use name along with the other options to return only resources that match the given name exactly.
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.
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

Examples

- name: Get all the clusters
  oci_cluster_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get a specific cluster
  oci_cluster_facts:
    cluster_id: ocid1.cluster.oc1..xxxxxEXAMPLExxxxx

- name: Get clusters in a compartment having the specified name
  oci_cluster_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    name: test_cluster

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
clusters
complex
always
List of cluster details

Sample:
[{'available_kubernetes_upgrades': ['v1.10.3'], 'endpoints': {'kubernetes': 'xxxxxEXAMPLExxxxx.clusters.oci.oraclecloud.com:xxxx'}, 'name': 'test', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'lifecycle_state': 'ACTIVE', 'id': 'ocid1.cluster.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_details': '', 'kubernetes_version': 'v1.9.7', 'options': {'add_ons': {'is_tiller_enabled': True, 'is_kubernetes_dashboard_enabled': True}, 'service_lb_subnet_ids': [], 'kubernetes_network_config': {'services_cidr': '10.96.0.0/16', 'pods_cidr': '10.244.0.0/16'}}, 'metadata': {'created_by_user_id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'deleted_by_work_request_id': None, 'time_updated': None, 'deleted_by_user_id': None, 'updated_by_user_id': None, 'time_created': '2018-07-26T18:42:25+00:00', 'time_deleted': None, 'created_by_work_request_id': 'ocid1.clustersworkrequest.oc1..xxxxxEXAMPLExxxxx', 'updated_by_work_request_id': None}}]
  available_kubernetes_upgrades
list
always
Available Kubernetes versions to which the clusters masters may be upgraded.

Sample:
['v1.10.3']
  compartment_id
string
always
The OCID of the compartment in which the cluster exists.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  endpoints
dictionary
always
Endpoints served up by the cluster masters.

Sample:
{'kubernetes': 'xxxEXAMPLExxx.us-ashburn-1.clusters.oci.oraclecloud.com:6443'}
  id
string
always
The OCID of the cluster.

Sample:
ocid1.cluster.oc1..xxxxxEXAMPLExxxxx
  kubernetes_version
string
always
The version of Kubernetes running on the cluster masters.

Sample:
v1.9.7
  lifecycle_details
string
always
Details about the state of the cluster masters.

  lifecycle_state
string
always
The state of the cluster masters.

Sample:
ACTIVE
  metadata
dictionary
always
Metadata about the cluster.

  name
string
always
The name of the cluster.

Sample:
sample_cluster
  options
dictionary
always
Optional attributes for the cluster.

  vcn_id
string
always
The OCID of the virtual cloud network (VCN) in which the cluster exists.



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.