portal/renterd/main.go

399 lines
14 KiB
Go

package renterd
import (
"context"
"flag"
"fmt"
"log"
"net"
"net/http"
"os"
"os/signal"
"path/filepath"
"strings"
"syscall"
"time"
"git.lumeweb.com/LumeWeb/portal/renterd/internal/node"
"go.sia.tech/core/types"
"go.sia.tech/jape"
"go.sia.tech/renterd/autopilot"
"go.sia.tech/renterd/build"
"go.sia.tech/renterd/bus"
"go.sia.tech/renterd/stores"
"go.sia.tech/renterd/tracing"
"go.sia.tech/renterd/wallet"
"go.sia.tech/renterd/worker"
"golang.org/x/term"
"gorm.io/gorm"
)
const (
// accountRefillInterval is the amount of time between refills of ephemeral
// accounts. If we conservatively assume that a good host charges 500 SC /
// TiB, we can pay for about 2.2 GiB with 1 SC. Since we want to refill
// ahead of time at 0.5 SC, that makes 1.1 GiB. Considering a 1 Gbps uplink
// that is shared across 30 uploads, we upload at around 33 Mbps to each
// host. That means uploading 1.1 GiB to drain 0.5 SC takes around 5
// minutes. That's why we assume 10 seconds to be more than frequent enough
// to refill an account when it's due for another refill.
defaultAccountRefillInterval = 10 * time.Second
)
var (
// to be supplied at build time
githash = "?"
builddate = "?"
// fetched once, then cached
apiPassword *string
apiAddr *string
seed *types.PrivateKey
ready = make(chan bool)
readyFired = false
shutdown = make(chan bool)
shutdownFired = false
)
func check(context string, err error) {
if err != nil {
log.Fatalf("%v: %v", context, err)
}
}
func GetAPIPassword() string {
if apiPassword == nil {
pw := os.Getenv("RENTERD_API_PASSWORD")
if pw != "" {
fmt.Println("Using RENTERD_API_PASSWORD environment variable.")
apiPassword = &pw
} else {
fmt.Print("Enter API password: ")
pw, err := term.ReadPassword(int(os.Stdin.Fd()))
fmt.Println()
if err != nil {
log.Fatal(err)
}
s := string(pw)
apiPassword = &s
}
}
return *apiPassword
}
func GetSeed() types.PrivateKey {
if seed == nil {
phrase := os.Getenv("RENTERD_SEED")
if phrase != "" {
fmt.Println("Using RENTERD_SEED environment variable")
} else {
fmt.Print("Enter seed: ")
pw, err := term.ReadPassword(int(os.Stdin.Fd()))
check("Could not read seed phrase:", err)
fmt.Println()
phrase = string(pw)
}
key, err := wallet.KeyFromPhrase(phrase)
if err != nil {
log.Fatal(err)
}
seed = &key
}
return *seed
}
type currencyVar types.Currency
func newCurrencyVar(c *types.Currency, d types.Currency) *currencyVar {
*c = d
return (*currencyVar)(c)
}
func (c *currencyVar) Set(s string) (err error) {
*(*types.Currency)(c), err = types.ParseCurrency(s)
return
}
func (c *currencyVar) String() string {
return strings.Replace((*types.Currency)(c).String(), " ", "", -1)
}
func flagCurrencyVar(c *types.Currency, name string, d types.Currency, usage string) {
flag.Var(newCurrencyVar(c, d), name, usage)
}
func getDBDialectorFromEnv() gorm.Dialector {
uri, user, password, dbName := stores.DBConfigFromEnv()
if uri == "" {
return nil
}
return stores.NewMySQLConnection(user, password, uri, dbName)
}
func parseEnvVar(s string, v interface{}) {
if env, ok := os.LookupEnv(s); ok {
if _, err := fmt.Sscan(env, v); err != nil {
log.Fatalf("failed to parse %s: %v", s, err)
}
fmt.Printf("Using %s environment variable\n", s)
}
}
func Main() {
log.SetFlags(0)
var nodeCfg struct {
shutdownTimeout time.Duration
}
var busCfg struct {
remoteAddr string
apiPassword string
node.BusConfig
}
busCfg.PersistInterval = 10 * time.Minute
busCfg.DBDialector = getDBDialectorFromEnv()
busCfg.Network = build.ConsensusNetwork
var workerCfg struct {
enabled bool
remoteAddrs string
apiPassword string
node.WorkerConfig
}
workerCfg.ContractLockTimeout = 30 * time.Second
var autopilotCfg struct {
enabled bool
node.AutopilotConfig
}
apiAddr = flag.String("http", build.DefaultAPIAddress, "address to serve API on")
tracingEnabled := flag.Bool("tracing-enabled", false, "Enables tracing through OpenTelemetry. If RENTERD_TRACING_ENABLED is set, it overwrites the CLI flag's value. Tracing can be configured using the standard OpenTelemetry environment variables. https://github.com/open-telemetry/opentelemetry-specification/blob/v1.8.0/specification/protocol/exporter.md")
tracingServiceInstanceId := flag.String("tracing-service-instance-id", "cluster", "ID of the service instance used for tracing. If RENTERD_TRACING_SERVICE_INSTANCE_ID is set, it overwrites the CLI flag's value.")
dir := flag.String("dir", ".", "directory to store node state in")
flag.StringVar(&busCfg.remoteAddr, "bus.remoteAddr", "", "URL of remote bus service - can be overwritten using RENTERD_BUS_REMOTE_ADDR environment variable")
flag.StringVar(&busCfg.apiPassword, "bus.apiPassword", "", "API password for remote bus service - can be overwritten using RENTERD_BUS_API_PASSWORD environment variable")
flag.BoolVar(&busCfg.Bootstrap, "bus.bootstrap", true, "bootstrap the gateway and consensus modules")
flag.StringVar(&busCfg.GatewayAddr, "bus.gatewayAddr", build.DefaultGatewayAddress, "address to listen on for Sia peer connections - can be overwritten using RENTERD_BUS_GATEWAY_ADDR environment variable")
flag.BoolVar(&workerCfg.enabled, "worker.enabled", true, "enable/disable creating a worker - can be overwritten using the RENTERD_WORKER_ENABLED environment variable")
flag.DurationVar(&workerCfg.BusFlushInterval, "worker.busFlushInterval", 5*time.Second, "time after which the worker flushes buffered data to bus for persisting")
flag.StringVar(&workerCfg.WorkerConfig.ID, "worker.id", "worker", "unique identifier of worker used internally - can be overwritten using the RENTERD_WORKER_ID environment variable")
flag.StringVar(&workerCfg.remoteAddrs, "worker.remoteAddrs", "", "URL of remote worker service(s). Multiple addresses can be provided by separating them with a semicolon. Can be overwritten using RENTERD_WORKER_REMOTE_ADDRS environment variable")
flag.StringVar(&workerCfg.apiPassword, "worker.apiPassword", "", "API password for remote worker service")
flag.DurationVar(&workerCfg.SessionLockTimeout, "worker.sessionLockTimeout", 30*time.Second, "the maximum amount of time a host should wait on the lock when the lock RPC is called")
flag.DurationVar(&workerCfg.SessionReconnectTimeout, "worker.sessionReconnectTimeout", 10*time.Second, "the maximum amount of time reconnecting a session is allowed to take")
flag.DurationVar(&workerCfg.SessionTTL, "worker.sessionTTL", 2*time.Minute, "the time a host session is valid for before reconnecting")
flag.DurationVar(&workerCfg.DownloadSectorTimeout, "worker.downloadSectorTimeout", 3*time.Second, "timeout applied to sector downloads when downloading a slab")
flag.DurationVar(&workerCfg.UploadSectorTimeout, "worker.uploadSectorTimeout", 5*time.Second, "timeout applied to sector uploads when uploading a slab")
flag.Uint64Var(&workerCfg.DownloadMaxOverdrive, "worker.downloadMaxOverdrive", 5, "maximum number of active overdrive workers when downloading a slab")
flag.Uint64Var(&workerCfg.UploadMaxOverdrive, "worker.uploadMaxOverdrive", 5, "maximum number of active overdrive workers when uploading a slab")
flag.DurationVar(&autopilotCfg.AccountsRefillInterval, "autopilot.accountRefillInterval", defaultAccountRefillInterval, "interval at which the autopilot checks the workers' accounts balance and refills them if necessary")
flag.BoolVar(&autopilotCfg.enabled, "autopilot.enabled", true, "enable/disable the autopilot - can be overwritten using the RENTERD_AUTOPILOT_ENABLED environment variable")
flag.DurationVar(&autopilotCfg.Heartbeat, "autopilot.heartbeat", 10*time.Minute, "interval at which autopilot loop runs")
flag.Float64Var(&autopilotCfg.MigrationHealthCutoff, "autopilot.migrationHealthCutoff", 0.75, "health threshold below which slabs are migrated to new hosts")
flag.DurationVar(&autopilotCfg.ScannerInterval, "autopilot.scannerInterval", 24*time.Hour, "interval at which hosts are scanned")
flag.Uint64Var(&autopilotCfg.ScannerBatchSize, "autopilot.scannerBatchSize", 1000, "size of the batch with which hosts are scanned")
flag.Uint64Var(&autopilotCfg.ScannerMinRecentFailures, "autopilot.scannerMinRecentFailures", 10, "minimum amount of consesutive failed scans a host must have before it is removed for exceeding the max downtime")
flag.Uint64Var(&autopilotCfg.ScannerNumThreads, "autopilot.scannerNumThreads", 100, "number of threads that scan hosts")
flag.DurationVar(&nodeCfg.shutdownTimeout, "node.shutdownTimeout", 5*time.Minute, "the timeout applied to the node shutdown")
flag.Parse()
log.Println("renterd v0.1.0")
log.Println("Network", build.ConsensusNetworkName)
if flag.Arg(0) == "version" {
log.Println("Commit:", githash)
log.Println("Build Date:", builddate)
return
} else if flag.Arg(0) == "seed" {
log.Println("Seed phrase:", wallet.NewSeedPhrase())
return
}
// Overwrite flags from environment if set.
parseEnvVar("RENTERD_BUS_REMOTE_ADDR", &busCfg.remoteAddr)
parseEnvVar("RENTERD_BUS_API_PASSWORD", &busCfg.apiPassword)
parseEnvVar("RENTERD_BUS_GATEWAY_ADDR", &busCfg.GatewayAddr)
parseEnvVar("RENTERD_WORKER_REMOTE_ADDRS", &workerCfg.remoteAddrs)
parseEnvVar("RENTERD_WORKER_API_PASSWORD", &workerCfg.apiPassword)
parseEnvVar("RENTERD_WORKER_ENABLED", &workerCfg.enabled)
parseEnvVar("RENTERD_WORKER_ID", &workerCfg.ID)
parseEnvVar("RENTERD_AUTOPILOT_ENABLED", &autopilotCfg.enabled)
parseEnvVar("RENTERD_TRACING_ENABLED", tracingEnabled)
parseEnvVar("RENTERD_TRACING_SERVICE_INSTANCE_ID", tracingServiceInstanceId)
var autopilotShutdownFn func(context.Context) error
var shutdownFns []func(context.Context) error
// Init tracing.
if *tracingEnabled {
shutdownFn, err := tracing.Init(*tracingServiceInstanceId)
if err != nil {
log.Fatal("failed to init tracing", err)
}
shutdownFns = append(shutdownFns, shutdownFn)
}
if busCfg.remoteAddr != "" && workerCfg.remoteAddrs != "" && !autopilotCfg.enabled {
log.Fatal("remote bus, remote worker, and no autopilot -- nothing to do!")
}
if workerCfg.remoteAddrs == "" && !workerCfg.enabled && autopilotCfg.enabled {
log.Fatal("can't enable autopilot without providing either workers to connect to or creating a worker")
}
// create listener first, so that we know the actual apiAddr if the user
// specifies port :0
l, err := net.Listen("tcp", *apiAddr)
if err != nil {
log.Fatal("failed to create listener", err)
}
shutdownFns = append(shutdownFns, func(_ context.Context) error {
_ = l.Close()
return nil
})
*apiAddr = "http://" + l.Addr().String()
auth := jape.BasicAuth(GetAPIPassword())
mux := treeMux{
h: createUIHandler(),
sub: make(map[string]treeMux),
}
// Create logger.
renterdLog := filepath.Join(*dir, "renterd.log")
logger, closeFn, err := node.NewLogger(renterdLog)
if err != nil {
log.Fatal("failed to create logger", err)
}
shutdownFns = append(shutdownFns, closeFn)
busAddr, busPassword := busCfg.remoteAddr, busCfg.apiPassword
if busAddr == "" {
b, shutdownFn, err := node.NewBus(busCfg.BusConfig, *dir, GetSeed(), logger)
if err != nil {
log.Fatal("failed to create bus, err: ", err)
}
shutdownFns = append(shutdownFns, shutdownFn)
mux.sub["/api/bus"] = treeMux{h: auth(b)}
busAddr = *apiAddr + "/api/bus"
busPassword = GetAPIPassword()
} else {
fmt.Println("connecting to remote bus at", busAddr)
}
bc := bus.NewClient(busAddr, busPassword)
var workers []autopilot.Worker
workerAddrs, workerPassword := workerCfg.remoteAddrs, workerCfg.apiPassword
if workerAddrs == "" {
if workerCfg.enabled {
w, shutdownFn, err := node.NewWorker(workerCfg.WorkerConfig, bc, GetSeed(), logger)
if err != nil {
log.Fatal("failed to create worker", err)
}
shutdownFns = append(shutdownFns, shutdownFn)
mux.sub["/api/worker"] = treeMux{h: auth(w)}
workerAddr := *apiAddr + "/api/worker"
workerPassword = GetAPIPassword()
workers = append(workers, worker.NewClient(workerAddr, workerPassword))
}
} else {
// TODO: all workers use the same password. Figure out a nice way to
// have individual passwords.
workerAddrsSplit := strings.Split(workerAddrs, ";")
for _, workerAddr := range workerAddrsSplit {
workers = append(workers, worker.NewClient(workerAddr, workerPassword))
fmt.Println("connecting to remote worker at", workerAddr)
}
}
autopilotErr := make(chan error, 1)
if autopilotCfg.enabled {
autopilotDir := filepath.Join(*dir, "autopilot")
if err := os.MkdirAll(autopilotDir, 0700); err != nil {
log.Fatal("failed to create autopilot dir", err)
}
s, err := stores.NewJSONAutopilotStore(autopilotDir)
if err != nil {
log.Fatal("failed to create JSON autopilot store", err)
}
ap, runFn, shutdownFn, err := node.NewAutopilot(autopilotCfg.AutopilotConfig, s, bc, workers, logger)
if err != nil {
log.Fatal("failed to create autopilot", err)
}
// NOTE: the autopilot shutdown function is not added to the shutdown
// functions array because it needs to be called first
autopilotShutdownFn = shutdownFn
go func() { autopilotErr <- runFn() }()
mux.sub["/api/autopilot"] = treeMux{h: auth(ap)}
}
srv := &http.Server{Handler: mux}
go srv.Serve(l)
log.Println("api: Listening on", l.Addr())
syncerAddress, err := bc.SyncerAddress(context.Background())
if err != nil {
log.Fatal("failed to fetch syncer address", err)
}
log.Println("bus: Listening on", syncerAddress)
signalCh := make(chan os.Signal, 1)
signal.Notify(signalCh, os.Interrupt, syscall.SIGTERM)
ready <- true
select {
case <-signalCh:
log.Println("Shutting down...")
shutdownFns = append(shutdownFns, srv.Shutdown)
case err := <-autopilotErr:
log.Fatalln("Fatal autopilot error:", err)
}
// Shut down the autopilot first, then the rest of the services in reverse order.
ctx, cancel := context.WithTimeout(context.Background(), nodeCfg.shutdownTimeout)
defer cancel()
if autopilotShutdownFn != nil {
if err := autopilotShutdownFn(ctx); err != nil {
log.Fatalf("Failed to shut down autopilot: %v", err)
}
}
for i := len(shutdownFns) - 1; i >= 0; i-- {
if err := shutdownFns[i](ctx); err != nil {
log.Fatalf("Shutdown function %v failed: %v", i+1, err)
}
}
shutdown <- true
}
func GetApiAddr() string {
return *apiAddr
}
func Ready() bool {
if readyFired {
return true
}
readyFired = <-ready
return true
}
func ShutdownComplete() bool {
if shutdownFired {
return true
}
shutdownFired = <-shutdown
return true
}