1 # Do not use this file for site configuration. Create application.yml
2 # instead (see application.yml.example).
4 # The order of precedence is:
5 # 1. config/environments/{RAILS_ENV}.rb (deprecated)
6 # 2. Section in application.yml corresponding to RAILS_ENV (e.g., development)
7 # 3. Section in application.yml called "common"
8 # 4. Section in application.default.yml corresponding to RAILS_ENV
9 # 5. Section in application.default.yml called "common"
13 ### Essential site configuration
16 # The prefix used for all database identifiers to identify the record as
17 # originating from this site. Must be exactly 5 alphanumeric characters
18 # (lowercase ASCII letters and digits).
21 # secret_token is a string of alphanumeric characters used by Rails
22 # to sign session tokens. IMPORTANT: This is a site secret. It
23 # should be at least 50 characters.
26 # blob_signing_key is a string of alphanumeric characters used to
27 # generate permission signatures for Keep locators. It must be
28 # identical to the permission key given to Keep. IMPORTANT: This is
29 # a site secret. It should be at least 50 characters.
31 # Modifying blob_signing_key will invalidate all existing
32 # signatures, which can cause programs to fail (e.g., arv-put,
33 # arv-get, and Crunch jobs). To avoid errors, rotate keys only when
34 # no such processes are running.
37 # These settings are provided by your OAuth2 provider (e.g.,
43 # If this is not false, HTML requests at the API server's root URL
44 # are redirected to this location, and it is provided in the text of
45 # user activation notification email messages to remind them where
47 workbench_address: false
49 # The ARVADOS_WEBSOCKETS environment variable determines whether to
50 # serve http, websockets, or both.
52 # If ARVADOS_WEBSOCKETS="true", http and websockets are both served
53 # from the same process.
55 # If ARVADOS_WEBSOCKETS="ws-only", only websockets is served.
57 # If ARVADOS_WEBSOCKETS="false" or not set at all, only http is
58 # served. In this case, you should have a separate process serving
59 # websockets, and the address of that service should be given here
60 # as websocket_address.
62 # If websocket_address is false (which is the default), the
63 # discovery document will tell clients to use the current server as
64 # the websocket service, or (if the current server does not have
65 # websockets enabled) not to use websockets at all.
67 # Example: Clients will connect to the specified endpoint.
68 #websocket_address: wss://127.0.0.1:3333/websocket
69 # Default: Clients will connect to this server if it's running
70 # websockets, otherwise none at all.
71 websocket_address: false
73 # Maximum number of websocket connections allowed
74 websocket_max_connections: 500
76 # Maximum number of events a single connection can be backlogged
77 websocket_max_notify_backlog: 1000
79 # Maximum number of subscriptions a single websocket connection can have
81 websocket_max_filters: 10
83 # When using multithreaded websocket server, set the size of the database
87 # Git repositories must be readable by api server, or you won't be
88 # able to submit crunch jobs. To pass the test suites, put a clone
89 # of the arvados tree in {git_repositories_dir}/arvados.git or
90 # {git_repositories_dir}/arvados/.git
91 git_repositories_dir: /var/lib/arvados/git/repositories
93 # This is a (bare) repository that stores commits used in jobs. When a job
94 # runs, the source commits are first fetched into this repository, then this
95 # repository is used to deploy to compute nodes. This should NOT be a
96 # subdirectory of {git_repositiories_dir}.
97 git_internal_dir: /var/lib/arvados/internal.git
99 # Default replication level for collections. This is used when a
100 # collection's replication_desired attribute is nil.
101 default_collection_replication: 2
105 ### Overriding default advertised hostnames/URLs
108 # If not false, this is the hostname that will be used for root_url and
109 # advertised in the discovery document. By default, use the default Rails
110 # logic for deciding on a hostname.
113 # Base part of SSH git clone url given with repository resources. If
114 # true, the default "git@git.(uuid_prefix).arvadosapi.com:" is
115 # used. If false, SSH clone URLs are not advertised. Include a
116 # trailing ":" or "/" if needed: it will not be added automatically.
117 git_repo_ssh_base: true
119 # Base part of HTTPS git clone urls given with repository
120 # resources. This is expected to be an arv-git-httpd service which
121 # accepts API tokens as HTTP-auth passwords. If true, the default
122 # "https://git.(uuid_prefix).arvadosapi.com/" is used. If false,
123 # HTTPS clone URLs are not advertised. Include a trailing ":" or "/"
124 # if needed: it will not be added automatically.
125 git_repo_https_base: true
129 ### New user and & email settings
132 # Config parameters to automatically setup new users.
133 # The params auto_setup_new_users_with_* are meaningful only when auto_setup_new_users is turned on.
134 # auto_setup_name_blacklist is a list of usernames to be blacklisted for auto setup.
135 auto_setup_new_users: false
136 auto_setup_new_users_with_vm_uuid: false
137 auto_setup_new_users_with_repository: false
138 auto_setup_name_blacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
140 # When new_users_are_active is set to true, the user agreement check is skipped.
141 new_users_are_active: false
143 # The e-mail address of the user you would like to become marked as an admin
144 # user on their first login.
145 # In the default configuration, authentication happens through the Arvados SSO
146 # server, which uses OAuth2 against Google's servers, so in that case this
147 # should be an address associated with a Google account.
148 auto_admin_user: false
150 # If auto_admin_first_user is set to true, the first user to log in when no
151 # other admin users exist will automatically become an admin user.
152 auto_admin_first_user: false
154 # Email address to notify whenever a user creates a profile for the
156 user_profile_notification_address: false
158 admin_notifier_email_from: arvados@example.com
159 email_subject_prefix: "[ARVADOS] "
160 user_notifier_email_from: arvados@example.com
161 new_user_notification_recipients: [ ]
162 new_inactive_user_notification_recipients: [ ]
166 ### Limits, timeouts and durations
169 # Lifetime (in seconds) of blob permission signatures generated by
170 # the API server. This determines how long a client can take (after
171 # retrieving a collection record) to retrieve the collection data
172 # from Keep. If the client needs more time than that (assuming the
173 # collection still has the same content and the relevant user/token
174 # still has permission) the client can retrieve the collection again
175 # to get fresh signatures.
177 # This must be exactly equal to the -blob-signature-ttl flag used by
178 # keepstore servers. Otherwise, reading data blocks and saving
179 # collections will fail with HTTP 403 permission errors.
181 # Modifying blob_signature_ttl invalidates existing signatures; see
182 # blob_signing_key note above.
184 # The default is 2 weeks.
185 blob_signature_ttl: 1209600
187 # Default lifetime for ephemeral collections: 2 weeks.
188 default_trash_lifetime: 1209600
190 # Maximum size (in bytes) allowed for a single API request. This
191 # limit is published in the discovery document for use by clients.
192 # Note: You must separately configure the upstream web server or
193 # proxy to actually enforce the desired maximum request size on the
195 max_request_size: 134217728
197 # Limit the number of bytes read from the database during an index
198 # request (by retrieving and returning fewer rows than would
199 # normally be returned in a single response).
200 # Note 1: This setting never reduces the number of returned rows to
201 # zero, no matter how big the first data row is.
202 # Note 2: Currently, this only limits the
203 # arvados.v1.collections.list API (GET /arvados/v1/collections), and
204 # only takes the size of manifest_text into account. Other fields
205 # (e.g., "properties" hashes) are not counted against this limit
206 # when returning collections, and the limit is not applied at all
207 # for other data types.
208 max_index_database_read: 134217728
210 # Maximum number of items to return when responding to a APIs that
211 # can return partial result sets using limit and offset parameters
212 # (e.g., *.index, groups.contents). If a request specifies a "limit"
213 # parameter higher than this value, this value is used instead.
214 max_items_per_response: 1000
216 # When you run the db:delete_old_job_logs task, it will find jobs that
217 # have been finished for at least this many seconds, and delete their
218 # stderr logs from the logs table.
219 clean_job_log_rows_after: <%= 30.days %>
221 # The maximum number of compute nodes that can be in use simultaneously
222 # If this limit is reduced, any existing nodes with slot number >= new limit
223 # will not be counted against the new limit. In other words, the new limit
224 # won't be strictly enforced until those nodes with higher slot numbers
226 max_compute_nodes: 64
228 # These two settings control how frequently log events are flushed to the
229 # database. Log lines are buffered until either crunch_log_bytes_per_event
230 # has been reached or crunch_log_seconds_between_events has elapsed since
232 crunch_log_bytes_per_event: 4096
233 crunch_log_seconds_between_events: 1
235 # The sample period for throttling logs, in seconds.
236 crunch_log_throttle_period: 60
238 # Maximum number of bytes that job can log over crunch_log_throttle_period
239 # before being silenced until the end of the period.
240 crunch_log_throttle_bytes: 65536
242 # Maximum number of lines that job can log over crunch_log_throttle_period
243 # before being silenced until the end of the period.
244 crunch_log_throttle_lines: 1024
246 # Maximum bytes that may be logged by a single job. Log bytes that are
247 # silenced by throttling are not counted against this total.
248 crunch_limit_log_bytes_per_job: 67108864
252 ### Crunch, DNS & compute node management
255 # Docker image to be used when none found in runtime_constraints of a job
256 default_docker_image_for_jobs: false
258 # :none or :slurm_immediate
259 crunch_job_wrapper: :none
261 # username, or false = do not set uid when running jobs.
262 crunch_job_user: crunch
264 # The web service must be able to create/write this file, and
265 # crunch-job must be able to stat() it.
266 crunch_refresh_trigger: /tmp/crunch_refresh_trigger
268 # Path to dns server configuration directory
269 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
270 # files or touch restart.txt (see below).
271 dns_server_conf_dir: false
273 # Template file for the dns server host snippets. See
274 # unbound.template in this directory for an example. If false, do
275 # not write any config files.
276 dns_server_conf_template: false
278 # String to write to {dns_server_conf_dir}/restart.txt (with a
279 # trailing newline) after updating local data. If false, do not
280 # open or write the restart.txt file.
281 dns_server_reload_command: false
283 # Command to run after each DNS update. Template variables will be
284 # substituted; see the "unbound" example below. If false, do not run
286 dns_server_update_command: false
288 ## Example for unbound:
289 #dns_server_conf_dir: /etc/unbound/conf.d
290 #dns_server_conf_template: /path/to/your/api/server/config/unbound.template
291 ## ...plus one of the following two methods of reloading:
292 #dns_server_reload_command: unbound-control reload
293 #dns_server_update_command: echo %{hostname} %{hostname}.%{uuid_prefix} %{hostname}.%{uuid_prefix}.arvadosapi.com %{ptr_domain} | xargs -n 1 unbound-control local_data_remove && unbound-control local_data %{hostname} IN A %{ip_address} && unbound-control local_data %{hostname}.%{uuid_prefix} IN A %{ip_address} && unbound-control local_data %{hostname}.%{uuid_prefix}.arvadosapi.com IN A %{ip_address} && unbound-control local_data %{ptr_domain}. IN PTR %{hostname}.%{uuid_prefix}.arvadosapi.com
295 compute_node_domain: false
296 compute_node_nameservers:
299 # Hostname to assign to a compute node when it sends a "ping" and the
300 # hostname in its Node record is nil.
301 # During bootstrapping, the "ping" script is expected to notice the
302 # hostname given in the ping response, and update its unix hostname
304 # If false, leave the hostname alone (this is appropriate if your compute
305 # nodes' hostnames are already assigned by some other mechanism).
307 # One way or another, the hostnames of your node records should agree
308 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
310 # Example for compute0000, compute0001, ....:
311 # assign_node_hostname: compute%<slot_number>04d
312 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
313 assign_node_hostname: compute%<slot_number>d
317 ### Remaining assorted configuration options.
320 arvados_theme: default
322 # Permit insecure (OpenSSL::SSL::VERIFY_NONE) connections to the Single Sign
323 # On (sso) server. Should only be enabled during development when the SSO
324 # server is using a self-signed cert.
327 ## Set Time.zone default to the specified zone and make Active
328 ## Record auto-convert to this zone. Run "rake -D time" for a list
329 ## of tasks for finding time zone names. Default is UTC.
330 #time_zone: Central Time (US & Canada)
332 ## Default encoding used in templates for Ruby 1.9.
335 # Enable the asset pipeline
338 # Version of your assets, change this if you want to expire all your assets
339 assets.version: "1.0"
341 # Allow clients to create collections by providing a manifest with
342 # unsigned data blob locators. IMPORTANT: This effectively disables
343 # access controls for data stored in Keep: a client who knows a hash
344 # can write a manifest that references the hash, pass it to
345 # collections.create (which will create a permission link), use
346 # collections.get to obtain a signature for that data locator, and
347 # use that signed locator to retrieve the data from Keep. Therefore,
348 # do not turn this on if your users expect to keep data private from
350 permit_create_collection_with_unsigned_manifest: false
352 default_openid_prefix: https://www.google.com/accounts/o8/id
354 # Override the automatic version string. With the default value of
355 # false, the version string is read from git-commit.version in
356 # Rails.root (included in vendor packages) or determined by invoking
358 source_version: false
360 crunch_log_partial_line_throttle_period: 5
362 # Enable asynchronous permission graph rebuild. Must run
363 # script/permission-updater.rb as a separate process. When the permission
364 # cache is invalidated, the background process will update the permission
365 # graph cache. This feature is experimental!
366 async_permissions_update: false
372 consider_all_requests_local: true
373 action_controller.perform_caching: false
374 action_mailer.raise_delivery_errors: false
375 action_mailer.perform_deliveries: false
376 active_support.deprecation: :log
377 action_dispatch.best_standards_support: :builtin
378 active_record.mass_assignment_sanitizer: :strict
379 active_record.auto_explain_threshold_in_seconds: 0.5
380 assets.compress: false
386 consider_all_requests_local: false
387 action_controller.perform_caching: true
388 serve_static_assets: false
389 assets.compress: true
390 assets.compile: false
396 serve_static_assets: true
397 static_cache_control: public, max-age=3600
399 consider_all_requests_local: true
400 action_controller.perform_caching: false
401 action_dispatch.show_exceptions: false
402 action_controller.allow_forgery_protection: false
403 action_mailer.delivery_method: :test
404 active_support.deprecation: :stderr
405 active_record.mass_assignment_sanitizer: :strict
407 sso_app_id: arvados-server
408 sso_app_secret: <%= rand(2**512).to_s(36) %>
409 sso_provider_url: http://localhost:3002
410 secret_token: <%= rand(2**512).to_s(36) %>
411 blob_signing_key: zfhgfenhffzltr9dixws36j1yhksjoll2grmku38mi7yxd66h5j4q9w4jzanezacp8s6q0ro3hxakfye02152hncy6zml2ed0uc
412 user_profile_notification_address: arvados@example.com
413 workbench_address: https://localhost:3001/
414 git_repositories_dir: <%= Rails.root.join 'tmp', 'git', 'test' %>
415 git_internal_dir: <%= Rails.root.join 'tmp', 'internal.git' %>