spack.container package

Submodules

spack.container.images module

Manages the details on the images used in the various stages.

spack.container.images.all_bootstrap_os()[source]

Return a list of all the OS that can be used to bootstrap Spack

spack.container.images.bootstrap_template_for(image)[source]
spack.container.images.build_info(image, spack_version)[source]

Returns the name of the build image and its tag.

Parameters
  • image (str) – image to be used at run-time. Should be of the form <image_name>:<image_tag> e.g. “ubuntu:18.04”

  • spack_version (str) – version of Spack that we want to use to build

Returns

A tuple with (image_name, image_tag) for the build image

spack.container.images.checkout_command(url, ref, enforce_sha, verify)[source]

Return the checkout command to be used in the bootstrap phase.

Parameters
  • url (str) – url of the Spack repository

  • ref (str) – either a branch name, a tag or a commit sha

  • enforce_sha (bool) – if true turns every

  • verify (bool) –

spack.container.images.commands_for(package_manager)[source]

Returns the commands used to update system repositories, install system packages and clean afterwards.

Parameters

package_manager (str) – package manager to be used

Returns

A tuple of (update, install, clean) commands.

spack.container.images.data()[source]

Returns a dictionary with the static data on the images.

The dictionary is read from a JSON file lazily the first time this function is called.

spack.container.images.os_package_manager_for(image)[source]

Returns the name of the OS package manager for the image passed as argument.

Parameters

image (str) – image to be used at run-time. Should be of the form <image_name>:<image_tag> e.g. “ubuntu:18.04”

Returns

Name of the package manager, e.g. “apt” or “yum”

Module contents

Package that provides functions and classes to generate container recipes from a Spack environment

spack.container.recipe(configuration, last_phase=None)[source]

Returns a recipe that conforms to the configuration passed as input.

Parameters
  • configuration (dict) – how to generate the current recipe

  • last_phase (str) – last phase to be printed or None to print them all

spack.container.validate(configuration_file)[source]

Validate a Spack environment YAML file that is being used to generate a recipe for a container.

Since a few attributes of the configuration must have specific values for the container recipe, this function returns a sanitized copy of the configuration in the input file. If any modification is needed, a warning will be issued.

Parameters

configuration_file (str) – path to the Spack environment YAML file

Returns

A sanitized copy of the configuration stored in the input file