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.7.4"
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
145 if dev || test || pkg {
154 "default-jdk-headless",
155 "default-jre-headless",
158 "libcrypt-ssleay-perl",
178 "postgresql-contrib",
181 "python3-virtualenv",
195 if osv.Debian && osv.Major <= 10 {
196 pkgs = append(pkgs, "iceweasel")
198 pkgs = append(pkgs, "firefox")
202 pkgs = append(pkgs, "squashfs-tools") // for singularity
205 case osv.Debian && osv.Major >= 10:
206 pkgs = append(pkgs, "libcurl4")
208 pkgs = append(pkgs, "libcurl3")
210 cmd := exec.CommandContext(ctx, "apt-get")
212 cmd = exec.CommandContext(ctx, "eatmydata", "apt-get")
214 cmd.Args = append(cmd.Args, "install", "--yes", "--no-install-recommends")
215 cmd.Args = append(cmd.Args, pkgs...)
216 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
225 os.Mkdir("/var/lib/arvados", 0755)
226 os.Mkdir("/var/lib/arvados/tmp", 0700)
228 u, er := user.Lookup("www-data")
230 err = fmt.Errorf("user.Lookup(%q): %w", "www-data", er)
233 uid, _ := strconv.Atoi(u.Uid)
234 gid, _ := strconv.Atoi(u.Gid)
235 os.Mkdir("/var/lib/arvados/wwwtmp", 0700)
236 err = os.Chown("/var/lib/arvados/wwwtmp", uid, gid)
241 rubymajorversion := rubyversion[:strings.LastIndex(rubyversion, ".")]
242 if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+rubyversion)) {
243 logger.Print("ruby " + rubyversion + " already installed")
247 trap 'rm -r "${tmp}"' ERR EXIT
248 wget --progress=dot:giga -O- https://cache.ruby-lang.org/pub/ruby/`+rubymajorversion+`/ruby-`+rubyversion+`.tar.gz | tar -C "${tmp}" -xzf -
249 cd "${tmp}/ruby-`+rubyversion+`"
250 ./configure --disable-install-static-library --enable-shared --disable-install-doc --prefix /var/lib/arvados
253 /var/lib/arvados/bin/gem install bundler --no-document
261 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
262 logger.Print("go " + goversion + " already installed")
266 rm -rf /var/lib/arvados/go/
267 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
268 ln -sfv /var/lib/arvados/go/bin/* /usr/local/bin/
277 if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
278 logger.Print("phantomjs " + pjsversion + " already installed")
281 PJS=phantomjs-`+pjsversion+`-linux-x86_64
282 wget --progress=dot:giga -O- https://cache.arvados.org/$PJS.tar.bz2 | tar -C /var/lib/arvados -xjf -
283 ln -sfv /var/lib/arvados/$PJS/bin/phantomjs /usr/local/bin/
290 if havegeckoversion, err := exec.Command("/usr/local/bin/geckodriver", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegeckoversion), " "+geckoversion+" ") {
291 logger.Print("geckodriver " + geckoversion + " already installed")
295 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
296 ln -sfv /var/lib/arvados/bin/geckodriver /usr/local/bin/
303 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
304 logger.Print("gradle " + gradleversion + " already installed")
308 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
310 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
311 unzip -o -d /var/lib/arvados ${zip}
312 ln -sfv /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
320 if havesingularityversion, err := exec.Command("/var/lib/arvados/bin/singularity", "--version").CombinedOutput(); err == nil && strings.Contains(string(havesingularityversion), singularityversion) {
321 logger.Print("singularity " + singularityversion + " already installed")
322 } else if dev || test {
324 S=`+singularityversion+`
325 tmp=/var/lib/arvados/tmp/singularity
326 trap "rm -r ${tmp}" ERR EXIT
327 cd /var/lib/arvados/tmp
328 git clone https://github.com/sylabs/singularity
331 ./mconfig --prefix=/var/lib/arvados
333 make -C ./builddir install
340 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
341 // it's installed, locale -a reports it as
343 wantlocale := "en_US.UTF-8"
344 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
345 logger.Print("locale " + wantlocale + " already installed")
347 err = inst.runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
362 if pgLsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
363 err = fmt.Errorf("pg_lsclusters: %s", err2)
365 } else if pgclusters := strings.Split(strings.TrimSpace(string(pgLsclusters)), "\n"); len(pgclusters) != 1 {
366 logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
367 } 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 {
368 err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
370 } else if pgc.Status == "online" {
371 logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
373 logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
374 cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
382 cmd.Process.Signal(syscall.SIGTERM)
383 logger.Info("sent SIGTERM; waiting for postgres to shut down")
386 err = waitPostgreSQLReady()
392 if os.Getpid() == 1 {
393 // We are the init process (presumably in a
394 // docker container) so although postgresql is
395 // installed, it's not running, and initdb
396 // might never have been run.
399 var needcoll []string
400 // If the en_US.UTF-8 locale wasn't installed when
401 // postgresql initdb ran, it needs to be added
402 // explicitly before we can use it in our test suite.
403 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
404 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')")
406 out, err2 := cmd.CombinedOutput()
408 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
411 if strings.Contains(string(out), "1") {
412 logger.Infof("postgresql supports collation %s", collname)
414 needcoll = append(needcoll, collname)
417 if len(needcoll) > 0 && os.Getpid() != 1 {
418 // In order for the CREATE COLLATION statement
419 // below to work, the locale must have existed
420 // when PostgreSQL started up. If we're
421 // running as init, we must have started
422 // PostgreSQL ourselves after installing the
423 // locales. Otherwise, it might need a
424 // restart, so we attempt to restart it with
426 if err = inst.runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
427 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
428 } else if err = waitPostgreSQLReady(); err != nil {
432 for _, collname := range needcoll {
433 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
439 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
444 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
445 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
447 if err := cmd.Run(); err == nil {
448 logger.Print("arvados role exists; superuser privileges added, password updated")
450 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
462 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == nodejsversion+"\n" {
463 logger.Print("nodejs " + nodejsversion + " already installed")
466 NJS=`+nodejsversion+`
467 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
468 ln -sfv /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
475 if haveyarnversion, err := exec.Command("/usr/local/bin/yarn", "--version").CombinedOutput(); err == nil && len(haveyarnversion) > 0 {
476 logger.Print("yarn " + strings.TrimSpace(string(haveyarnversion)) + " already installed")
480 ln -sfv /var/lib/arvados/node-`+nodejsversion+`-linux-x64/bin/{yarn,yarnpkg} /usr/local/bin/
487 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" {
488 logger.Print("workbench2 repo is already at " + workbench2version)
491 V=`+workbench2version+`
493 if [[ ! -e arvados-workbench2 ]]; then
494 git clone https://git.arvados.org/arvados-workbench2.git
495 cd arvados-workbench2
498 cd arvados-workbench2
499 if ! git checkout $V; then
511 if err = inst.runBash(`
512 cd /var/lib/arvados/arvados-workbench2
514 `, stdout, stderr); err != nil {
520 // Install Go programs to /var/lib/arvados/bin/
521 for _, srcdir := range []string{
522 "cmd/arvados-client",
523 "cmd/arvados-server",
524 "services/arv-git-httpd",
525 "services/crunch-dispatch-local",
526 "services/crunch-dispatch-slurm",
528 "services/keep-balance",
530 "services/keepproxy",
531 "services/keepstore",
534 fmt.Fprintf(stderr, "building %s...\n", srcdir)
535 cmd := exec.Command("go", "install", "-ldflags", "-X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+" -X main.version="+inst.PackageVersion+" -s -w")
536 cmd.Env = append(cmd.Env, os.Environ()...)
537 cmd.Env = append(cmd.Env, "GOBIN=/var/lib/arvados/bin")
538 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
547 // Symlink user-facing Go programs /usr/bin/x ->
548 // /var/lib/arvados/bin/x
549 for _, prog := range []string{"arvados-client", "arvados-server"} {
550 err = os.Remove("/usr/bin/" + prog)
551 if err != nil && !errors.Is(err, os.ErrNotExist) {
554 err = os.Symlink("/var/lib/arvados/bin/"+prog, "/usr/bin/"+prog)
560 // Copy assets from source tree to /var/lib/arvados/share
561 cmd := exec.Command("install", "-v", "-t", "/var/lib/arvados/share", filepath.Join(inst.SourcePath, "sdk/python/tests/nginx.conf"))
569 // Install Rails apps to /var/lib/arvados/{railsapi,workbench1}/
570 for dstdir, srcdir := range map[string]string{
571 "railsapi": "services/api",
572 "workbench1": "apps/workbench",
574 fmt.Fprintf(stderr, "building %s...\n", srcdir)
575 cmd := exec.Command("rsync",
576 "-a", "--no-owner", "--no-group", "--delete-after", "--delete-excluded",
577 "--exclude", "/coverage",
580 "--exclude", "/vendor",
581 "--exclude", "/config/environments",
582 "./", "/var/lib/arvados/"+dstdir+"/")
583 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
590 for _, cmdline := range [][]string{
591 {"mkdir", "-p", "log", "tmp", ".bundle", "/var/www/.gem", "/var/www/.bundle", "/var/www/.passenger"},
592 {"touch", "log/production.log"},
593 {"chown", "-R", "--from=root", "www-data:www-data", "/var/www/.gem", "/var/www/.bundle", "/var/www/.passenger", "log", "tmp", ".bundle", "Gemfile.lock", "config.ru", "config/environment.rb"},
594 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--conservative", "--no-document", "bundler:" + bundlerversion},
595 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--deployment", "--jobs", "8", "--path", "/var/www/.gem", "--without", "development test diagnostics performance"},
596 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
597 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
599 cmd = exec.Command(cmdline[0], cmdline[1:]...)
600 cmd.Dir = "/var/lib/arvados/" + dstdir
603 fmt.Fprintf(stderr, "... %s\n", cmd.Args)
609 cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
610 cmd.Dir = "/var/lib/arvados/" + dstdir
614 if err != nil && !strings.Contains(err.Error(), "exit status 2") {
615 // Exit code 2 indicates there were warnings (like
616 // "other passenger installations have been detected",
617 // which we can't expect to avoid) but no errors.
618 // Other non-zero exit codes (1, 9) indicate errors.
623 // Install workbench2 app to /var/lib/arvados/workbench2/
624 if err = inst.runBash(`
625 cd /var/lib/arvados/arvados-workbench2
626 VERSION="`+inst.PackageVersion+`" BUILD_NUMBER=1 GIT_COMMIT="`+workbench2version[:9]+`" yarn build
627 rsync -a --delete-after build/ /var/lib/arvados/workbench2/
628 `, stdout, stderr); err != nil {
632 err = os.WriteFile("/lib/systemd/system/arvados.service", arvadosServiceFile, 0777)
636 // This is equivalent to "systemd enable", but does
637 // not depend on the systemctl program being
639 symlink := "/etc/systemd/system/multi-user.target.wants/arvados.service"
640 err = os.Remove(symlink)
641 if err != nil && !errors.Is(err, os.ErrNotExist) {
644 err = os.Symlink("/lib/systemd/system/arvados.service", symlink)
653 type osversion struct {
660 func identifyOS() (osversion, error) {
662 f, err := os.Open("/etc/os-release")
668 kv := map[string]string{}
669 scanner := bufio.NewScanner(f)
671 line := strings.TrimSpace(scanner.Text())
672 if strings.HasPrefix(line, "#") {
675 toks := strings.SplitN(line, "=", 2)
677 return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
680 v := strings.Trim(toks[1], `"`)
682 v = strings.Trim(v, `'`)
686 if err = scanner.Err(); err != nil {
697 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
699 vstr := kv["VERSION_ID"]
700 if i := strings.Index(vstr, "."); i > 0 {
703 osv.Major, err = strconv.Atoi(vstr)
705 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
710 func waitPostgreSQLReady() error {
711 for deadline := time.Now().Add(10 * time.Second); ; {
712 output, err := exec.Command("pg_isready").CombinedOutput()
715 } else if time.Now().After(deadline) {
716 return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
718 time.Sleep(time.Second)
723 func (inst *installCommand) runBash(script string, stdout, stderr io.Writer) error {
724 cmd := exec.Command("bash", "-")
726 cmd = exec.Command("eatmydata", "bash", "-")
728 cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
734 func prodpkgs(osv osversion) []string {
749 if osv.Debian || osv.Ubuntu {
750 if osv.Debian && osv.Major == 8 {
751 pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
752 } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
753 pkgs = append(pkgs, "python3-distutils") // sdk/cwl
757 "libcurl4-openssl-dev", // services/api
759 "libpython2.7", // services/fuse
760 "mime-support", // keep-web
761 "zlib1g-dev", // services/api
763 } else if osv.Centos {
765 "fuse-libs", // services/fuse
768 "libcurl-devel", // services/api
769 "mailcap", // keep-web
770 "postgresql-devel", // services/api
773 panic("os version not supported")
777 func ProductionDependencies() ([]string, error) {
778 osv, err := identifyOS()
782 return prodpkgs(osv), nil