Guix

From Grid5000
Revision as of 20:38, 23 March 2021 by Pringot (talk | contribs) (Generating image to use with singularity)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Note.png Note

This page is actively maintained by the Grid'5000 team. If you encounter problems, please report them (see the Support page). Additionally, as it is a wiki page, you are free to make minor corrections yourself if needed. If you would like to suggest a more fundamental change, please contact the Grid'5000 team.

The Guix package manager is available on Grid'5000 to provide an alternative way of installing software on nodes.

This page describes the use of Guix on Grid'5000. For additional information about Guix, see:


Note: For now, Guix is only available on Grid'5000 nodes with x86_64 architecture (not on POWER or ARM nodes).


Quick start

Guix is available on frontends and nodes (using standard or deployed -nfs and -big environments) directly through the guix command.

For example:

$ guix install hello

To make the hello executable available, programs installed by Guix must be added to your PATH. You can do this by simply running:

$ export GUIX_PROFILE=~/.guix-profile
$ . "$GUIX_PROFILE/etc/profile"

(you can add these two commands to your .bashrc to make it persistent)

You can then use what you just installed:

$ hello
Hello, world!

To update available packages from Guix channels, use:

$ guix pull

(be patient it will take a while the first time)

Advanced usage examples

Generating image to use with singularity

You can use Guix to create container image for singularity with guix pack. For instance, to build an image containing emacs and bash, use:

$ guix pack -f squashfs bash emacs gcc
....
/gnu/store/7pzhxrkjrfk3sh9i4dn2k61gvi1slr7g-squashfs-pack.gz.squashfs

The built image can be run using singularity. For instance, from a node:

node$ singularity run /gnu/store/7pzhxrkjrfk3sh9i4dn2k61gvi1slr7g-squashfs-pack.gz.squashfs
WARNING: passwd file doesn't exist in container, not updating
WARNING: group file doesn't exist in container, not updating
/bin/sh: warning: setlocale: LC_ALL: cannot change locale (en_US.UTF-8)
No runscript found in container, executing /bin/sh
sh: warning: setlocale: LC_ALL: cannot change locale (en_US.UTF-8)
Singularity> gcc -v
Using built-in specs.
COLLECT_GCC=gcc
COLLECT_LTO_WRAPPER=/gnu/store/xpdy9vvqym9xv7praqkwsm3gdzn2kv1p-gcc- 
10.2.0/libexec/gcc/x86_64-unknown-linux-gnu/10.2.0/lto-wrapper
Target: x86_64-unknown-linux-gnu
Configured with:
Thread model: posix
Supported LTO compression algorithms: zlib
gcc version 10.2.0 (GCC)

Note: If you forget the bash (or similar) package, singularity run and singularity exec will fail with an unhelpful “no such file or directory” message.

For more information of singularity usage under Grid'5000, see Singularity page.

Container

Guix container command can be used to easily isolate the execution of your program. For instance, this will instanciate an isolated container containing coreutils, gcc and procps

node$ guix environment --ad-hoc --container coreutils gcc procps
node ~ [env]$ gcc -v
Using built-in specs.
COLLECT_GCC=gcc
COLLECT_LTO_WRAPPER=/gnu/store/xpdy9vvqym9xv7praqkwsm3gdzn2kv1p-gcc- 
10.2.0/libexec/gcc/x86_64-unknown-linux-gnu/10.2.0/lto-wrapper
Target: x86_64-unknown-linux-gnu
Configured with:
Thread model: posix
Supported LTO compression algorithms: zlib
gcc version 10.2.0 (GCC)

Note: This feature is only available from nodes, not frontends

Configuration details

Here are some details of Guix deployment and configuration under Grid'5000 that may help in case of problem or for your customized deployment.

Guix profile

Note: To work properly, a .guix directory is created in your home directory (it's a Grid'5000-specific directory). If you remove it, Guix will stop working since your profile is stored there.

Warning.png Warning

If you have a guix profile because you have used guix before you should move it somewhere else or it won't work with the guix we provide

Environment variables

In order to use Guix on Grid'5000, some environment variables are correctly set:

$ env | grep GUIX
GUIX_DAEMON_SOCKET=guix://guix.sophia.grid5000.fr
GUIX_LOCPATH=/var/guix/profiles/per-user/root/guix-profile/lib/locale
GUIX_PROFILE=/home/ddelabroye/.guix-profile

If those variables are not set you will have to manually source /etc/profile.d/guix.sh:

node$ . /etc/profile.d/guix.sh

Package installation steps

When you try to install or compile a package, the following steps happen:

  • Guix first tries to fetch the compiled package from ci.guix.gnu.org
  • If not found, it will try to find it on all Grid'5000 Guix servers. (Each Grid'5000 site hosts a Guix server communicating with each other. If you install a package on Nancy and then decide to install the same package in Grenoble, it will be fetched from Nancy).
  • If it still not found, it will be compiled on a dedicated machine on Grid'5000, which is not accessible to the users