apps/workbench/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 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.
  17
  18 require 'config_loader'
  19 require 'config_validators'
  20 require 'open3'
  21
  22 # Load the defaults, used by config:migrate and fallback loading
  23 # legacy application.yml
  24 Open3.popen2("arvados-server", "config-defaults") do |stdin, stdout, status_thread|
  25   confs = YAML.load(stdout, deserialize_symbols: false)
  26   clusterID, clusterConfig = confs["Clusters"].first
  27   $arvados_config_defaults = clusterConfig
  28   $arvados_config_defaults["ClusterID"] = clusterID
  29 end
  30
  31 # Load the global config file
  32 Open3.popen2("arvados-server", "config-dump") do |stdin, stdout, status_thread|
  33   confs = YAML.load(stdout, deserialize_symbols: false)
  34   if confs && !confs.empty?
  35     # config-dump merges defaults with user configuration, so every
  36     # key should be set.
  37     clusterID, clusterConfig = confs["Clusters"].first
  38     $arvados_config_global = clusterConfig
  39     $arvados_config_global["ClusterID"] = clusterID
  40   else
  41     # config-dump failed, assume we will be loading from legacy
  42     # application.yml, initialize with defaults.
  43     $arvados_config_global = $arvados_config_defaults.deep_dup
  44   end
  45 end
  46
  47 # Now make a copy
  48 $arvados_config = $arvados_config_global.deep_dup
  49
  50 # Declare all our configuration items.
  51 arvcfg = ConfigLoader.new
  52
  53 arvcfg.declare_config "ManagementToken", String, :ManagementToken
  54 arvcfg.declare_config "TLS.Insecure", Boolean, :arvados_insecure_https
  55
  56 arvcfg.declare_config "Services.Controller.ExternalURL", URI, :arvados_v1_base, ->(cfg, k, v) {
  57   u = URI(v)
  58   u.path = ""
  59   ConfigLoader.set_cfg cfg, "Services.Controller.ExternalURL", u
  60 }
  61
  62 arvcfg.declare_config "Services.WebShell.ExternalURL", URI, :shell_in_a_box_url, ->(cfg, k, v) {
  63   v ||= ""
  64   u = URI(v.sub("%{hostname}", "*"))
  65   u.path = ""
  66   ConfigLoader.set_cfg cfg, "Services.WebShell.ExternalURL", u
  67 }
  68
  69 arvcfg.declare_config "Services.WebDAV.ExternalURL", URI, :keep_web_url, ->(cfg, k, v) {
  70   v ||= ""
  71   u = URI(v.sub("%{uuid_or_pdh}", "*"))
  72   u.path = ""
  73   ConfigLoader.set_cfg cfg, "Services.WebDAV.ExternalURL", u
  74 }
  75
  76 arvcfg.declare_config "Services.WebDAVDownload.ExternalURL", URI, :keep_web_download_url, ->(cfg, k, v) {
  77   v ||= ""
  78   u = URI(v.sub("%{uuid_or_pdh}", "*"))
  79   u.path = ""
  80   ConfigLoader.set_cfg cfg, "Services.WebDAVDownload.ExternalURL", u
  81 }
  82
  83 arvcfg.declare_config "Services.Composer.ExternalURL", URI, :composer_url
  84 arvcfg.declare_config "Services.Workbench2.ExternalURL", URI, :workbench2_url
  85
  86 arvcfg.declare_config "Users.AnonymousUserToken", String, :anonymous_user_token
  87
  88 arvcfg.declare_config "Workbench.SecretKeyBase", String, :secret_key_base
  89
  90 arvcfg.declare_config "Workbench.ApplicationMimetypesWithViewIcon", Hash, :application_mimetypes_with_view_icon, ->(cfg, k, v) {
  91   mimetypes = {}
  92   v.each do |m|
  93     mimetypes[m] = {}
  94   end
  95   ConfigLoader.set_cfg cfg, "Workbench.ApplicationMimetypesWithViewIcon", mimetypes
  96 }
  97
  98 arvcfg.declare_config "Workbench.RunningJobLogRecordsToFetch", Integer, :running_job_log_records_to_fetch
  99 arvcfg.declare_config "Workbench.LogViewerMaxBytes", Integer, :log_viewer_max_bytes
 100 arvcfg.declare_config "Workbench.TrustAllContent", Boolean, :trust_all_content
 101 arvcfg.declare_config "Workbench.UserProfileFormFields", Hash, :user_profile_form_fields, ->(cfg, k, v) {
 102   if !v
 103     v = []
 104   end
 105   entries = {}
 106   v.each_with_index do |s,i|
 107     entries[s["key"]] = {
 108       "Type" => s["type"],
 109       "FormFieldTitle" => s["form_field_title"],
 110       "FormFieldDescription" => s["form_field_description"],
 111       "Required" => s["required"],
 112       "Position": i
 113     }
 114     if s["options"]
 115       entries[s["key"]]["Options"] = {}
 116       s["options"].each do |o|
 117         entries[s["key"]]["Options"][o] = {}
 118       end
 119     end
 120   end
 121   ConfigLoader.set_cfg cfg, "Workbench.UserProfileFormFields", entries
 122 }
 123 arvcfg.declare_config "Workbench.UserProfileFormMessage", String, :user_profile_form_message
 124 arvcfg.declare_config "Workbench.Theme", String, :arvados_theme
 125 arvcfg.declare_config "Workbench.ShowUserNotifications", Boolean, :show_user_notifications
 126 arvcfg.declare_config "Workbench.ShowUserAgreementInline", Boolean, :show_user_agreement_inline
 127 arvcfg.declare_config "Workbench.RepositoryCache", String, :repository_cache
 128 arvcfg.declare_config "Workbench.Repositories", Boolean, :repositories
 129 arvcfg.declare_config "Workbench.APIClientConnectTimeout", ActiveSupport::Duration, :api_client_connect_timeout
 130 arvcfg.declare_config "Workbench.APIClientReceiveTimeout", ActiveSupport::Duration, :api_client_receive_timeout
 131 arvcfg.declare_config "Workbench.APIResponseCompression", Boolean, :api_response_compression
 132 arvcfg.declare_config "Workbench.SiteName", String, :site_name
 133 arvcfg.declare_config "Workbench.MultiSiteSearch", String, :multi_site_search, ->(cfg, k, v) {
 134   if !v
 135     v = ""
 136   end
 137   ConfigLoader.set_cfg cfg, "Workbench.MultiSiteSearch", v.to_s
 138 }
 139 arvcfg.declare_config "Workbench.EnablePublicProjectsPage", Boolean, :enable_public_projects_page
 140 arvcfg.declare_config "Workbench.EnableGettingStartedPopup", Boolean, :enable_getting_started_popup
 141 arvcfg.declare_config "Workbench.ArvadosPublicDataDocURL", String, :arvados_public_data_doc_url
 142 arvcfg.declare_config "Workbench.ArvadosDocsite", String, :arvados_docsite
 143 arvcfg.declare_config "Workbench.ShowRecentCollectionsOnDashboard", Boolean, :show_recent_collections_on_dashboard
 144 arvcfg.declare_config "Workbench.ActivationContactLink", String, :activation_contact_link
 145 arvcfg.declare_config "Workbench.DefaultOpenIdPrefix", String, :default_openid_prefix
 146
 147 arvcfg.declare_config "Mail.SendUserSetupNotificationEmail", Boolean, :send_user_setup_notification_email
 148 arvcfg.declare_config "Mail.IssueReporterEmailFrom", String, :issue_reporter_email_from
 149 arvcfg.declare_config "Mail.IssueReporterEmailTo", String, :issue_reporter_email_to
 150 arvcfg.declare_config "Mail.SupportEmailAddress", String, :support_email_address
 151 arvcfg.declare_config "Mail.EmailFrom", String, :email_from
 152
 153 application_config = {}
 154 %w(application.default application).each do |cfgfile|
 155   path = "#{::Rails.root.to_s}/config/#{cfgfile}.yml"
 156   confs = ConfigLoader.load(path, erb: true)
 157   # Ignore empty YAML file:
 158   next if confs == false
 159   application_config.deep_merge!(confs['common'] || {})
 160   application_config.deep_merge!(confs[::Rails.env.to_s] || {})
 161 end
 162
 163 $remaining_config = arvcfg.migrate_config(application_config, $arvados_config)
 164
 165 # Checks for wrongly typed configuration items, coerces properties
 166 # into correct types (such as Duration), and optionally raise error
 167 # for essential configuration that can't be empty.
 168 arvcfg.coercion_and_check $arvados_config_defaults, check_nonempty: false
 169 arvcfg.coercion_and_check $arvados_config_global, check_nonempty: false
 170 arvcfg.coercion_and_check $arvados_config, check_nonempty: true
 171
 172 # * $arvados_config_defaults is the defaults
 173 # * $arvados_config_global is $arvados_config_defaults merged with the contents of /etc/arvados/config.yml
 174 # These are used by the rake config: tasks
 175 #
 176 # * $arvados_config is $arvados_config_global merged with the migrated contents of application.yml
 177 # This is what actually gets copied into the Rails configuration object.
 178
 179 ArvadosWorkbench::Application.configure do
 180   # Copy into the Rails config object.  This also turns Hash into
 181   # OrderedOptions so that application code can use
 182   # Rails.configuration.API.Blah instead of
 183   # Rails.configuration.API["Blah"]
 184   ConfigLoader.copy_into_config $arvados_config, config
 185   ConfigLoader.copy_into_config $remaining_config, config
 186   secrets.secret_key_base = $arvados_config["Workbench"]["SecretKeyBase"]
 187   ConfigValidators.validate_wb2_url_config()
 188 end