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