Lanl/mirrors

README.md

@@ -5,3 +5,17 @@ A tool for building a scientific software stack from a recipe for vClusters on C
 Read the [documentation](https://eth-cscs.github.io/stackinator/) to get started.
 
 Create a ticket in our [GitHub issues](https://github.com/eth-cscs/stackinator/issues) if you find a bug, have a feature request or have a question.
+
+## running tests:
+
+Use uv to run the tests, which will in turn ensure that the correct dependencies from `pyproject.toml` are used:
+
+```
+uv run pytest
+```
+
+Before pushing, apply the linting rules (this calls uv under the hood):
+
+```
+./lint
+```

bin/stack-config

@@ -2,6 +2,8 @@
 # /// script
 # requires-python = ">=3.12"
 # dependencies = [
+#   "requests",
+#   "python-magic",
 #   "jinja2",
 #   "jsonschema",
 #   "pyYAML",

docs/cluster-config.md

@@ -93,6 +93,27 @@ packages:
         version: ["git.59b6de6a91d9637809677c50cc48b607a91a9acb=main"]
     ```
 
+### Configuring Spack mirrors: `mirrors.yaml`
+
+On air-gapped systems, Spack is unable to reach its default mirror to fetch packages. The `mirrors.yaml` configuration can be used to connect Spack to local mirrors for fetching and building packages.
+
+`mirrors.yaml` treats source mirrors, buildcaches, and bootstrap mirrors the same, and they may all be included in this file. Spack will search the topmost mirror first and the bottom-most mirror last, and will append the default Spack mirror to the bottom of the list when the Spack mirror config is generated.
+
+If using a buildcache, public and private keys must be provided for signing and verifying packages.
+
+```yaml title="mirrors.yaml"
+local_filesystem:
+  url: file:///home/username/spack-mirror-2014-06-24
+site_server:
+  url: https://example.com/some/web-hosted/directory
+buildcache-mirror:
+  url: https://example.com/some/buildcache/mirror
+  public_key: ../buildcache-key.public.gpg
+  private_key: /user-home/.gnupg/private-keys-v1.d/my-private-key.asc
+  cache: true
+  bootstrap: true
+```
+
 ## Site and System Configurations
 
 The `repo.yaml` configuration can be used to provide a list of additional Spack package repositories to use on the target system.

nohup.out

@@ -0,0 +1,21 @@
+Stackinator
+  recipe path: /usr/projects/hpctools/grodzki/uenv/my-recipes/recipes/prgenv-gnu-openmpi
+  build path : /dev/shm/grodzki/build
+  system     : /usr/projects/hpctools/grodzki/uenv/my-recipes/cluster-config/venadito
+  mount      : default
+  build cache: None
+  develop    : False
+spack: https://github.com/spack/spack.git already cloned to /dev/shm/grodzki/build/spack
+spack: fetching releases/v1.0
+spack: checking out releases/v1.0
+spack: commit hash is f36409b78591f8b02e8332eb4ad78da62c02571e
+spack-packages: https://github.com/spack/spack-packages.git already cloned to /dev/shm/grodzki/build/spack-packages
+spack-packages: fetching develop
+spack-packages: checking out develop
+spack-packages: commit hash is fc656595ff4c7e9c7e5045625dfdd3e92e97b10e
+
+Configuration finished, run the following to build the environment:
+
+cd /dev/shm/grodzki/build
+env --ignore-environment PATH=/usr/bin:/bin:`pwd -P`/spack/bin HOME=$HOME make store.squashfs -j32
+see logfile for more information /tmp/grodzki/log_stackinator_20260428-112546

output.log

@@ -0,0 +1,2 @@
+nohup: ignoring input
+/usr/bin/env: ‘uv’: No such file or directory

pyproject.toml

@@ -11,6 +11,8 @@ license-files = ["LICENSE"]
 dynamic = ["version"]
 requires-python = ">=3.12"
 dependencies = [
+  "requests",
+  "python-magic",
   "Jinja2",
   "jsonschema",
   "PyYAML",

requirements.txt

@@ -0,0 +1,13 @@
+attrs==25.4.0
+iniconfig==2.3.0
+jsonschema==4.26.0
+jsonschema-specifications==2025.9.1
+packaging==26.0
+pluggy==1.6.0
+pygments==2.19.2
+pytest==9.0.2
+python-magic==0.4.27
+pyyaml==6.0.3
+referencing==0.37.0
+requests==2.32.5
+rpds-py==0.30.0

stackinator/builder.py

@@ -11,7 +11,7 @@
 import jinja2
 import yaml
 
-from . import VERSION, cache, root_logger, spack_util
+from . import VERSION, root_logger, spack_util, mirror
 
 
 def install(src, dst, *, ignore=None, symlinks=False):
@@ -164,13 +164,16 @@ def environment_meta(self, recipe):
         self._environment_meta = meta
 
     def generate(self, recipe):
+        """Setup the recipe build environment."""
         # make the paths, in case bwrap is not used, directly write to recipe.mount
         store_path = self.path / "store" if not recipe.no_bwrap else pathlib.Path(recipe.mount)
         tmp_path = self.path / "tmp"
+        config_path = self.path / "config"
 
         self.path.mkdir(exist_ok=True, parents=True)
         store_path.mkdir(exist_ok=True)
         tmp_path.mkdir(exist_ok=True)
+        config_path.mkdir(exist_ok=True)
 
         # check out the version of spack
         spack_version = recipe.spack_version
@@ -226,12 +229,13 @@ def generate(self, recipe):
         with (self.path / "Makefile").open("w") as f:
             f.write(
                 makefile_template.render(
-                    cache=recipe.mirror,
                     modules=recipe.with_modules,
                     post_install_hook=recipe.post_install_hook,
                     pre_install_hook=recipe.pre_install_hook,
                     spack_version=spack_version,
                     spack_meta=spack_meta,
+                    gpg_keys=recipe.mirrors.keys,
+                    cache=recipe.build_cache_mirror,
                     exclude_from_cache=["nvhpc", "cuda", "perl"],
                     verbose=False,
                 )
@@ -299,8 +303,6 @@ def generate(self, recipe):
 
         # Generate the system configuration: the compilers, environments, etc.
         # that are defined for the target cluster.
-        config_path = self.path / "config"
-        config_path.mkdir(exist_ok=True)
         packages_path = config_path / "packages.yaml"
 
         # the packages.yaml configuration that will be used when building all environments
@@ -312,11 +314,12 @@ def generate(self, recipe):
             fid.write(global_packages_yaml)
 
         # generate a mirrors.yaml file if build caches have been configured
-        if recipe.mirror:
-            dst = config_path / "mirrors.yaml"
-            self._logger.debug(f"generate the build cache mirror: {dst}")
-            with dst.open("w") as fid:
-                fid.write(cache.generate_mirrors_yaml(recipe.mirror))
+        self._logger.debug(f"Generating the spack mirror configs in '{config_path}'")
+        try:
+            recipe.mirrors.setup_configs(config_path)
+        except mirror.MirrorError as err:
+            self._logger.error(f"Could not set up mirrors.\n{err}")
+            return 1
 
         # Add custom spack package recipes, configured via Spack repos.
         # Step 1: copy Spack repos to store_path where they will be used to

stackinator/main.py

@@ -81,13 +81,31 @@ def log_header(args):
 def make_argparser():
     parser = argparse.ArgumentParser(description=("Generate a build configuration for a spack stack from a recipe."))
     parser.add_argument("--version", action="version", version=f"stackinator version {VERSION}")
-    parser.add_argument("-b", "--build", required=True, type=str)
+    parser.add_argument(
+        "-b",
+        "--build",
+        required=True,
+        type=str,
+        help="Where to set up the stackinator build directory. ('/tmp' is not allowed, use '/var/tmp')",
+    )
     parser.add_argument("--no-bwrap", action="store_true", required=False)
-    parser.add_argument("-r", "--recipe", required=True, type=str)
-    parser.add_argument("-s", "--system", required=True, type=str)
+    parser.add_argument(
+        "-r", "--recipe", required=True, type=str, help="Name of (and/or path to) the Stackinator recipe."
+    )
+    parser.add_argument(
+        "-s", "--system", required=True, type=str, help="Name of (and/or path to) the Stackinator system configuration."
+    )
     parser.add_argument("-d", "--debug", action="store_true")
-    parser.add_argument("-m", "--mount", required=False, type=str)
-    parser.add_argument("-c", "--cache", required=False, type=str)
+    parser.add_argument(
+        "-m", "--mount", required=False, type=str, help="The mount point where the environment will be located."
+    )
+    parser.add_argument(
+        "-c",
+        "--cache",
+        required=False,
+        type=str,
+        help="Buildcache location or name (from system config's mirrors.yaml).",
+    )
     parser.add_argument("--develop", action="store_true", required=False)
 
     return parser