feat(deployment): adds support for exposing healthcheck for deployments

This commit adds support for defining liveness probe. You can set HTTP, EXEC or TCP liveness probe

riocli/apply/manifests/package-nonros-device.yaml

@@ -20,6 +20,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -31,6 +40,16 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
+
       docker:
         image: "busybox:latest"
         imagePullPolicy: "Always" # Always, Never, IfNotPresent(default)

riocli/apply/manifests/package-ros-device-no-rosbag.yaml

@@ -21,6 +21,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -32,6 +41,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       docker:
         image: "busybox:latest"
         imagePullPolicy: "Always" # Always, Never, IfNotPresent(default)

riocli/apply/manifests/package-ros-device-rosbag.yaml

@@ -21,6 +21,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -32,6 +41,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       docker:
         image: "busybox:latest"
         imagePullPolicy: "Always" # Always, Never, IfNotPresent(default)

riocli/apply/manifests/package.yaml

@@ -20,6 +20,15 @@ spec:
       limits:
         cpu: 0.025 # Unit: Core Options: [Multiple of 0.025, <= 8]
         memory: 128 # Unit: MB Options: [Multiple of 128, <= 32768]
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -32,6 +41,15 @@ spec:
       limits:
         cpu: 0.025 # Unit: Core Options: [Multiple of 0.025, <= 8]
         memory: 128 # Unit: MB Options: [Multiple of 128, <= 32768]
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       docker:
         image: "busybox:latest"
         pullSecret:
@@ -166,6 +184,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -177,6 +204,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       docker:
         image: "busybox:latest"
         imagePullPolicy: "Always" # Always, Never, IfNotPresent(default)
@@ -299,6 +335,15 @@ spec:
       limits:
         cpu: 0.025 # Unit: Core Options: [Multiple of 0.025, <= 8]
         memory: 128 # Unit: MB Options: [Multiple of 128, <= 32768]
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -311,6 +356,15 @@ spec:
       limits:
         cpu: 0.025 # Unit: Core Options: [Multiple of 0.025, <= 8]
         memory: 128 # Unit: MB Options: [Multiple of 128, <= 32768]
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       docker:
         image: "busybox:latest"
         pullSecret:
@@ -377,6 +431,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -388,6 +451,15 @@ spec:
       limits: # Optional
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       docker:
         image: "busybox:latest"
         imagePullPolicy: "Always" # Always, Never, IfNotPresent(default)
@@ -431,6 +503,15 @@ spec:
       limits:
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       build:
         depends:
           kind: build
@@ -442,6 +523,15 @@ spec:
       limits:
         cpu: 0.025 # Unit: Core (Optional)
         memory: 128 # Unit: MB (Optional)
+      livenessProbe: # Optional
+        exec:
+          command:
+            - "shell-cmd"
+        initialDelaySeconds: 5  # Number of seconds after the container has started before liveness probes are initiated.
+        periodSeconds: 10 # How often (in seconds) to perform the probe.
+        failureThreshold: 1 # Minimum consecutive failures for the probe to be considered failed after having succeeded.
+        successThreshold: 3 # Minimum consecutive successes for the probe to be considered successful after having failed.
+        timeoutSeconds: 1 # Number of seconds after which the probe times out.
       docker:
         image: "busybox:latest"
         imagePullPolicy: "Always" # Always, Never, IfNotPresent(default)

riocli/jsonschema/schemas/package-schema.yaml

@@ -122,8 +122,8 @@ definitions:
           - docker
           - build
           - preInstalled
-      command:
-        type: string
+        command:
+          type: string
       runAsBash:
         type: boolean
         default: True
@@ -137,6 +137,58 @@ definitions:
           memory:
             type: number
             minimum: 0
+      livenessProbe:
+        type: object
+        properties:
+          http:
+            type: object
+            properties:
+              path:
+                type: string
+                description: Path to access for the HTTP probe.
+              port:
+                type: integer
+                description: Port number for the HTTP probe.
+            required:
+              - path
+              - port
+          exec:
+            type: object
+            properties:
+              command:
+                type: array
+                items:
+                  type: string
+                description: Command to execute for the Exec probe.
+            required:
+              - command
+          tcp:
+            type: object
+            properties:
+              port:
+                type: integer
+                description: Port number for the TCP probe.
+            required:
+              - port
+          initialDelaySeconds:
+            type: integer
+            description: Number of seconds after the container has started before liveness probes are initiated.
+          timeoutSeconds:
+            type: integer
+            default: 1
+            description: Number of seconds after which the probe times out.
+          periodSeconds:
+            type: integer
+            default: 1
+            description: How often (in seconds) to perform the probe.
+          successThreshold:
+            type: integer
+            default: 3
+            description: Minimum consecutive successes for the probe to be considered successful after having failed.
+          failureThreshold:
+            type: integer
+            default: 3
+            description: Minimum consecutive failures for the probe to be considered failed after having succeeded.
     required:
       - type
     dependencies:

riocli/package/model.py

@@ -159,7 +159,6 @@ def create_object(self, client: Client, **kwargs):
             component_obj.rosBagJobDefs = self.spec.rosBagJobs
 
         pkg_object.plans[0].components = [component_obj]
-
         return client.create_package(pkg_object)
 
     def update_object(self, client: Client, obj: typing.Any) -> typing.Any:
@@ -198,6 +197,10 @@ def _map_executable(self, exec):
                 'memory': exec.limits.get('memory', 0)
             }
 
+        if 'livenessProbe' in exec:
+            if exec.livenessProbe.get("http") or exec.livenessProbe.get("tcp") or exec.livenessProbe.get("exec"):
+                exec_object.livenessProbe = exec.livenessProbe
+
         if exec.get('runAsBash'):
             if 'command' in exec:
                 exec_object.cmd = ['/bin/bash', '-c', exec.command]