Jira: add ZDU related methods and adjust existing #570

Author: gonchik

atlassian/jira.py

@@ -424,6 +424,10 @@ def get_all_system_avatars(self, avatar_type: str = "user") -> T_resp_json:
     """
 
     def get_cluster_all_nodes(self) -> T_resp_json:
+        """
+        Get all nodes in the cluster
+        :return:
+        """
         url = self.resource_url("cluster/nodes")
         return self.get(url)
 
@@ -457,7 +461,8 @@ def get_cluster_alive_nodes(self) -> list:
 
     def request_current_index_from_node(self, node_id: T_id) -> T_resp_json:
         """
-        Request current index from node (the request is processed asynchronously)
+        Request current index from node (the request is processed asynchronously).
+        This method is deprecated as it is Lucene specific and is planned for removal in Jira 11.
         :return:
         """
         base_url = self.resource_url("cluster/index-snapshot")
@@ -502,7 +507,43 @@ def download_support_zip(self, file_name: str) -> bytes:
     Reference: https://docs.atlassian.com/software/jira/docs/api/REST/8.5.0/#api/2/cluster/zdu
     """
 
+    def approve_cluster_zdu_upgrade(self) -> T_resp_json:
+        """
+        Approves the cluster upgrade.
+        :return:
+        """
+        url = self.resource_url("cluster/zdu/approve")
+        return self.post(url)
+
+    def cancel_cluster_zdu_upgrade(self) -> T_resp_json:
+        """
+        Cancels the ongoing cluster upgrade.
+        :return:
+        """
+        url = self.resource_url("cluster/zdu/cancel")
+        return self.post(url)
+
+    def retry_cluster_zdu_upgrade(self) -> T_resp_json:
+        """
+        Retries the cluster upgrade.
+        :return:
+        """
+        url = self.resource_url("cluster/zdu/retryUpgrade")
+        return self.post(url)
+
+    def start_cluster_zdu_upgrade(self) -> T_resp_json:
+        """
+        Starts the cluster upgrade.
+        :return:
+        """
+        url = self.resource_url("cluster/zdu/start")
+        return self.post(url)
+
     def get_cluster_zdu_state(self) -> T_resp_json:
+        """
+        Get the state of the cluster upgrade.
+        :return:
+        """
         url = self.resource_url("cluster/zdu/state")
         return self.get(url)
 

docs/jira.rst

@@ -602,6 +602,16 @@ Cluster methods (only for DC edition)
     # Request current index from node (the request is processed asynchronously).
     jira.request_current_index_from_node(node_id)
 
+    # Get cluster nodes where alive = True
+    jira.get_cluster_alive_nodes()
+
+    # Change the node's state to offline if the node is reporting as active, but is not alive
+    jira.set_node_to_offline(node_id)
+
+    #  Delete the node from the cluster if state of node is OFFLINE
+    jira.delete_cluster_node(node_id)
+
+
 Health checks methods (only for on-prem edition)
 ------------------------------------------------
 .. code-block:: python