;;; GNU Guix --- Functional package management for GNU
-;;; Copyright © 2014 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
+;;; Copyright © 2015 Mark H Weaver <mhw@netris.org>
;;;
;;; This file is part of GNU Guix.
;;;
(define-module (gnu system install)
#:use-module (gnu)
#:use-module (guix gexp)
+ #:use-module (guix store)
#:use-module (guix monads)
+ #:use-module ((guix store) #:select (%store-prefix))
+ #:use-module (guix profiles)
+ #:use-module (gnu services shepherd)
+ #:use-module (gnu packages admin)
+ #:use-module (gnu packages bash)
#:use-module (gnu packages linux)
+ #:use-module (gnu packages cryptsetup)
#:use-module (gnu packages package-management)
#:use-module (gnu packages disk)
+ #:use-module (gnu packages grub)
#:use-module (gnu packages texinfo)
- #:export (installation-os))
+ #:use-module (gnu packages compression)
+ #:use-module (ice-9 match)
+ #:use-module (srfi srfi-26)
+ #:export (self-contained-tarball
+ installation-os))
;;; Commentary:
;;;
;;;
;;; Code:
+\f
+(define* (self-contained-tarball #:key (guix guix))
+ "Return a self-contained tarball containing a store initialized with the
+closure of GUIX. The tarball contains /gnu/store, /var/guix, and a profile
+under /root/.guix-profile where GUIX is installed."
+ (mlet %store-monad ((profile (profile-derivation
+ (manifest
+ (list (package->manifest-entry guix))))))
+ (define build
+ #~(begin
+ (use-modules (guix build utils)
+ (gnu build install))
+
+ (define %root "root")
+
+ (setenv "PATH"
+ (string-append #$guix "/sbin:" #$tar "/bin:" #$xz "/bin"))
+
+ ;; Note: there is not much to gain here with deduplication and there
+ ;; is the overhead of the '.links' directory, so turn it off.
+ (populate-single-profile-directory %root
+ #:profile #$profile
+ #:closure "profile"
+ #:deduplicate? #f)
+
+ ;; Create the tarball. Use GNU format so there's no file name
+ ;; length limitation.
+ (with-directory-excursion %root
+ (zero? (system* "tar" "--xz" "--format=gnu"
+
+ ;; Avoid non-determinism in the archive. Use
+ ;; mtime = 1, not zero, because that is what the
+ ;; daemon does for files in the store (see the
+ ;; 'mtimeStore' constant in local-store.cc.)
+ "--sort=name"
+ "--mtime=@1" ;for files in /var/guix
+ "--owner=root:0"
+ "--group=root:0"
+
+ "--check-links"
+ "-cvf" #$output
+ ;; Avoid adding / and /var to the tarball,
+ ;; so that the ownership and permissions of those
+ ;; directories will not be overwritten when
+ ;; extracting the archive. Do not include /root
+ ;; because the root account might have a different
+ ;; home directory.
+ "./var/guix"
+ (string-append "." (%store-directory)))))))
+
+ (gexp->derivation "guix-tarball.tar.xz" build
+ #:references-graphs `(("profile" ,profile))
+ #:modules '((guix build utils)
+ (guix build store-copy)
+ (gnu build install)))))
+
+\f
(define (log-to-info)
"Return a script that spawns the Info reader on the right section of the
manual."
- (gexp->script "log-to-info"
- #~(execl (string-append #$texinfo-4 "/bin/info") "info"
- "-d" "/run/current-system/profile/share/info"
- "-f" (string-append #$guix "/share/info/guix.info")
- "-n" "System Configuration")))
+ (program-file "log-to-info"
+ #~(begin
+ ;; 'gunzip' is needed to decompress the doc.
+ (setenv "PATH" (string-append #$gzip "/bin"))
+
+ (execl (string-append #$info-reader "/bin/info") "info"
+ "-d" "/run/current-system/profile/share/info"
+ "-f" (string-append #$guix "/share/info/guix.info")
+ "-n" "System Installation"))))
+
+(define %backing-directory
+ ;; Sub-directory used as the backing store for copy-on-write.
+ "/tmp/guix-inst")
+
+(define (make-cow-store target)
+ "Return a gexp that makes the store copy-on-write, using TARGET as the
+backing store. This is useful when TARGET is on a hard disk, whereas the
+current store is on a RAM disk."
+ (define (unionfs read-only read-write mount-point)
+ ;; Make MOUNT-POINT the union of READ-ONLY and READ-WRITE.
+
+ ;; Note: in the command below, READ-WRITE appears before READ-ONLY so that
+ ;; it is considered a "higher-level branch", as per unionfs-fuse(8),
+ ;; thereby allowing files existing on READ-ONLY to be copied over to
+ ;; READ-WRITE.
+ #~(fork+exec-command
+ (list (string-append #$unionfs-fuse "/bin/unionfs")
+ "-o"
+ "cow,allow_other,use_ino,max_files=65536,nonempty"
+ (string-append #$read-write "=RW:" #$read-only "=RO")
+ #$mount-point)))
+
+ (define (set-store-permissions directory)
+ ;; Set the right perms on DIRECTORY to use it as the store.
+ #~(begin
+ (chown #$directory 0 30000) ;use the fixed 'guixbuild' GID
+ (chmod #$directory #o1775)))
+
+ #~(begin
+ ;; Bind-mount TARGET's /tmp in case we need space to build things.
+ (let ((tmpdir (string-append #$target "/tmp")))
+ (mkdir-p tmpdir)
+ (mount tmpdir "/tmp" "none" MS_BIND))
+
+ (unless (file-exists? "/.ro-store")
+ (mkdir "/.ro-store")
+ (mount #$(%store-prefix) "/.ro-store" "none"
+ (logior MS_BIND MS_RDONLY)))
+
+ (let ((rw-dir (string-append target #$%backing-directory)))
+ (mkdir-p rw-dir)
+ (mkdir-p "/.rw-store")
+ #$(set-store-permissions #~rw-dir)
+ #$(set-store-permissions "/.rw-store")
+
+ ;; Mount the union, then atomically make it the store.
+ (and #$(unionfs "/.ro-store" #~rw-dir "/.rw-store")
+ (begin
+ (sleep 1) ;XXX: wait for unionfs to be ready
+ (mount "/.rw-store" #$(%store-prefix) "" MS_MOVE)
+ (rmdir "/.rw-store"))))))
+
+(define cow-store-service-type
+ (shepherd-service-type
+ 'cow-store
+ (lambda _
+ (shepherd-service
+ (requirement '(root-file-system user-processes))
+ (provision '(cow-store))
+ (documentation
+ "Make the store copy-on-write, with writes going to \
+the given target.")
+
+ ;; This is meant to be explicitly started by the user.
+ (auto-start? #f)
+
+ (start #~(case-lambda
+ ((target)
+ #$(make-cow-store #~target)
+ target)
+ (else
+ ;; Do nothing, and mark the service as stopped.
+ #f)))
+ (stop #~(lambda (target)
+ ;; Delete the temporary directory, but leave everything
+ ;; mounted as there may still be processes using it since
+ ;; 'user-processes' doesn't depend on us. The 'user-unmount'
+ ;; service will unmount TARGET eventually.
+ (delete-file-recursively
+ (string-append target #$%backing-directory))))))))
+
+(define (cow-store-service)
+ "Return a service that makes the store copy-on-write, such that writes go to
+the user's target storage device rather than on the RAM disk."
+ ;; See <http://bugs.gnu.org/18061> for the initial report.
+ (service cow-store-service-type 'mooooh!))
+
+
+(define (/etc/configuration-files _)
+ "Return a list of tuples representing configuration templates to add to
+/etc."
+ (define (file f)
+ (local-file (search-path %load-path
+ (string-append "gnu/system/examples/" f))))
+
+ (define directory
+ (computed-file "configuration-templates"
+ #~(begin
+ (mkdir #$output)
+ (for-each (lambda (file target)
+ (copy-file file
+ (string-append #$output "/"
+ target)))
+ '(#$(file "bare-bones.tmpl")
+ #$(file "desktop.tmpl")
+ #$(file "lightweight-desktop.tmpl"))
+ '("bare-bones.scm"
+ "desktop.scm"
+ "lightweight-desktop.scm"))
+ #t)
+ #:modules '((guix build utils))))
+
+ `(("configuration" ,directory)))
+
+(define configuration-template-service-type
+ (service-type (name 'configuration-template)
+ (extensions
+ (list (service-extension etc-service-type
+ /etc/configuration-files)))))
+
+(define %configuration-template-service
+ (service configuration-template-service-type #t))
+
+
+(define %nscd-minimal-caches
+ ;; Minimal in-memory caching policy for nscd.
+ (list (nscd-cache (database 'hosts)
+ (positive-time-to-live (* 3600 12))
+
+ ;; Do not cache lookup failures at all since they are
+ ;; quite likely (for instance when someone tries to ping a
+ ;; host before networking is functional.)
+ (negative-time-to-live 0)
+
+ (persistent? #f)
+ (max-database-size (* 5 (expt 2 20)))))) ;5 MiB
(define (installation-services)
"Return the list services for the installation image."
- (let ((motd (text-file "motd" "
-Welcome to the installation of the GNU operating system!
+ (let ((motd (plain-file "motd" "
+Welcome to the installation of the Guix System Distribution!
There is NO WARRANTY, to the extent permitted by law. In particular, you may
LOSE ALL YOUR DATA as a side effect of the installation process. Furthermore,
-it is alpha software, so it may BREAK IN UNEXPECTED WAYS.
+it is 'beta' software, so it may contain bugs.
You have been warned. Thanks for being so brave.
")))
(define (normal-tty tty)
- (mingetty-service tty
- #:motd motd
- #:auto-login "root"
- #:login-pause? #t))
+ (mingetty-service (mingetty-configuration (tty tty)
+ (motd motd)
+ (auto-login "root")
+ (login-pause? #t))))
+
+ (list (mingetty-service (mingetty-configuration
+ (tty "tty1")
+ (motd motd)
+ (auto-login "root")))
- (list (mingetty-service "tty1"
- #:motd motd
- #:auto-login "root")
+ ;; Documentation. The manual is in UTF-8, but
+ ;; 'console-font-service' sets up Unicode support and loads a font
+ ;; with all the useful glyphs like em dash and quotation marks.
+ (mingetty-service (mingetty-configuration
+ (tty "tty2")
+ (motd motd)
+ (auto-login "guest")
+ (login-program (log-to-info))))
- ;; Documentation.
- (mingetty-service "tty2"
- #:motd motd
- #:auto-login "guest"
- #:login-program (log-to-info))
+ ;; Documentation add-on.
+ %configuration-template-service
;; A bunch of 'root' ttys.
(normal-tty "tty3")
;; The build daemon. Register the hydra.gnu.org key as trusted.
;; This allows the installation process to use substitutes by
;; default.
- (guix-service #:authorize-hydra-key? #t)
+ (guix-service (guix-configuration (authorize-key? #t)))
+
+ ;; Start udev so that useful device nodes are available.
+ ;; Use device-mapper rules for cryptsetup & co; enable the CRDA for
+ ;; regulations-compliant WiFi access.
+ (udev-service #:rules (list lvm2 crda))
+
+ ;; Add the 'cow-store' service, which users have to start manually
+ ;; since it takes the installation directory as an argument.
+ (cow-store-service)
- (nscd-service))))
+ ;; Install Unicode support and a suitable font.
+ (console-font-service "tty1")
+ (console-font-service "tty2")
+ (console-font-service "tty3")
+ (console-font-service "tty4")
+ (console-font-service "tty5")
+ (console-font-service "tty6")
+
+ ;; To facilitate copy/paste.
+ (gpm-service)
+
+ ;; Since this is running on a USB stick with a unionfs as the root
+ ;; file system, use an appropriate cache configuration.
+ (nscd-service (nscd-configuration
+ (caches %nscd-minimal-caches))))))
(define %issue
;; Greeting.
(operating-system
(host-name "gnu")
(timezone "Europe/Paris")
- (locale "en_US.UTF-8")
+ (locale "en_US.utf8")
(bootloader (grub-configuration
(device "/dev/sda")))
(file-systems
;; Note: the disk image build code overrides this root file system with
;; the appropriate one.
- (list (file-system
- (mount-point "/")
- (device "gnu-disk-image")
- (type "ext4"))))
+ (cons* (file-system
+ (mount-point "/")
+ (device "gnu-disk-image")
+ (title 'label)
+ (type "ext4"))
+
+ ;; Make /tmp a tmpfs instead of keeping the unionfs. This is
+ ;; because FUSE creates '.fuse_hiddenXYZ' files for each open file,
+ ;; and this confuses Guix's test suite, for instance. See
+ ;; <http://bugs.gnu.org/23056>.
+ (file-system
+ (mount-point "/tmp")
+ (device "none")
+ (title 'device)
+ (type "tmpfs")
+ (check? #f))
+
+ ;; XXX: This should be %BASE-FILE-SYSTEMS but we don't need
+ ;; elogind's cgroup file systems.
+ (list %pseudo-terminal-file-system
+ %shared-memory-file-system
+ %immutable-store)))
(users (list (user-account
(name "guest")
- (group "wheel")
+ (group "users")
+ (supplementary-groups '("wheel")) ; allow use of sudo
(password "")
(comment "Guest of GNU")
(home-directory "/home/guest"))))
- (groups (list (user-group (name "root") (id 0))
- (user-group
- (name "wheel")
- (id 1)
- (members '("guest"))) ; allow 'guest' to use sudo
- (user-group
- (name "users")
- (id 100)
- (members '("guest")))))
(issue %issue)
;; Explicitly allow for empty passwords.
(base-pam-services #:allow-empty-passwords? #t))
- (packages (cons* texinfo-4 ; for the standalone Info reader
- parted fdisk ddrescue
+ (packages (cons* (canonical-package glibc) ;for 'tzselect' & co.
+ parted ddrescue
+ grub ;mostly so xrefs to its manual work
+ cryptsetup
+ btrfs-progs
+ wireless-tools iw wpa-supplicant-minimal iproute
+ ;; XXX: We used to have GNU fdisk here, but as of version
+ ;; 2.0.0a, that pulls Guile 1.8, which takes unreasonable
+ ;; space; furthermore util-linux's fdisk is already
+ ;; available here, so we keep that.
+ bash-completion
%base-packages))))
;; Return it here so 'guix system' can consume it directly.