deploy_tools.models.module

Members

EnvVar	Represents an environment variable to set when loading the Module.
Module	Represents a Module to be deployed.
ModuleDependency	Specify an Environment Module to include as a dependency.
Release	Represents a Module along with its lifecycle (deprecation) status.

class deploy_tools.models.module.ModuleDependency(*, name: str, version: str | None = None)

Specify an Environment Module to include as a dependency.

The version is optional. If a version is given and the dependency is a Module managed by this same Deployment, that version must exist among the deployed (non-deprecated) versions to pass validation. If no version is given, the dependency’s default version is resolved at load time and is not validated.

class deploy_tools.models.module.EnvVar(*, name: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[a-zA-Z_][a-zA-Z0-9_]*$, ascii_only=None)], value: str)

Represents an environment variable to set when loading the Module.

class deploy_tools.models.module.Module(*, name: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[a-zA-Z][0-9a-zA-Z_-]*$, ascii_only=None)], version: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=None, pattern=^[^.].*$, ascii_only=None)], description: str | None = None, dependencies: list[~deploy_tools.models.module.ModuleDependency] = [], env_vars: list[~deploy_tools.models.module.EnvVar] = [], applications: list[~typing.Annotated[~deploy_tools.models.apptainer_app.ApptainerApp | ~deploy_tools.models.shell_app.ShellApp | ~deploy_tools.models.binary_app.BinaryApp, FieldInfo(annotation=NoneType, required=True, discriminator='app_type')]], allow_updates: bool = False, exclude_from_defaults: bool = False, load_script: list[str] = [], unload_script: list[str] = [])

Represents a Module to be deployed.

Modules can optionally include a set of applications, environment variables to load, and a list of module dependencies.

class deploy_tools.models.module.Release(*, module: Module, deprecated: bool = False)

Represents a Module along with its lifecycle (deprecation) status.