feat(inventory): allow instances in any state to be fetched optionally

Signed-off-by: Samuel McKendrick <[email protected]>
oracle · Oct 10, 2024 · 17c09d8 · 17c09d8
1 parent 17db579
commit 17c09d8
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 11 deletions.
diff --git a/docs/inventory_plugin/index.rst b/docs/inventory_plugin/index.rst
@@ -526,8 +526,8 @@ as simple as the following example:
 .. important::
    ``use_extra_vars`` option will work with ansible v2.11 or higher.
 
-Fetch All Compute Hosts
-~~~~~~~~~~~~~~~~~~~~~~~
+Fetch All Running Compute Hosts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To fetch all hosts, your configuration can be as simple as the following
 example:
@@ -536,6 +536,18 @@ example:
 
    plugin: oracle.oci.oci
 
+Fetch All Compute Hosts (Regardless Of State)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To fetch all hosts regardless of the instance's lifecycle state, your configuration would look
+similar to the following example:
+
+.. code:: yaml
+
+   plugin: oracle.oci.oci
+
+   fetch_all_compute_hosts: True
+
 Fetch Only DB Hosts
 ~~~~~~~~~~~~~~~~~~~
 
@@ -733,6 +745,7 @@ with more configuration options:
 
    # Compute Hosts (bool type)
    fetch_compute_hosts: True
+   fetch_all_compute_hosts: False
 
    # Process only the primary vnic of a compute instance
    primary_vnic_only: True

diff --git a/plugins/inventory/oci.py b/plugins/inventory/oci.py
@@ -124,6 +124,9 @@
         fetch_compute_hosts:
              description: When set, the compute nodes are fetched. Default value set to True.
              type: bool
+        fetch_all_compute_hosts:
+             description: When set along with fetch_compute_hosts, compute nodes in any lifecycle state are fetched. Default value set to False.
+             type: bool
         primary_vnic_only:
             description: The default behavior of the plugin is to process all VNIC's attached to a compute instance.
                          This might result in instance having multiple entries. When this parameter is set to True,
@@ -354,6 +357,7 @@
 
 # Compute Hosts (bool type)
 fetch_compute_hosts: True
+fetch_all_compute_hosts: False
 
 # Process only the primary vnic of a compute instance
 primary_vnic_only: True
@@ -1845,16 +1849,28 @@ def get_filtered_instances(self, compartment_ocid, region):
         )
         try:
             compute_client = self.get_compute_client_for_region(region)
+            limit = 2000
+
+            if self.get_option("fetch_all_compute_hosts"):
+                instances = self.get_filtered_resources(
+                    oci_common_utils.list_all_resources(
+                        target_fn=compute_client.list_instances,
+                        compartment_id=compartment_ocid,
+                        limit=limit,
+                    ),
+                    compartment_ocid,
+                )
+            else:
+                instances = self.get_filtered_resources(
+                    oci_common_utils.list_all_resources(
+                        target_fn=compute_client.list_instances,
+                        compartment_id=compartment_ocid,
+                        lifecycle_state="RUNNING",
+                        limit=limit,
+                    ),
+                    compartment_ocid,
+                )
 
-            instances = self.get_filtered_resources(
-                oci_common_utils.list_all_resources(
-                    target_fn=compute_client.list_instances,
-                    compartment_id=compartment_ocid,
-                    lifecycle_state="RUNNING",
-                    limit=2000,
-                ),
-                compartment_ocid,
-            )
             return instances
         except ServiceError as ex:
             self.debug(