Internal Nublado API

The Nublado controller and the command-line tools are built as a Docker image intended for deployment in a Kubernetes cluster using Phalanx and is not supported as an installed Python module. This documentation therefore exists only to assist developers and code analysis and does not define a supported API.

nublado.config.base Module

Pydantic settings class that prioritizes environment variables.

Classes

CamelEnvFirstSettings

Base class for Pydantic settings with environment overrides.

Class Inheritance Diagram

nublado.config.images Module

Configuration for the image management command-line tool.

Classes

DockerSourceConfig	Configuration for a Docker source.
GARSourceConfig	Configuration for a Google Artifact Registry source.
ImagesConfig	Configuration for Nublado image management.

Variables

ImageSourceConfig

Type alias.

Class Inheritance Diagram

nublado.constants Module

Constants for Nublado. Overrideable for testing.

Variables

ALERT_HOOK_ENV_VAR	Name of environment variable specifying Slack alert webhook.
DOCKER_CREDENTIALS_PATH	Default path to the Docker API secrets.
ENV_PREFIX	Prefix for environment variables governing Nublado behavior.
GAR_RETRY_DELAY	How long to wait between Google Artifact Registry retries.
GAR_RETRY_LIMIT	How many total times to attempt Google Artifact Registry calls.
ROOT_LOGGER	Root logger name.

nublado.controller.background Module

Nublado controller background processing.

Classes

BackgroundTaskManager(*, config, ...)

Manage Nublado controller background tasks.

Class Inheritance Diagram

nublado.controller.config Module

Global configuration parsing.

Classes

BaseVolumeSource	Source of a volume to be mounted in the lab.
Config	Nublado controller configuration.
ContainerImage	Docker image that may be run as a container.
DisabledFileserverConfig	Configuration when user file servers are disabled.
EmptyDirSource(*values)	Where space for emptyDirs (e.g. /tmp) should come from.
EmptyDirVolumeSource	Empty directory shared between all Pod containers.
EnabledFileserverConfig	Configuration for enabled user file servers.
FSAdminConfig	Configuration for filesystem administration environment.
FileserverConfig	Base configuration for user file servers.
HostPathVolumeSource	Path on Kubernetes node to mount in the container.
LabConfig	Configuration for spawning user labs.
LabInitContainer	A container to run as an init container before the user's lab.
LabNSSFiles	Rules for /etc/passwd and /etc/group inside the lab.
LabSecret	A secret to make available to lab containers.
LabSizeDefinition	Possible size of lab.
NFSVolumeSource	NFS volume to mount in the container.
PVCVolumeResources	Resources for a persistent volume claim.
PVCVolumeSource	A PVC to create to materialize the volume to mount in the container.
PrepullerConfig	Configuration for the prepuller.
UserHomeDirectorySchema(*values)	Algorithm for building a user's home directory path.
VolumeConfig	A volume that may be mounted inside a container.
VolumeMountConfig	The mount of a volume inside a container.

Class Inheritance Diagram

nublado.controller.constants Module

Global constants.

Variables

ARGO_CD_ANNOTATIONS	Annotations to add to most created objects.
CONFIGURATION_PATH	Default path to controller configuration.
DOCKER_CREDENTIALS_PATH	Default path to the Docker API secrets.
DROPDOWN_SENTINEL_VALUE	Used in the lab form for image_list when image_dropdown is used.
GROUPNAME_REGEX	Regex matching all valid group names.
KUBERNETES_NAME_PATTERN	Pattern matching valid Kubernetes names.
KUBERNETES_REQUEST_TIMEOUT	How long to wait for generic sequences of Kubernetes API calls.
MEMORY_TO_TMP_SIZE_RATIO	Ratio of maximum memory size to maximum size of /tmp filesystem.
METADATA_PATH	Default path to injected pod metadata.
RESERVED_ENV	Environment variables reserved to the controller or JupyterHub.
RESERVED_PATHS	Paths within the lab that are reserved for special purposes.
USERNAME_REGEX	Regex matching all valid usernames.

nublado.controller.dependencies.config Module

Config dependency.

Classes

ConfigDependency([path])

Dependency to manage a cached Nublado controller configuration.

Variables

config_dependency

The dependency that will return the global configuration.

Class Inheritance Diagram

nublado.controller.dependencies.context Module

Request context management.

ContextDependency is an all-in-one dependency, because managing individual dependencies turned out to be a real pain. It’s designed to capture the context of any request. It requires that a Config object has been loaded before it can be instantiated.

Classes

ContextDependency()	Provide a per-request context as a FastAPI dependency.
RequestContext(request, logger, factory, ...)	Holds the incoming request and its surrounding context.

Variables

context_dependency

The dependency that will return the per-request context.

Class Inheritance Diagram

nublado.controller.dependencies.user Module

User and authentication dependencies for FastAPI.

Functions

user_dependency(context, ...)	Return the validated user for the given request.
username_path_dependency(username, ...)	Validate and return the username in the request path.

nublado.controller.events Module

Metrics events for the Nublado controller.

Classes

ActiveLabsEvent	Current count of the number of active labs.
LabEvents()	Event publishers for Nublado controller events about labs.
LabMetadata	Common lab metadata for events.
SpawnFailureEvent	A lab spawn failed.
SpawnSuccessEvent	A lab spawn succeeded.

Class Inheritance Diagram

nublado.controller.exceptions Module

Exceptions for the Nublado lab controller.

Classes

ControllerTimeoutError(operation[, user])	Wraps TimeoutError with additional context and Slack support.
DuplicateObjectError(message, *[, user, ...])	Multiple Kubernetes objects were found when one was expected.
GafaelfawrParseError(message, error)	Unable to parse the reply from Gafaelfawr.
GafaelfawrWebError(message, *[, failed_at, ...])	An API call to Gafaelfawr failed.
InsufficientQuotaError(message[, location, ...])	The user's quota is insufficient to satisfy this request.
InvalidDockerReferenceError(message[, ...])	Docker reference does not contain a tag.
InvalidLabSizeError(size)	The provided lab size is not one of the configured sizes.
InvalidPodPhaseError(message[, location, ...])	The pod was not in a valid phase.
InvalidTokenError(message[, location, ...])	The delegated user token is invalid.
KubernetesError(message, *[, user, kind, ...])	An API call to Kubernetes failed.
LabDeletionError(message[, user, failed_at])	An error occurred when deleting a lab.
LabExistsError(message[, location, field_path])	Lab creation was attempted for a user with an active lab.
MissingObjectError(message, *[, user, ...])	An expected Kubernetes object is missing.
MissingSecretError(name, namespace[, key])	Secret specified in the controller configuration was not found.
NoOperationError(message[, user, failed_at])	No operation was in progress when attempting to wait.
NotConfiguredError(message[, location, ...])	An attempt was made to use a disabled service.
OperationConflictError(username)	Attempt to perform an operation when another is in progress.
PermissionDeniedError(message[, location, ...])	Attempt to access a restricted resource.
PodNotFoundError(message[, location, field_path])	Pod could not be found.
UnknownDockerImageError(message[, location, ...])	Cannot find a Docker image matching the requested parameters.
UnknownUserError(message[, location, field_path])	No resource has been created for this user.

Class Inheritance Diagram

nublado.controller.factory Module

Component factory and global and per-request context management.

Classes

Factory(context, logger)	Build lab controller components.
ProcessContext(config, http_client, ...)	Per-process global application state.

Class Inheritance Diagram

nublado.controller.main Module

The main application factory for the Nublado controller service.

Functions

create_app(*[, load_config])

Create the FastAPI application.

nublado.controller.models.domain.docker Module

Domain models for talking to the Docker API.

Classes

DockerReference(registry, repository, tag, ...)

Parses a Docker reference.

Class Inheritance Diagram

nublado.controller.models.domain.fileserver Module

Models for the fileserver state.

Classes

FileserverObjects(pvcs, ingress, service, job)	All of the Kubernetes objects making up a user's fileserver.
FileserverStateObjects(job, pod, ingress)	Kubernetes objects used for inspecting the state of a fileserver.

Class Inheritance Diagram

nublado.controller.models.domain.fsadmin Module

Models for the file system admin pod state.

Classes

FSAdminObjects(pod, pvcs)

All of the Kubernetes objects making up an fsadmin instance.

Class Inheritance Diagram

nublado.controller.models.domain.gafaelfawr Module

Models for talking to Gafaelfawr.

Classes

GafaelfawrUser

User information from Gafaelfawr supplemented with the user's token.

Class Inheritance Diagram

nublado.controller.models.domain.image Module

Internal models returned by image service methods.

Classes

MenuImage	A single spawnable image.
MenuImages	All available spawnable images.
NodeData(name, images[, eligible, comment])	Cached data about a Kubernetes node.

Class Inheritance Diagram

nublado.controller.models.domain.kubernetes Module

Data types for interacting with Kubernetes.

Classes

Affinity	Pod affinity rules.
KubernetesModel(*args, **kwargs)	Protocol for Kubernetes object models.
KubernetesNodeImage(references, size)	A cached image on a Kubernetes node.
LabelSelector	Rule for matching labels of pods or namespaces.
LabelSelectorOperator(*values)	Match operations for label selectors.
LabelSelectorRequirement	Single rule for label matching.
NodeAffinity	Node affinity rules.
NodeSelector	Matching terms for nodes.
NodeSelectorOperator(*values)	Match operations for node selectors.
NodeSelectorRequirement	Individual match rule for nodes.
NodeSelectorTerm	Term to match nodes.
NodeToleration(eligible[, comment])	Whether a single node is tolerated.
PodAffinity	Pod affinity rules.
PodAffinityAttrs	Base class for pod affinity rules.
PodAffinityTerm	Pod matching term for pod affinity.
PodAntiAffinity	Pod anti-affinity rules.
PodChange(phase, pod)	Represents a change (not creation or deletion) of a pod.
PodPhase(*values)	One of the valid phases reported in the status section of a Pod.
PreferredSchedulingTerm	Scheduling term with a weight, used to find preferred nodes.
PropagationPolicy(*values)	Possible values for the propagationPolicy parameter to delete.
PullPolicy(*values)	Pull policy for Docker images in Kubernetes.
TaintEffect(*values)	Possible effects of a pod toleration.
Toleration	Represents a single pod toleration rule.
TolerationOperator(*values)	Possible operators for a toleration.
VolumeAccessMode(*values)	Access mode for a persistent volume.
WatchEventType(*values)	Possible values of the type field of Kubernetes watch events.
WeightedPodAffinityTerm	Pod matching term for pod affinity with an associated weight.

Class Inheritance Diagram

nublado.controller.models.domain.lab Module

Internal models related to user labs.

Classes

Event	One lab operation event for a user.
EventType(*values)	Type of message.
LabObjectNames(username, namespace, ...)	Names for the key Kubernetes objects making up a user's lab.
LabObjects(env_config_map, quota, pod, ...)	All of the Kubernetes objects making up a user's lab.
LabStateObjects(env_config_map, quota, pod)	All of the Kubernetes objects required to reconstruct lab state.

Class Inheritance Diagram

nublado.controller.models.domain.volumes Module

Models for mounted volumes.

Classes

MountedVolume(volume, volume_mount)

Represents a volume along with its corresponding mount.

Class Inheritance Diagram

nublado.controller.models.index Module

Top-level request models for the Nublado controller.

Classes

Index

Metadata returned by the external root URL of the application.

Class Inheritance Diagram

nublado.controller.models.v1.fileserver Module

API-visible models for user file servers.

Classes

FileserverStatus

Status of a user's file server.

Class Inheritance Diagram

nublado.controller.models.v1.fsadmin Module

API-visible model for fsadmin.

Classes

FSAdminCommand	Command to start the file system admin pod.
FSAdminStatus	Status for a running file system admin pod.

Class Inheritance Diagram

nublado.controller.models.v1.lab Module

API-visible models for user lab environments.

Classes

CommonLabOptions	Options shared by both the input and output model for lab options.
ImageClass(*values)	Supported classes of images.
LabOptions	Options for the lab, specified at creation time.
LabRequestOptions	User-provided lab configuration options.
LabResources	Resource requests and limits for a lab.
LabSize(*values)	Allowable names for pod sizes.
LabSpecification	Specification of lab to spawn, sent by the JupyterHub spawner.
LabState	Current state of the user's lab.
LabStatus(*values)	Possible states the user's lab may be in.
ResourceQuantity	A Kubernetes resource request or limit.
UserGroup	Group membership.
UserInfo	Metadata about the user who owns the lab.

Class Inheritance Diagram

nublado.controller.models.v1.prepuller Module

Models for prepuller.

Classes

Image	A single Docker image that is available or prepulled.
Node	Information about available images on a single Kubernetes node.
NodeImage	An available image present on at least some Kubernetes nodes.
PrepulledImage	Used to display available images.
PrepullerImageStatus	Status of the images being prepulled.
PrepullerOptions	Options for the prepuller.
PrepullerStatus	Status of the image prepuller.
SpawnerImages	Images known to the Nublado controller and available for spawning.

Class Inheritance Diagram

nublado.controller.services.builder.fileserver Module

Construction of Kubernetes objects for user fileservers.

Classes

FileserverBuilder(*, config, base_url, ...)

Construct Kubernetes objects for user file servers.

Class Inheritance Diagram

nublado.controller.services.builder.fsadmin Module

Construction of Kubernetes objects for user fileservers.

Classes

FSAdminBuilder(config, volumes, ...)

Construct Kubernetes objects for file system administrative pods.

Class Inheritance Diagram

nublado.controller.services.builder.lab Module

Construction of Kubernetes objects for user lab environments.

Classes

LabBuilder(*, config, base_url, ...)

Construct Kubernetes objects for user lab environments.

Class Inheritance Diagram

nublado.controller.services.builder.prepuller Module

Construct Kubernetes objects used by the prepuller.

Classes

PrepullerBuilder(config, metadata_storage[, ...])

Construct Kubernetes objects used by the prepuller.

Class Inheritance Diagram

nublado.controller.services.builder.volumes Module

Construction of Kubernetes objects for volumes and volume mounts.

Classes

VolumeBuilder()

Construct Kubernetes objects for volumes and volume mounts.

Class Inheritance Diagram

nublado.controller.services.fileserver Module

Service to manage user fileservers.

Classes

FileserverManager(*, config, ...)

Manage user file servers.

Class Inheritance Diagram

nublado.controller.services.fsadmin Module

Service to manage administrative filesystem environment.

Classes

FSAdminManager(*, config, fsadmin_builder, ...)

Manage filesystem admin environment.

Class Inheritance Diagram

nublado.controller.services.image Module

Container image service.

Classes

ImageService(*, config, node_selector, ...)

Service to track the available images for Jupyter labs.

Class Inheritance Diagram

nublado.controller.services.lab Module

Service to manage user lab environments.

Classes

LabManager(*, config, image_service, ...)

Manage user labs.

Class Inheritance Diagram

nublado.controller.services.prepuller Module

Prepull images to Kubernetes nodes.

Classes

Prepuller(*, config, image_service, ...[, ...])

Prepull images to Kubernetes nodes.

Class Inheritance Diagram

nublado.controller.services.source.base Module

Base class for image sources.

Classes

ImageSource(logger, image_filter)

Base class for image sources.

Class Inheritance Diagram

nublado.controller.services.source.docker Module

Image source using a Docker Registry.

Classes

DockerImageSource(config, docker, logger, ...)

Image source using a Docker Registry.

Class Inheritance Diagram

nublado.controller.services.source.gar Module

Image source using a Google Artifact Registry.

Classes

GARImageSource(config, gar, logger, image_filter)

Image source using a Google Artifact Registry.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.creator Module

Generic Kubernetes object storage supporting only create and read.

Provides a generic Kubernetes object management class and instantiations of that class for Kubernetes object types that only support create and read. This is sufficient for a lot of object types the lab controller manipulates. Storage classes for object types that only need those operations are provided here.

For object types that need to support other operations, see KubernetesObjectDeleter, which subclasses KubernetesObjectCreator and adds list and delete support, and its subclasses.

Classes

ConfigMapStorage(api_client, logger)	Storage layer for ConfigMap objects.
KubernetesObjectCreator(*, create_method, ...)	Generic Kubernetes object storage supporting create and read.
NetworkPolicyStorage(api_client, logger)	Storage layer for NetworkPolicy objects.
ResourceQuotaStorage(api_client, logger)	Storage layer for ResourceQuota objects.
SecretStorage(api_client, logger)	Storage layer for Secret objects.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.custom Module

Storage layer for Kubernetes custom objects objects.

Classes

CustomStorage(*, api_client, group, version, ...)	Storage layer for Kubernetes custom objects.
GafaelfawrIngressStorage(api_client, ...)	Storage layer for GafaelfawrIngress objects.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.deleter Module

Generic Kubernetes object storage including list and delete.

Provides a generic Kubernetes object management class and instantiations of that class for Kubernetes object types that support list and delete (as well as create and read, provided by the superclass). Storage classes for object types that only need those operations are provided here; more complex storage classes with other operations are defined in their own modules.

Classes

JobStorage(api_client, reconnect_timeout, logger)	Storage layer for Job objects.
KubernetesObjectDeleter(*, create_method, ...)	Generic Kubernetes object storage supporting list and delete.
PersistentVolumeClaimStorage(api_client, ...)	Storage layer for PersistentVolumeClaim objects.
ServiceAccountStorage(api_client, ...)	Storage layer for Service objects.
ServiceStorage(api_client, ...)	Storage layer for Service objects.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.fileserver Module

Kubernetes storage layer for user fileservers.

Classes

FileserverStorage(api_client, ...)

Kubernetes storage layer for file servers.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.fsadmin Module

Kubernetes storage layer for filesystem administration pod.

Classes

FSAdminStorage(*, config, metadata_storage, ...)

Kubernetes storage layer for a filesystem admin pod.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.ingress Module

Storage layer for Ingress objects.

Functions

ingress_has_ip_address(ingress)

Check whether an ingress has an IP address assigned.

Classes

IngressStorage(api_client, ...)

Storage layer for Ingress objects.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.lab Module

Kubernetes storage layer for user labs.

Classes

LabStorage(api_client, reconnect_timeout, logger)

Kubernetes storage layer for user labs.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.namespace Module

Storage layer for Namespace objects.

Classes

NamespaceStorage(api_client, ...)

Storage layer for Namespace objects.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.node Module

Storage layer for Kubernetes node objects.

Classes

NodeStorage(api_client, logger)

Storage layer for Kubernetes node objects.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.pod Module

Storage layer for Pod objects.

Classes

PodStorage(api_client, reconnect_timeout, logger)

Storage layer for Pod objects.

Class Inheritance Diagram

nublado.controller.storage.kubernetes.watcher Module

Watch a Kubernetes namespace or cluster for events.

Classes

KubernetesWatcher(*, method, object_type, kind)	Watch Kubernetes for events.
WatchEvent(action, object)	Parsed event from a Kubernetes watch.

Class Inheritance Diagram

nublado.controller.storage.metadata Module

Storage layer for pod metadata.

Classes

MetadataStorage(metadata_path)

Storage layer for pod metadata for the running pod.

Class Inheritance Diagram

nublado.controller.templates Module

Template management.

Provides a shared Jinja template environment used whenever the Nublado controller generates responses based on templates.

Variables

templates

The template manager.

nublado.controller.timeout Module

Timeout class for Kubernetes operations.

Classes

Timeout(operation, timeout[, user])

Track a cumulative timeout on a series of operations.

Class Inheritance Diagram

nublado.controller.units Module

Unit conversions for the Nublado controller.

Functions

bytes_to_si(val)	Convert a number of bytes into a human-readable SI string.
cpu_to_cores(cpu)	Convert a Kubernetes CPU resource value to a float number of cores.
memory_to_bytes(memory)	Convert a string representation of memory to a number of bytes.

nublado.exceptions Module

Exceptions used by Nublado.

Classes

DockerError(message, *[, failed_at, method, ...])	An API call to a Docker Registry failed.
DockerInvalidUrlError(error, url, next_url, ...)	An invalid link was encountered while retrieving tag results.

Class Inheritance Diagram

nublado.factory Module

Factories for Nublado tools.

Classes

ImagesFactory(config, logger)

Factory for Nublado image management.

Class Inheritance Diagram

nublado.inithome.provisioner Module

Provisioner for user home directories.

Classes

InvalidHomeError	The home directory already exists but is not acceptable.
Provisioner(home, uid, gid)	Create the user's home directory if it doesn't exist.

Class Inheritance Diagram

nublado.landingpage.exceptions Module

Exceptions for the CST landing page provisioner.

Classes

DestinationError	The destination target exists and cannot be replaced safely.
DestinationIsDirectoryError	The destination target exists and is a directory.
PrecheckError	Initial input-files-and-home-directory sanity check failed.

Class Inheritance Diagram

nublado.landingpage.provisioner Module

A tool to set up user directories to hold what will be the default page for “science” sites, to allow those sites to load a tutorial document on startup.

It has two phases: first, it creates copies of the landing page and supporting files, and second, if the user default for opening the file is not the Markdown Viewer already, it writes out configuration for that.

The files must be somewhere that the Notebook container can open them, and must be writeable files (not symlinks to a read-only target) if the Save-All or Save-And-Quit functionality is to work.

The tool is expected to be running in the context of the current user, as part of an initContainer running after the user home directories are provisioned, but before the user lab container begins to start.

Classes

Provisioner(inp)

Ensure user environment is ready to open tutorial landing page.

Class Inheritance Diagram

nublado.models.docker Module

Models for managing Docker credentials.

Classes

DockerCredentialStore(credentials)	Read and write the .dockerconfigjson syntax used by Kubernetes.
DockerCredentials(username, password)	Holds the credentials for one Docker API server.

Class Inheritance Diagram

nublado.models.images Package

Models for referring to and managing Nublado lab images.

Classes

DockerSource	Docker Registry from which to get images.
GARSource	Google Artifact Registry from which to get images.
ImageFilter	Policy for images to display within a given category.
ImageFilterPolicy	Configuration for display of RSP images.
RSPImage(*, tag, image_type, display_name[, ...])	A tagged Rubin Science Platform image.
RSPImageCollection(images[, cycle])	Provides operations on a collection of RSPImage objects.
RSPImageTag(*, tag, image_type, display_name)	A sortable image tag for a Rubin Science Platform image.
RSPImageTagCollection(tags)	Hold and perform operations on a set of RSPImageTag objects.
RSPImageType(*values)	The type (generally, release series) of the identified image.

Variables

DOCKER_DEFAULT_TAG	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
ImageSource	Type alias.

Class Inheritance Diagram

nublado.purger.config Module

Application configuration for the purger.

Classes

Config	Configuration for the purger.
EnvFirstSettings	Base class for Pydantic settings with environment overrides.

Class Inheritance Diagram

nublado.purger.constants Module

Constants for rsp-scratchpurger. Overrideable for testing.

Variables

ALERT_HOOK_ENV_VAR	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
CONFIG_FILE	Path subclass for non-Windows systems.
CONFIG_FILE_ENV_VAR	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
ENV_PREFIX	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
POLICY_FILE	Path subclass for non-Windows systems.
ROOT_LOGGER	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

nublado.purger.exceptions Module

Exceptions for the purger.

Classes

PlanNotReadyError(message[, user, failed_at])	An operation needing a Plan was requested, but no Plan is ready.
PurgeFailedError(message, failed_files)	A purge encountered errors.

Class Inheritance Diagram

nublado.purger.models.plan Module

Object representing files to be purged, and why.

Classes

FileClass(*values)	Whether a file is large or small.
FileReason(*values)	Whether a file is to be purged on access, creation, or modification time grounds.
FileRecord	A file to be purged, and why.
Plan	List of files to be purged, and why.

Class Inheritance Diagram

nublado.purger.models.v1.policy Module

Model for purger policy.

Classes

DirectoryPolicy	Policy for purging objects from a directory and its children.
Intervals	Intervals specify how long it must have been since a filesystem object was accessed, created, or modified before that object will be considered for purging.
MantissaAndMultiplier(mantissa, multiplier)	Utility for intermediate results in HumanSizeBytes conversion.
Policy	Policy for purging objects across multiple directory trees.
SizedIntervals	Container to hold intervals for purging large and small files.

Variables

HumanSizeBytes

Parse an input indicating a number of bytes into an int.

Class Inheritance Diagram

nublado.purger.purger Module

The Purger class provides mechanisms for setting its policy, planning actions according to its policy, reporting its plans, and executing its plans.

Classes

Purger(config[, logger])

Object to plan and execute filesystem purges.

Class Inheritance Diagram

nublado.services.images Package

Image managers for different backends.

Classes

DockerImagesManager(docker_client, logger)	Manage Nublado images using the Docker API.
GARImagesManager(gar_client, logger)	Manage Nublado images using the Google Artifact Registry API.
ImagesManager()	Base class defining the shared API for images managers.

Class Inheritance Diagram

nublado.startup.constants Module

Constants for RSP startup.

Variables

APP_NAME	Application name, used for logging.
ETC_PATH	Configuration directory, usually /etc, but overrideable for tests.
LAB_STATIC_CMD_ARGS	Constants used in Lab startup invocation.
MAX_NUMBER_OUTPUTS	Maximum number of output lines to display in a Jupyter notebook cell.
PREVIOUS_LOGGING_CHECKSUMS	sha256 sums of previous iterations of 20-logging.py.
STARTUP_PATH	Directory for lab startup files, overrideable for tests.

nublado.startup.exceptions Module

Exceptions for the LabRunner startup service.

Classes

CommandFailedError(args, exc)	Execution of a command failed.
CommandTimedOutError(args, exc)	Execution of a command failed.
RSPErrorCode(*values)	New Error codes for RSP Startup.
RSPStartupError(*args, **kwargs)	RSPStartupError is a subclass of OSError that is designed to be more portable than the standard OSError, since we are throwing it to a client that could, potentially, be running on a different architecture or OS, and whose numeric error codes might therefore not match (e.g. EDQUOT is 69 under MacOS aarch64, but 122 for Linux x64).

Class Inheritance Diagram

nublado.startup.services.credentials Module

Manage merging site Butler credentials with user-specific credentials.

Classes

CredentialManager(env, logger)

Merge site credentials with user-specific credentials.

Class Inheritance Diagram

nublado.startup.services.dask Module

Set up Dask proxy configuration, needed by lsdb.

Classes

DaskConfigurator(home, logger)

Configure dask proxy for lsdb.

Class Inheritance Diagram

nublado.startup.services.environment Module

Handles updates to the runtime environment.

Classes

EnvironmentConfigurator(env, logger)

Set up runtime environment for the Lab.

Class Inheritance Diagram

nublado.startup.services.homedir Module

Tasks around ensuring the home directory is working correctly.

Classes

HomedirManager(env, home, logger)

Ensure homedir is working correctly.

Class Inheritance Diagram

nublado.startup.services.preparer Module

RSP Lab preparer.

Classes

Preparer()

Class to prepare for JupyterLab launch by modifying the filesystem and writing out a file representing the runtime environment, to be used by the launcher.

Class Inheritance Diagram

nublado.startup.storage.command Module

Wrapper around executing external commands.

Classes

Command(*[, capture_output, ignore_fail, ...])

Wrapper around executing external commands.

Class Inheritance Diagram

nublado.startup.utils Module

Utility functions for starting LSST JupyterLab notebook environment.

Functions

get_digest()	Return the digest of the current Docker image.
get_jupyterlab_config_dir()	Return the directory where Jupyterlab configuration is stored.
get_runtime_mounts_dir()	Return the directory where Nublado runtime info is mounted.

nublado.storage.docker Module

Client for the Docker v2 API.

Classes

DockerStorageClient(credentials_path, ...)

Client to query the Docker API for image information.

Class Inheritance Diagram

nublado.storage.gar Module

Client for Google Artifact Registry.

Classes

GARStorageClient(logger)

Client for Google Artifact Registry.

Class Inheritance Diagram