jobflow_remote.cli.runner module#

jobflow_remote.cli.runner.foreground() → None[source]#

Connect to the daemon processes in the foreground.

jobflow_remote.cli.runner.info(verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a18550>] = 0, pings: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f46cc8d0>] = False) → None[source]#

Fetch the information about the process of the daemon. Contain the supervisord process and the processes running the Runner.

jobflow_remote.cli.runner.kill() → None[source]#

Send a kill signal to the Runner processes. Return immediately, does not wait for processes to be killed.

jobflow_remote.cli.runner.reset(yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, force_deprecated: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a193d0>] = False, break_lock: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a19ad0>] = False) → None[source]#

Reset the value of the machine executing the runner from the database. Should be executed only if it is certain that the runner is not active on that machine anymore.

jobflow_remote.cli.runner.restart() → None[source]#

Restart the runner. Send a stop signal, wait for the runner to stop and restart it. The options to start the runner (e.g. –single) remain the same.

jobflow_remote.cli.runner.run(log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7f48f4a18650>] = LogLevel.INFO, set_pid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4519950>] = False, transfer: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451a190>] = False, complete: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451a8d0>] = False, queue: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451a990>] = False, checkout: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451aad0>] = False, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451ad50>] = False, daemonized: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451ae90>] = False) → None[source]#

Execute the Runner in the foreground. Do NOT execute this to start as a daemon. Should be used by the daemon or for testing purposes.

jobflow_remote.cli.runner.shutdown(wait: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f46cc390>] = False) → None[source]#

Shuts down the supervisord process. Note that the supervisord process will stop after all the runner processes have finished

jobflow_remote.cli.runner.start(transfer: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f451b110>] = 1, complete: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f451b150>] = 1, single: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451af10>] = False, log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7f48f4a18650>] = LogLevel.INFO, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f451b210>] = False) → None[source]#

Start the Runner as a daemon.

jobflow_remote.cli.runner.status() → None[source]#

Fetch the status of the daemon runner.

jobflow_remote.cli.runner.stop(wait: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44eb410>] = False) → None[source]#

Shuts down the supervisord process. Note that the supervisord process will stop after all the runner processes have finished.

jobflow_remote.cli.runner.stop_processes(wait: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f45412d0>] = False) → None[source]#

Send a stop signal to the Runner processes. Each of the Runner processes will stop when finished the task being executed. By default, return immediately.

jobflow_remote.cli.runner.update_status(log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7f48f4a18650>] = LogLevel.INFO, set_pid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f46cca50>] = False, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f46ccb90>] = False) → None[source]#

Update the “submitted” and “running” states of jobs, flows and batches.

This command updates the “submitted” and “running” states of jobs, flows, and batches. It does not perform submissions, uploads, downloads, or any other side-effecting actions.

  • Only jobs in a SUBMITTED, BATCH_SUBMITTED, RUNNING, or BATCH_RUNNING state are updated.

  • Flows currently do not change state (though this may be extended in the future).

  • Batch jobs in SUBMITTED or RUNNING states are updated.

This command is primarily intended for upgrade scenarios where: - The runner must reflect the latest job statuses. - No new jobs should be submitted. - Actions such as uploads or database insertions are intentionally skipped.

Note that this command should be run only when the runner is stopped to avoid inconsistent states.