1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
25 "git.arvados.org/arvados.git/lib/cmd"
26 "git.arvados.org/arvados.git/sdk/go/ctxlog"
30 var Command cmd.Handler = &installCommand{}
32 const goversion = "1.17.7"
36 bundlerversion = "2.2.19"
37 singularityversion = "3.9.9"
39 geckoversion = "0.24.0"
40 gradleversion = "5.3.1"
41 nodejsversion = "v12.22.11"
42 devtestDatabasePassword = "insecure_arvados_test"
43 workbench2version = "5e020488f67b5bc919796e0dc8b0b9f3b3ff23b0"
46 //go:embed arvados.service
47 var arvadosServiceFile []byte
49 type installCommand struct {
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)
65 logger.WithError(err).Info("exiting")
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")
77 if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
79 } else if *versionFlag {
80 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
83 var dev, test, prod, pkg bool
84 switch inst.ClusterType {
94 err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', 'production', or 'package')", inst.ClusterType)
99 err = errors.New("production install is not yet implemented")
103 osv, err := identifyOS()
108 listdir, err := os.Open("/var/lib/apt/lists")
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")
125 cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends", "eatmydata")
126 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
135 pkgs := prodpkgs(osv)
140 "eatmydata", // install it for later steps, even if we're not using it now
144 if dev || test || pkg {
153 "default-jdk-headless",
154 "default-jre-headless",
157 "libcrypt-ssleay-perl",
176 "postgresql-contrib",
179 "python3-virtualenv",
194 if osv.Debian && osv.Major <= 10 {
195 pkgs = append(pkgs, "iceweasel")
197 pkgs = append(pkgs, "firefox")
201 pkgs = append(pkgs, "squashfs-tools") // for singularity
202 pkgs = append(pkgs, "gnupg") // for docker install recipe
205 case osv.Debian && osv.Major >= 11:
206 pkgs = append(pkgs, "libcurl4", "perl-modules-5.32")
207 case osv.Debian && osv.Major >= 10:
208 pkgs = append(pkgs, "libcurl4", "perl-modules")
210 pkgs = append(pkgs, "libcurl3", "perl-modules")
212 cmd := exec.CommandContext(ctx, "apt-get")
214 cmd = exec.CommandContext(ctx, "eatmydata", "apt-get")
216 cmd.Args = append(cmd.Args, "install", "--yes", "--no-install-recommends")
217 cmd.Args = append(cmd.Args, pkgs...)
218 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
228 if havedockerversion, err := exec.Command("docker", "--version").CombinedOutput(); err == nil {
229 logger.Printf("%s installed, assuming that version is ok", bytes.TrimSuffix(havedockerversion, []byte("\n")))
230 } else if osv.Debian {
236 codename = "bullseye"
238 err = fmt.Errorf("don't know how to install docker-ce for debian %d", osv.Major)
242 rm -f /usr/share/keyrings/docker-archive-keyring.gpg
243 curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
244 echo 'deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian/ `+codename+` stable' | \
245 tee /etc/apt/sources.list.d/docker.list
247 DEBIAN_FRONTEND=noninteractive apt-get --yes --no-install-recommends install docker-ce
253 err = fmt.Errorf("don't know how to install docker for osversion %v", osv)
258 os.Mkdir("/var/lib/arvados", 0755)
259 os.Mkdir("/var/lib/arvados/tmp", 0700)
261 u, er := user.Lookup("www-data")
263 err = fmt.Errorf("user.Lookup(%q): %w", "www-data", er)
266 uid, _ := strconv.Atoi(u.Uid)
267 gid, _ := strconv.Atoi(u.Gid)
268 os.Mkdir("/var/lib/arvados/wwwtmp", 0700)
269 err = os.Chown("/var/lib/arvados/wwwtmp", uid, gid)
274 rubymajorversion := rubyversion[:strings.LastIndex(rubyversion, ".")]
275 if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+rubyversion)) {
276 logger.Print("ruby " + rubyversion + " already installed")
280 trap 'rm -r "${tmp}"' ERR EXIT
281 wget --progress=dot:giga -O- https://cache.ruby-lang.org/pub/ruby/`+rubymajorversion+`/ruby-`+rubyversion+`.tar.gz | tar -C "${tmp}" -xzf -
282 cd "${tmp}/ruby-`+rubyversion+`"
283 ./configure --disable-install-static-library --enable-shared --disable-install-doc --prefix /var/lib/arvados
286 /var/lib/arvados/bin/gem install bundler --no-document
294 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
295 logger.Print("go " + goversion + " already installed")
299 rm -rf /var/lib/arvados/go/
300 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
301 ln -sfv /var/lib/arvados/go/bin/* /usr/local/bin/
310 if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
311 logger.Print("phantomjs " + pjsversion + " already installed")
314 PJS=phantomjs-`+pjsversion+`-linux-x86_64
315 wget --progress=dot:giga -O- https://cache.arvados.org/$PJS.tar.bz2 | tar -C /var/lib/arvados -xjf -
316 ln -sfv /var/lib/arvados/$PJS/bin/phantomjs /usr/local/bin/
323 if havegeckoversion, err := exec.Command("/usr/local/bin/geckodriver", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegeckoversion), " "+geckoversion+" ") {
324 logger.Print("geckodriver " + geckoversion + " already installed")
328 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
329 ln -sfv /var/lib/arvados/bin/geckodriver /usr/local/bin/
336 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
337 logger.Print("gradle " + gradleversion + " already installed")
341 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
343 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
344 unzip -o -d /var/lib/arvados ${zip}
345 ln -sfv /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
353 if havesingularityversion, err := exec.Command("/var/lib/arvados/bin/singularity", "--version").CombinedOutput(); err == nil && strings.Contains(string(havesingularityversion), singularityversion) {
354 logger.Print("singularity " + singularityversion + " already installed")
355 } else if dev || test {
357 S=`+singularityversion+`
358 tmp=/var/lib/arvados/tmp/singularity
359 trap "rm -r ${tmp}" ERR EXIT
360 cd /var/lib/arvados/tmp
361 git clone https://github.com/sylabs/singularity
364 ./mconfig --prefix=/var/lib/arvados
366 make -C ./builddir install
373 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
374 // it's installed, locale -a reports it as
376 wantlocale := "en_US.UTF-8"
377 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
378 logger.Print("locale " + wantlocale + " already installed")
380 err = inst.runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
395 if pgLsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
396 err = fmt.Errorf("pg_lsclusters: %s", err2)
398 } else if pgclusters := strings.Split(strings.TrimSpace(string(pgLsclusters)), "\n"); len(pgclusters) != 1 {
399 logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
400 } 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 {
401 err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
403 } else if pgc.Status == "online" {
404 logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
406 logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
407 cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
415 cmd.Process.Signal(syscall.SIGTERM)
416 logger.Info("sent SIGTERM; waiting for postgres to shut down")
419 err = waitPostgreSQLReady()
425 if os.Getpid() == 1 {
426 // We are the init process (presumably in a
427 // docker container) so although postgresql is
428 // installed, it's not running, and initdb
429 // might never have been run.
432 var needcoll []string
433 // If the en_US.UTF-8 locale wasn't installed when
434 // postgresql initdb ran, it needs to be added
435 // explicitly before we can use it in our test suite.
436 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
437 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')")
439 out, err2 := cmd.CombinedOutput()
441 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
444 if strings.Contains(string(out), "1") {
445 logger.Infof("postgresql supports collation %s", collname)
447 needcoll = append(needcoll, collname)
450 if len(needcoll) > 0 && os.Getpid() != 1 {
451 // In order for the CREATE COLLATION statement
452 // below to work, the locale must have existed
453 // when PostgreSQL started up. If we're
454 // running as init, we must have started
455 // PostgreSQL ourselves after installing the
456 // locales. Otherwise, it might need a
457 // restart, so we attempt to restart it with
459 if err = inst.runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
460 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
461 } else if err = waitPostgreSQLReady(); err != nil {
465 for _, collname := range needcoll {
466 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
472 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
477 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
478 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
480 if err := cmd.Run(); err == nil {
481 logger.Print("arvados role exists; superuser privileges added, password updated")
483 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
495 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == nodejsversion+"\n" {
496 logger.Print("nodejs " + nodejsversion + " already installed")
499 NJS=`+nodejsversion+`
500 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
501 ln -sfv /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
508 if haveyarnversion, err := exec.Command("/usr/local/bin/yarn", "--version").CombinedOutput(); err == nil && len(haveyarnversion) > 0 {
509 logger.Print("yarn " + strings.TrimSpace(string(haveyarnversion)) + " already installed")
513 ln -sfv /var/lib/arvados/node-`+nodejsversion+`-linux-x64/bin/{yarn,yarnpkg} /usr/local/bin/
520 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" {
521 logger.Print("workbench2 repo is already at " + workbench2version)
524 V=`+workbench2version+`
526 if [[ ! -e arvados-workbench2 ]]; then
527 git clone https://git.arvados.org/arvados-workbench2.git
528 cd arvados-workbench2
531 cd arvados-workbench2
532 if ! git checkout $V; then
534 git checkout yarn.lock
545 if err = inst.runBash(`
546 cd /var/lib/arvados/arvados-workbench2
548 `, stdout, stderr); err != nil {
554 // Install Go programs to /var/lib/arvados/bin/
555 for _, srcdir := range []string{
556 "cmd/arvados-client",
557 "cmd/arvados-server",
558 "services/crunch-dispatch-local",
559 "services/crunch-dispatch-slurm",
561 "services/keep-balance",
562 "services/keepstore",
565 fmt.Fprintf(stderr, "building %s...\n", srcdir)
566 cmd := exec.Command("go", "install", "-ldflags", "-X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+" -X main.version="+inst.PackageVersion+" -s -w")
567 cmd.Env = append(cmd.Env, os.Environ()...)
568 cmd.Env = append(cmd.Env, "GOBIN=/var/lib/arvados/bin")
569 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
578 // Symlink user-facing Go programs /usr/bin/x ->
579 // /var/lib/arvados/bin/x
580 for _, prog := range []string{"arvados-client", "arvados-server"} {
581 err = os.Remove("/usr/bin/" + prog)
582 if err != nil && !errors.Is(err, os.ErrNotExist) {
585 err = os.Symlink("/var/lib/arvados/bin/"+prog, "/usr/bin/"+prog)
591 // Copy assets from source tree to /var/lib/arvados/share
592 cmd := exec.Command("install", "-v", "-t", "/var/lib/arvados/share", filepath.Join(inst.SourcePath, "sdk/python/tests/nginx.conf"))
600 // Install Rails apps to /var/lib/arvados/{railsapi,workbench1}/
601 for dstdir, srcdir := range map[string]string{
602 "railsapi": "services/api",
603 "workbench1": "apps/workbench",
605 fmt.Fprintf(stderr, "building %s...\n", srcdir)
606 cmd := exec.Command("rsync",
607 "-a", "--no-owner", "--no-group", "--delete-after", "--delete-excluded",
608 "--exclude", "/coverage",
610 "--exclude", "/node_modules",
612 "--exclude", "/public/assets",
613 "--exclude", "/vendor",
614 "--exclude", "/config/environments",
615 "./", "/var/lib/arvados/"+dstdir+"/")
616 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
623 for _, cmdline := range [][]string{
624 {"mkdir", "-p", "log", "public/assets", "tmp", "vendor", ".bundle", "/var/www/.bundle", "/var/www/.gem", "/var/www/.npm", "/var/www/.passenger"},
625 {"touch", "log/production.log"},
626 {"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"},
627 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--conservative", "--no-document", "bundler:" + bundlerversion},
628 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--deployment", "--jobs", "8", "--path", "/var/www/.gem", "--without", "development test diagnostics performance"},
630 {"chown", "www-data:www-data", ".", "public/assets"},
631 // {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "config", "set", "--local", "system", "true"},
632 {"sudo", "-u", "www-data", "ARVADOS_CONFIG=none", "RAILS_GROUPS=assets", "RAILS_ENV=production", "/var/lib/arvados/bin/bundle", "exec", "rake", "npm:install"},
633 {"sudo", "-u", "www-data", "ARVADOS_CONFIG=none", "RAILS_GROUPS=assets", "RAILS_ENV=production", "/var/lib/arvados/bin/bundle", "exec", "rake", "assets:precompile"},
634 {"chown", "root:root", "."},
635 {"chown", "-R", "root:root", "public/assets", "vendor"},
637 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
638 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
640 if cmdline[len(cmdline)-2] == "rake" && dstdir != "workbench1" {
643 cmd = exec.Command(cmdline[0], cmdline[1:]...)
644 cmd.Dir = "/var/lib/arvados/" + dstdir
647 fmt.Fprintf(stderr, "... %s\n", cmd.Args)
653 cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
654 cmd.Dir = "/var/lib/arvados/" + dstdir
658 if err != nil && !strings.Contains(err.Error(), "exit status 2") {
659 // Exit code 2 indicates there were warnings (like
660 // "other passenger installations have been detected",
661 // which we can't expect to avoid) but no errors.
662 // Other non-zero exit codes (1, 9) indicate errors.
667 // Install workbench2 app to /var/lib/arvados/workbench2/
668 if err = inst.runBash(`
669 cd /var/lib/arvados/arvados-workbench2
670 VERSION="`+inst.PackageVersion+`" BUILD_NUMBER=1 GIT_COMMIT="`+workbench2version[:9]+`" yarn build
671 rsync -a --delete-after build/ /var/lib/arvados/workbench2/
672 `, stdout, stderr); err != nil {
676 err = os.WriteFile("/lib/systemd/system/arvados.service", arvadosServiceFile, 0777)
680 // This is equivalent to "systemd enable", but does
681 // not depend on the systemctl program being
683 symlink := "/etc/systemd/system/multi-user.target.wants/arvados.service"
684 err = os.Remove(symlink)
685 if err != nil && !errors.Is(err, os.ErrNotExist) {
688 err = os.Symlink("/lib/systemd/system/arvados.service", symlink)
697 type osversion struct {
704 func identifyOS() (osversion, error) {
706 f, err := os.Open("/etc/os-release")
712 kv := map[string]string{}
713 scanner := bufio.NewScanner(f)
715 line := strings.TrimSpace(scanner.Text())
716 if strings.HasPrefix(line, "#") {
719 toks := strings.SplitN(line, "=", 2)
721 return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
724 v := strings.Trim(toks[1], `"`)
726 v = strings.Trim(v, `'`)
730 if err = scanner.Err(); err != nil {
741 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
743 vstr := kv["VERSION_ID"]
744 if i := strings.Index(vstr, "."); i > 0 {
747 osv.Major, err = strconv.Atoi(vstr)
749 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
754 func waitPostgreSQLReady() error {
755 for deadline := time.Now().Add(10 * time.Second); ; {
756 output, err := exec.Command("pg_isready").CombinedOutput()
759 } else if time.Now().After(deadline) {
760 return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
762 time.Sleep(time.Second)
767 func (inst *installCommand) runBash(script string, stdout, stderr io.Writer) error {
768 cmd := exec.Command("bash", "-")
770 cmd = exec.Command("eatmydata", "bash", "-")
772 cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
778 func prodpkgs(osv osversion) []string {
793 if osv.Debian || osv.Ubuntu {
794 if osv.Debian && osv.Major == 8 {
795 pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
796 } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
797 pkgs = append(pkgs, "python3-distutils") // sdk/cwl
801 "libcurl4-openssl-dev", // services/api
803 "libpython2.7", // services/fuse
804 "mime-support", // keep-web
805 "zlib1g-dev", // services/api
807 } else if osv.Centos {
809 "fuse-libs", // services/fuse
812 "libcurl-devel", // services/api
813 "mailcap", // keep-web
814 "postgresql-devel", // services/api
817 panic("os version not supported")
821 func ProductionDependencies() ([]string, error) {
822 osv, err := identifyOS()
826 return prodpkgs(osv), nil