quickstart.validators

Credential and configuration validators.

Module Contents

Classes

ValidationResult

Result of a validation check.

Functions

is_quickstart_running	Check if NMP quickstart container is already running via Docker.
validate_config	Run all validations on a config.
validate_docker_available	Check if Docker daemon is available.
validate_docker_socket	Validate docker socket exists and is accessible.
validate_ngc_credentials	Validate NGC API key by attempting a docker login.
validate_port_available	Validate that a port is available for binding.
validate_registry_credentials	Validate custom registry credentials.
validate_storage_path	Validate storage path can be created and written to.

API

class quickstart.validators.ValidationResult

Result of a validation check.

message: str

None

valid: bool

None

quickstart.validators.is_quickstart_running(

config: quickstart.config.QuickstartConfig,

) → bool

Check if NMP quickstart container is already running via Docker.

Parameters:

config – Quickstart configuration with container name.

Returns:

True if the quickstart container is running, False otherwise.

quickstart.validators.validate_config(

config: quickstart.config.QuickstartConfig,

) → list[quickstart.validators.ValidationResult]

Run all validations on a config.

Parameters:

config – The QuickstartConfig to validate.

Returns:

List of ValidationResult objects.

quickstart.validators.validate_docker_available() → quickstart.validators.ValidationResult

Check if Docker daemon is available.

Returns:

ValidationResult indicating success or failure.

quickstart.validators.validate_docker_socket(

socket_path: pathlib.Path,

) → quickstart.validators.ValidationResult

Validate docker socket exists and is accessible.

Parameters:

socket_path – Path to the docker socket.

Returns:

ValidationResult indicating success or failure.

quickstart.validators.validate_ngc_credentials(

api_key: str,

) → quickstart.validators.ValidationResult

Validate NGC API key by attempting a docker login.

Parameters:

api_key – The NGC API key to validate.

Returns:

ValidationResult indicating success or failure.

quickstart.validators.validate_port_available(

port: int,

config: quickstart.config.QuickstartConfig | None = None,

) → quickstart.validators.ValidationResult

Validate that a port is available for binding.

Parameters:

• port – Port number to check.

• config – Optional quickstart config to check if NMP is using the port.

Returns:

ValidationResult indicating success or failure.

quickstart.validators.validate_registry_credentials(

registry: str,

username: str,

password: str,

) → quickstart.validators.ValidationResult

Validate custom registry credentials.

Parameters:

• registry – Registry URL.

• username – Registry username.

• password – Registry password.

Returns:

ValidationResult indicating success or failure.

quickstart.validators.validate_storage_path(

storage_path: pathlib.Path,

) → quickstart.validators.ValidationResult

Validate storage path can be created and written to.

Parameters:

storage_path – Path to the storage directory.

Returns:

ValidationResult indicating success or failure.