[ARVADOS] updated: cef8879203c34fe72725afee259d42bbc0bd5a69

Git user git at public.curoverse.com
Wed Sep 21 14:09:00 EDT 2016


Summary of changes:
 services/keepproxy/keepproxy.go | 12 +++---
 services/keepproxy/usage.go     | 82 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 89 insertions(+), 5 deletions(-)
 create mode 100644 services/keepproxy/usage.go

  discards  af0b0f0aed160e5339b4156906668f1e4ad9857c (commit)
       via  cef8879203c34fe72725afee259d42bbc0bd5a69 (commit)

This update added new revisions after undoing existing revisions.  That is
to say, the old revision is not a strict subset of the new revision.  This
situation occurs when you --force push a change and generate a repository
containing something like this:

 * -- * -- B -- O -- O -- O (af0b0f0aed160e5339b4156906668f1e4ad9857c)
            \
             N -- N -- N (cef8879203c34fe72725afee259d42bbc0bd5a69)

When this happens we assume that you've already had alert emails for all
of the O revisions, and so we here report only the revisions in the N
branch from the common base, B.

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit cef8879203c34fe72725afee259d42bbc0bd5a69
Author: Tom Clegg <tom at curoverse.com>
Date:   Wed Sep 21 14:07:30 2016 -0400

    9955: Add keepproxy config file and systemd unit file.

diff --git a/sdk/go/arvados/duration.go b/sdk/go/arvados/duration.go
index 1639c58..7b87aee 100644
--- a/sdk/go/arvados/duration.go
+++ b/sdk/go/arvados/duration.go
@@ -13,9 +13,7 @@ type Duration time.Duration
 // UnmarshalJSON implements json.Unmarshaler
 func (d *Duration) UnmarshalJSON(data []byte) error {
 	if data[0] == '"' {
-		dur, err := time.ParseDuration(string(data[1 : len(data)-1]))
-		*d = Duration(dur)
-		return err
+		return d.Set(string(data[1 : len(data)-1]))
 	}
 	return fmt.Errorf("duration must be given as a string like \"600s\" or \"1h30m\"")
 }
@@ -29,3 +27,10 @@ func (d *Duration) MarshalJSON() ([]byte, error) {
 func (d Duration) String() string {
 	return time.Duration(d).String()
 }
+
+// Value implements flag.Value
+func (d *Duration) Set(s string) error {
+	dur, err := time.ParseDuration(s)
+	*d = Duration(dur)
+	return err
+}
diff --git a/services/keepproxy/keepproxy.go b/services/keepproxy/keepproxy.go
index 226c388..4666493 100644
--- a/services/keepproxy/keepproxy.go
+++ b/services/keepproxy/keepproxy.go
@@ -1,12 +1,10 @@
 package main
 
 import (
+	"encoding/json"
 	"errors"
 	"flag"
 	"fmt"
-	"git.curoverse.com/arvados.git/sdk/go/arvadosclient"
-	"git.curoverse.com/arvados.git/sdk/go/keepclient"
-	"github.com/gorilla/mux"
 	"io"
 	"io/ioutil"
 	"log"
@@ -18,98 +16,125 @@ import (
 	"sync"
 	"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/keepclient"
+	"github.com/coreos/go-systemd/daemon"
+	"github.com/gorilla/mux"
 )
 
-// Default TCP address on which to listen for requests.
-// Override with -listen.
-const DefaultAddr = ":25107"
+type Config struct {
+	Client          arvados.Client
+	Listen          string
+	DisableGet      bool
+	DisablePut      bool
+	DefaultReplicas int
+	Timeout         arvados.Duration
+	PIDFile         string
+	Debug           bool
+}
+
+func DefaultConfig() *Config {
+	return &Config{
+		Listen:  ":25107",
+		Timeout: arvados.Duration(15 * time.Second),
+	}
+}
 
 var listener net.Listener
 
 func main() {
-	var (
-		listen           string
-		no_get           bool
-		no_put           bool
-		default_replicas int
-		timeout          int64
-		pidfile          string
-	)
+	cfg := DefaultConfig()
 
 	flagset := flag.NewFlagSet("keepproxy", flag.ExitOnError)
-
-	flagset.StringVar(
-		&listen,
-		"listen",
-		DefaultAddr,
-		"Interface on which to listen for requests, in the format "+
-			"ipaddr:port. e.g. -listen=10.0.1.24:8000. Use -listen=:port "+
-			"to listen on all network interfaces.")
-
-	flagset.BoolVar(
-		&no_get,
-		"no-get",
-		false,
-		"If set, disable GET operations")
-
-	flagset.BoolVar(
-		&no_put,
-		"no-put",
-		false,
-		"If set, disable PUT operations")
-
-	flagset.IntVar(
-		&default_replicas,
-		"default-replicas",
-		2,
-		"Default number of replicas to write if not specified by the client.")
-
-	flagset.Int64Var(
-		&timeout,
-		"timeout",
-		15,
-		"Timeout on requests to internal Keep services (default 15 seconds)")
-
-	flagset.StringVar(
-		&pidfile,
-		"pid",
-		"",
-		"Path to write pid file")
-
+	flagset.Usage = usage
+
+	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)
+
+	var cfgPath string
+	const defaultCfgPath = "/etc/arvados/keepproxy/config.json"
+	flagset.StringVar(&cfgPath, "config", defaultCfgPath, "Configuration file `path`")
 	flagset.Parse(os.Args[1:])
 
-	arv, err := arvadosclient.MakeArvadosClient()
+	err := config.LoadFile(cfg, cfgPath)
+	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
+		}
+		if j, err := json.MarshalIndent(cfg, "", "    "); err == nil {
+			log.Print("Current configuration:\n", string(j))
+		}
+		cfg.Timeout = arvados.Duration(time.Duration(*timeoutSeconds) * time.Second)
+	}
+
+	arv, err := arvadosclient.New(&cfg.Client)
 	if err != nil {
 		log.Fatalf("Error setting up arvados client %s", err.Error())
 	}
 
-	if os.Getenv("ARVADOS_DEBUG") != "" {
+	if cfg.Debug {
 		keepclient.DebugPrintf = log.Printf
 	}
-	kc, err := keepclient.MakeKeepClient(&arv)
+	kc, err := keepclient.MakeKeepClient(arv)
 	if err != nil {
 		log.Fatalf("Error setting up keep client %s", err.Error())
 	}
 
-	if pidfile != "" {
-		f, err := os.Create(pidfile)
+	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("Error writing pid file (%s): %s", pidfile, err.Error())
+			log.Fatalf("write(%s): %s", cfg.PIDFile, err)
+		}
+		err = f.Sync()
+		if err != nil {
+			log.Fatal("sync(%s): %s", cfg.PIDFile, err)
 		}
-		fmt.Fprint(f, os.Getpid())
-		f.Close()
-		defer os.Remove(pidfile)
 	}
 
-	kc.Want_replicas = default_replicas
-	kc.Client.Timeout = time.Duration(timeout) * time.Second
+	if cfg.DefaultReplicas > 0 {
+		kc.Want_replicas = cfg.DefaultReplicas
+	}
+	kc.Client.Timeout = time.Duration(cfg.Timeout)
 	go kc.RefreshServices(5*time.Minute, 3*time.Second)
 
-	listener, err = net.Listen("tcp", listen)
+	listener, err = net.Listen("tcp", cfg.Listen)
 	if err != nil {
-		log.Fatalf("Could not listen on %v", listen)
+		log.Fatalf("listen(%s): %s", cfg.Listen, err)
+	}
+	if _, err := daemon.SdNotify("READY=1"); err != nil {
+		log.Printf("Error notifying init daemon: %v", err)
 	}
-	log.Printf("Arvados Keep proxy started listening on %v", listener.Addr())
+	log.Println("Listening at", listener.Addr())
 
 	// Shut down the server gracefully (by closing the listener)
 	// if SIGTERM is received.
@@ -123,7 +148,7 @@ func main() {
 	signal.Notify(term, syscall.SIGINT)
 
 	// Start serving requests.
-	http.Serve(listener, MakeRESTRouter(!no_get, !no_put, kc))
+	http.Serve(listener, MakeRESTRouter(!cfg.DisableGet, !cfg.DisablePut, kc))
 
 	log.Println("shutting down")
 }
diff --git a/services/keepproxy/keepproxy.service b/services/keepproxy/keepproxy.service
new file mode 100644
index 0000000..5bd3036
--- /dev/null
+++ b/services/keepproxy/keepproxy.service
@@ -0,0 +1,12 @@
+[Unit]
+Description=Arvados Keep Proxy
+Documentation=https://doc.arvados.org/
+After=network.target
+
+[Service]
+Type=notify
+ExecStart=/usr/bin/keepproxy
+Restart=always
+
+[Install]
+WantedBy=multi-user.target
diff --git a/services/keepproxy/usage.go b/services/keepproxy/usage.go
new file mode 100644
index 0000000..18bf0ad
--- /dev/null
+++ b/services/keepproxy/usage.go
@@ -0,0 +1,82 @@
+package main
+
+import (
+	"encoding/json"
+	"flag"
+	"fmt"
+	"os"
+)
+
+func usage() {
+	c := DefaultConfig()
+	c.Client.APIHost = "zzzzz.arvadosapi.com:443"
+	exampleConfigFile, err := json.MarshalIndent(c, "    ", "  ")
+	if err != nil {
+		panic(err)
+	}
+	fmt.Fprintf(os.Stderr, `
+
+Keepproxy forwards GET and PUT requests to keepstore servers.  See
+http://doc.arvados.org/install/install-keepproxy.html
+
+Usage: keepproxy [-config path/to/config.json]
+
+Options:
+`)
+	flag.PrintDefaults()
+	fmt.Fprintf(os.Stderr, `
+Example config file:
+    %s
+
+Client.APIHost:
+
+    Address (or address:port) of the Arvados API endpoint.
+
+Client.AuthToken:
+
+    Anonymous API token.
+
+Client.Insecure:
+
+    True if your Arvados API endpoint uses an unverifiable SSL/TLS
+    certificate.
+
+Listen:
+
+    Local port to listen on. Can be "address:port" or ":port", where
+    "address" is a host IP address or name and "port" is a port number
+    or name.
+
+DisableGet:
+
+    Respond 404 to GET and HEAD requests.
+
+DisablePut:
+
+    Respond 404 to PUT, POST, and OPTIONS requests.
+
+DefaultReplicas:
+
+    Default number of replicas to write if not specified by the
+    client. If this is zero or omitted, the site-wide
+    defaultCollectionReplication configuration will be used.
+
+Timeout:
+
+    Timeout for requests to keep services, with units (e.g., "120s",
+    "2m").
+
+PIDFile:
+
+    Path to PID file. During startup this file will be created if
+    needed, and locked using flock() until keepproxy exits. If it is
+    already locked, or any error is encountered while writing to it,
+    keepproxy will exit immediately. If omitted or empty, no PID file
+    will be used.
+
+Debug:
+
+    Enable debug logging.
+
+`, exampleConfigFile)
+}

-----------------------------------------------------------------------


hooks/post-receive
-- 




More information about the arvados-commits mailing list