services/api/config/arvados_config.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 #
   6 # Load Arvados configuration from /etc/arvados/config.yml, using defaults
   7 # from config.default.yml
   8 #
   9 # Existing application.yml is migrated into the new config structure.
  10 # Keys in the legacy application.yml take precedence.
  11 #
  12 # Use "bundle exec config:dump" to get the complete active configuration
  13 #
  14 # Use "bundle exec config:migrate" to migrate application.yml and
  15 # database.yml to config.yml.  After adding the output of
  16 # config:migrate to /etc/arvados/config.yml, you will be able to
  17 # delete application.yml and database.yml.
  18
  19 require "cgi"
  20 require 'config_loader'
  21 require 'open3'
  22
  23 begin
  24   # If secret_token.rb exists here, we need to load it first.
  25   require_relative 'secret_token.rb'
  26 rescue LoadError
  27   # Normally secret_token.rb is missing and the secret token is
  28   # configured by application.yml (i.e., here!) instead.
  29 end
  30
  31 if (File.exist?(File.expand_path '../omniauth.rb', __FILE__) and
  32     not defined? WARNED_OMNIAUTH_CONFIG)
  33   Rails.logger.warn <<-EOS
  34 DEPRECATED CONFIGURATION:
  35  Please move your SSO provider config into config/application.yml
  36  and delete config/initializers/omniauth.rb.
  37 EOS
  38   # Real values will be copied from globals by omniauth_init.rb. For
  39   # now, assign some strings so the generic *.yml config loader
  40   # doesn't overwrite them or complain that they're missing.
  41   Rails.configuration.Login["SSO"]["ProviderAppID"] = 'xxx'
  42   Rails.configuration.Login["SSO"]["ProviderAppSecret"] = 'xxx'
  43   Rails.configuration.Services["SSO"]["ExternalURL"] = '//xxx'
  44   WARNED_OMNIAUTH_CONFIG = true
  45 end
  46
  47 # Load the defaults, used by config:migrate and fallback loading
  48 # legacy application.yml
  49 Open3.popen2("arvados-server", "config-dump", "-config=-", "-skip-legacy") do |stdin, stdout, status_thread|
  50   stdin.write("Clusters: {xxxxx: {}}")
  51   stdin.close
  52   confs = YAML.load(stdout, deserialize_symbols: false)
  53   clusterID, clusterConfig = confs["Clusters"].first
  54   $arvados_config_defaults = clusterConfig
  55   $arvados_config_defaults["ClusterID"] = clusterID
  56 end
  57
  58 # Load the global config file
  59 Open3.popen2("arvados-server", "config-dump", "-skip-legacy") do |stdin, stdout, status_thread|
  60   confs = YAML.load(stdout, deserialize_symbols: false)
  61   if confs && !confs.empty?
  62     # config-dump merges defaults with user configuration, so every
  63     # key should be set.
  64     clusterID, clusterConfig = confs["Clusters"].first
  65     $arvados_config_global = clusterConfig
  66     $arvados_config_global["ClusterID"] = clusterID
  67   else
  68     # config-dump failed, assume we will be loading from legacy
  69     # application.yml, initialize with defaults.
  70     $arvados_config_global = $arvados_config_defaults.deep_dup
  71   end
  72 end
  73
  74 # Now make a copy
  75 $arvados_config = $arvados_config_global.deep_dup
  76
  77 def arrayToHash cfg, k, v
  78   val = {}
  79   v.each do |entry|
  80     val[entry.to_s] = {}
  81   end
  82   ConfigLoader.set_cfg cfg, k, val
  83 end
  84
  85 # Declare all our configuration items.
  86 arvcfg = ConfigLoader.new
  87 arvcfg.declare_config "ClusterID", NonemptyString, :uuid_prefix
  88 arvcfg.declare_config "ManagementToken", String, :ManagementToken
  89 arvcfg.declare_config "SystemRootToken", String
  90 arvcfg.declare_config "Git.Repositories", String, :git_repositories_dir
  91 arvcfg.declare_config "API.DisabledAPIs", Hash, :disable_api_methods, ->(cfg, k, v) { arrayToHash cfg, "API.DisabledAPIs", v }
  92 arvcfg.declare_config "API.MaxRequestSize", Integer, :max_request_size
  93 arvcfg.declare_config "API.MaxIndexDatabaseRead", Integer, :max_index_database_read
  94 arvcfg.declare_config "API.MaxItemsPerResponse", Integer, :max_items_per_response
  95 arvcfg.declare_config "API.AsyncPermissionsUpdateInterval", ActiveSupport::Duration, :async_permissions_update_interval
  96 arvcfg.declare_config "API.RailsSessionSecretToken", NonemptyString, :secret_token
  97 arvcfg.declare_config "Users.AutoSetupNewUsers", Boolean, :auto_setup_new_users
  98 arvcfg.declare_config "Users.AutoSetupNewUsersWithVmUUID", String, :auto_setup_new_users_with_vm_uuid
  99 arvcfg.declare_config "Users.AutoSetupNewUsersWithRepository", Boolean, :auto_setup_new_users_with_repository
 100 arvcfg.declare_config "Users.AutoSetupUsernameBlacklist", Hash, :auto_setup_name_blacklist, ->(cfg, k, v) { arrayToHash cfg, "Users.AutoSetupUsernameBlacklist", v }
 101 arvcfg.declare_config "Users.NewUsersAreActive", Boolean, :new_users_are_active
 102 arvcfg.declare_config "Users.AutoAdminUserWithEmail", String, :auto_admin_user
 103 arvcfg.declare_config "Users.AutoAdminFirstUser", Boolean, :auto_admin_first_user
 104 arvcfg.declare_config "Users.UserProfileNotificationAddress", String, :user_profile_notification_address
 105 arvcfg.declare_config "Users.AdminNotifierEmailFrom", String, :admin_notifier_email_from
 106 arvcfg.declare_config "Users.EmailSubjectPrefix", String, :email_subject_prefix
 107 arvcfg.declare_config "Users.UserNotifierEmailFrom", String, :user_notifier_email_from
 108 arvcfg.declare_config "Users.NewUserNotificationRecipients", Hash, :new_user_notification_recipients, ->(cfg, k, v) { arrayToHash cfg, "Users.NewUserNotificationRecipients", v }
 109 arvcfg.declare_config "Users.NewInactiveUserNotificationRecipients", Hash, :new_inactive_user_notification_recipients, method(:arrayToHash)
 110 arvcfg.declare_config "Login.SSO.ProviderAppSecret", String, :sso_app_secret
 111 arvcfg.declare_config "Login.SSO.ProviderAppID", String, :sso_app_id
 112 arvcfg.declare_config "Login.LoginCluster", String
 113 arvcfg.declare_config "Login.RemoteTokenRefresh", ActiveSupport::Duration
 114 arvcfg.declare_config "TLS.Insecure", Boolean, :sso_insecure
 115 arvcfg.declare_config "Services.SSO.ExternalURL", String, :sso_provider_url
 116 arvcfg.declare_config "AuditLogs.MaxAge", ActiveSupport::Duration, :max_audit_log_age
 117 arvcfg.declare_config "AuditLogs.MaxDeleteBatch", Integer, :max_audit_log_delete_batch
 118 arvcfg.declare_config "AuditLogs.UnloggedAttributes", Hash, :unlogged_attributes, ->(cfg, k, v) { arrayToHash cfg, "AuditLogs.UnloggedAttributes", v }
 119 arvcfg.declare_config "SystemLogs.MaxRequestLogParamsSize", Integer, :max_request_log_params_size
 120 arvcfg.declare_config "Collections.DefaultReplication", Integer, :default_collection_replication
 121 arvcfg.declare_config "Collections.DefaultTrashLifetime", ActiveSupport::Duration, :default_trash_lifetime
 122 arvcfg.declare_config "Collections.CollectionVersioning", Boolean, :collection_versioning
 123 arvcfg.declare_config "Collections.PreserveVersionIfIdle", ActiveSupport::Duration, :preserve_version_if_idle
 124 arvcfg.declare_config "Collections.TrashSweepInterval", ActiveSupport::Duration, :trash_sweep_interval
 125 arvcfg.declare_config "Collections.BlobSigningKey", NonemptyString, :blob_signing_key
 126 arvcfg.declare_config "Collections.BlobSigningTTL", ActiveSupport::Duration, :blob_signature_ttl
 127 arvcfg.declare_config "Collections.BlobSigning", Boolean, :permit_create_collection_with_unsigned_manifest, ->(cfg, k, v) { ConfigLoader.set_cfg cfg, "Collections.BlobSigning", !v }
 128 arvcfg.declare_config "Collections.ForwardSlashNameSubstitution", String
 129 arvcfg.declare_config "Containers.SupportedDockerImageFormats", Hash, :docker_image_formats, ->(cfg, k, v) { arrayToHash cfg, "Containers.SupportedDockerImageFormats", v }
 130 arvcfg.declare_config "Containers.LogReuseDecisions", Boolean, :log_reuse_decisions
 131 arvcfg.declare_config "Containers.DefaultKeepCacheRAM", Integer, :container_default_keep_cache_ram
 132 arvcfg.declare_config "Containers.MaxDispatchAttempts", Integer, :max_container_dispatch_attempts
 133 arvcfg.declare_config "Containers.MaxRetryAttempts", Integer, :container_count_max
 134 arvcfg.declare_config "Containers.UsePreemptibleInstances", Boolean, :preemptible_instances
 135 arvcfg.declare_config "Containers.MaxComputeVMs", Integer, :max_compute_nodes
 136 arvcfg.declare_config "Containers.Logging.LogBytesPerEvent", Integer, :crunch_log_bytes_per_event
 137 arvcfg.declare_config "Containers.Logging.LogSecondsBetweenEvents", ActiveSupport::Duration, :crunch_log_seconds_between_events
 138 arvcfg.declare_config "Containers.Logging.LogThrottlePeriod", ActiveSupport::Duration, :crunch_log_throttle_period
 139 arvcfg.declare_config "Containers.Logging.LogThrottleBytes", Integer, :crunch_log_throttle_bytes
 140 arvcfg.declare_config "Containers.Logging.LogThrottleLines", Integer, :crunch_log_throttle_lines
 141 arvcfg.declare_config "Containers.Logging.LimitLogBytesPerJob", Integer, :crunch_limit_log_bytes_per_job
 142 arvcfg.declare_config "Containers.Logging.LogPartialLineThrottlePeriod", ActiveSupport::Duration, :crunch_log_partial_line_throttle_period
 143 arvcfg.declare_config "Containers.Logging.LogUpdatePeriod", ActiveSupport::Duration, :crunch_log_update_period
 144 arvcfg.declare_config "Containers.Logging.LogUpdateSize", Integer, :crunch_log_update_size
 145 arvcfg.declare_config "Containers.Logging.MaxAge", ActiveSupport::Duration, :clean_container_log_rows_after
 146 arvcfg.declare_config "Containers.SLURM.Managed.DNSServerConfDir", Pathname, :dns_server_conf_dir
 147 arvcfg.declare_config "Containers.SLURM.Managed.DNSServerConfTemplate", Pathname, :dns_server_conf_template
 148 arvcfg.declare_config "Containers.SLURM.Managed.DNSServerReloadCommand", String, :dns_server_reload_command
 149 arvcfg.declare_config "Containers.SLURM.Managed.DNSServerUpdateCommand", String, :dns_server_update_command
 150 arvcfg.declare_config "Containers.SLURM.Managed.ComputeNodeDomain", String, :compute_node_domain
 151 arvcfg.declare_config "Containers.SLURM.Managed.ComputeNodeNameservers", Hash, :compute_node_nameservers, ->(cfg, k, v) { arrayToHash cfg, "Containers.SLURM.Managed.ComputeNodeNameservers", v }
 152 arvcfg.declare_config "Containers.SLURM.Managed.AssignNodeHostname", String, :assign_node_hostname
 153 arvcfg.declare_config "Containers.JobsAPI.Enable", String, :enable_legacy_jobs_api, ->(cfg, k, v) { ConfigLoader.set_cfg cfg, "Containers.JobsAPI.Enable", v.to_s }
 154 arvcfg.declare_config "Containers.JobsAPI.GitInternalDir", String, :git_internal_dir
 155 arvcfg.declare_config "Mail.MailchimpAPIKey", String, :mailchimp_api_key
 156 arvcfg.declare_config "Mail.MailchimpListID", String, :mailchimp_list_id
 157 arvcfg.declare_config "Services.Controller.ExternalURL", URI
 158 arvcfg.declare_config "Services.Workbench1.ExternalURL", URI, :workbench_address
 159 arvcfg.declare_config "Services.Websocket.ExternalURL", URI, :websocket_address
 160 arvcfg.declare_config "Services.WebDAV.ExternalURL", URI, :keep_web_service_url
 161 arvcfg.declare_config "Services.GitHTTP.ExternalURL", URI, :git_repo_https_base
 162 arvcfg.declare_config "Services.GitSSH.ExternalURL", URI, :git_repo_ssh_base, ->(cfg, k, v) { ConfigLoader.set_cfg cfg, "Services.GitSSH.ExternalURL", "ssh://#{v}" }
 163 arvcfg.declare_config "RemoteClusters", Hash, :remote_hosts, ->(cfg, k, v) {
 164   h = if cfg["RemoteClusters"] then
 165         cfg["RemoteClusters"].deep_dup
 166       else
 167         {}
 168       end
 169   v.each do |clusterid, host|
 170     if h[clusterid].nil?
 171       h[clusterid] = {
 172         "Host" => host,
 173         "Proxy" => true,
 174         "Scheme" => "https",
 175         "Insecure" => false,
 176         "ActivateUsers" => false
 177       }
 178     end
 179   end
 180   ConfigLoader.set_cfg cfg, "RemoteClusters", h
 181 }
 182 arvcfg.declare_config "RemoteClusters.*.Proxy", Boolean, :remote_hosts_via_dns
 183
 184 dbcfg = ConfigLoader.new
 185
 186 dbcfg.declare_config "PostgreSQL.ConnectionPool", Integer, :pool
 187 dbcfg.declare_config "PostgreSQL.Connection.host", String, :host
 188 dbcfg.declare_config "PostgreSQL.Connection.port", String, :port
 189 dbcfg.declare_config "PostgreSQL.Connection.user", String, :username
 190 dbcfg.declare_config "PostgreSQL.Connection.password", String, :password
 191 dbcfg.declare_config "PostgreSQL.Connection.dbname", String, :database
 192 dbcfg.declare_config "PostgreSQL.Connection.template", String, :template
 193 dbcfg.declare_config "PostgreSQL.Connection.encoding", String, :encoding
 194 dbcfg.declare_config "PostgreSQL.Connection.collation", String, :collation
 195
 196 application_config = {}
 197 %w(application.default application).each do |cfgfile|
 198   path = "#{::Rails.root.to_s}/config/#{cfgfile}.yml"
 199   confs = ConfigLoader.load(path, erb: true)
 200   # Ignore empty YAML file:
 201   next if confs == false
 202   application_config.deep_merge!(confs['common'] || {})
 203   application_config.deep_merge!(confs[::Rails.env.to_s] || {})
 204 end
 205
 206 db_config = {}
 207 path = "#{::Rails.root.to_s}/config/database.yml"
 208 if !ENV['ARVADOS_CONFIG_NOLEGACY'] && File.exist?(path)
 209   db_config = ConfigLoader.load(path, erb: true)
 210 end
 211
 212 $remaining_config = arvcfg.migrate_config(application_config, $arvados_config)
 213 dbcfg.migrate_config(db_config[::Rails.env.to_s] || {}, $arvados_config)
 214
 215 if application_config[:auto_activate_users_from]
 216   application_config[:auto_activate_users_from].each do |cluster|
 217     if $arvados_config.RemoteClusters[cluster]
 218       $arvados_config.RemoteClusters[cluster]["ActivateUsers"] = true
 219     end
 220   end
 221 end
 222
 223 if application_config[:host] || application_config[:port] || application_config[:scheme]
 224   if !application_config[:host] || application_config[:host].empty?
 225     raise "Must set 'host' when setting 'port' or 'scheme'"
 226   end
 227   $arvados_config.Services["Controller"]["ExternalURL"] = URI((application_config[:scheme] || "https")+"://"+application_config[:host]+
 228                                                               (if application_config[:port] then ":#{application_config[:port]}" else "" end))
 229 end
 230
 231 # Checks for wrongly typed configuration items, coerces properties
 232 # into correct types (such as Duration), and optionally raise error
 233 # for essential configuration that can't be empty.
 234 arvcfg.coercion_and_check $arvados_config_defaults, check_nonempty: false
 235 arvcfg.coercion_and_check $arvados_config_global, check_nonempty: false
 236 arvcfg.coercion_and_check $arvados_config, check_nonempty: true
 237 dbcfg.coercion_and_check $arvados_config, check_nonempty: true
 238
 239 # * $arvados_config_defaults is the defaults
 240 # * $arvados_config_global is $arvados_config_defaults merged with the contents of /etc/arvados/config.yml
 241 # These are used by the rake config: tasks
 242 #
 243 # * $arvados_config is $arvados_config_global merged with the migrated contents of application.yml
 244 # This is what actually gets copied into the Rails configuration object.
 245
 246 if $arvados_config["Collections"]["DefaultTrashLifetime"] < 86400.seconds then
 247   raise "default_trash_lifetime is %d, must be at least 86400" % Rails.configuration.Collections.DefaultTrashLifetime
 248 end
 249
 250 #
 251 # Special case for test database where there's no database.yml,
 252 # because the Arvados config.yml doesn't have a concept of multiple
 253 # rails environments.
 254 #
 255 if ::Rails.env.to_s == "test" && db_config["test"].nil?
 256   $arvados_config["PostgreSQL"]["Connection"]["dbname"] = "arvados_test"
 257 end
 258 if ::Rails.env.to_s == "test"
 259   # Use template0 when creating a new database. Avoids
 260   # character-encoding/collation problems.
 261   $arvados_config["PostgreSQL"]["Connection"]["template"] = "template0"
 262   # Some test cases depend on en_US.UTF-8 collation.
 263   $arvados_config["PostgreSQL"]["Connection"]["collation"] = "en_US.UTF-8"
 264 end
 265
 266 if $arvados_config["PostgreSQL"]["Connection"]["password"].empty?
 267   raise "Database password is empty, PostgreSQL section is: #{$arvados_config["PostgreSQL"]}"
 268 end
 269
 270 dbhost = $arvados_config["PostgreSQL"]["Connection"]["host"]
 271 if $arvados_config["PostgreSQL"]["Connection"]["port"] != 0
 272   dbhost += ":#{$arvados_config["PostgreSQL"]["Connection"]["port"]}"
 273 end
 274
 275 #
 276 # If DATABASE_URL is set, then ActiveRecord won't error out if database.yml doesn't exist.
 277 #
 278 # For config migration, we've previously populated the PostgreSQL
 279 # section of the config from database.yml
 280 #
 281 database_url = "postgresql://#{CGI.escape $arvados_config["PostgreSQL"]["Connection"]["user"]}:"+
 282                       "#{CGI.escape $arvados_config["PostgreSQL"]["Connection"]["password"]}@"+
 283                       "#{dbhost}/#{CGI.escape $arvados_config["PostgreSQL"]["Connection"]["dbname"]}?"+
 284                       "template=#{$arvados_config["PostgreSQL"]["Connection"]["template"]}&"+
 285                       "encoding=#{$arvados_config["PostgreSQL"]["Connection"]["client_encoding"]}&"+
 286                       "collation=#{$arvados_config["PostgreSQL"]["Connection"]["collation"]}&"+
 287                       "pool=#{$arvados_config["PostgreSQL"]["ConnectionPool"]}"
 288
 289 ENV["DATABASE_URL"] = database_url
 290
 291 Server::Application.configure do
 292   # Copy into the Rails config object.  This also turns Hash into
 293   # OrderedOptions so that application code can use
 294   # Rails.configuration.API.Blah instead of
 295   # Rails.configuration.API["Blah"]
 296   ConfigLoader.copy_into_config $arvados_config, config
 297   ConfigLoader.copy_into_config $remaining_config, config
 298   secrets.secret_key_base = $arvados_config["API"]["RailsSessionSecretToken"]
 299 end