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