X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/03a016b1edff72e698474cd31a887530ea89b530..63b1a5c12557bb11505f9dcfcc955f328b51e118:/services/keepproxy/keepproxy.go diff --git a/services/keepproxy/keepproxy.go b/services/keepproxy/keepproxy.go index e2a6221f10..2b15d79940 100644 --- a/services/keepproxy/keepproxy.go +++ b/services/keepproxy/keepproxy.go @@ -20,36 +20,19 @@ import ( "syscall" "time" - "git.curoverse.com/arvados.git/sdk/go/arvados" - "git.curoverse.com/arvados.git/sdk/go/arvadosclient" - "git.curoverse.com/arvados.git/sdk/go/config" - "git.curoverse.com/arvados.git/sdk/go/health" - "git.curoverse.com/arvados.git/sdk/go/httpserver" - "git.curoverse.com/arvados.git/sdk/go/keepclient" - log "github.com/Sirupsen/logrus" + "git.arvados.org/arvados.git/lib/config" + "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/arvadosclient" + "git.arvados.org/arvados.git/sdk/go/health" + "git.arvados.org/arvados.git/sdk/go/httpserver" + "git.arvados.org/arvados.git/sdk/go/keepclient" "github.com/coreos/go-systemd/daemon" "github.com/ghodss/yaml" "github.com/gorilla/mux" + log "github.com/sirupsen/logrus" ) -type Config struct { - Client arvados.Client - Listen string - DisableGet bool - DisablePut bool - DefaultReplicas int - Timeout arvados.Duration - PIDFile string - Debug bool - ManagementToken string -} - -func DefaultConfig() *Config { - return &Config{ - Listen: ":25107", - Timeout: arvados.Duration(15 * time.Second), - } -} +var version = "dev" var ( listener net.Listener @@ -58,105 +41,109 @@ var ( const rfc3339NanoFixed = "2006-01-02T15:04:05.000000000Z07:00" -func main() { - log.SetFormatter(&log.JSONFormatter{ - TimestampFormat: rfc3339NanoFixed, - }) +func configure(logger log.FieldLogger, args []string) (*arvados.Cluster, error) { + flags := flag.NewFlagSet(args[0], flag.ExitOnError) - cfg := DefaultConfig() + dumpConfig := flags.Bool("dump-config", false, "write current configuration to stdout and exit") + getVersion := flags.Bool("version", false, "Print version information and exit.") - flagset := flag.NewFlagSet("keepproxy", flag.ExitOnError) - flagset.Usage = usage + loader := config.NewLoader(os.Stdin, logger) + loader.SetupFlags(flags) - const deprecated = " (DEPRECATED -- use config file instead)" - flagset.StringVar(&cfg.Listen, "listen", cfg.Listen, "Local port to listen on."+deprecated) - flagset.BoolVar(&cfg.DisableGet, "no-get", cfg.DisableGet, "Disable GET operations."+deprecated) - flagset.BoolVar(&cfg.DisablePut, "no-put", cfg.DisablePut, "Disable PUT operations."+deprecated) - flagset.IntVar(&cfg.DefaultReplicas, "default-replicas", cfg.DefaultReplicas, "Default number of replicas to write if not specified by the client. If 0, use site default."+deprecated) - flagset.StringVar(&cfg.PIDFile, "pid", cfg.PIDFile, "Path to write pid file."+deprecated) - timeoutSeconds := flagset.Int("timeout", int(time.Duration(cfg.Timeout)/time.Second), "Timeout (in seconds) on requests to internal Keep services."+deprecated) - flagset.StringVar(&cfg.ManagementToken, "management-token", cfg.ManagementToken, "Authorization token to be included in all health check requests.") + args = loader.MungeLegacyConfigArgs(logger, args[1:], "-legacy-keepproxy-config") + flags.Parse(args) - var cfgPath string - const defaultCfgPath = "/etc/arvados/keepproxy/keepproxy.yml" - flagset.StringVar(&cfgPath, "config", defaultCfgPath, "Configuration file `path`") - dumpConfig := flagset.Bool("dump-config", false, "write current configuration to stdout and exit") - flagset.Parse(os.Args[1:]) + // Print version information if requested + if *getVersion { + fmt.Printf("keepproxy %s\n", version) + return nil, nil + } - err := config.LoadFile(cfg, cfgPath) + cfg, err := loader.Load() if err != nil { - h := os.Getenv("ARVADOS_API_HOST") - t := os.Getenv("ARVADOS_API_TOKEN") - if h == "" || t == "" || !os.IsNotExist(err) || cfgPath != defaultCfgPath { - log.Fatal(err) - } - log.Print("DEPRECATED: No config file found, but ARVADOS_API_HOST and ARVADOS_API_TOKEN environment variables are set. Please use a config file instead.") - cfg.Client.APIHost = h - cfg.Client.AuthToken = t - if regexp.MustCompile("^(?i:1|yes|true)$").MatchString(os.Getenv("ARVADOS_API_HOST_INSECURE")) { - cfg.Client.Insecure = true + return nil, err + } + cluster, err := cfg.GetCluster("") + if err != nil { + return nil, err + } + + if *dumpConfig { + out, err := yaml.Marshal(cfg) + if err != nil { + return nil, err } - if y, err := yaml.Marshal(cfg); err == nil && !*dumpConfig { - log.Print("Current configuration:\n", string(y)) + if _, err := os.Stdout.Write(out); err != nil { + return nil, err } - cfg.Timeout = arvados.Duration(time.Duration(*timeoutSeconds) * time.Second) + return nil, nil + } + return cluster, nil +} + +func main() { + logger := log.New() + logger.Formatter = &log.JSONFormatter{ + TimestampFormat: rfc3339NanoFixed, } - if *dumpConfig { - log.Fatal(config.DumpAndExit(cfg)) + cluster, err := configure(logger, os.Args) + if err != nil { + log.Fatal(err) + } + if cluster == nil { + return + } + + log.Printf("keepproxy %s started", version) + + if err := run(logger, cluster); err != nil { + log.Fatal(err) + } + + log.Println("shutting down") +} + +func run(logger log.FieldLogger, cluster *arvados.Cluster) error { + client, err := arvados.NewClientFromConfig(cluster) + if err != nil { + return err } + client.AuthToken = cluster.SystemRootToken - arv, err := arvadosclient.New(&cfg.Client) + arv, err := arvadosclient.New(client) if err != nil { - log.Fatalf("Error setting up arvados client %s", err.Error()) + return fmt.Errorf("Error setting up arvados client %v", err) } - if cfg.Debug { + if cluster.SystemLogs.LogLevel == "debug" { keepclient.DebugPrintf = log.Printf } kc, err := keepclient.MakeKeepClient(arv) if err != nil { - log.Fatalf("Error setting up keep client %s", err.Error()) + return fmt.Errorf("Error setting up keep client %v", err) } keepclient.RefreshServiceDiscoveryOnSIGHUP() - if cfg.PIDFile != "" { - f, err := os.Create(cfg.PIDFile) - if err != nil { - log.Fatal(err) - } - defer f.Close() - err = syscall.Flock(int(f.Fd()), syscall.LOCK_EX|syscall.LOCK_NB) - if err != nil { - log.Fatalf("flock(%s): %s", cfg.PIDFile, err) - } - defer os.Remove(cfg.PIDFile) - err = f.Truncate(0) - if err != nil { - log.Fatalf("truncate(%s): %s", cfg.PIDFile, err) - } - _, err = fmt.Fprint(f, os.Getpid()) - if err != nil { - log.Fatalf("write(%s): %s", cfg.PIDFile, err) - } - err = f.Sync() - if err != nil { - log.Fatal("sync(%s): %s", cfg.PIDFile, err) - } + if cluster.Collections.DefaultReplication > 0 { + kc.Want_replicas = cluster.Collections.DefaultReplication } - if cfg.DefaultReplicas > 0 { - kc.Want_replicas = cfg.DefaultReplicas + var listen arvados.URL + for listen = range cluster.Services.Keepproxy.InternalURLs { + break } - listener, err = net.Listen("tcp", cfg.Listen) - if err != nil { - log.Fatalf("listen(%s): %s", cfg.Listen, err) + var lErr error + listener, lErr = net.Listen("tcp", listen.Host) + if lErr != nil { + return fmt.Errorf("listen(%s): %v", listen.Host, lErr) } + if _, err := daemon.SdNotify(false, "READY=1"); err != nil { log.Printf("Error notifying init daemon: %v", err) } - log.Println("Listening at", listener.Addr()) + log.Println("listening at", listener.Addr()) // Shut down the server gracefully (by closing the listener) // if SIGTERM is received. @@ -170,10 +157,8 @@ func main() { signal.Notify(term, syscall.SIGINT) // Start serving requests. - router = MakeRESTRouter(!cfg.DisableGet, !cfg.DisablePut, kc, time.Duration(cfg.Timeout), cfg.ManagementToken) - http.Serve(listener, httpserver.AddRequestIDs(httpserver.LogRequests(router))) - - log.Println("shutting down") + router = MakeRESTRouter(kc, time.Duration(cluster.API.KeepServiceRequestTimeout), cluster.ManagementToken) + return http.Serve(listener, httpserver.AddRequestIDs(httpserver.LogRequests(router))) } type ApiTokenCache struct { @@ -221,35 +206,56 @@ func GetRemoteAddress(req *http.Request) string { } func CheckAuthorizationHeader(kc *keepclient.KeepClient, cache *ApiTokenCache, req *http.Request) (pass bool, tok string) { - var auth string - if auth = req.Header.Get("Authorization"); auth == "" { + parts := strings.SplitN(req.Header.Get("Authorization"), " ", 2) + if len(parts) < 2 || !(parts[0] == "OAuth2" || parts[0] == "Bearer") || len(parts[1]) == 0 { return false, "" } + tok = parts[1] - _, err := fmt.Sscanf(auth, "OAuth2 %s", &tok) - if err != nil { - // Scanning error - return false, "" + // Tokens are validated differently depending on what kind of + // operation is being performed. For example, tokens in + // collection-sharing links permit GET requests, but not + // PUT requests. + var op string + if req.Method == "GET" || req.Method == "HEAD" { + op = "read" + } else { + op = "write" } - if cache.RecallToken(tok) { + if cache.RecallToken(op + ":" + tok) { // Valid in the cache, short circuit return true, tok } + var err error arv := *kc.Arvados arv.ApiToken = tok - if err := arv.Call("HEAD", "users", "", "current", nil, nil); err != nil { + arv.RequestID = req.Header.Get("X-Request-Id") + if op == "read" { + err = arv.Call("HEAD", "keep_services", "", "accessible", nil, nil) + } else { + err = arv.Call("HEAD", "users", "", "current", nil, nil) + } + if err != nil { log.Printf("%s: CheckAuthorizationHeader error: %v", GetRemoteAddress(req), err) return false, "" } // Success! Update cache - cache.RememberToken(tok) + cache.RememberToken(op + ":" + tok) return true, tok } +// We need to make a private copy of the default http transport early +// in initialization, then make copies of our private copy later. It +// won't be safe to copy http.DefaultTransport itself later, because +// its private mutexes might have already been used. (Without this, +// the test suite sometimes panics "concurrent map writes" in +// net/http.(*Transport).removeIdleConnLocked().) +var defaultTransport = *(http.DefaultTransport.(*http.Transport)) + type proxyHandler struct { http.Handler *keepclient.KeepClient @@ -260,10 +266,10 @@ type proxyHandler struct { // MakeRESTRouter returns an http.Handler that passes GET and PUT // requests to the appropriate handlers. -func MakeRESTRouter(enable_get bool, enable_put bool, kc *keepclient.KeepClient, timeout time.Duration, mgmtToken string) http.Handler { +func MakeRESTRouter(kc *keepclient.KeepClient, timeout time.Duration, mgmtToken string) http.Handler { rest := mux.NewRouter() - transport := *(http.DefaultTransport.(*http.Transport)) + transport := defaultTransport transport.DialContext = (&net.Dialer{ Timeout: keepclient.DefaultConnectTimeout, KeepAlive: keepclient.DefaultKeepAlive, @@ -283,24 +289,20 @@ func MakeRESTRouter(enable_get bool, enable_put bool, kc *keepclient.KeepClient, }, } - if enable_get { - rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Get).Methods("GET", "HEAD") - rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Get).Methods("GET", "HEAD") + rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Get).Methods("GET", "HEAD") + rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Get).Methods("GET", "HEAD") - // List all blocks - rest.HandleFunc(`/index`, h.Index).Methods("GET") + // List all blocks + rest.HandleFunc(`/index`, h.Index).Methods("GET") - // List blocks whose hash has the given prefix - rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, h.Index).Methods("GET") - } + // List blocks whose hash has the given prefix + rest.HandleFunc(`/index/{prefix:[0-9a-f]{0,32}}`, h.Index).Methods("GET") - if enable_put { - rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Put).Methods("PUT") - rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Put).Methods("PUT") - rest.HandleFunc(`/`, h.Put).Methods("POST") - rest.HandleFunc(`/{any}`, h.Options).Methods("OPTIONS") - rest.HandleFunc(`/`, h.Options).Methods("OPTIONS") - } + rest.HandleFunc(`/{locator:[0-9a-f]{32}\+.*}`, h.Put).Methods("PUT") + rest.HandleFunc(`/{locator:[0-9a-f]{32}}`, h.Put).Methods("PUT") + rest.HandleFunc(`/`, h.Put).Methods("POST") + rest.HandleFunc(`/{any}`, h.Options).Methods("OPTIONS") + rest.HandleFunc(`/`, h.Options).Methods("OPTIONS") rest.Handle("/_health/{check}", &health.Handler{ Token: mgmtToken, @@ -455,6 +457,15 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { locatorIn := mux.Vars(req)["locator"] + // Check if the client specified storage classes + if req.Header.Get("X-Keep-Storage-Classes") != "" { + var scl []string + for _, sc := range strings.Split(req.Header.Get("X-Keep-Storage-Classes"), ",") { + scl = append(scl, strings.Trim(sc, " ")) + } + kc.StorageClasses = scl + } + _, err = fmt.Sscanf(req.Header.Get("Content-Length"), "%d", &expectLength) if err != nil || expectLength < 0 { err = LengthRequiredError @@ -498,13 +509,13 @@ func (h *proxyHandler) Put(resp http.ResponseWriter, req *http.Request) { // Now try to put the block through if locatorIn == "" { - if bytes, err := ioutil.ReadAll(req.Body); err != nil { - err = errors.New(fmt.Sprintf("Error reading request body: %s", err)) + bytes, err2 := ioutil.ReadAll(req.Body) + if err2 != nil { + err = fmt.Errorf("Error reading request body: %s", err2) status = http.StatusInternalServerError return - } else { - locatorOut, wroteReplicas, err = kc.PutB(bytes) } + locatorOut, wroteReplicas, err = kc.PutB(bytes) } else { locatorOut, wroteReplicas, err = kc.PutHR(locatorIn, req.Body, expectLength) } @@ -598,13 +609,13 @@ func (h *proxyHandler) Index(resp http.ResponseWriter, req *http.Request) { func (h *proxyHandler) makeKeepClient(req *http.Request) *keepclient.KeepClient { kc := *h.KeepClient + kc.RequestID = req.Header.Get("X-Request-Id") kc.HTTPClient = &proxyClient{ client: &http.Client{ Timeout: h.timeout, Transport: h.transport, }, - proto: req.Proto, - requestID: req.Header.Get("X-Request-Id"), + proto: req.Proto, } return &kc }