lib/install/init.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package install
   6
   7 import (
   8         "context"
   9         "crypto/rand"
  10         "crypto/rsa"
  11         "crypto/x509"
  12         "encoding/pem"
  13         "flag"
  14         "fmt"
  15         "io"
  16         "os"
  17         "os/exec"
  18         "os/user"
  19         "regexp"
  20         "strconv"
  21         "text/template"
  22
  23         "git.arvados.org/arvados.git/lib/cmd"
  24         "git.arvados.org/arvados.git/lib/config"
  25         "git.arvados.org/arvados.git/sdk/go/arvados"
  26         "git.arvados.org/arvados.git/sdk/go/ctxlog"
  27         "github.com/lib/pq"
  28 )
  29
  30 var InitCommand cmd.Handler = &initCommand{}
  31
  32 type initCommand struct {
  33         ClusterID          string
  34         Domain             string
  35         PostgreSQLPassword string
  36         Login              string
  37         Insecure           bool
  38 }
  39
  40 func (initcmd *initCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  41         logger := ctxlog.New(stderr, "text", "info")
  42         ctx := ctxlog.Context(context.Background(), logger)
  43         ctx, cancel := context.WithCancel(ctx)
  44         defer cancel()
  45
  46         var err error
  47         defer func() {
  48                 if err != nil {
  49                         logger.WithError(err).Info("exiting")
  50                 }
  51         }()
  52
  53         hostname, err := os.Hostname()
  54         if err != nil {
  55                 err = fmt.Errorf("Hostname(): %w", err)
  56                 return 1
  57         }
  58
  59         flags := flag.NewFlagSet(prog, flag.ContinueOnError)
  60         flags.SetOutput(stderr)
  61         versionFlag := flags.Bool("version", false, "Write version information to stdout and exit 0")
  62         flags.StringVar(&initcmd.ClusterID, "cluster-id", "", "cluster `id`, like x1234 for a dev cluster")
  63         flags.StringVar(&initcmd.Domain, "domain", hostname, "cluster public DNS `name`, like x1234.arvadosapi.com")
  64         flags.StringVar(&initcmd.Login, "login", "", "login `backend`: test, pam, or ''")
  65         flags.BoolVar(&initcmd.Insecure, "insecure", false, "accept invalid TLS certificates and configure TrustAllContent (do not use in production!)")
  66         if ok, code := cmd.ParseFlags(flags, prog, args, "", stderr); !ok {
  67                 return code
  68         } else if *versionFlag {
  69                 return cmd.Version.RunCommand(prog, args, stdin, stdout, stderr)
  70         } else if !regexp.MustCompile(`^[a-z][a-z0-9]{4}`).MatchString(initcmd.ClusterID) {
  71                 err = fmt.Errorf("cluster ID %q is invalid; must be an ASCII letter followed by 4 alphanumerics (try -help)", initcmd.ClusterID)
  72                 return 1
  73         }
  74
  75         wwwuser, err := user.Lookup("www-data")
  76         if err != nil {
  77                 err = fmt.Errorf("user.Lookup(%q): %w", "www-data", err)
  78                 return 1
  79         }
  80         wwwgid, err := strconv.Atoi(wwwuser.Gid)
  81         if err != nil {
  82                 return 1
  83         }
  84         initcmd.PostgreSQLPassword = initcmd.RandomHex(32)
  85
  86         err = os.Mkdir("/var/lib/arvados/keep", 0600)
  87         if err != nil && !os.IsExist(err) {
  88                 err = fmt.Errorf("mkdir /var/lib/arvados/keep: %w", err)
  89                 return 1
  90         }
  91         fmt.Fprintln(stderr, "created /var/lib/arvados/keep")
  92
  93         err = os.Mkdir("/etc/arvados", 0750)
  94         if err != nil && !os.IsExist(err) {
  95                 err = fmt.Errorf("mkdir /etc/arvados: %w", err)
  96                 return 1
  97         }
  98         err = os.Chown("/etc/arvados", 0, wwwgid)
  99         f, err := os.OpenFile("/etc/arvados/config.yml", os.O_CREATE|os.O_EXCL|os.O_WRONLY, 0644)
 100         if err != nil {
 101                 err = fmt.Errorf("open /etc/arvados/config.yml: %w", err)
 102                 return 1
 103         }
 104         tmpl, err := template.New("config").Parse(`Clusters:
 105   {{.ClusterID}}:
 106     Services:
 107       Controller:
 108         InternalURLs:
 109           "http://0.0.0.0:8003/": {}
 110         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4430/" ) }}
 111       RailsAPI:
 112         InternalURLs:
 113           "http://0.0.0.0:8004/": {}
 114       Websocket:
 115         InternalURLs:
 116           "http://0.0.0.0:8005/": {}
 117         ExternalURL: {{printf "%q" ( print "wss://" .Domain ":4435/websocket" ) }}
 118       Keepbalance:
 119         InternalURLs:
 120           "http://0.0.0.0:9005/": {}
 121       GitHTTP:
 122         InternalURLs:
 123           "http://0.0.0.0:9001/": {}
 124         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4436/" ) }}
 125       DispatchCloud:
 126         InternalURLs:
 127           "http://0.0.0.0:9006/": {}
 128       Keepproxy:
 129         InternalURLs:
 130           "http://0.0.0.0:25108/": {}
 131         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4437/" ) }}
 132       WebDAV:
 133         InternalURLs:
 134           "http://0.0.0.0:9002/": {}
 135         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4438/" ) }}
 136       WebDAVDownload:
 137         InternalURLs:
 138           "http://0.0.0.0:8004/": {}
 139         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4439/" ) }}
 140       Keepstore:
 141         InternalURLs:
 142           "http://0.0.0.0:25107/": {}
 143       Composer:
 144         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4440/composer" ) }}
 145       Workbench1:
 146         InternalURLs:
 147           "http://0.0.0.0:8001/": {}
 148         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4441/" ) }}
 149       Workbench2:
 150         ExternalURL: {{printf "%q" ( print "https://" .Domain ":4442/" ) }}
 151       Health:
 152         InternalURLs:
 153           "http://0.0.0.0:9007/": {}
 154     Collections:
 155       BlobSigningKey: {{printf "%q" ( .RandomHex 50 )}}
 156       {{if .Insecure}}
 157       TrustAllContent: true
 158       {{end}}
 159     Containers:
 160       DispatchPrivateKey: {{printf "%q" .GenerateSSHPrivateKey}}
 161     ManagementToken: {{printf "%q" ( .RandomHex 50 )}}
 162     PostgreSQL:
 163       Connection:
 164         dbname: arvados_production
 165         host: localhost
 166         user: arvados
 167         password: {{printf "%q" .PostgreSQLPassword}}
 168     SystemRootToken: {{printf "%q" ( .RandomHex 50 )}}
 169     {{if .Insecure}}
 170     TLS:
 171       Insecure: true
 172     {{end}}
 173     Volumes:
 174       {{.ClusterID}}-nyw5e-000000000000000:
 175         Driver: Directory
 176         DriverParameters:
 177           Root: /var/lib/arvados/keep
 178         Replication: 2
 179     Workbench:
 180       SecretKeyBase: {{printf "%q" ( .RandomHex 50 )}}
 181     Login:
 182       {{if eq .Login "pam"}}
 183       PAM:
 184         Enable: true
 185       {{else if eq .Login "test"}}
 186       Test:
 187         Enable: true
 188         Users:
 189           admin:
 190             Email: admin@example.com
 191             Password: admin
 192       {{else}}
 193       {}
 194       {{end}}
 195     Users:
 196       {{if eq .Login "test"}}
 197       AutoAdminUserWithEmail: admin@example.com
 198       {{else}}
 199       {}
 200       {{end}}
 201 `)
 202         if err != nil {
 203                 return 1
 204         }
 205         err = tmpl.Execute(f, initcmd)
 206         if err != nil {
 207                 err = fmt.Errorf("/etc/arvados/config.yml: tmpl.Execute: %w", err)
 208                 return 1
 209         }
 210         err = f.Close()
 211         if err != nil {
 212                 err = fmt.Errorf("/etc/arvados/config.yml: close: %w", err)
 213                 return 1
 214         }
 215         fmt.Fprintln(stderr, "created /etc/arvados/config.yml")
 216
 217         ldr := config.NewLoader(nil, logger)
 218         ldr.SkipLegacy = true
 219         cfg, err := ldr.Load()
 220         if err != nil {
 221                 err = fmt.Errorf("/etc/arvados/config.yml: %w", err)
 222                 return 1
 223         }
 224         cluster, err := cfg.GetCluster("")
 225         if err != nil {
 226                 return 1
 227         }
 228
 229         err = initcmd.createDB(ctx, cluster.PostgreSQL.Connection, stderr)
 230         if err != nil {
 231                 return 1
 232         }
 233
 234         cmd := exec.CommandContext(ctx, "sudo", "-u", "www-data", "-E", "HOME=/var/www", "PATH=/var/lib/arvados/bin:"+os.Getenv("PATH"), "/var/lib/arvados/bin/bundle", "exec", "rake", "db:setup")
 235         cmd.Dir = "/var/lib/arvados/railsapi"
 236         cmd.Stdout = stderr
 237         cmd.Stderr = stderr
 238         err = cmd.Run()
 239         if err != nil {
 240                 err = fmt.Errorf("rake db:setup: %w", err)
 241                 return 1
 242         }
 243         fmt.Fprintln(stderr, "initialized database")
 244
 245         return 0
 246 }
 247
 248 func (initcmd *initCommand) GenerateSSHPrivateKey() (string, error) {
 249         privkey, err := rsa.GenerateKey(rand.Reader, 4096)
 250         if err != nil {
 251                 return "", err
 252         }
 253         err = privkey.Validate()
 254         if err != nil {
 255                 return "", err
 256         }
 257         return string(pem.EncodeToMemory(&pem.Block{
 258                 Type:  "RSA PRIVATE KEY",
 259                 Bytes: x509.MarshalPKCS1PrivateKey(privkey),
 260         })), nil
 261 }
 262
 263 func (initcmd *initCommand) RandomHex(chars int) string {
 264         b := make([]byte, chars/2)
 265         _, err := rand.Read(b)
 266         if err != nil {
 267                 panic(err)
 268         }
 269         return fmt.Sprintf("%x", b)
 270 }
 271
 272 func (initcmd *initCommand) createDB(ctx context.Context, dbconn arvados.PostgreSQLConnection, stderr io.Writer) error {
 273         for _, sql := range []string{
 274                 `CREATE USER ` + pq.QuoteIdentifier(dbconn["user"]) + ` WITH SUPERUSER ENCRYPTED PASSWORD ` + pq.QuoteLiteral(dbconn["password"]),
 275                 `CREATE DATABASE ` + pq.QuoteIdentifier(dbconn["dbname"]) + ` WITH TEMPLATE template0 ENCODING 'utf8'`,
 276                 `CREATE EXTENSION IF NOT EXISTS pg_trgm`,
 277         } {
 278                 cmd := exec.CommandContext(ctx, "sudo", "-u", "postgres", "psql", "-c", sql)
 279                 cmd.Stdout = stderr
 280                 cmd.Stderr = stderr
 281                 err := cmd.Run()
 282                 if err != nil {
 283                         return fmt.Errorf("error setting up arvados user/database: %w", err)
 284                 }
 285         }
 286         return nil
 287 }