1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
24 "git.arvados.org/arvados.git/lib/cmd"
25 "git.arvados.org/arvados.git/sdk/go/ctxlog"
29 var Command cmd.Handler = &installCommand{}
31 const goversion = "1.17.7"
35 singularityversion = "3.7.4"
37 geckoversion = "0.24.0"
38 gradleversion = "5.3.1"
39 nodejsversion = "v12.22.2"
40 devtestDatabasePassword = "insecure_arvados_test"
41 workbench2version = "cfa81dfc3041cb459c8a0918a2732dfcf3a11d40"
44 type installCommand struct {
51 func (inst *installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
52 logger := ctxlog.New(stderr, "text", "info")
53 ctx := ctxlog.Context(context.Background(), logger)
54 ctx, cancel := context.WithCancel(ctx)
60 logger.WithError(err).Info("exiting")
64 flags := flag.NewFlagSet(prog, flag.ContinueOnError)
65 flags.SetOutput(stderr)
66 versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
67 flags.StringVar(&inst.ClusterType, "type", "production", "cluster `type`: development, test, production, or package")
68 flags.StringVar(&inst.SourcePath, "source", "/arvados", "source tree location (required for -type=package)")
69 flags.StringVar(&inst.PackageVersion, "package-version", "0.0.0", "version string to embed in executable files")
70 flags.BoolVar(&inst.EatMyData, "eatmydata", false, "use eatmydata to speed up install")
72 if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
74 } else if *versionFlag {
75 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
78 var dev, test, prod, pkg bool
79 switch inst.ClusterType {
89 err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', 'production', or 'package')", inst.ClusterType)
94 err = errors.New("production install is not yet implemented")
98 osv, err := identifyOS()
103 listdir, err := os.Open("/var/lib/apt/lists")
105 logger.Warnf("error while checking whether to run apt-get update: %s", err)
106 } else if names, _ := listdir.Readdirnames(1); len(names) == 0 {
107 // Special case for a base docker image where the
108 // package cache has been deleted and all "apt-get
109 // install" commands will fail unless we fetch repos.
110 cmd := exec.CommandContext(ctx, "apt-get", "update")
120 cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends", "eatmydata")
121 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
130 pkgs := prodpkgs(osv)
135 "eatmydata", // install it for later steps, even if we're not using it now
140 if dev || test || pkg {
149 "default-jdk-headless",
150 "default-jre-headless",
153 "libcrypt-ssleay-perl",
173 "postgresql-contrib",
176 "python3-virtualenv",
190 if osv.Debian && osv.Major <= 10 {
191 pkgs = append(pkgs, "iceweasel")
193 pkgs = append(pkgs, "firefox")
197 pkgs = append(pkgs, "squashfs-tools") // for singularity
200 case osv.Debian && osv.Major >= 10:
201 pkgs = append(pkgs, "libcurl4")
203 pkgs = append(pkgs, "libcurl3")
205 cmd := exec.CommandContext(ctx, "apt-get")
207 cmd = exec.CommandContext(ctx, "eatmydata", "apt-get")
209 cmd.Args = append(cmd.Args, "install", "--yes", "--no-install-recommends")
210 cmd.Args = append(cmd.Args, pkgs...)
211 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
220 os.Mkdir("/var/lib/arvados", 0755)
221 os.Mkdir("/var/lib/arvados/tmp", 0700)
223 u, er := user.Lookup("www-data")
225 err = fmt.Errorf("user.Lookup(%q): %w", "www-data", er)
228 uid, _ := strconv.Atoi(u.Uid)
229 gid, _ := strconv.Atoi(u.Gid)
230 os.Mkdir("/var/lib/arvados/wwwtmp", 0700)
231 err = os.Chown("/var/lib/arvados/wwwtmp", uid, gid)
236 rubymajorversion := rubyversion[:strings.LastIndex(rubyversion, ".")]
237 if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+rubyversion)) {
238 logger.Print("ruby " + rubyversion + " already installed")
242 trap 'rm -r "${tmp}"' ERR EXIT
243 wget --progress=dot:giga -O- https://cache.ruby-lang.org/pub/ruby/`+rubymajorversion+`/ruby-`+rubyversion+`.tar.gz | tar -C "${tmp}" -xzf -
244 cd "${tmp}/ruby-`+rubyversion+`"
245 ./configure --disable-install-static-library --enable-shared --disable-install-doc --prefix /var/lib/arvados
248 /var/lib/arvados/bin/gem install bundler --no-document
256 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
257 logger.Print("go " + goversion + " already installed")
261 rm -rf /var/lib/arvados/go/
262 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
263 ln -sfv /var/lib/arvados/go/bin/* /usr/local/bin/
272 if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
273 logger.Print("phantomjs " + pjsversion + " already installed")
276 PJS=phantomjs-`+pjsversion+`-linux-x86_64
277 wget --progress=dot:giga -O- https://cache.arvados.org/$PJS.tar.bz2 | tar -C /var/lib/arvados -xjf -
278 ln -sfv /var/lib/arvados/$PJS/bin/phantomjs /usr/local/bin/
285 if havegeckoversion, err := exec.Command("/usr/local/bin/geckodriver", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegeckoversion), " "+geckoversion+" ") {
286 logger.Print("geckodriver " + geckoversion + " already installed")
290 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
291 ln -sfv /var/lib/arvados/bin/geckodriver /usr/local/bin/
298 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
299 logger.Print("gradle " + gradleversion + " already installed")
303 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
305 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
306 unzip -o -d /var/lib/arvados ${zip}
307 ln -sfv /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
315 if havesingularityversion, err := exec.Command("/var/lib/arvados/bin/singularity", "--version").CombinedOutput(); err == nil && strings.Contains(string(havesingularityversion), singularityversion) {
316 logger.Print("singularity " + singularityversion + " already installed")
317 } else if dev || test {
319 S=`+singularityversion+`
320 tmp=/var/lib/arvados/tmp/singularity
321 trap "rm -r ${tmp}" ERR EXIT
322 cd /var/lib/arvados/tmp
323 git clone https://github.com/sylabs/singularity
326 ./mconfig --prefix=/var/lib/arvados
328 make -C ./builddir install
335 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
336 // it's installed, locale -a reports it as
338 wantlocale := "en_US.UTF-8"
339 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
340 logger.Print("locale " + wantlocale + " already installed")
342 err = inst.runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
357 if pgLsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
358 err = fmt.Errorf("pg_lsclusters: %s", err2)
360 } else if pgclusters := strings.Split(strings.TrimSpace(string(pgLsclusters)), "\n"); len(pgclusters) != 1 {
361 logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
362 } 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 {
363 err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
365 } else if pgc.Status == "online" {
366 logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
368 logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
369 cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
377 cmd.Process.Signal(syscall.SIGTERM)
378 logger.Info("sent SIGTERM; waiting for postgres to shut down")
381 err = waitPostgreSQLReady()
387 if os.Getpid() == 1 {
388 // We are the init process (presumably in a
389 // docker container) so although postgresql is
390 // installed, it's not running, and initdb
391 // might never have been run.
394 var needcoll []string
395 // If the en_US.UTF-8 locale wasn't installed when
396 // postgresql initdb ran, it needs to be added
397 // explicitly before we can use it in our test suite.
398 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
399 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')")
401 out, err2 := cmd.CombinedOutput()
403 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
406 if strings.Contains(string(out), "1") {
407 logger.Infof("postgresql supports collation %s", collname)
409 needcoll = append(needcoll, collname)
412 if len(needcoll) > 0 && os.Getpid() != 1 {
413 // In order for the CREATE COLLATION statement
414 // below to work, the locale must have existed
415 // when PostgreSQL started up. If we're
416 // running as init, we must have started
417 // PostgreSQL ourselves after installing the
418 // locales. Otherwise, it might need a
419 // restart, so we attempt to restart it with
421 if err = inst.runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
422 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
423 } else if err = waitPostgreSQLReady(); err != nil {
427 for _, collname := range needcoll {
428 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
434 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
439 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
440 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
442 if err := cmd.Run(); err == nil {
443 logger.Print("arvados role exists; superuser privileges added, password updated")
445 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
457 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == nodejsversion+"\n" {
458 logger.Print("nodejs " + nodejsversion + " already installed")
461 NJS=`+nodejsversion+`
462 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
463 ln -sfv /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
470 if haveyarnversion, err := exec.Command("/usr/local/bin/yarn", "--version").CombinedOutput(); err == nil && len(haveyarnversion) > 0 {
471 logger.Print("yarn " + strings.TrimSpace(string(haveyarnversion)) + " already installed")
475 ln -sfv /var/lib/arvados/node-`+nodejsversion+`-linux-x64/bin/{yarn,yarnpkg} /usr/local/bin/
482 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" {
483 logger.Print("workbench2 repo is already at " + workbench2version)
486 V=`+workbench2version+`
488 if [[ ! -e arvados-workbench2 ]]; then
489 git clone https://git.arvados.org/arvados-workbench2.git
490 cd arvados-workbench2
493 cd arvados-workbench2
494 if ! git checkout $V; then
506 if err = inst.runBash(`
507 cd /var/lib/arvados/arvados-workbench2
509 `, stdout, stderr); err != nil {
515 // Install Go programs to /var/lib/arvados/bin/
516 for _, srcdir := range []string{
517 "cmd/arvados-client",
518 "cmd/arvados-server",
519 "services/arv-git-httpd",
520 "services/crunch-dispatch-local",
521 "services/crunch-dispatch-slurm",
523 "services/keep-balance",
525 "services/keepproxy",
526 "services/keepstore",
529 fmt.Fprintf(stderr, "building %s...\n", srcdir)
530 cmd := exec.Command("go", "install", "-ldflags", "-X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+" -X main.version="+inst.PackageVersion+" -s -w")
531 cmd.Env = append(cmd.Env, os.Environ()...)
532 cmd.Env = append(cmd.Env, "GOBIN=/var/lib/arvados/bin")
533 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
542 // Copy assets from source tree to /var/lib/arvados/share
543 cmd := exec.Command("install", "-v", "-t", "/var/lib/arvados/share", filepath.Join(inst.SourcePath, "sdk/python/tests/nginx.conf"))
551 // Install Rails apps to /var/lib/arvados/{railsapi,workbench1}/
552 for dstdir, srcdir := range map[string]string{
553 "railsapi": "services/api",
554 "workbench1": "apps/workbench",
556 fmt.Fprintf(stderr, "building %s...\n", srcdir)
557 cmd := exec.Command("rsync",
558 "-a", "--no-owner", "--no-group", "--delete-after", "--delete-excluded",
559 "--exclude", "/coverage",
562 "--exclude", "/vendor",
563 "--exclude", "/config/environments",
564 "./", "/var/lib/arvados/"+dstdir+"/")
565 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
572 for _, cmdline := range [][]string{
573 {"mkdir", "-p", "log", "tmp", ".bundle", "/var/www/.gem", "/var/www/.bundle", "/var/www/.passenger"},
574 {"touch", "log/production.log"},
575 {"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"},
576 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--conservative", "--no-document", "bundler:2.2.19"},
577 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--deployment", "--jobs", "8", "--path", "/var/www/.gem"},
578 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
579 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
581 cmd = exec.Command(cmdline[0], cmdline[1:]...)
582 cmd.Dir = "/var/lib/arvados/" + dstdir
585 fmt.Fprintf(stderr, "... %s\n", cmd.Args)
591 cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
592 cmd.Dir = "/var/lib/arvados/" + dstdir
596 if err != nil && !strings.Contains(err.Error(), "exit status 2") {
597 // Exit code 2 indicates there were warnings (like
598 // "other passenger installations have been detected",
599 // which we can't expect to avoid) but no errors.
600 // Other non-zero exit codes (1, 9) indicate errors.
605 // Install workbench2 app to /var/lib/arvados/workbench2/
606 if err = inst.runBash(`
607 cd /var/lib/arvados/arvados-workbench2
608 VERSION="`+inst.PackageVersion+`" BUILD_NUMBER=1 GIT_COMMIT="`+workbench2version[:9]+`" yarn build
609 rsync -a --delete-after build/ /var/lib/arvados/workbench2/
610 `, stdout, stderr); err != nil {
618 type osversion struct {
625 func identifyOS() (osversion, error) {
627 f, err := os.Open("/etc/os-release")
633 kv := map[string]string{}
634 scanner := bufio.NewScanner(f)
636 line := strings.TrimSpace(scanner.Text())
637 if strings.HasPrefix(line, "#") {
640 toks := strings.SplitN(line, "=", 2)
642 return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
645 v := strings.Trim(toks[1], `"`)
647 v = strings.Trim(v, `'`)
651 if err = scanner.Err(); err != nil {
662 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
664 vstr := kv["VERSION_ID"]
665 if i := strings.Index(vstr, "."); i > 0 {
668 osv.Major, err = strconv.Atoi(vstr)
670 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
675 func waitPostgreSQLReady() error {
676 for deadline := time.Now().Add(10 * time.Second); ; {
677 output, err := exec.Command("pg_isready").CombinedOutput()
680 } else if time.Now().After(deadline) {
681 return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
683 time.Sleep(time.Second)
688 func (inst *installCommand) runBash(script string, stdout, stderr io.Writer) error {
689 cmd := exec.Command("bash", "-")
691 cmd = exec.Command("eatmydata", "bash", "-")
693 cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
699 func prodpkgs(osv osversion) []string {
714 if osv.Debian || osv.Ubuntu {
715 if osv.Debian && osv.Major == 8 {
716 pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
717 } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
718 pkgs = append(pkgs, "python3-distutils") // sdk/cwl
722 "libcurl4-openssl-dev", // services/api
724 "libpython2.7", // services/fuse
725 "mime-support", // keep-web
726 "zlib1g-dev", // services/api
728 } else if osv.Centos {
730 "fuse-libs", // services/fuse
733 "libcurl-devel", // services/api
734 "mailcap", // keep-web
735 "postgresql-devel", // services/api
738 panic("os version not supported")
742 func ProductionDependencies() ([]string, error) {
743 osv, err := identifyOS()
747 return prodpkgs(osv), nil