quickstart.preflight#

Pre-flight checks for quickstart cluster.

Module Contents#

Classes#

CheckStatus

Status of a pre-flight check.

PreflightChecker

Runs pre-flight checks before starting the quickstart cluster.

PreflightResult

Result of a single pre-flight check.

Functions#

detect_gpus

Check if NVIDIA GPUs are available on the system.

API#

class quickstart.preflight.CheckStatus(*args, **kwds)#

Bases: enum.Enum

Status of a pre-flight check.

Initialization

FAIL#

‘fail’

PASS#

‘pass’

WARN#

‘warn’

class quickstart.preflight.PreflightChecker(config: quickstart.config.QuickstartConfig)#

Runs pre-flight checks before starting the quickstart cluster.

Pre-flight checks verify that the system is ready to run the quickstart container, including Docker availability, socket permissions, storage directories, port availability, and credentials.

Initialization

Initialize pre-flight checker.

Parameters:

config – Quickstart configuration to validate.

get_failures() list[quickstart.preflight.PreflightResult]#

Get list of failed checks.

get_warnings() list[quickstart.preflight.PreflightResult]#

Get list of checks with warnings.

has_failures() bool#

Return True if any check failed.

has_warnings() bool#

Return True if any check has warnings.

is_already_running() bool#

Return True if NMP quickstart is already running.

run_all() list[quickstart.preflight.PreflightResult]#

Run all pre-flight checks and return results.

Returns:

List of PreflightResult objects for each check.

class quickstart.preflight.PreflightResult#

Result of a single pre-flight check.

details: str | None#

None

message: str#

None

name: str#

None

status: quickstart.preflight.CheckStatus#

None

quickstart.preflight.detect_gpus() tuple[bool, str]#

Check if NVIDIA GPUs are available on the system.

Returns:

Tuple of (gpus_detected, message).