Merge branch '19140-service-acct-creation-doc'. Closes #19140
[arvados.git] / lib / install / deps.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package install
6
7 import (
8         "bufio"
9         "bytes"
10         "context"
11         _ "embed"
12         "errors"
13         "flag"
14         "fmt"
15         "io"
16         "os"
17         "os/exec"
18         "os/user"
19         "path/filepath"
20         "runtime"
21         "strconv"
22         "strings"
23         "syscall"
24         "time"
25
26         "git.arvados.org/arvados.git/lib/cmd"
27         "git.arvados.org/arvados.git/sdk/go/ctxlog"
28         "github.com/lib/pq"
29 )
30
31 var Command cmd.Handler = &installCommand{}
32
33 const goversion = "1.20.6"
34
35 const (
36         rubyversion             = "2.7.7"
37         bundlerversion          = "2.2.19"
38         singularityversion      = "3.10.4"
39         pjsversion              = "1.9.8"
40         geckoversion            = "0.24.0"
41         gradleversion           = "5.3.1"
42         nodejsversion           = "v12.22.12"
43         devtestDatabasePassword = "insecure_arvados_test"
44 )
45
46 //go:embed arvados.service
47 var arvadosServiceFile []byte
48
49 type installCommand struct {
50         ClusterType    string
51         SourcePath     string
52         PackageVersion string
53         EatMyData      bool
54 }
55
56 func (inst *installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
57         logger := ctxlog.New(stderr, "text", "info")
58         ctx := ctxlog.Context(context.Background(), logger)
59         ctx, cancel := context.WithCancel(ctx)
60         defer cancel()
61
62         var err error
63         defer func() {
64                 if err != nil {
65                         logger.WithError(err).Info("exiting")
66                 }
67         }()
68
69         flags := flag.NewFlagSet(prog, flag.ContinueOnError)
70         flags.SetOutput(stderr)
71         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
72         flags.StringVar(&inst.ClusterType, "type", "production", "cluster `type`: development, test, production, or package")
73         flags.StringVar(&inst.SourcePath, "source", "/arvados", "source tree location (required for -type=package)")
74         flags.StringVar(&inst.PackageVersion, "package-version", "0.0.0", "version string to embed in executable files")
75         flags.BoolVar(&inst.EatMyData, "eatmydata", false, "use eatmydata to speed up install")
76
77         if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
78                 return code
79         } else if *versionFlag {
80                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
81         }
82
83         var dev, test, prod, pkg bool
84         switch inst.ClusterType {
85         case "development":
86                 dev = true
87         case "test":
88                 test = true
89         case "production":
90                 prod = true
91         case "package":
92                 pkg = true
93         default:
94                 err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', 'production', or 'package')", inst.ClusterType)
95                 return 2
96         }
97
98         if prod {
99                 err = errors.New("production install is not yet implemented")
100                 return 1
101         }
102
103         osv, err := identifyOS()
104         if err != nil {
105                 return 1
106         }
107
108         listdir, err := os.Open("/var/lib/apt/lists")
109         if err != nil {
110                 logger.Warnf("error while checking whether to run apt-get update: %s", err)
111         } else if names, _ := listdir.Readdirnames(1); len(names) == 0 {
112                 // Special case for a base docker image where the
113                 // package cache has been deleted and all "apt-get
114                 // install" commands will fail unless we fetch repos.
115                 cmd := exec.CommandContext(ctx, "apt-get", "update")
116                 cmd.Stdout = stdout
117                 cmd.Stderr = stderr
118                 err = cmd.Run()
119                 if err != nil {
120                         return 1
121                 }
122         }
123
124         if inst.EatMyData {
125                 cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends", "eatmydata")
126                 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
127                 cmd.Stdout = stdout
128                 cmd.Stderr = stderr
129                 err = cmd.Run()
130                 if err != nil {
131                         return 1
132                 }
133         }
134
135         pkgs := prodpkgs(osv)
136
137         if pkg {
138                 pkgs = append(pkgs,
139                         "dpkg-dev",
140                         "eatmydata", // install it for later steps, even if we're not using it now
141                 )
142         }
143
144         if dev || test || pkg {
145                 pkgs = append(pkgs,
146                         "automake",
147                         "bison",
148                         "bsdmainutils",
149                         "build-essential",
150                         "cadaver",
151                         "curl",
152                         "cython3",
153                         "default-jdk-headless",
154                         "default-jre-headless",
155                         "gettext",
156                         "libattr1-dev",
157                         "libfuse-dev",
158                         "libgbm1", // cypress / workbench2 tests
159                         "libgnutls28-dev",
160                         "libpam-dev",
161                         "libpcre3-dev",
162                         "libpq-dev",
163                         "libreadline-dev",
164                         "libssl-dev",
165                         "libxml2-dev",
166                         "libxslt1-dev",
167                         "linkchecker",
168                         "lsof",
169                         "make",
170                         "net-tools",
171                         "pandoc",
172                         "pkg-config",
173                         "postgresql",
174                         "postgresql-contrib",
175                         "python3-dev",
176                         "python3-venv",
177                         "python3-virtualenv",
178                         "r-base",
179                         "r-cran-testthat",
180                         "r-cran-devtools",
181                         "r-cran-knitr",
182                         "r-cran-markdown",
183                         "r-cran-roxygen2",
184                         "r-cran-xml",
185                         "rsync",
186                         "sudo",
187                         "uuid-dev",
188                         "wget",
189                         "xvfb",
190                         "zlib1g-dev", // services/api
191                 )
192                 if test {
193                         if osv.Debian && osv.Major <= 10 {
194                                 pkgs = append(pkgs, "iceweasel")
195                         } else if osv.Debian && osv.Major >= 11 {
196                                 pkgs = append(pkgs, "firefox-esr")
197                         } else {
198                                 pkgs = append(pkgs, "firefox")
199                         }
200                 }
201                 if dev || test {
202                         pkgs = append(pkgs,
203                                 "libglib2.0-dev", // singularity (conmon)
204                                 "libseccomp-dev", // singularity (seccomp)
205                                 "squashfs-tools", // singularity
206                                 "gnupg")          // docker install recipe
207                 }
208                 switch {
209                 case osv.Debian && osv.Major >= 11:
210                         pkgs = append(pkgs, "g++", "libcurl4", "libcurl4-openssl-dev")
211                 case osv.Debian && osv.Major >= 10:
212                         pkgs = append(pkgs, "g++", "libcurl4", "libcurl4-openssl-dev")
213                 case osv.Debian || osv.Ubuntu:
214                         pkgs = append(pkgs, "g++", "libcurl3", "libcurl3-openssl-dev")
215                 case osv.Centos:
216                         pkgs = append(pkgs, "gcc", "gcc-c++", "libcurl-devel", "postgresql-devel")
217                 }
218                 cmd := exec.CommandContext(ctx, "apt-get")
219                 if inst.EatMyData {
220                         cmd = exec.CommandContext(ctx, "eatmydata", "apt-get")
221                 }
222                 cmd.Args = append(cmd.Args, "install", "--yes", "--no-install-recommends")
223                 cmd.Args = append(cmd.Args, pkgs...)
224                 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
225                 cmd.Stdout = stdout
226                 cmd.Stderr = stderr
227                 err = cmd.Run()
228                 if err != nil {
229                         return 1
230                 }
231         }
232
233         if dev || test {
234                 if havedockerversion, err := exec.Command("docker", "--version").CombinedOutput(); err == nil {
235                         logger.Printf("%s installed, assuming that version is ok", bytes.TrimSuffix(havedockerversion, []byte("\n")))
236                 } else if osv.Debian {
237                         var codename string
238                         switch osv.Major {
239                         case 10:
240                                 codename = "buster"
241                         case 11:
242                                 codename = "bullseye"
243                         default:
244                                 err = fmt.Errorf("don't know how to install docker-ce for debian %d", osv.Major)
245                                 return 1
246                         }
247                         err = inst.runBash(`
248 rm -f /usr/share/keyrings/docker-archive-keyring.gpg
249 curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
250 echo 'deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian/ `+codename+` stable' | \
251     tee /etc/apt/sources.list.d/docker.list
252 apt-get update
253 DEBIAN_FRONTEND=noninteractive apt-get --yes --no-install-recommends install docker-ce
254 `, stdout, stderr)
255                         if err != nil {
256                                 return 1
257                         }
258                 } else {
259                         err = fmt.Errorf("don't know how to install docker for osversion %v", osv)
260                         return 1
261                 }
262
263                 err = inst.runBash(`
264 add="fs.inotify.max_user_watches=524288"
265 if ! grep -F -- "$add" /etc/sysctl.conf; then
266     echo "$add" | tee -a /etc/sysctl.conf
267     sysctl -p
268 fi
269 `, stdout, stderr)
270                 if err != nil {
271                         // Just warn instead of fail because this is expected when running
272                         // inside Docker.
273                         logger.Warnf("couldn't set fs.inotify.max_user_watches value: %v", err)
274                 }
275         }
276
277         os.Mkdir("/var/lib/arvados", 0755)
278         os.Mkdir("/var/lib/arvados/tmp", 0700)
279         if prod || pkg {
280                 u, er := user.Lookup("www-data")
281                 if er != nil {
282                         err = fmt.Errorf("user.Lookup(%q): %w", "www-data", er)
283                         return 1
284                 }
285                 uid, _ := strconv.Atoi(u.Uid)
286                 gid, _ := strconv.Atoi(u.Gid)
287                 os.Mkdir("/var/lib/arvados/wwwtmp", 0700)
288                 err = os.Chown("/var/lib/arvados/wwwtmp", uid, gid)
289                 if err != nil {
290                         return 1
291                 }
292         }
293         rubymajorversion := rubyversion[:strings.LastIndex(rubyversion, ".")]
294         if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+rubyversion)) {
295                 logger.Print("ruby " + rubyversion + " already installed")
296         } else {
297                 err = inst.runBash(`
298 tmp="$(mktemp -d)"
299 trap 'rm -r "${tmp}"' ERR EXIT
300 wget --progress=dot:giga -O- https://cache.ruby-lang.org/pub/ruby/`+rubymajorversion+`/ruby-`+rubyversion+`.tar.gz | tar -C "${tmp}" -xzf -
301 cd "${tmp}/ruby-`+rubyversion+`"
302 ./configure --disable-install-static-library --enable-shared --disable-install-doc --prefix /var/lib/arvados
303 make -j8
304 make install
305 /var/lib/arvados/bin/gem install bundler --no-document
306 `, stdout, stderr)
307                 if err != nil {
308                         return 1
309                 }
310         }
311
312         if !prod {
313                 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
314                         logger.Print("go " + goversion + " already installed")
315                 } else {
316                         err = inst.runBash(`
317 cd /tmp
318 rm -rf /var/lib/arvados/go/
319 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
320 ln -sfv /var/lib/arvados/go/bin/* /usr/local/bin/
321 `, stdout, stderr)
322                         if err != nil {
323                                 return 1
324                         }
325                 }
326         }
327
328         if !prod && !pkg {
329                 if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
330                         logger.Print("phantomjs " + pjsversion + " already installed")
331                 } else {
332                         err = inst.runBash(`
333 PJS=phantomjs-`+pjsversion+`-linux-x86_64
334 wget --progress=dot:giga -O- https://cache.arvados.org/$PJS.tar.bz2 | tar -C /var/lib/arvados -xjf -
335 ln -sfv /var/lib/arvados/$PJS/bin/phantomjs /usr/local/bin/
336 `, stdout, stderr)
337                         if err != nil {
338                                 return 1
339                         }
340                 }
341
342                 if havegeckoversion, err := exec.Command("/usr/local/bin/geckodriver", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegeckoversion), " "+geckoversion+" ") {
343                         logger.Print("geckodriver " + geckoversion + " already installed")
344                 } else {
345                         err = inst.runBash(`
346 GD=v`+geckoversion+`
347 wget --progress=dot:giga -O- https://github.com/mozilla/geckodriver/releases/download/$GD/geckodriver-$GD-linux64.tar.gz | tar -C /var/lib/arvados/bin -xzf - geckodriver
348 ln -sfv /var/lib/arvados/bin/geckodriver /usr/local/bin/
349 `, stdout, stderr)
350                         if err != nil {
351                                 return 1
352                         }
353                 }
354
355                 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
356                         logger.Print("gradle " + gradleversion + " already installed")
357                 } else {
358                         err = inst.runBash(`
359 G=`+gradleversion+`
360 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
361 trap "rm ${zip}" ERR
362 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
363 unzip -o -d /var/lib/arvados ${zip}
364 ln -sfv /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
365 rm ${zip}
366 `, stdout, stderr)
367                         if err != nil {
368                                 return 1
369                         }
370                 }
371
372                 if havesingularityversion, err := exec.Command("/var/lib/arvados/bin/singularity", "--version").CombinedOutput(); err == nil && strings.Contains(string(havesingularityversion), singularityversion) {
373                         logger.Print("singularity " + singularityversion + " already installed")
374                 } else if dev || test {
375                         err = inst.runBash(`
376 S=`+singularityversion+`
377 tmp=/var/lib/arvados/tmp/singularity
378 trap "rm -r ${tmp}" ERR EXIT
379 cd /var/lib/arvados/tmp
380 git clone --recurse-submodules https://github.com/sylabs/singularity
381 cd singularity
382 git checkout v${S}
383 ./mconfig --prefix=/var/lib/arvados
384 make -C ./builddir
385 make -C ./builddir install
386 `, stdout, stderr)
387                         if err != nil {
388                                 return 1
389                         }
390                 }
391
392                 err = inst.runBash(`
393 install /usr/bin/nsenter /var/lib/arvados/bin/nsenter
394 setcap "cap_sys_admin+pei cap_sys_chroot+pei" /var/lib/arvados/bin/nsenter
395 `, stdout, stderr)
396                 if err != nil {
397                         return 1
398                 }
399
400                 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
401                 // it's installed, locale -a reports it as
402                 // "en_US.utf8".
403                 wantlocale := "en_US.UTF-8"
404                 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
405                         logger.Print("locale " + wantlocale + " already installed")
406                 } else {
407                         err = inst.runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
408                         if err != nil {
409                                 return 1
410                         }
411                 }
412
413                 var pgc struct {
414                         Version       string
415                         Cluster       string
416                         Port          int
417                         Status        string
418                         Owner         string
419                         DataDirectory string
420                         LogFile       string
421                 }
422                 if pgLsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
423                         err = fmt.Errorf("pg_lsclusters: %s", err2)
424                         return 1
425                 } else if pgclusters := strings.Split(strings.TrimSpace(string(pgLsclusters)), "\n"); len(pgclusters) != 1 {
426                         logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
427                 } else if _, err = fmt.Sscanf(pgclusters[0], "%s %s %d %s %s %s %s", &pgc.Version, &pgc.Cluster, &pgc.Port, &pgc.Status, &pgc.Owner, &pgc.DataDirectory, &pgc.LogFile); err != nil {
428                         err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
429                         return 1
430                 } else if pgc.Status == "online" {
431                         logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
432                 } else {
433                         logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
434                         cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
435                         cmd.Stdout = stdout
436                         cmd.Stderr = stderr
437                         err = cmd.Start()
438                         if err != nil {
439                                 return 1
440                         }
441                         defer func() {
442                                 cmd.Process.Signal(syscall.SIGTERM)
443                                 logger.Info("sent SIGTERM; waiting for postgres to shut down")
444                                 cmd.Wait()
445                         }()
446                         err = waitPostgreSQLReady()
447                         if err != nil {
448                                 return 1
449                         }
450                 }
451
452                 if os.Getpid() == 1 {
453                         // We are the init process (presumably in a
454                         // docker container) so although postgresql is
455                         // installed, it's not running, and initdb
456                         // might never have been run.
457                 }
458
459                 var needcoll []string
460                 // If the en_US.UTF-8 locale wasn't installed when
461                 // postgresql initdb ran, it needs to be added
462                 // explicitly before we can use it in our test suite.
463                 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
464                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-t", "-c", "SELECT 1 FROM pg_catalog.pg_collation WHERE collname='"+collname+"' AND collcollate IN ('en_US.UTF-8', 'en_US.utf8')")
465                         cmd.Dir = "/"
466                         out, err2 := cmd.CombinedOutput()
467                         if err != nil {
468                                 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
469                                 return 1
470                         }
471                         if strings.Contains(string(out), "1") {
472                                 logger.Infof("postgresql supports collation %s", collname)
473                         } else {
474                                 needcoll = append(needcoll, collname)
475                         }
476                 }
477                 if len(needcoll) > 0 && os.Getpid() != 1 {
478                         // In order for the CREATE COLLATION statement
479                         // below to work, the locale must have existed
480                         // when PostgreSQL started up. If we're
481                         // running as init, we must have started
482                         // PostgreSQL ourselves after installing the
483                         // locales. Otherwise, it might need a
484                         // restart, so we attempt to restart it with
485                         // systemd.
486                         if err = inst.runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
487                                 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
488                         } else if err = waitPostgreSQLReady(); err != nil {
489                                 return 1
490                         }
491                 }
492                 for _, collname := range needcoll {
493                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
494                         cmd.Stdout = stdout
495                         cmd.Stderr = stderr
496                         cmd.Dir = "/"
497                         err = cmd.Run()
498                         if err != nil {
499                                 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
500                                 return 1
501                         }
502                 }
503
504                 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
505                 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
506                 cmd.Dir = "/"
507                 if err := cmd.Run(); err == nil {
508                         logger.Print("arvados role exists; superuser privileges added, password updated")
509                 } else {
510                         cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
511                         cmd.Dir = "/"
512                         cmd.Stdout = stdout
513                         cmd.Stderr = stderr
514                         err = cmd.Run()
515                         if err != nil {
516                                 return 1
517                         }
518                 }
519         }
520
521         if !prod {
522                 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == nodejsversion+"\n" {
523                         logger.Print("nodejs " + nodejsversion + " already installed")
524                 } else {
525                         err = inst.runBash(`
526 NJS=`+nodejsversion+`
527 rm -rf /var/lib/arvados/node-*-linux-x64
528 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
529 ln -sfv /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
530 `, stdout, stderr)
531                         if err != nil {
532                                 return 1
533                         }
534                 }
535
536                 if haveyarnversion, err := exec.Command("/usr/local/bin/yarn", "--version").CombinedOutput(); err == nil && len(haveyarnversion) > 0 {
537                         logger.Print("yarn " + strings.TrimSpace(string(haveyarnversion)) + " already installed")
538                 } else {
539                         err = inst.runBash(`
540 npm install -g yarn
541 ln -sfv /var/lib/arvados/node-`+nodejsversion+`-linux-x64/bin/{yarn,yarnpkg} /usr/local/bin/
542 `, stdout, stderr)
543                         if err != nil {
544                                 return 1
545                         }
546                 }
547         }
548
549         if prod || pkg {
550                 // Install Go programs to /var/lib/arvados/bin/
551                 for _, srcdir := range []string{
552                         "cmd/arvados-client",
553                         "cmd/arvados-server",
554                 } {
555                         fmt.Fprintf(stderr, "building %s...\n", srcdir)
556                         cmd := exec.Command("go", "install", "-ldflags", "-X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+" -X main.version="+inst.PackageVersion+" -s -w")
557                         cmd.Env = append(cmd.Env, os.Environ()...)
558                         cmd.Env = append(cmd.Env, "GOBIN=/var/lib/arvados/bin")
559                         cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
560                         cmd.Stdout = stdout
561                         cmd.Stderr = stderr
562                         err = cmd.Run()
563                         if err != nil {
564                                 return 1
565                         }
566                 }
567
568                 // Copy assets from source tree to /var/lib/arvados/share
569                 cmd := exec.Command("install", "-v", "-t", "/var/lib/arvados/share", filepath.Join(inst.SourcePath, "sdk/python/tests/nginx.conf"))
570                 cmd.Stdout = stdout
571                 cmd.Stderr = stderr
572                 err = cmd.Run()
573                 if err != nil {
574                         return 1
575                 }
576
577                 // Install python SDK and arv-mount in
578                 // /var/lib/arvados/lib/python.
579                 //
580                 // setup.py writes a file in the source directory in
581                 // order to include the version number in the package
582                 // itself.  We don't want to write to the source tree
583                 // (in "arvados-package" context it's mounted
584                 // readonly) so we run setup.py in a temporary copy of
585                 // the source dir.
586                 if err = inst.runBash(`
587 v=/var/lib/arvados/lib/python
588 tmp=/var/lib/arvados/tmp/python
589 python3 -m venv "$v"
590 . "$v/bin/activate"
591 pip3 install --no-cache-dir 'setuptools>=18.5' 'pip>=7'
592 export ARVADOS_BUILDING_VERSION="`+inst.PackageVersion+`"
593 for src in "`+inst.SourcePath+`/sdk/python" "`+inst.SourcePath+`/services/fuse"; do
594   rsync -a --delete-after "$src/" "$tmp/"
595   cd "$tmp"
596   python3 setup.py install
597   cd ..
598   rm -rf "$tmp"
599 done
600 `, stdout, stderr); err != nil {
601                         return 1
602                 }
603
604                 // Install Rails apps to /var/lib/arvados/{railsapi,workbench1}/
605                 for dstdir, srcdir := range map[string]string{
606                         "railsapi":   "services/api",
607                         "workbench1": "apps/workbench",
608                 } {
609                         fmt.Fprintf(stderr, "building %s...\n", srcdir)
610                         cmd := exec.Command("rsync",
611                                 "-a", "--no-owner", "--no-group", "--delete-after", "--delete-excluded",
612                                 "--exclude", "/coverage",
613                                 "--exclude", "/log",
614                                 "--exclude", "/node_modules",
615                                 "--exclude", "/tmp",
616                                 "--exclude", "/public/assets",
617                                 "--exclude", "/vendor",
618                                 "--exclude", "/config/environments",
619                                 "./", "/var/lib/arvados/"+dstdir+"/")
620                         cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
621                         cmd.Stdout = stdout
622                         cmd.Stderr = stderr
623                         err = cmd.Run()
624                         if err != nil {
625                                 return 1
626                         }
627                         for _, cmdline := range [][]string{
628                                 {"mkdir", "-p", "log", "public/assets", "tmp", "vendor", ".bundle", "/var/www/.bundle", "/var/www/.gem", "/var/www/.npm", "/var/www/.passenger"},
629                                 {"touch", "log/production.log"},
630                                 {"chown", "-R", "--from=root", "www-data:www-data", "/var/www/.bundle", "/var/www/.gem", "/var/www/.npm", "/var/www/.passenger", "log", "tmp", "vendor", ".bundle", "Gemfile.lock", "config.ru", "config/environment.rb"},
631                                 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--conservative", "--no-document", "bundler:" + bundlerversion},
632                                 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "deployment", "true"},
633                                 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "path", "/var/www/.gem"},
634                                 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "without", "development test diagnostics performance"},
635                                 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--jobs", fmt.Sprintf("%d", runtime.NumCPU())},
636
637                                 {"chown", "www-data:www-data", ".", "public/assets"},
638                                 // {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "system", "true"},
639                                 {"sudo", "-u", "www-data", "ARVADOS_CONFIG=none", "RAILS_GROUPS=assets", "RAILS_ENV=production", "PATH=/var/lib/arvados/bin:" + os.Getenv("PATH"), "/var/lib/arvados/bin/bundle", "exec", "rake", "npm:install"},
640                                 {"sudo", "-u", "www-data", "ARVADOS_CONFIG=none", "RAILS_GROUPS=assets", "RAILS_ENV=production", "PATH=/var/lib/arvados/bin:" + os.Getenv("PATH"), "/var/lib/arvados/bin/bundle", "exec", "rake", "assets:precompile"},
641                                 {"chown", "root:root", "."},
642                                 {"chown", "-R", "root:root", "public/assets", "vendor"},
643
644                                 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
645                                 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
646                         } {
647                                 if cmdline[len(cmdline)-2] == "rake" && dstdir != "workbench1" {
648                                         continue
649                                 }
650                                 cmd = exec.Command(cmdline[0], cmdline[1:]...)
651                                 cmd.Dir = "/var/lib/arvados/" + dstdir
652                                 cmd.Stdout = stdout
653                                 cmd.Stderr = stderr
654                                 fmt.Fprintf(stderr, "... %s\n", cmd.Args)
655                                 err = cmd.Run()
656                                 if err != nil {
657                                         return 1
658                                 }
659                         }
660                         cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
661                         cmd.Dir = "/var/lib/arvados/" + dstdir
662                         cmd.Stdout = stdout
663                         cmd.Stderr = stderr
664                         err = cmd.Run()
665                         if err != nil && !strings.Contains(err.Error(), "exit status 2") {
666                                 // Exit code 2 indicates there were warnings (like
667                                 // "other passenger installations have been detected",
668                                 // which we can't expect to avoid) but no errors.
669                                 // Other non-zero exit codes (1, 9) indicate errors.
670                                 return 1
671                         }
672                 }
673
674                 // Install workbench2 app to /var/lib/arvados/workbench2/
675                 if err = inst.runBash(`
676 cd `+inst.SourcePath+`/services/workbench2
677 VERSION="`+inst.PackageVersion+`" BUILD_NUMBER=1 GIT_COMMIT=000000000 yarn build
678 rsync -a --delete-after build/ /var/lib/arvados/workbench2/
679 `, stdout, stderr); err != nil {
680                         return 1
681                 }
682
683                 // Install arvados-cli gem (binaries go in
684                 // /var/lib/arvados/bin)
685                 if err = inst.runBash(`
686 /var/lib/arvados/bin/gem install --conservative --no-document arvados-cli
687 `, stdout, stderr); err != nil {
688                         return 1
689                 }
690
691                 err = os.WriteFile("/lib/systemd/system/arvados.service", arvadosServiceFile, 0777)
692                 if err != nil {
693                         return 1
694                 }
695                 if prod {
696                         // (fpm will do this for us in the pkg case)
697                         // This is equivalent to "systemd enable", but
698                         // does not depend on the systemctl program
699                         // being available:
700                         symlink := "/etc/systemd/system/multi-user.target.wants/arvados.service"
701                         err = os.Remove(symlink)
702                         if err != nil && !errors.Is(err, os.ErrNotExist) {
703                                 return 1
704                         }
705                         err = os.Symlink("/lib/systemd/system/arvados.service", symlink)
706                         if err != nil {
707                                 return 1
708                         }
709                 }
710
711                 // Add symlinks in /usr/bin for user-facing programs
712                 for _, srcdst := range [][]string{
713                         // go
714                         {"bin/arvados-client"},
715                         {"bin/arvados-client", "arv"},
716                         {"bin/arvados-server"},
717                         // sdk/cli
718                         {"bin/arv", "arv-ruby"},
719                         {"bin/arv-tag"},
720                         // sdk/python
721                         {"lib/python/bin/arv-copy"},
722                         {"lib/python/bin/arv-federation-migrate"},
723                         {"lib/python/bin/arv-get"},
724                         {"lib/python/bin/arv-keepdocker"},
725                         {"lib/python/bin/arv-ls"},
726                         {"lib/python/bin/arv-migrate-docker19"},
727                         {"lib/python/bin/arv-normalize"},
728                         {"lib/python/bin/arv-put"},
729                         {"lib/python/bin/arv-ws"},
730                         // services/fuse
731                         {"lib/python/bin/arv-mount"},
732                 } {
733                         src := "/var/lib/arvados/" + srcdst[0]
734                         if _, err = os.Stat(src); err != nil {
735                                 return 1
736                         }
737                         dst := srcdst[len(srcdst)-1]
738                         _, dst = filepath.Split(dst)
739                         dst = "/usr/bin/" + dst
740                         err = os.Remove(dst)
741                         if err != nil && !errors.Is(err, os.ErrNotExist) {
742                                 return 1
743                         }
744                         err = os.Symlink(src, dst)
745                         if err != nil {
746                                 return 1
747                         }
748                 }
749         }
750
751         return 0
752 }
753
754 type osversion struct {
755         Debian bool
756         Ubuntu bool
757         Centos bool
758         Major  int
759 }
760
761 func identifyOS() (osversion, error) {
762         var osv osversion
763         f, err := os.Open("/etc/os-release")
764         if err != nil {
765                 return osv, err
766         }
767         defer f.Close()
768
769         kv := map[string]string{}
770         scanner := bufio.NewScanner(f)
771         for scanner.Scan() {
772                 line := strings.TrimSpace(scanner.Text())
773                 if strings.HasPrefix(line, "#") {
774                         continue
775                 }
776                 toks := strings.SplitN(line, "=", 2)
777                 if len(toks) != 2 {
778                         return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
779                 }
780                 k := toks[0]
781                 v := strings.Trim(toks[1], `"`)
782                 if v == toks[1] {
783                         v = strings.Trim(v, `'`)
784                 }
785                 kv[k] = v
786         }
787         if err = scanner.Err(); err != nil {
788                 return osv, err
789         }
790         switch kv["ID"] {
791         case "ubuntu":
792                 osv.Ubuntu = true
793         case "debian":
794                 osv.Debian = true
795         case "centos":
796                 osv.Centos = true
797         default:
798                 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
799         }
800         vstr := kv["VERSION_ID"]
801         if i := strings.Index(vstr, "."); i > 0 {
802                 vstr = vstr[:i]
803         }
804         osv.Major, err = strconv.Atoi(vstr)
805         if err != nil {
806                 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
807         }
808         return osv, nil
809 }
810
811 func waitPostgreSQLReady() error {
812         for deadline := time.Now().Add(10 * time.Second); ; {
813                 output, err := exec.Command("pg_isready").CombinedOutput()
814                 if err == nil {
815                         return nil
816                 } else if time.Now().After(deadline) {
817                         return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
818                 } else {
819                         time.Sleep(time.Second)
820                 }
821         }
822 }
823
824 func (inst *installCommand) runBash(script string, stdout, stderr io.Writer) error {
825         cmd := exec.Command("bash", "-")
826         if inst.EatMyData {
827                 cmd = exec.Command("eatmydata", "bash", "-")
828         }
829         cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
830         cmd.Stdout = stdout
831         cmd.Stderr = stderr
832         return cmd.Run()
833 }
834
835 func prodpkgs(osv osversion) []string {
836         pkgs := []string{
837                 "ca-certificates",
838                 "curl",
839                 "fuse",
840                 "git",
841                 "gitolite3",
842                 "graphviz",
843                 "haveged",
844                 "libcurl3-gnutls",
845                 "libxslt1.1",
846                 "nginx",
847                 "python3",
848                 "sudo",
849         }
850         if osv.Debian || osv.Ubuntu {
851                 if osv.Debian && osv.Major == 8 {
852                         pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
853                 } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
854                         pkgs = append(pkgs, "python3-distutils") // sdk/cwl
855                 }
856                 return append(pkgs,
857                         "mime-support", // keep-web
858                 )
859         } else if osv.Centos {
860                 return append(pkgs,
861                         "fuse-libs", // services/fuse
862                         "mailcap",   // keep-web
863                 )
864         } else {
865                 panic("os version not supported")
866         }
867 }
868
869 func ProductionDependencies() ([]string, error) {
870         osv, err := identifyOS()
871         if err != nil {
872                 return nil, err
873         }
874         return prodpkgs(osv), nil
875 }