Add comments

uc-cdis · Jan 29, 2025 · 7308f12 · 7308f12
1 parent 3fc9674
commit 7308f12
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/files/scripts/workspaces_launch_test.py b/files/scripts/workspaces_launch_test.py
@@ -128,6 +128,12 @@ def start_workspace_launch_test(self):
 
 
     def monitor_workspace_status(self, interval=10):
+        """
+        In an interval of given time (in seconds) hit the workspace status endpoint to monitor the status of the workspace
+
+        Args:
+            interval (int, optional): Interval (in seconds) to hit the options endpoint. Defaults to 10 seconds.
+        """
         status_url = self.commons_url + "/lw-workspace/status"
 
         while True:

diff --git a/kube/services/jobs/workspace-launch-test-cronjob.yaml b/kube/services/jobs/workspace-launch-test-cronjob.yaml
@@ -1,3 +1,7 @@
+# To run: gen3 job run workspace-launch-test-cronjob COMMONS_URL <commons base url> NOTEBOOK <NOTEBOOK name>
+# example: gen3 job run workspace-launch-test-cronjob COMMONS_URL https://qa-heal.planx-pla.net NOTEBOOK '(Generic) Jupyter Lab Notebook with R Kernel'
+# If NOTEBOOK isn't provided, it defaults to '(Generic) Jupyter Lab Notebook with R Kernel'
+
 apiVersion: batch/v1
 kind: CronJob
 metadata:

diff --git a/kube/services/jobs/workspace-launch-test-job.yaml b/kube/services/jobs/workspace-launch-test-job.yaml
@@ -1,3 +1,7 @@
+# To run: gen3 job run workspace-launch-test COMMONS_URL <commons base url> NOTEBOOK <NOTEBOOK name>
+# example: gen3 job run workspace-launch-test COMMONS_URL https://qa-heal.planx-pla.net NOTEBOOK '(Generic) Jupyter Lab Notebook with R Kernel'
+# If NOTEBOOK isn't provided, it defaults to '(Generic) Jupyter Lab Notebook with R Kernel'
+
 apiVersion: batch/v1
 kind: Job
 metadata: