X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/71fd4da18b22100682ae7e2079aadfd66360d310..b30dca66a056bc6ee627bab5956dd8884a0e74aa:/sdk/go/arvados/config.go diff --git a/sdk/go/arvados/config.go b/sdk/go/arvados/config.go index 1154f922ba..6ec8f345d7 100644 --- a/sdk/go/arvados/config.go +++ b/sdk/go/arvados/config.go @@ -8,12 +8,19 @@ import ( "encoding/json" "errors" "fmt" + "net/url" "os" "git.curoverse.com/arvados.git/sdk/go/config" ) -const DefaultConfigFile = "/etc/arvados/config.yml" +var DefaultConfigFile = func() string { + if path := os.Getenv("ARVADOS_CONFIG"); path != "" { + return path + } else { + return "/etc/arvados/config.yml" + } +}() type Config struct { Clusters map[string]Cluster @@ -50,100 +57,355 @@ func (sc *Config) GetCluster(clusterID string) (*Cluster, error) { } } -type RequestLimits struct { - MaxItemsPerResponse int - MultiClusterRequestConcurrency int +type WebDAVCacheConfig struct { + TTL Duration + UUIDTTL Duration + MaxBlockEntries int + MaxCollectionEntries int + MaxCollectionBytes int64 + MaxPermissionEntries int + MaxUUIDEntries int } - type Cluster struct { - ClusterID string `json:"-"` - ManagementToken string - NodeProfiles map[string]NodeProfile - InstanceTypes InstanceTypeMap - CloudVMs CloudVMs - Dispatch Dispatch - HTTPRequestTimeout Duration - RemoteClusters map[string]RemoteCluster - PostgreSQL PostgreSQL - RequestLimits RequestLimits + ClusterID string `json:"-"` + ManagementToken string + SystemRootToken string + Services Services + InstanceTypes InstanceTypeMap + Containers ContainersConfig + RemoteClusters map[string]RemoteCluster + PostgreSQL PostgreSQL + + API struct { + AsyncPermissionsUpdateInterval Duration + DisabledAPIs StringSet + MaxIndexDatabaseRead int + MaxItemsPerResponse int + MaxConcurrentRequests int + MaxKeepBlobBuffers int + MaxRequestAmplification int + MaxRequestSize int + RailsSessionSecretToken string + RequestTimeout Duration + SendTimeout Duration + WebsocketClientEventQueue int + WebsocketServerEventQueue int + KeepServiceRequestTimeout Duration + } + AuditLogs struct { + MaxAge Duration + MaxDeleteBatch int + UnloggedAttributes StringSet + } + Collections struct { + BlobSigning bool + BlobSigningKey string + BlobSigningTTL Duration + BlobTrash bool + BlobTrashLifetime Duration + BlobTrashCheckInterval Duration + BlobTrashConcurrency int + BlobDeleteConcurrency int + BlobReplicateConcurrency int + CollectionVersioning bool + DefaultTrashLifetime Duration + DefaultReplication int + ManagedProperties map[string]struct { + Value interface{} + Function string + Protected bool + } + PreserveVersionIfIdle Duration + TrashSweepInterval Duration + TrustAllContent bool + + BlobMissingReport string + BalancePeriod Duration + BalanceCollectionBatch int + BalanceCollectionBuffers int + + WebDAVCache WebDAVCacheConfig + } + Git struct { + GitCommand string + GitoliteHome string + Repositories string + } + Login struct { + GoogleClientID string + GoogleClientSecret string + ProviderAppID string + ProviderAppSecret string + LoginCluster string + RemoteTokenRefresh Duration + } + Mail struct { + MailchimpAPIKey string + MailchimpListID string + SendUserSetupNotificationEmail bool + IssueReporterEmailFrom string + IssueReporterEmailTo string + SupportEmailAddress string + EmailFrom string + } + SystemLogs struct { + LogLevel string + Format string + MaxRequestLogParamsSize int + } + TLS struct { + Certificate string + Key string + Insecure bool + } + Users struct { + AnonymousUserToken string + AdminNotifierEmailFrom string + AutoAdminFirstUser bool + AutoAdminUserWithEmail string + AutoSetupNewUsers bool + AutoSetupNewUsersWithRepository bool + AutoSetupNewUsersWithVmUUID string + AutoSetupUsernameBlacklist StringSet + EmailSubjectPrefix string + NewInactiveUserNotificationRecipients StringSet + NewUserNotificationRecipients StringSet + NewUsersAreActive bool + UserNotifierEmailFrom string + UserProfileNotificationAddress string + } + Volumes map[string]Volume + Workbench struct { + ActivationContactLink string + APIClientConnectTimeout Duration + APIClientReceiveTimeout Duration + APIResponseCompression bool + ApplicationMimetypesWithViewIcon StringSet + ArvadosDocsite string + ArvadosPublicDataDocURL string + DefaultOpenIdPrefix string + EnableGettingStartedPopup bool + EnablePublicProjectsPage bool + FileViewersConfigURL string + LogViewerMaxBytes ByteSize + MultiSiteSearch string + ProfilingEnabled bool + Repositories bool + RepositoryCache string + RunningJobLogRecordsToFetch int + SecretKeyBase string + ShowRecentCollectionsOnDashboard bool + ShowUserAgreementInline bool + ShowUserNotifications bool + SiteName string + Theme string + UserProfileFormFields map[string]struct { + Type string + FormFieldTitle string + FormFieldDescription string + Required bool + Position int + Options map[string]struct{} + } + UserProfileFormMessage string + VocabularyURL string + WelcomePageHTML string + InactivePageHTML string + } + + EnableBetaController14287 bool } -type PostgreSQL struct { - Connection PostgreSQLConnection - ConnectionPool int +type Volume struct { + AccessViaHosts map[URL]VolumeAccess + ReadOnly bool + Replication int + StorageClasses map[string]bool + Driver string + DriverParameters json.RawMessage } -type PostgreSQLConnection map[string]string +type S3VolumeDriverParameters struct { + AccessKey string + SecretKey string + Endpoint string + Region string + Bucket string + LocationConstraint bool + IndexPageSize int + ConnectTimeout Duration + ReadTimeout Duration + RaceWindow Duration + UnsafeDelete bool +} -type RemoteCluster struct { - // API endpoint host or host:port; default is {id}.arvadosapi.com - Host string - // Perform a proxy request when a local client requests an - // object belonging to this remote. - Proxy bool - // Scheme, default "https". Can be set to "http" for testing. - Scheme string - // Disable TLS verify. Can be set to true for testing. - Insecure bool +type AzureVolumeDriverParameters struct { + StorageAccountName string + StorageAccountKey string + StorageBaseURL string + ContainerName string + RequestTimeout Duration + ListBlobsRetryDelay Duration + ListBlobsMaxAttempts int } -type InstanceType struct { - Name string - ProviderType string - VCPUs int - RAM ByteSize - Scratch ByteSize - Price float64 - Preemptible bool +type DirectoryVolumeDriverParameters struct { + Root string + Serialize bool } -type Dispatch struct { - // PEM encoded SSH key (RSA, DSA, or ECDSA) able to log in to - // cloud VMs. - PrivateKey []byte +type VolumeAccess struct { + ReadOnly bool +} - // Max time for workers to come up before abandoning stale - // locks from previous run - StaleLockTimeout Duration +type Services struct { + Composer Service + Controller Service + DispatchCloud Service + GitHTTP Service + GitSSH Service + Health Service + Keepbalance Service + Keepproxy Service + Keepstore Service + Nodemanager Service + RailsAPI Service + SSO Service + WebDAVDownload Service + WebDAV Service + WebShell Service + Websocket Service + Workbench1 Service + Workbench2 Service +} - // Interval between queue polls - PollInterval Duration +type Service struct { + InternalURLs map[URL]ServiceInstance + ExternalURL URL +} - // Interval between probes to each worker - ProbeInterval Duration +// URL is a url.URL that is also usable as a JSON key/value. +type URL url.URL - // Maximum total worker probes per second - MaxProbesPerSecond int +// UnmarshalText implements encoding.TextUnmarshaler so URL can be +// used as a JSON key/value. +func (su *URL) UnmarshalText(text []byte) error { + u, err := url.Parse(string(text)) + if err == nil { + *su = URL(*u) + } + return err } -type CloudVMs struct { - // Shell command that exits zero IFF the VM is fully booted - // and ready to run containers, e.g., "mount | grep - // /encrypted-tmp" - BootProbeCommand string +func (su URL) MarshalText() ([]byte, error) { + return []byte(fmt.Sprintf("%s", (*url.URL)(&su).String())), nil +} - // Listening port (name or number) of SSH servers on worker - // VMs - SSHPort string +func (su URL) String() string { + return (*url.URL)(&su).String() +} - SyncInterval Duration +type ServiceInstance struct { + Rendezvous string `json:",omitempty"` +} - // Maximum idle time before automatic shutdown - TimeoutIdle Duration +type PostgreSQL struct { + Connection PostgreSQLConnection + ConnectionPool int +} + +type PostgreSQLConnection map[string]string - // Maximum booting time before automatic shutdown - TimeoutBooting Duration +type RemoteCluster struct { + Host string + Proxy bool + Scheme string + Insecure bool + ActivateUsers bool +} - // Maximum time with no successful probes before automatic shutdown - TimeoutProbe Duration +type InstanceType struct { + Name string + ProviderType string + VCPUs int + RAM ByteSize + Scratch ByteSize + IncludedScratch ByteSize + AddedScratch ByteSize + Price float64 + Preemptible bool +} - // Time after shutdown to retry shutdown - TimeoutShutdown Duration +type ContainersConfig struct { + CloudVMs CloudVMsConfig + CrunchRunCommand string + CrunchRunArgumentsList []string + DefaultKeepCacheRAM ByteSize + DispatchPrivateKey string + LogReuseDecisions bool + MaxComputeVMs int + MaxDispatchAttempts int + MaxRetryAttempts int + MinRetryPeriod Duration + ReserveExtraRAM ByteSize + StaleLockTimeout Duration + SupportedDockerImageFormats StringSet + UsePreemptibleInstances bool + + JobsAPI struct { + Enable string + GitInternalDir string + } + Logging struct { + MaxAge Duration + LogBytesPerEvent int + LogSecondsBetweenEvents int + LogThrottlePeriod Duration + LogThrottleBytes int + LogThrottleLines int + LimitLogBytesPerJob int + LogPartialLineThrottlePeriod Duration + LogUpdatePeriod Duration + LogUpdateSize ByteSize + } + SLURM struct { + PrioritySpread int64 + SbatchArgumentsList []string + SbatchEnvironmentVariables map[string]string + Managed struct { + DNSServerConfDir string + DNSServerConfTemplate string + DNSServerReloadCommand string + DNSServerUpdateCommand string + ComputeNodeDomain string + ComputeNodeNameservers StringSet + AssignNodeHostname string + } + } +} - ImageID string +type CloudVMsConfig struct { + Enable bool + + BootProbeCommand string + ImageID string + MaxCloudOpsPerSecond int + MaxProbesPerSecond int + PollInterval Duration + ProbeInterval Duration + SSHPort string + SyncInterval Duration + TimeoutBooting Duration + TimeoutIdle Duration + TimeoutProbe Duration + TimeoutShutdown Duration + TimeoutSignal Duration + TimeoutTERM Duration + ResourceTags map[string]string + TagKeyPrefix string Driver string - DriverParameters map[string]interface{} + DriverParameters json.RawMessage } type InstanceTypeMap map[string]InstanceType @@ -168,6 +430,20 @@ func (it *InstanceTypeMap) UnmarshalJSON(data []byte) error { if _, ok := (*it)[t.Name]; ok { return errDuplicateInstanceTypeName } + if t.ProviderType == "" { + t.ProviderType = t.Name + } + if t.Scratch == 0 { + t.Scratch = t.IncludedScratch + t.AddedScratch + } else if t.AddedScratch == 0 { + t.AddedScratch = t.Scratch - t.IncludedScratch + } else if t.IncludedScratch == 0 { + t.IncludedScratch = t.Scratch - t.AddedScratch + } + + if t.Scratch != (t.IncludedScratch + t.AddedScratch) { + return fmt.Errorf("%v: Scratch != (IncludedScratch + AddedScratch)", t.Name) + } (*it)[t.Name] = t } return nil @@ -177,50 +453,51 @@ func (it *InstanceTypeMap) UnmarshalJSON(data []byte) error { if err != nil { return err } - // Fill in Name field using hash key. + // Fill in Name field (and ProviderType field, if not + // specified) using hash key. *it = InstanceTypeMap(hash) for name, t := range *it { t.Name = name + if t.ProviderType == "" { + t.ProviderType = name + } (*it)[name] = t } return nil } -// GetNodeProfile returns a NodeProfile for the given hostname. An -// error is returned if the appropriate configuration can't be -// determined (e.g., this does not appear to be a system node). If -// node is empty, use the OS-reported hostname. -func (cc *Cluster) GetNodeProfile(node string) (*NodeProfile, error) { - if node == "" { - hostname, err := os.Hostname() +type StringSet map[string]struct{} + +// UnmarshalJSON handles old config files that provide an array of +// instance types instead of a hash. +func (ss *StringSet) UnmarshalJSON(data []byte) error { + if len(data) > 0 && data[0] == '[' { + var arr []string + err := json.Unmarshal(data, &arr) if err != nil { - return nil, err + return err } - node = hostname + if len(arr) == 0 { + *ss = nil + return nil + } + *ss = make(map[string]struct{}, len(arr)) + for _, t := range arr { + (*ss)[t] = struct{}{} + } + return nil } - if cfg, ok := cc.NodeProfiles[node]; ok { - return &cfg, nil + var hash map[string]struct{} + err := json.Unmarshal(data, &hash) + if err != nil { + return err } - // If node is not listed, but "*" gives a default system node - // config, use the default config. - if cfg, ok := cc.NodeProfiles["*"]; ok { - return &cfg, nil + *ss = make(map[string]struct{}, len(hash)) + for t, _ := range hash { + (*ss)[t] = struct{}{} } - return nil, fmt.Errorf("config does not provision host %q as a system node", node) -} -type NodeProfile struct { - Controller SystemServiceInstance `json:"arvados-controller"` - Health SystemServiceInstance `json:"arvados-health"` - Keepbalance SystemServiceInstance `json:"keep-balance"` - Keepproxy SystemServiceInstance `json:"keepproxy"` - Keepstore SystemServiceInstance `json:"keepstore"` - Keepweb SystemServiceInstance `json:"keep-web"` - Nodemanager SystemServiceInstance `json:"arvados-node-manager"` - DispatchCloud SystemServiceInstance `json:"arvados-dispatch-cloud"` - RailsAPI SystemServiceInstance `json:"arvados-api-server"` - Websocket SystemServiceInstance `json:"arvados-ws"` - Workbench SystemServiceInstance `json:"arvados-workbench"` + return nil } type ServiceName string @@ -229,8 +506,10 @@ const ( ServiceNameRailsAPI ServiceName = "arvados-api-server" ServiceNameController ServiceName = "arvados-controller" ServiceNameDispatchCloud ServiceName = "arvados-dispatch-cloud" + ServiceNameHealth ServiceName = "arvados-health" ServiceNameNodemanager ServiceName = "arvados-node-manager" - ServiceNameWorkbench ServiceName = "arvados-workbench" + ServiceNameWorkbench1 ServiceName = "arvados-workbench1" + ServiceNameWorkbench2 ServiceName = "arvados-workbench2" ServiceNameWebsocket ServiceName = "arvados-ws" ServiceNameKeepbalance ServiceName = "keep-balance" ServiceNameKeepweb ServiceName = "keep-web" @@ -238,39 +517,21 @@ const ( ServiceNameKeepstore ServiceName = "keepstore" ) -// ServicePorts returns the configured listening address (or "" if -// disabled) for each service on the node. -func (np *NodeProfile) ServicePorts() map[ServiceName]string { - return map[ServiceName]string{ - ServiceNameRailsAPI: np.RailsAPI.Listen, - ServiceNameController: np.Controller.Listen, - ServiceNameDispatchCloud: np.DispatchCloud.Listen, - ServiceNameNodemanager: np.Nodemanager.Listen, - ServiceNameWorkbench: np.Workbench.Listen, - ServiceNameWebsocket: np.Websocket.Listen, - ServiceNameKeepbalance: np.Keepbalance.Listen, - ServiceNameKeepweb: np.Keepweb.Listen, - ServiceNameKeepproxy: np.Keepproxy.Listen, - ServiceNameKeepstore: np.Keepstore.Listen, +// Map returns all services as a map, suitable for iterating over all +// services or looking up a service by name. +func (svcs Services) Map() map[ServiceName]Service { + return map[ServiceName]Service{ + ServiceNameRailsAPI: svcs.RailsAPI, + ServiceNameController: svcs.Controller, + ServiceNameDispatchCloud: svcs.DispatchCloud, + ServiceNameHealth: svcs.Health, + ServiceNameNodemanager: svcs.Nodemanager, + ServiceNameWorkbench1: svcs.Workbench1, + ServiceNameWorkbench2: svcs.Workbench2, + ServiceNameWebsocket: svcs.Websocket, + ServiceNameKeepbalance: svcs.Keepbalance, + ServiceNameKeepweb: svcs.WebDAV, + ServiceNameKeepproxy: svcs.Keepproxy, + ServiceNameKeepstore: svcs.Keepstore, } } - -func (h RequestLimits) GetMultiClusterRequestConcurrency() int { - if h.MultiClusterRequestConcurrency == 0 { - return 4 - } - return h.MultiClusterRequestConcurrency -} - -func (h RequestLimits) GetMaxItemsPerResponse() int { - if h.MaxItemsPerResponse == 0 { - return 1000 - } - return h.MaxItemsPerResponse -} - -type SystemServiceInstance struct { - Listen string - TLS bool - Insecure bool -}