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