1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
22 "git.arvados.org/arvados.git/lib/cmd"
23 "git.arvados.org/arvados.git/sdk/go/ctxlog"
27 var Command cmd.Handler = installCommand{}
29 const devtestDatabasePassword = "insecure_arvados_test"
31 type installCommand struct{}
33 func (installCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
34 logger := ctxlog.New(stderr, "text", "info")
35 ctx := ctxlog.Context(context.Background(), logger)
36 ctx, cancel := context.WithCancel(ctx)
42 logger.WithError(err).Info("exiting")
46 flags := flag.NewFlagSet(prog, flag.ContinueOnError)
47 flags.SetOutput(stderr)
48 versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
49 clusterType := flags.String("type", "production", "cluster `type`: development, test, or production")
50 err = flags.Parse(args)
51 if err == flag.ErrHelp {
54 } else if err != nil {
56 } else if *versionFlag {
57 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
60 var dev, test, prod bool
69 err = fmt.Errorf("invalid cluster type %q (must be 'development', 'test', or 'production')", *clusterType)
74 err = errors.New("production install is not yet implemented")
78 osv, err := identifyOS()
83 listdir, err := os.Open("/var/lib/apt/lists")
85 logger.Warnf("error while checking whether to run apt-get update: %s", err)
86 } else if names, _ := listdir.Readdirnames(1); len(names) == 0 {
87 // Special case for a base docker image where the
88 // package cache has been deleted and all "apt-get
89 // install" commands will fail unless we fetch repos.
90 cmd := exec.CommandContext(ctx, "apt-get", "update")
108 "daemontools", // lib/boot uses setuidgid to drop privileges when running as root
109 "default-jdk-headless",
110 "default-jre-headless",
119 "libcrypt-ssleay-perl",
120 "libcrypt-ssleay-perl",
122 "libcurl4-openssl-dev",
143 "postgresql-contrib",
148 "python3-virtualenv",
155 case osv.Debian && osv.Major >= 10:
156 debs = append(debs, "libcurl4")
158 debs = append(debs, "libcurl3")
160 cmd := exec.CommandContext(ctx, "apt-get", "install", "--yes", "--no-install-recommends")
161 cmd.Args = append(cmd.Args, debs...)
162 cmd.Env = append(os.Environ(), "DEBIAN_FRONTEND=noninteractive")
171 os.Mkdir("/var/lib/arvados", 0755)
172 rubyversion := "2.5.7"
173 if haverubyversion, err := exec.Command("/var/lib/arvados/bin/ruby", "-v").CombinedOutput(); err == nil && bytes.HasPrefix(haverubyversion, []byte("ruby "+rubyversion)) {
174 logger.Print("ruby " + rubyversion + " already installed")
177 mkdir -p /var/lib/arvados/tmp
178 tmp=/var/lib/arvados/tmp/ruby-`+rubyversion+`
179 trap "rm -r ${tmp}" ERR
180 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 -
182 ./configure --disable-install-doc --prefix /var/lib/arvados
185 /var/lib/arvados/bin/gem install bundler
195 if havegoversion, err := exec.Command("/usr/local/bin/go", "version").CombinedOutput(); err == nil && bytes.HasPrefix(havegoversion, []byte("go version go"+goversion+" ")) {
196 logger.Print("go " + goversion + " already installed")
200 wget --progress=dot:giga -O- https://storage.googleapis.com/golang/go`+goversion+`.linux-amd64.tar.gz | tar -C /var/lib/arvados -xzf -
201 ln -sf /var/lib/arvados/go/bin/* /usr/local/bin/
208 pjsversion := "1.9.8"
209 if havepjsversion, err := exec.Command("/usr/local/bin/phantomjs", "--version").CombinedOutput(); err == nil && string(havepjsversion) == "1.9.8\n" {
210 logger.Print("phantomjs " + pjsversion + " already installed")
213 PJS=phantomjs-`+pjsversion+`-linux-x86_64
214 wget --progress=dot:giga -O- https://bitbucket.org/ariya/phantomjs/downloads/$PJS.tar.bz2 | tar -C /var/lib/arvados -xjf -
215 ln -sf /var/lib/arvados/$PJS/bin/phantomjs /usr/local/bin/
222 geckoversion := "0.24.0"
223 if havegeckoversion, err := exec.Command("/usr/local/bin/geckodriver", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegeckoversion), " "+geckoversion+" ") {
224 logger.Print("geckodriver " + geckoversion + " already installed")
228 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
229 ln -sf /var/lib/arvados/bin/geckodriver /usr/local/bin/
236 nodejsversion := "v8.15.1"
237 if havenodejsversion, err := exec.Command("/usr/local/bin/node", "--version").CombinedOutput(); err == nil && string(havenodejsversion) == nodejsversion+"\n" {
238 logger.Print("nodejs " + nodejsversion + " already installed")
241 NJS=`+nodejsversion+`
242 wget --progress=dot:giga -O- https://nodejs.org/dist/${NJS}/node-${NJS}-linux-x64.tar.xz | sudo tar -C /var/lib/arvados -xJf -
243 ln -sf /var/lib/arvados/node-${NJS}-linux-x64/bin/{node,npm} /usr/local/bin/
250 gradleversion := "5.3.1"
251 if havegradleversion, err := exec.Command("/usr/local/bin/gradle", "--version").CombinedOutput(); err == nil && strings.Contains(string(havegradleversion), "Gradle "+gradleversion+"\n") {
252 logger.Print("gradle " + gradleversion + " already installed")
256 mkdir -p /var/lib/arvados/tmp
257 zip=/var/lib/arvados/tmp/gradle-${G}-bin.zip
259 wget --progress=dot:giga -O${zip} https://services.gradle.org/distributions/gradle-${G}-bin.zip
260 unzip -o -d /var/lib/arvados ${zip}
261 ln -sf /var/lib/arvados/gradle-${G}/bin/gradle /usr/local/bin/
269 // The entry in /etc/locale.gen is "en_US.UTF-8"; once
270 // it's installed, locale -a reports it as
272 wantlocale := "en_US.UTF-8"
273 if havelocales, err := exec.Command("locale", "-a").CombinedOutput(); err == nil && bytes.Contains(havelocales, []byte(strings.Replace(wantlocale+"\n", "UTF-", "utf", 1))) {
274 logger.Print("locale " + wantlocale + " already installed")
276 err = runBash(`sed -i 's/^# *\(`+wantlocale+`\)/\1/' /etc/locale.gen && locale-gen`, stdout, stderr)
291 if pg_lsclusters, err2 := exec.Command("pg_lsclusters", "--no-header").CombinedOutput(); err2 != nil {
292 err = fmt.Errorf("pg_lsclusters: %s", err2)
294 } else if pgclusters := strings.Split(strings.TrimSpace(string(pg_lsclusters)), "\n"); len(pgclusters) != 1 {
295 logger.Warnf("pg_lsclusters returned %d postgresql clusters -- skipping postgresql initdb/startup, hope that's ok", len(pgclusters))
296 } 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 {
297 err = fmt.Errorf("error parsing pg_lsclusters output: %s", err)
299 } else if pgc.Status == "online" {
300 logger.Infof("postgresql cluster %s-%s is online", pgc.Version, pgc.Cluster)
302 logger.Infof("postgresql cluster %s-%s is %s; trying to start", pgc.Version, pgc.Cluster, pgc.Status)
303 cmd := exec.Command("pg_ctlcluster", "--foreground", pgc.Version, pgc.Cluster, "start")
311 cmd.Process.Signal(syscall.SIGTERM)
312 logger.Info("sent SIGTERM; waiting for postgres to shut down")
315 err = waitPostgreSQLReady()
321 if os.Getpid() == 1 {
322 // We are the init process (presumably in a
323 // docker container) so although postgresql is
324 // installed, it's not running, and initdb
325 // might never have been run.
328 var needcoll []string
329 // If the en_US.UTF-8 locale wasn't installed when
330 // postgresql initdb ran, it needs to be added
331 // explicitly before we can use it in our test suite.
332 for _, collname := range []string{"en_US", "en_US.UTF-8"} {
333 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')")
335 out, err2 := cmd.CombinedOutput()
337 err = fmt.Errorf("error while checking postgresql collations: %s", err2)
340 if strings.Contains(string(out), "1") {
341 logger.Infof("postgresql supports collation %s", collname)
343 needcoll = append(needcoll, collname)
346 if len(needcoll) > 0 && os.Getpid() != 1 {
347 // In order for the CREATE COLLATION statement
348 // below to work, the locale must have existed
349 // when PostgreSQL started up. If we're
350 // running as init, we must have started
351 // PostgreSQL ourselves after installing the
352 // locales. Otherwise, it might need a
353 // restart, so we attempt to restart it with
355 if err = runBash(`sudo systemctl restart postgresql`, stdout, stderr); err != nil {
356 logger.Warn("`systemctl restart postgresql` failed; hoping postgresql does not need to be restarted")
357 } else if err = waitPostgreSQLReady(); err != nil {
361 for _, collname := range needcoll {
362 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE COLLATION \""+collname+"\" (LOCALE = \"en_US.UTF-8\")")
368 err = fmt.Errorf("error adding postgresql collation %s: %s", collname, err)
373 withstuff := "WITH LOGIN SUPERUSER ENCRYPTED PASSWORD " + pq.QuoteLiteral(devtestDatabasePassword)
374 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "ALTER ROLE arvados "+withstuff)
376 if err := cmd.Run(); err == nil {
377 logger.Print("arvados role exists; superuser privileges added, password updated")
379 cmd := exec.Command("sudo", "-u", "postgres", "psql", "-c", "CREATE ROLE arvados "+withstuff)
393 type osversion struct {
399 func identifyOS() (osversion, error) {
401 f, err := os.Open("/etc/os-release")
407 kv := map[string]string{}
408 scanner := bufio.NewScanner(f)
410 line := strings.TrimSpace(scanner.Text())
411 if strings.HasPrefix(line, "#") {
414 toks := strings.SplitN(line, "=", 2)
416 return osv, fmt.Errorf("invalid line in /etc/os-release: %q", line)
419 v := strings.Trim(toks[1], `"`)
421 v = strings.Trim(v, `'`)
425 if err = scanner.Err(); err != nil {
434 return osv, fmt.Errorf("unsupported ID in /etc/os-release: %q", kv["ID"])
436 vstr := kv["VERSION_ID"]
437 if i := strings.Index(vstr, "."); i > 0 {
440 osv.Major, err = strconv.Atoi(vstr)
442 return osv, fmt.Errorf("incomprehensible VERSION_ID in /etc/os-release: %q", kv["VERSION_ID"])
447 func waitPostgreSQLReady() error {
448 for deadline := time.Now().Add(10 * time.Second); ; {
449 output, err := exec.Command("pg_isready").CombinedOutput()
452 } else if time.Now().After(deadline) {
453 return fmt.Errorf("timed out waiting for pg_isready (%q)", output)
455 time.Sleep(time.Second)
460 func runBash(script string, stdout, stderr io.Writer) error {
461 cmd := exec.Command("bash", "-")
462 cmd.Stdin = bytes.NewBufferString("set -ex -o pipefail\n" + script)