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 devtestDatabasePassword = "insecure_arvados_test"
33 type installCommand struct {
39 func (inst *installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
40 logger := ctxlog.New(stderr, "text", "info")
41 ctx := ctxlog.Context(context.Background(), logger)
42 ctx, cancel := context.WithCancel(ctx)
48 logger.WithError(err).Info("exiting")
52 flags := flag.NewFlagSet(prog, flag.ContinueOnError)
53 flags.SetOutput(stderr)
54 versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
55 flags.StringVar(&inst.ClusterType, "type", "production", "cluster `type`: development, test, production, or package")
56 flags.StringVar(&inst.SourcePath, "source", "/arvados", "source tree location (required for -type=package)")
57 flags.StringVar(&inst.PackageVersion, "package-version", "0.0.0", "version string to embed in executable files")
58 err = flags.Parse(args)
59 if err == flag.ErrHelp {
62 } else if err != nil {
64 } else if *versionFlag {
65 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
66 } else if len(flags.Args()) > 0 {
67 err = fmt.Errorf("unrecognized command line arguments: %v", flags.Args())
71 var dev, test, prod, pkg bool
72 switch inst.ClusterType {
82 err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', 'production', or 'package')", inst.ClusterType)
87 err = errors.New("production install is not yet implemented")
91 osv, err := identifyOS()
96 listdir, err := os.Open("/var/lib/apt/lists")
98 logger.Warnf("error while checking whether to run apt-get update: %s", err)
99 } else if names, _ := listdir.Readdirnames(1); len(names) == 0 {
100 // Special case for a base docker image where the
101 // package cache has been deleted and all "apt-get
102 // install" commands will fail unless we fetch repos.
103 cmd := exec.CommandContext(ctx, "apt-get", "update")
112 pkgs := prodpkgs(osv)
121 if dev || test || pkg {
129 "daemontools", // lib/boot uses setuidgid to drop privileges when running as root
130 "default-jdk-headless",
131 "default-jre-headless",
135 "libcrypt-ssleay-perl",
155 "postgresql-contrib",
166 case osv.Debian && osv.Major >= 10:
167 pkgs = append(pkgs, "libcurl4")
169 pkgs = append(pkgs, "libcurl3")
171 cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends")
172 cmd.Args = append(cmd.Args, pkgs...)
173 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
182 os.Mkdir("/var/lib/arvados", 0755)
183 os.Mkdir("/var/lib/arvados/tmp", 0700)
185 os.Mkdir("/var/lib/arvados/wwwtmp", 0700)
186 u, er := user.Lookup("www-data")
188 err = fmt.Errorf("user.Lookup(%q): %w", "www-data", er)
191 uid, _ := strconv.Atoi(u.Uid)
192 gid, _ := strconv.Atoi(u.Gid)
193 err = os.Chown("/var/lib/arvados/wwwtmp", uid, gid)
198 rubyversion := "2.5.7"
199 if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+rubyversion)) {
200 logger.Print("ruby " + rubyversion + " already installed")
203 tmp=/var/lib/arvados/tmp/ruby-`+rubyversion+`
204 trap "rm -r ${tmp}" ERR
205 wget --progress=dot:giga -O- https://cache.ruby-lang.org/pub/ruby/2.5/ruby-`+rubyversion+`.tar.gz | tar -C /var/lib/arvados/tmp -xzf -
207 ./configure --disable-install-static-library --enable-shared --disable-install-doc --prefix /var/lib/arvados
210 /var/lib/arvados/bin/gem install bundler --no-ri --no-rdoc
211 # "gem update --system" can be removed when we use ruby ≥2.6.3: https://bundler.io/blog/2019/05/14/solutions-for-cant-find-gem-bundler-with-executable-bundle.html
212 /var/lib/arvados/bin/gem update --system --no-ri --no-rdoc
222 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
223 logger.Print("go " + goversion + " already installed")
227 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
228 ln -sf /var/lib/arvados/go/bin/* /usr/local/bin/
237 pjsversion := "1.9.8"
238 if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
239 logger.Print("phantomjs " + pjsversion + " already installed")
242 PJS=phantomjs-`+pjsversion+`-linux-x86_64
243 wget --progress=dot:giga -O- https://bitbucket.org/ariya/phantomjs/downloads/$PJS.tar.bz2 | tar -C /var/lib/arvados -xjf -
244 ln -sf /var/lib/arvados/$PJS/bin/phantomjs /usr/local/bin/
251 geckoversion := "0.24.0"
252 if havegeckoversion, err := exec.Command("/usr/local/bin/geckodriver", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegeckoversion), " "+geckoversion+" ") {
253 logger.Print("geckodriver " + geckoversion + " already installed")
257 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
258 ln -sf /var/lib/arvados/bin/geckodriver /usr/local/bin/
265 nodejsversion := "v8.15.1"
266 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == nodejsversion+"\n" {
267 logger.Print("nodejs " + nodejsversion + " already installed")
270 NJS=`+nodejsversion+`
271 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
272 ln -sf /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
279 gradleversion := "5.3.1"
280 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
281 logger.Print("gradle " + gradleversion + " already installed")
285 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
287 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
288 unzip -o -d /var/lib/arvados ${zip}
289 ln -sf /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
297 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
298 // it's installed, locale -a reports it as
300 wantlocale := "en_US.UTF-8"
301 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
302 logger.Print("locale " + wantlocale + " already installed")
304 err = runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
319 if pg_lsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
320 err = fmt.Errorf("pg_lsclusters: %s", err2)
322 } else if pgclusters := strings.Split(strings.TrimSpace(string(pg_lsclusters)), "\n"); len(pgclusters) != 1 {
323 logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
324 } 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 {
325 err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
327 } else if pgc.Status == "online" {
328 logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
330 logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
331 cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
339 cmd.Process.Signal(syscall.SIGTERM)
340 logger.Info("sent SIGTERM; waiting for postgres to shut down")
343 err = waitPostgreSQLReady()
349 if os.Getpid() == 1 {
350 // We are the init process (presumably in a
351 // docker container) so although postgresql is
352 // installed, it's not running, and initdb
353 // might never have been run.
356 var needcoll []string
357 // If the en_US.UTF-8 locale wasn't installed when
358 // postgresql initdb ran, it needs to be added
359 // explicitly before we can use it in our test suite.
360 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
361 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')")
363 out, err2 := cmd.CombinedOutput()
365 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
368 if strings.Contains(string(out), "1") {
369 logger.Infof("postgresql supports collation %s", collname)
371 needcoll = append(needcoll, collname)
374 if len(needcoll) > 0 && os.Getpid() != 1 {
375 // In order for the CREATE COLLATION statement
376 // below to work, the locale must have existed
377 // when PostgreSQL started up. If we're
378 // running as init, we must have started
379 // PostgreSQL ourselves after installing the
380 // locales. Otherwise, it might need a
381 // restart, so we attempt to restart it with
383 if err = runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
384 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
385 } else if err = waitPostgreSQLReady(); err != nil {
389 for _, collname := range needcoll {
390 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
396 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
401 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
402 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
404 if err := cmd.Run(); err == nil {
405 logger.Print("arvados role exists; superuser privileges added, password updated")
407 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
419 // Install Rails apps to /var/lib/arvados/{railsapi,workbench1}/
420 for dstdir, srcdir := range map[string]string{
421 "railsapi": "services/api",
422 "workbench1": "apps/workbench",
424 fmt.Fprintf(stderr, "building %s...\n", srcdir)
425 cmd := exec.Command("rsync",
426 "-a", "--no-owner", "--delete-after", "--delete-excluded",
427 "--exclude", "/coverage",
430 "--exclude", "/vendor",
431 "./", "/var/lib/arvados/"+dstdir+"/")
432 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
439 for _, cmdline := range [][]string{
440 {"mkdir", "-p", "log", "tmp", ".bundle", "/var/www/.gem", "/var/www/.bundle", "/var/www/.passenger"},
441 {"touch", "log/production.log"},
442 {"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"},
443 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/gem", "install", "--user", "--conservative", "--no-document", "bundler:1.16.6", "bundler:1.17.3", "bundler:2.0.2"},
444 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "install", "--deployment", "--jobs", "8", "--path", "/var/www/.gem"},
445 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "build-native-support"},
446 {"sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "install-standalone-runtime"},
448 cmd = exec.Command(cmdline[0], cmdline[1:]...)
449 cmd.Env = append([]string{}, os.Environ()...)
450 cmd.Dir = "/var/lib/arvados/" + dstdir
453 fmt.Fprintf(stderr, "... %s\n", cmd.Args)
459 cmd = exec.Command("sudo", "-u", "www-data", "/var/lib/arvados/bin/bundle", "exec", "passenger-config", "validate-install")
460 cmd.Dir = "/var/lib/arvados/" + dstdir
464 if err != nil && !strings.Contains(err.Error(), "exit status 2") {
465 // Exit code 2 indicates there were warnings (like
466 // "other passenger installations have been detected",
467 // which we can't expect to avoid) but no errors.
468 // Other non-zero exit codes (1, 9) indicate errors.
473 // Install Go programs to /var/lib/arvados/bin/
474 for _, srcdir := range []string{
475 "cmd/arvados-client",
476 "cmd/arvados-server",
477 "services/arv-git-httpd",
478 "services/crunch-dispatch-local",
479 "services/crunch-dispatch-slurm",
481 "services/keep-balance",
483 "services/keepproxy",
484 "services/keepstore",
487 fmt.Fprintf(stderr, "building %s...\n", srcdir)
488 cmd := exec.Command("go", "install", "-ldflags", "-X git.arvados.org/arvados.git/lib/cmd.version="+inst.PackageVersion+" -X main.version="+inst.PackageVersion)
489 cmd.Env = append([]string{"GOBIN=/var/lib/arvados/bin"}, os.Environ()...)
490 cmd.Dir = filepath.Join(inst.SourcePath, srcdir)
499 // Copy assets from source tree to /var/lib/arvados/share
500 cmd := exec.Command("install", "-v", "-t", "/var/lib/arvados/share", filepath.Join(inst.SourcePath, "sdk/python/tests/nginx.conf"))
512 type osversion struct {
519 func identifyOS() (osversion, error) {
521 f, err := os.Open("/etc/os-release")
527 kv := map[string]string{}
528 scanner := bufio.NewScanner(f)
530 line := strings.TrimSpace(scanner.Text())
531 if strings.HasPrefix(line, "#") {
534 toks := strings.SplitN(line, "=", 2)
536 return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
539 v := strings.Trim(toks[1], `"`)
541 v = strings.Trim(v, `'`)
545 if err = scanner.Err(); err != nil {
556 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
558 vstr := kv["VERSION_ID"]
559 if i := strings.Index(vstr, "."); i > 0 {
562 osv.Major, err = strconv.Atoi(vstr)
564 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
569 func waitPostgreSQLReady() error {
570 for deadline := time.Now().Add(10 * time.Second); ; {
571 output, err := exec.Command("pg_isready").CombinedOutput()
574 } else if time.Now().After(deadline) {
575 return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
577 time.Sleep(time.Second)
582 func runBash(script string, stdout, stderr io.Writer) error {
583 cmd := exec.Command("bash", "-")
584 cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)
590 func prodpkgs(osv osversion) []string {
605 if osv.Debian || osv.Ubuntu {
606 if osv.Debian && osv.Major == 8 {
607 pkgs = append(pkgs, "libgnutls-deb0-28") // sdk/cwl
608 } else if osv.Debian && osv.Major >= 10 || osv.Ubuntu && osv.Major >= 16 {
609 pkgs = append(pkgs, "python3-distutils") // sdk/cwl
613 "libcurl4-openssl-dev", // services/api
615 "libpython2.7", // services/fuse
616 "mime-support", // keep-web
617 "zlib1g-dev", // services/api
619 } else if osv.Centos {
621 "fuse-libs", // services/fuse
624 "libcurl-devel", // services/api
625 "mailcap", // keep-web
626 "postgresql-devel", // services/api
629 panic("os version not supported")
633 func ProductionDependencies() ([]string, error) {
634 osv, err := identifyOS()
638 return prodpkgs(osv), nil