open-nomad/nomad/config.go

210 lines
6.5 KiB
Go
Raw Normal View History

2015-06-01 15:49:10 +00:00
package nomad
import (
"fmt"
"io"
2015-06-03 10:26:50 +00:00
"net"
2015-06-03 10:58:00 +00:00
"os"
"runtime"
2015-06-05 21:54:45 +00:00
"time"
2015-06-01 15:49:10 +00:00
2015-06-03 10:58:00 +00:00
"github.com/hashicorp/memberlist"
"github.com/hashicorp/nomad/nomad/structs"
"github.com/hashicorp/nomad/scheduler"
2015-06-01 15:49:10 +00:00
"github.com/hashicorp/raft"
2015-06-03 10:58:00 +00:00
"github.com/hashicorp/serf/serf"
)
const (
DefaultRegion = "region1"
DefaultDC = "dc1"
2015-08-16 22:10:11 +00:00
DefaultSerfPort = 4648
2015-06-01 15:49:10 +00:00
)
// These are the protocol versions that Nomad can understand
const (
ProtocolVersionMin uint8 = 1
ProtocolVersionMax = 1
)
2015-06-03 10:58:00 +00:00
// ProtocolVersionMap is the mapping of Nomad protocol versions
// to Serf protocol versions. We mask the Serf protocols using
// our own protocol version.
var protocolVersionMap map[uint8]uint8
func init() {
protocolVersionMap = map[uint8]uint8{
1: 5,
}
}
2015-06-03 10:26:50 +00:00
var (
DefaultRPCAddr = &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 4647}
2015-06-03 10:26:50 +00:00
)
2015-06-01 15:49:10 +00:00
// Config is used to parameterize the server
type Config struct {
// Bootstrap mode is used to bring up the first Consul server.
// It is required so that it can elect a leader without any
// other nodes being present
Bootstrap bool
2015-06-03 10:58:00 +00:00
// BootstrapExpect mode is used to automatically bring up a collection of
// Consul servers. This can be used to automatically bring up a collection
// of nodes.
BootstrapExpect int
2015-06-01 15:49:10 +00:00
// DataDir is the directory to store our state in
DataDir string
2015-06-01 19:11:40 +00:00
// DevMode is used for development purposes only and limits the
// use of persistence or state.
DevMode bool
2015-06-05 21:54:45 +00:00
// DevDisableBootstrap is used to disable bootstrap mode while
// in DevMode. This is largely used for testing.
DevDisableBootstrap bool
2015-06-01 15:49:10 +00:00
// LogOutput is the location to write logs to. If this is not set,
// logs will go to stderr.
LogOutput io.Writer
// ProtocolVersion is the protocol version to speak. This must be between
// ProtocolVersionMin and ProtocolVersionMax.
ProtocolVersion uint8
2015-06-03 10:26:50 +00:00
// RPCAddr is the RPC address used by Nomad. This should be reachable
// by the other servers and clients
RPCAddr *net.TCPAddr
// RPCAdvertise is the address that is advertised to other nodes for
// the RPC endpoint. This can differ from the RPC address, if for example
// the RPCAddr is unspecified "0.0.0.0:4646", but this address must be
// reachable
RPCAdvertise *net.TCPAddr
2015-06-01 15:49:10 +00:00
// RaftConfig is the configuration used for Raft in the local DC
RaftConfig *raft.Config
2015-06-03 10:26:50 +00:00
// RaftTimeout is applied to any network traffic for raft. Defaults to 10s.
RaftTimeout time.Duration
2015-06-03 10:26:50 +00:00
// RequireTLS ensures that all RPC traffic is protected with TLS
RequireTLS bool
2015-06-03 10:58:00 +00:00
// SerfConfig is the configuration for the serf cluster
SerfConfig *serf.Config
// Node name is the name we use to advertise. Defaults to hostname.
NodeName string
// Region is the region this Nomad server belongs to.
Region string
// Datacenter is the datacenter this Nomad server belongs to.
Datacenter string
// Build is a string that is gossiped around, and can be used to help
// operators track which versions are actively deployed
Build string
2015-06-05 21:54:45 +00:00
// NumSchedulers is the number of scheduler thread that are run.
// This can be as many as one per core, or zero to disable this server
// from doing any scheduling work.
NumSchedulers int
// EnabledSchedulers controls the set of sub-schedulers that are
// enabled for this server to handle. This will restrict the evaluations
// that the workers dequeue for processing.
EnabledSchedulers []string
2015-08-17 00:44:18 +00:00
// ServerAddress is used by clients to connect to the servers.
// Defaults to "nomad.service.consul:4647"
ServerAddress []string
2015-06-05 21:54:45 +00:00
// ReconcileInterval controls how often we reconcile the strongly
// consistent store with the Serf info. This is used to handle nodes
// that are force removed, as well as intermittent unavailability during
// leader election.
ReconcileInterval time.Duration
2015-08-15 22:15:00 +00:00
// EvalGCInterval is how often we dispatch a job to GC evaluations
EvalGCInterval time.Duration
// EvalGCThreshold is how "old" an evaluation must be to be eligible
// for GC. This gives users some time to debug a failed evaluation.
EvalGCThreshold time.Duration
// EvalNackTimeout controls how long we allow a sub-scheduler to
// work on an evaluation before we consider it failed and Nack it.
// This allows that evaluation to be handed to another sub-scheduler
// to work on. Defaults to 60 seconds. This should be long enough that
// no evaluation hits it unless the sub-scheduler has failed.
EvalNackTimeout time.Duration
// EvalDeliveryLimit is the limit of attempts we make to deliver and
// process an evaluation. This is used so that an eval that will never
// complete eventually fails out of the system.
EvalDeliveryLimit int
2015-06-01 15:49:10 +00:00
}
// CheckVersion is used to check if the ProtocolVersion is valid
func (c *Config) CheckVersion() error {
if c.ProtocolVersion < ProtocolVersionMin {
return fmt.Errorf("Protocol version '%d' too low. Must be in range: [%d, %d]",
c.ProtocolVersion, ProtocolVersionMin, ProtocolVersionMax)
} else if c.ProtocolVersion > ProtocolVersionMax {
return fmt.Errorf("Protocol version '%d' too high. Must be in range: [%d, %d]",
c.ProtocolVersion, ProtocolVersionMin, ProtocolVersionMax)
}
return nil
}
// DefaultConfig returns the default configuration
func DefaultConfig() *Config {
2015-06-03 10:58:00 +00:00
hostname, err := os.Hostname()
if err != nil {
panic(err)
}
2015-06-01 15:49:10 +00:00
c := &Config{
2015-06-05 21:54:45 +00:00
Region: DefaultRegion,
Datacenter: DefaultDC,
NodeName: hostname,
ProtocolVersion: ProtocolVersionMax,
RaftConfig: raft.DefaultConfig(),
RaftTimeout: 10 * time.Second,
2015-06-05 21:54:45 +00:00
RPCAddr: DefaultRPCAddr,
SerfConfig: serf.DefaultConfig(),
NumSchedulers: 1,
2015-08-17 00:44:18 +00:00
ServerAddress: []string{"nomad.service.consul:4647"},
2015-06-05 21:54:45 +00:00
ReconcileInterval: 60 * time.Second,
2015-08-15 22:15:00 +00:00
EvalGCInterval: 60 * time.Second,
EvalGCThreshold: 1 * time.Hour,
EvalNackTimeout: 60 * time.Second,
EvalDeliveryLimit: 3,
2015-06-01 15:49:10 +00:00
}
2015-06-03 10:58:00 +00:00
// Enable all known schedulers by default
c.EnabledSchedulers = make([]string, 0, len(scheduler.BuiltinSchedulers))
for name := range scheduler.BuiltinSchedulers {
c.EnabledSchedulers = append(c.EnabledSchedulers, name)
}
c.EnabledSchedulers = append(c.EnabledSchedulers, structs.JobTypeCore)
// Default the number of schedulers to match the coores
c.NumSchedulers = runtime.NumCPU()
2015-06-05 22:32:28 +00:00
// Increase our reap interval to 3 days instead of 24h.
c.SerfConfig.ReconnectTimeout = 3 * 24 * time.Hour
2015-06-03 10:58:00 +00:00
// Serf should use the WAN timing, since we are using it
// to communicate between DC's
c.SerfConfig.MemberlistConfig = memberlist.DefaultWANConfig()
c.SerfConfig.MemberlistConfig.BindPort = DefaultSerfPort
// Disable shutdown on removal
c.RaftConfig.ShutdownOnRemove = false
2015-06-01 15:49:10 +00:00
return c
}