[jackhill/guix/guix.git] / gnu / system / install.scm

;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2014, 2015 Ludovic Courtès <ludo@gnu.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(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 (gnu packages admin)
  #: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)
  #:use-module (gnu packages compression)
  #:export (installation-os))

;;; Commentary:
;;;
;;; This module provides an 'operating-system' definition for use on images
;;; for USB sticks etc., for the installation of the GNU system.
;;;
;;; Code:

(define (log-to-info)
  "Return a script that spawns the Info reader on the right section of the
manual."
  (gexp->script "log-to-info"
                #~(begin
                    ;; 'gunzip' is needed to decompress the doc.
                    (setenv "PATH" (string-append #$gzip "/bin"))

                    (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 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
      (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)
  "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.
  (with-monad %store-monad
    (return (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 (configuration-template-service)
  "Return a dummy service whose purpose is to install an operating system
configuration template file in the installation system."

  (define local-template
    "/etc/configuration-template.scm")
  (define template
    (search-path %load-path "gnu/system/os-config.tmpl"))

  (mlet %store-monad ((template (interned-file template)))
    (return (service
             (requirement '(root-file-system))
             (provision '(os-config-template))
             (documentation
              "This dummy service installs an OS configuration template.")
             (start #~(const #t))
             (stop  #~(const #f))
             (activate
              #~(unless (file-exists? #$local-template)
                  (copy-file #$template #$local-template)))))))

(define %nscd-minimal-caches
  ;; Minimal in-memory caching policy for nscd.
  (list (nscd-cache (database 'hosts)
                    (positive-time-to-live (* 3600 12))
                    (negative-time-to-live 20)
                    (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 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.

You have been warned.  Thanks for being so brave.
")))
    (define (normal-tty tty)
      (mingetty-service tty
                        #:motd motd
                        #:auto-login "root"
                        #:login-pause? #t))

    (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 "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")
          (normal-tty "tty4")
          (normal-tty "tty5")
          (normal-tty "tty6")

          ;; The usual services.
          (syslog-service)

          ;; 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)

          ;; Start udev so that useful device nodes are available.
          (udev-service)

          ;; Add the 'cow-store' service, which users have to start manually
          ;; since it takes the installation directory as an argument.
          (cow-store-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")

          ;; 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.
  "
This is an installation image of the GNU system.  Welcome.

Use Alt-F2 for documentation.
")

(define installation-os
  ;; The operating system used on installation images for USB sticks etc.
  (operating-system
    (host-name "gnu")
    (timezone "Europe/Paris")
    (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.
     (cons (file-system
             (mount-point "/")
             (device "gnu-disk-image")
             (type "ext4"))
           %base-file-systems))

    (users (list (user-account
                  (name "guest")
                  (group "users")
                  (supplementary-groups '("wheel"))  ; allow use of sudo
                  (password "")
                  (comment "Guest of GNU")
                  (home-directory "/home/guest"))))

    (issue %issue)

    (services (installation-services))

    ;; We don't need setuid programs so pass the empty list so we don't pull
    ;; additional programs here.
    (setuid-programs '())

    (pam-services
     ;; Explicitly allow for empty passwords.
     (base-pam-services #:allow-empty-passwords? #t))

    (packages (cons* texinfo-4                 ;for the standalone Info reader
                     parted ddrescue
                     grub                  ;mostly so xrefs to its manual work
                     cryptsetup
                     wireless-tools iw wpa-supplicant-light
                     ;; 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.
                     %base-packages))))

;; Return it here so 'guix system' can consume it directly.
installation-os

;;; install.scm ends here
Commit	Line	Data
fc91c17a	1	;;; GNU Guix --- Functional package management for GNU
e87f0591	2	;;; Copyright © 2014, 2015 Ludovic Courtès <ludo@gnu.org>
fc91c17a LC	3	;;;
	4	;;; This file is part of GNU Guix.
	5	;;;
	6	;;; GNU Guix is free software; you can redistribute it and/or modify it
	7	;;; under the terms of the GNU General Public License as published by
	8	;;; the Free Software Foundation; either version 3 of the License, or (at
	9	;;; your option) any later version.
	10	;;;
	11	;;; GNU Guix is distributed in the hope that it will be useful, but
	12	;;; WITHOUT ANY WARRANTY; without even the implied warranty of
	13	;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	;;; GNU General Public License for more details.
	15	;;;
	16	;;; You should have received a copy of the GNU General Public License
	17	;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
	18
	19	(define-module (gnu system install)
	20	#:use-module (gnu)
	21	#:use-module (guix gexp)
e87f0591	22	#:use-module (guix store)
fc91c17a	23	#:use-module (guix monads)
83a17b62	24	#:use-module ((guix store) #:select (%store-prefix))
db84467a	25	#:use-module (gnu packages admin)
fc91c17a	26	#:use-module (gnu packages linux)
b419c7f5	27	#:use-module (gnu packages cryptsetup)
fc91c17a	28	#:use-module (gnu packages package-management)
cc4a2aeb	29	#:use-module (gnu packages disk)
7eda0c56	30	#:use-module (gnu packages grub)
fc91c17a	31	#:use-module (gnu packages texinfo)
dd6b28d1	32	#:use-module (gnu packages compression)
fc91c17a LC	33	#:export (installation-os))
	34
	35	;;; Commentary:
	36	;;;
	37	;;; This module provides an 'operating-system' definition for use on images
	38	;;; for USB sticks etc., for the installation of the GNU system.
	39	;;;
	40	;;; Code:
	41
	42	(define (log-to-info)
	43	"Return a script that spawns the Info reader on the right section of the
	44	manual."
	45	(gexp->script "log-to-info"
dd6b28d1 LC	46	#~(begin
	47	;; 'gunzip' is needed to decompress the doc.
	48	(setenv "PATH" (string-append #$gzip "/bin"))
	49
	50	(execl (string-append #$texinfo-4 "/bin/info") "info"
	51	"-d" "/run/current-system/profile/share/info"
	52	"-f" (string-append #$guix "/share/info/guix.info")
	53	"-n" "System Installation"))))
fc91c17a	54
83a17b62 LC	55	(define %backing-directory
	56	;; Sub-directory used as the backing store for copy-on-write.
	57	"/tmp/guix-inst")
	58
	59	(define (make-cow-store target)
	60	"Return a gexp that makes the store copy-on-write, using TARGET as the
	61	backing store. This is useful when TARGET is on a hard disk, whereas the
	62	current store is on a RAM disk."
	63	(define (unionfs read-only read-write mount-point)
	64	;; Make MOUNT-POINT the union of READ-ONLY and READ-WRITE.
	65
	66	;; Note: in the command below, READ-WRITE appears before READ-ONLY so that
	67	;; it is considered a "higher-level branch", as per unionfs-fuse(8),
	68	;; thereby allowing files existing on READ-ONLY to be copied over to
	69	;; READ-WRITE.
	70	#~(fork+exec-command
	71	(list (string-append #$unionfs-fuse "/bin/unionfs")
	72	"-o"
	73	"cow,allow_other,use_ino,max_files=65536,nonempty"
	74	(string-append #$read-write "=RW:" #$read-only "=RO")
	75	#$mount-point)))
	76
	77	(define (set-store-permissions directory)
	78	;; Set the right perms on DIRECTORY to use it as the store.
	79	#~(begin
	80	(chown #$directory 0 30000) ;use the fixed 'guixbuild' GID
	81	(chmod #$directory #o1775)))
	82
	83	#~(begin
	84	(unless (file-exists? "/.ro-store")
	85	(mkdir "/.ro-store")
	86	(mount #$(%store-prefix) "/.ro-store" "none"
	87	(logior MS_BIND MS_RDONLY)))
	88
	89	(let ((rw-dir (string-append target #$%backing-directory)))
	90	(mkdir-p rw-dir)
	91	(mkdir-p "/.rw-store")
	92	#$(set-store-permissions #~rw-dir)
	93	#$(set-store-permissions "/.rw-store")
	94
	95	;; Mount the union, then atomically make it the store.
	96	(and #$(unionfs "/.ro-store" #~rw-dir "/.rw-store")
	97	(begin
	98	(sleep 1) ;XXX: wait for unionfs to be ready
	99	(mount "/.rw-store" #$(%store-prefix) "" MS_MOVE)
	100	(rmdir "/.rw-store"))))))
	101
	102	(define (cow-store-service)
	103	"Return a service that makes the store copy-on-write, such that writes go to
	104	the user's target storage device rather than on the RAM disk."
	105	;; See <http://bugs.gnu.org/18061> for the initial report.
	106	(with-monad %store-monad
	107	(return (service
	108	(requirement '(root-file-system user-processes))
	109	(provision '(cow-store))
	110	(documentation
	111	"Make the store copy-on-write, with writes going to \
	112	the given target.")
fdaacbad LC	113
	114	;; This is meant to be explicitly started by the user.
	115	(auto-start? #f)
	116
83a17b62 LC	117	(start #~(case-lambda
	118	((target)
	119	#$(make-cow-store #~target)
	120	target)
	121	(else
	122	;; Do nothing, and mark the service as stopped.
	123	#f)))
	124	(stop #~(lambda (target)
	125	;; Delete the temporary directory, but leave everything
	126	;; mounted as there may still be processes using it
d6e2a622 LC	127	;; since 'user-processes' doesn't depend on us. The
	128	;; 'user-unmount' service will unmount TARGET
	129	;; eventually.
83a17b62 LC	130	(delete-file-recursively
	131	(string-append target #$%backing-directory))))))))
	132
1dac8566 LC	133	(define (configuration-template-service)
	134	"Return a dummy service whose purpose is to install an operating system
	135	configuration template file in the installation system."
	136
	137	(define local-template
	138	"/etc/configuration-template.scm")
	139	(define template
	140	(search-path %load-path "gnu/system/os-config.tmpl"))
	141
	142	(mlet %store-monad ((template (interned-file template)))
	143	(return (service
	144	(requirement '(root-file-system))
	145	(provision '(os-config-template))
	146	(documentation
	147	"This dummy service installs an OS configuration template.")
	148	(start #~(const #t))
	149	(stop #~(const #f))
	150	(activate
	151	#~(unless (file-exists? #$local-template)
	152	(copy-file #$template #$local-template)))))))
	153
61ff0a3a LC	154	(define %nscd-minimal-caches
	155	;; Minimal in-memory caching policy for nscd.
	156	(list (nscd-cache (database 'hosts)
	157	(positive-time-to-live (* 3600 12))
	158	(negative-time-to-live 20)
	159	(persistent? #f)
	160	(max-database-size (* 5 (expt 2 20)))))) ;5 MiB
	161
fc91c17a LC	162	(define (installation-services)
	163	"Return the list services for the installation image."
	164	(let ((motd (text-file "motd" "
c73adb09	165	Welcome to the installation of the Guix System Distribution!
fc91c17a LC	166
	167	There is NO WARRANTY, to the extent permitted by law. In particular, you may
	168	LOSE ALL YOUR DATA as a side effect of the installation process. Furthermore,
	169	it is alpha software, so it may BREAK IN UNEXPECTED WAYS.
	170
	171	You have been warned. Thanks for being so brave.
	172	")))
	173	(define (normal-tty tty)
	174	(mingetty-service tty
	175	#:motd motd
	176	#:auto-login "root"
	177	#:login-pause? #t))
	178
	179	(list (mingetty-service "tty1"
	180	#:motd motd
	181	#:auto-login "root")
	182
62ca0fdf LC	183	;; Documentation. The manual is in UTF-8, but
	184	;; 'console-font-service' sets up Unicode support and loads a font
	185	;; with all the useful glyphs like em dash and quotation marks.
fc91c17a LC	186	(mingetty-service "tty2"
	187	#:motd motd
	188	#:auto-login "guest"
	189	#:login-program (log-to-info))
	190
1dac8566 LC	191	;; Documentation add-on.
	192	(configuration-template-service)
	193
fc91c17a LC	194	;; A bunch of 'root' ttys.
	195	(normal-tty "tty3")
	196	(normal-tty "tty4")
	197	(normal-tty "tty5")
	198	(normal-tty "tty6")
	199
	200	;; The usual services.
	201	(syslog-service)
2c5c696c LC	202
	203	;; The build daemon. Register the hydra.gnu.org key as trusted.
	204	;; This allows the installation process to use substitutes by
	205	;; default.
	206	(guix-service #:authorize-hydra-key? #t)
	207
e11390df LC	208	;; Start udev so that useful device nodes are available.
	209	(udev-service)
	210
83a17b62 LC	211	;; Add the 'cow-store' service, which users have to start manually
	212	;; since it takes the installation directory as an argument.
	213	(cow-store-service)
	214
62ca0fdf LC	215	;; Install Unicode support and a suitable font.
	216	(console-font-service "tty1")
	217	(console-font-service "tty2")
	218	(console-font-service "tty3")
	219	(console-font-service "tty4")
	220	(console-font-service "tty5")
	221	(console-font-service "tty6")
	222
61ff0a3a LC	223	;; Since this is running on a USB stick with a unionfs as the root
	224	;; file system, use an appropriate cache configuration.
	225	(nscd-service (nscd-configuration
	226	(caches %nscd-minimal-caches))))))
fc91c17a LC	227
	228	(define %issue
	229	;; Greeting.
	230	"
	231	This is an installation image of the GNU system. Welcome.
	232
	233	Use Alt-F2 for documentation.
	234	")
	235
	236	(define installation-os
	237	;; The operating system used on installation images for USB sticks etc.
	238	(operating-system
	239	(host-name "gnu")
	240	(timezone "Europe/Paris")
9cd0dfaa	241	(locale "en_US.utf8")
fc91c17a LC	242	(bootloader (grub-configuration
	243	(device "/dev/sda")))
	244	(file-systems
	245	;; Note: the disk image build code overrides this root file system with
	246	;; the appropriate one.
a69576ea	247	(cons (file-system
fc91c17a LC	248	(mount-point "/")
fc91c17a LC	249	(device "gnu-disk-image")
a69576ea LC	250	(type "ext4"))
a69576ea LC	251	%base-file-systems))
fc91c17a LC	252
	253	(users (list (user-account
	254	(name "guest")
72507e23 LC	255	(group "users")
72507e23 LC	256	(supplementary-groups '("wheel")) ; allow use of sudo
fc91c17a LC	257	(password "")
	258	(comment "Guest of GNU")
	259	(home-directory "/home/guest"))))
fc91c17a LC	260
	261	(issue %issue)
	262
	263	(services (installation-services))
	264
	265	;; We don't need setuid programs so pass the empty list so we don't pull
	266	;; additional programs here.
	267	(setuid-programs '())
	268
	269	(pam-services
	270	;; Explicitly allow for empty passwords.
	271	(base-pam-services #:allow-empty-passwords? #t))
	272
7eda0c56	273	(packages (cons* texinfo-4 ;for the standalone Info reader
8f297d42	274	parted ddrescue
7eda0c56	275	grub ;mostly so xrefs to its manual work
b419c7f5	276	cryptsetup
4fb7e0de	277	wireless-tools iw wpa-supplicant-light
8f297d42 LC	278	;; XXX: We used to have GNU fdisk here, but as of version
	279	;; 2.0.0a, that pulls Guile 1.8, which takes unreasonable
	280	;; space; furthermore util-linux's fdisk is already
	281	;; available here, so we keep that.
6f436c54	282	%base-packages))))
fc91c17a LC	283
	284	;; Return it here so 'guix system' can consume it directly.
	285	installation-os
	286
	287	;;; install.scm ends here