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 to
15 # config.yml. After adding the output of config:migrate to
16 # /etc/arvados/config.yml, you will be able to delete application.yml.
18 require 'config_loader'
19 require 'config_validators'
22 # Load the defaults, used by config:migrate and fallback loading
23 # legacy application.yml
24 defaultYAML, stderr, status = Open3.capture3("arvados-server", "config-dump", "-config=-", "-skip-legacy", stdin_data: "Clusters: {xxxxx: {}}")
27 raise "error loading config: #{status}"
29 confs = YAML.load(defaultYAML, deserialize_symbols: false)
30 clusterID, clusterConfig = confs["Clusters"].first
31 $arvados_config_defaults = clusterConfig
32 $arvados_config_defaults["ClusterID"] = clusterID
34 # Load the global config file
35 Open3.popen2("arvados-server", "config-dump", "-skip-legacy") do |stdin, stdout, status_thread|
36 confs = YAML.load(stdout, deserialize_symbols: false)
37 if confs && !confs.empty?
38 # config-dump merges defaults with user configuration, so every
40 clusterID, clusterConfig = confs["Clusters"].first
41 $arvados_config_global = clusterConfig
42 $arvados_config_global["ClusterID"] = clusterID
44 # config-dump failed, assume we will be loading from legacy
45 # application.yml, initialize with defaults.
46 $arvados_config_global = $arvados_config_defaults.deep_dup
51 $arvados_config = $arvados_config_global.deep_dup
53 # Declare all our configuration items.
54 arvcfg = ConfigLoader.new
56 arvcfg.declare_config "ManagementToken", String, :ManagementToken
57 arvcfg.declare_config "TLS.Insecure", Boolean, :arvados_insecure_https
58 arvcfg.declare_config "Collections.TrustAllContent", Boolean, :trust_all_content
60 arvcfg.declare_config "Services.Controller.ExternalURL", URI, :arvados_v1_base, ->(cfg, k, v) {
63 ConfigLoader.set_cfg cfg, "Services.Controller.ExternalURL", u
66 arvcfg.declare_config "Services.WebShell.ExternalURL", URI, :shell_in_a_box_url, ->(cfg, k, v) {
68 u = URI(v.sub("%{hostname}", "*"))
70 ConfigLoader.set_cfg cfg, "Services.WebShell.ExternalURL", u
73 arvcfg.declare_config "Services.WebDAV.ExternalURL", URI, :keep_web_url, ->(cfg, k, v) {
75 u = URI(v.sub("%{uuid_or_pdh}", "*"))
77 ConfigLoader.set_cfg cfg, "Services.WebDAV.ExternalURL", u
80 arvcfg.declare_config "Services.WebDAVDownload.ExternalURL", URI, :keep_web_download_url, ->(cfg, k, v) {
82 u = URI(v.sub("%{uuid_or_pdh}", "*"))
84 ConfigLoader.set_cfg cfg, "Services.WebDAVDownload.ExternalURL", u
87 arvcfg.declare_config "Services.Composer.ExternalURL", URI, :composer_url
88 arvcfg.declare_config "Services.Workbench2.ExternalURL", URI, :workbench2_url
90 arvcfg.declare_config "Users.AnonymousUserToken", String, :anonymous_user_token
92 arvcfg.declare_config "Workbench.SecretKeyBase", String, :secret_key_base
94 arvcfg.declare_config "Workbench.ApplicationMimetypesWithViewIcon", Hash, :application_mimetypes_with_view_icon, ->(cfg, k, v) {
99 ConfigLoader.set_cfg cfg, "Workbench.ApplicationMimetypesWithViewIcon", mimetypes
102 arvcfg.declare_config "Workbench.RunningJobLogRecordsToFetch", Integer, :running_job_log_records_to_fetch
103 arvcfg.declare_config "Workbench.LogViewerMaxBytes", Integer, :log_viewer_max_bytes
104 arvcfg.declare_config "Workbench.ProfilingEnabled", Boolean, :profiling_enabled
105 arvcfg.declare_config "Workbench.APIResponseCompression", Boolean, :api_response_compression
106 arvcfg.declare_config "Workbench.UserProfileFormFields", Hash, :user_profile_form_fields, ->(cfg, k, v) {
111 v.each_with_index do |s,i|
112 entries[s["key"]] = {
114 "FormFieldTitle" => s["form_field_title"],
115 "FormFieldDescription" => s["form_field_description"],
116 "Required" => s["required"],
120 entries[s["key"]]["Options"] = {}
121 s["options"].each do |o|
122 entries[s["key"]]["Options"][o] = {}
126 ConfigLoader.set_cfg cfg, "Workbench.UserProfileFormFields", entries
128 arvcfg.declare_config "Workbench.UserProfileFormMessage", String, :user_profile_form_message
129 arvcfg.declare_config "Workbench.Theme", String, :arvados_theme
130 arvcfg.declare_config "Workbench.ShowUserNotifications", Boolean, :show_user_notifications
131 arvcfg.declare_config "Workbench.ShowUserAgreementInline", Boolean, :show_user_agreement_inline
132 arvcfg.declare_config "Workbench.RepositoryCache", String, :repository_cache
133 arvcfg.declare_config "Workbench.Repositories", Boolean, :repositories
134 arvcfg.declare_config "Workbench.APIClientConnectTimeout", ActiveSupport::Duration, :api_client_connect_timeout
135 arvcfg.declare_config "Workbench.APIClientReceiveTimeout", ActiveSupport::Duration, :api_client_receive_timeout
136 arvcfg.declare_config "Workbench.APIResponseCompression", Boolean, :api_response_compression
137 arvcfg.declare_config "Workbench.SiteName", String, :site_name
138 arvcfg.declare_config "Workbench.MultiSiteSearch", String, :multi_site_search, ->(cfg, k, v) {
142 ConfigLoader.set_cfg cfg, "Workbench.MultiSiteSearch", v.to_s
144 arvcfg.declare_config "Workbench.EnablePublicProjectsPage", Boolean, :enable_public_projects_page
145 arvcfg.declare_config "Workbench.EnableGettingStartedPopup", Boolean, :enable_getting_started_popup
146 arvcfg.declare_config "Workbench.ArvadosPublicDataDocURL", String, :arvados_public_data_doc_url
147 arvcfg.declare_config "Workbench.ArvadosDocsite", String, :arvados_docsite
148 arvcfg.declare_config "Workbench.ShowRecentCollectionsOnDashboard", Boolean, :show_recent_collections_on_dashboard
149 arvcfg.declare_config "Workbench.ActivationContactLink", String, :activation_contact_link
150 arvcfg.declare_config "Workbench.DefaultOpenIdPrefix", String, :default_openid_prefix
152 arvcfg.declare_config "Mail.SendUserSetupNotificationEmail", Boolean, :send_user_setup_notification_email
153 arvcfg.declare_config "Mail.IssueReporterEmailFrom", String, :issue_reporter_email_from
154 arvcfg.declare_config "Mail.IssueReporterEmailTo", String, :issue_reporter_email_to
155 arvcfg.declare_config "Mail.SupportEmailAddress", String, :support_email_address
156 arvcfg.declare_config "Mail.EmailFrom", String, :email_from
158 application_config = {}
159 %w(application.default application).each do |cfgfile|
160 path = "#{::Rails.root.to_s}/config/#{cfgfile}.yml"
161 confs = ConfigLoader.load(path, erb: true)
162 # Ignore empty YAML file:
163 next if confs == false
164 application_config.deep_merge!(confs['common'] || {})
165 application_config.deep_merge!(confs[::Rails.env.to_s] || {})
168 $remaining_config = arvcfg.migrate_config(application_config, $arvados_config)
170 # Checks for wrongly typed configuration items, coerces properties
171 # into correct types (such as Duration), and optionally raise error
172 # for essential configuration that can't be empty.
173 arvcfg.coercion_and_check $arvados_config_defaults, check_nonempty: false
174 arvcfg.coercion_and_check $arvados_config_global, check_nonempty: false
175 arvcfg.coercion_and_check $arvados_config, check_nonempty: true
177 # * $arvados_config_defaults is the defaults
178 # * $arvados_config_global is $arvados_config_defaults merged with the contents of /etc/arvados/config.yml
179 # These are used by the rake config: tasks
181 # * $arvados_config is $arvados_config_global merged with the migrated contents of application.yml
182 # This is what actually gets copied into the Rails configuration object.
184 ArvadosWorkbench::Application.configure do
185 # Copy into the Rails config object. This also turns Hash into
186 # OrderedOptions so that application code can use
187 # Rails.configuration.API.Blah instead of
188 # Rails.configuration.API["Blah"]
189 ConfigLoader.copy_into_config $arvados_config, config
190 ConfigLoader.copy_into_config $remaining_config, config
191 secrets.secret_key_base = $arvados_config["Workbench"]["SecretKeyBase"]
192 ConfigValidators.validate_wb2_url_config()
193 ConfigValidators.validate_download_config()