Add option to restart deployments in DeviceSet (#5)

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Next version
+
+### 🚀 New
+
+* [#5](https://github.com/sdss/lvmgort/pull/5) Add option to restart deployments associated with a device set as `GortDeviceSet.restart()`.
+
+
 ## 0.2.2 - July 23, 2023
 
 ### 🚀 New

src/gort/devices/ag.py

@@ -70,6 +70,7 @@ class AGSet(GortDeviceSet[AG]):
     """A set of auto-guiders."""
 
     __DEVICE_CLASS__ = AG
+    __DEPLOYMENTS__ = ["lvmagcam"]
 
     async def reconnect(self):
         """Reconnects all the AG cameras.

src/gort/devices/enclosure.py

@@ -11,7 +11,7 @@
 from typing import TYPE_CHECKING
 
 from gort.exceptions import GortEnclosureError
-from gort.gort import GortDevice
+from gort.gort import GortDevice, GortDeviceSet
 
 
 if TYPE_CHECKING:
@@ -25,9 +25,17 @@
 class Enclosure(GortDevice):
     """Class representing the LVM enclosure."""
 
+    __DEPLOYMENTS__ = ["lvmecp"]
+
     def __init__(self, gort: GortClient, name: str, actor: str, **kwargs):
         super().__init__(gort, name, actor)
 
+    async def restart(self):
+        """Restarts the ``lvmecp`` deployment."""
+
+        # HACK: GortDevice has the everything that is needed to run restart.
+        await GortDeviceSet.restart(self)  # type: ignore
+
     async def status(self):
         """Retrieves the status of the power outlet."""
 

src/gort/devices/guider.py

@@ -294,6 +294,7 @@ class GuiderSet(GortDeviceSet[Guider]):
     """A set of telescope guiders."""
 
     __DEVICE_CLASS__ = Guider
+    __DEPLOYMENTS__ = ["lvmguider"]
 
     async def expose(self, *args, continuous: bool = False, **kwargs):
         """Exposes all the cameras using the guider.

src/gort/devices/nps.py

@@ -55,3 +55,4 @@ class NPSSet(GortDeviceSet[NPS]):
     """A set of networked power switches."""
 
     __DEVICE_CLASS__ = NPS
+    __DEPLOYMENTS__ = ["lvmnps"]

src/gort/devices/spec.py

@@ -529,6 +529,7 @@ class SpectrographSet(GortDeviceSet[Spectrograph]):
     """A set of LVM spectrographs."""
 
     __DEVICE_CLASS__ = Spectrograph
+    __DEPLOYMENTS__ = ["lvmscp"]
 
     def __init__(self, gort: GortClient, data: dict[str, dict], **kwargs):
         super().__init__(gort, data, **kwargs)

src/gort/devices/telescope.py

@@ -655,6 +655,13 @@ class TelescopeSet(GortDeviceSet[Telescope]):
     """A representation of a set of telescopes."""
 
     __DEVICE_CLASS__ = Telescope
+    __DEPLOYMENTS__ = [
+        "lvm-sci-pwi",
+        "lvm-spec-pwi",
+        "lvm-skye-pwi",
+        "lvm-skyw-pwi",
+        "lvmtan",
+    ]
 
     def __init__(self, gort: GortClient, data: dict[str, dict]):
         super().__init__(gort, data)
@@ -666,6 +673,14 @@ async def initialise(self):
 
         await asyncio.gather(*[tel.initialise() for tel in self.values()])
 
+    async def restart(self):
+        """Restarts the ``lvmpwi`` and ``lvmtan`` deployments and re-homes."""
+
+        await super().restart()
+
+        self.write_to_log("Homing all devices after a restart.")
+        await self.home(home_subdevices=True)
+
     async def home(self, home_subdevices: bool = False):
         """Initialises and homes all telescopes.
 

src/gort/gort.py

@@ -194,6 +194,7 @@ class GortDeviceSet(dict[str, GortDeviceType], Generic[GortDeviceType]):
     """
 
     __DEVICE_CLASS__: ClassVar[Type["GortDevice"]]
+    __DEPLOYMENTS__: ClassVar[list[str]] = []
 
     def __init__(self, gort: GortClient, data: dict[str, dict], **kwargs):
         self.gort = gort
@@ -301,6 +302,25 @@ def write_to_log(
 
         self.gort.log.log(level, message)
 
+    async def restart(self):
+        """Restarts the set deployments and resets all controllers."""
+
+        if not isinstance(self.gort, Gort):
+            raise GortError("Client is not a Gort instance.")
+
+        if self.gort.kubernetes is None:
+            raise GortError("The Kubernetes cluster is not accessible.")
+
+        for deployment in self.__DEPLOYMENTS__:
+            self.gort.kubernetes.restart_deployment(deployment, from_file=True)
+
+        await asyncio.sleep(5)
+
+        running_deployments = self.gort.kubernetes.list_deployments()
+        for deployment in self.__DEPLOYMENTS__:
+            if deployment not in running_deployments:
+                self.write_to_log(f"Deployment {deployment} did not restart.", "error")
+
 
 class GortDevice:
     """A gort-managed device.

src/gort/kubernetes.py

@@ -142,7 +142,7 @@ def restart_deployment(self, deployment: str, from_file: bool = True):
                 namespace = self.get_deployment_namespace(deployment)
                 self.log.debug(f"Deleting deployment {deployment}.")
                 self.apps_v1.delete_namespaced_deployment(deployment, namespace)
-                sleep(5)  # Give some time for the pods to exit.
+                sleep(3)  # Give some time for the pods to exit.
             else:
                 self.log.warning(f"{deployment!r} is not running.")