1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 # Do not use this file for site configuration. Create application.yml
6 # instead (see application.yml.example).
8 # The order of precedence is:
9 # 1. config/environments/{RAILS_ENV}.rb (deprecated)
10 # 2. Section in application.yml corresponding to RAILS_ENV (e.g., development)
11 # 3. Section in application.yml called "common"
12 # 4. Section in application.default.yml corresponding to RAILS_ENV
13 # 5. Section in application.default.yml called "common"
17 ### Essential site configuration
20 # The prefix used for all database identifiers to identify the record as
21 # originating from this site. Must be exactly 5 alphanumeric characters
22 # (lowercase ASCII letters and digits).
25 # secret_token is a string of alphanumeric characters used by Rails
26 # to sign session tokens. IMPORTANT: This is a site secret. It
27 # should be at least 50 characters.
30 # blob_signing_key is a string of alphanumeric characters used to
31 # generate permission signatures for Keep locators. It must be
32 # identical to the permission key given to Keep. IMPORTANT: This is
33 # a site secret. It should be at least 50 characters.
35 # Modifying blob_signing_key will invalidate all existing
36 # signatures, which can cause programs to fail (e.g., arv-put,
37 # arv-get, and Crunch jobs). To avoid errors, rotate keys only when
38 # no such processes are running.
41 # These settings are provided by your OAuth2 provider (e.g.,
47 # If this is not false, HTML requests at the API server's root URL
48 # are redirected to this location, and it is provided in the text of
49 # user activation notification email messages to remind them where
51 workbench_address: false
53 # Client-facing URI for websocket service. Nginx should be
54 # configured to proxy this URI to arvados-ws; see
55 # http://doc.arvados.org/install/install-ws.html
57 # If websocket_address is false (which is the default), no websocket
58 # server will be advertised to clients. This configuration is not
62 #websocket_address: wss://ws.zzzzz.arvadosapi.com/websocket
63 websocket_address: false
65 # Maximum number of websocket connections allowed
66 websocket_max_connections: 500
68 # Maximum number of events a single connection can be backlogged
69 websocket_max_notify_backlog: 1000
71 # Maximum number of subscriptions a single websocket connection can have
73 websocket_max_filters: 10
75 # Git repositories must be readable by api server, or you won't be
76 # able to submit crunch jobs. To pass the test suites, put a clone
77 # of the arvados tree in {git_repositories_dir}/arvados.git or
78 # {git_repositories_dir}/arvados/.git
79 git_repositories_dir: /var/lib/arvados/git/repositories
81 # This is a (bare) repository that stores commits used in jobs. When a job
82 # runs, the source commits are first fetched into this repository, then this
83 # repository is used to deploy to compute nodes. This should NOT be a
84 # subdirectory of {git_repositiories_dir}.
85 git_internal_dir: /var/lib/arvados/internal.git
87 # Default replication level for collections. This is used when a
88 # collection's replication_desired attribute is nil.
89 default_collection_replication: 2
93 ### Overriding default advertised hostnames/URLs
96 # If not false, this is the hostname that will be used for root_url and
97 # advertised in the discovery document. By default, use the default Rails
98 # logic for deciding on a hostname.
101 # Base part of SSH git clone url given with repository resources. If
102 # true, the default "git@git.(uuid_prefix).arvadosapi.com:" is
103 # used. If false, SSH clone URLs are not advertised. Include a
104 # trailing ":" or "/" if needed: it will not be added automatically.
105 git_repo_ssh_base: true
107 # Base part of HTTPS git clone urls given with repository
108 # resources. This is expected to be an arv-git-httpd service which
109 # accepts API tokens as HTTP-auth passwords. If true, the default
110 # "https://git.(uuid_prefix).arvadosapi.com/" is used. If false,
111 # HTTPS clone URLs are not advertised. Include a trailing ":" or "/"
112 # if needed: it will not be added automatically.
113 git_repo_https_base: true
117 ### New user and & email settings
120 # Config parameters to automatically setup new users. If enabled,
121 # this users will be able to self-activate. Enable this if you want
122 # to run an open instance where anyone can create an account and use
123 # the system without requiring manual approval.
125 # The params auto_setup_new_users_with_* are meaningful only when auto_setup_new_users is turned on.
126 # auto_setup_name_blacklist is a list of usernames to be blacklisted for auto setup.
127 auto_setup_new_users: false
128 auto_setup_new_users_with_vm_uuid: false
129 auto_setup_new_users_with_repository: false
130 auto_setup_name_blacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
132 # When new_users_are_active is set to true, new users will be active
133 # immediately. This skips the "self-activate" step which enforces
134 # user agreements. Should only be enabled for development.
135 new_users_are_active: false
137 # The e-mail address of the user you would like to become marked as an admin
138 # user on their first login.
139 # In the default configuration, authentication happens through the Arvados SSO
140 # server, which uses OAuth2 against Google's servers, so in that case this
141 # should be an address associated with a Google account.
142 auto_admin_user: false
144 # If auto_admin_first_user is set to true, the first user to log in when no
145 # other admin users exist will automatically become an admin user.
146 auto_admin_first_user: false
148 # Email address to notify whenever a user creates a profile for the
150 user_profile_notification_address: false
152 admin_notifier_email_from: arvados@example.com
153 email_subject_prefix: "[ARVADOS] "
154 user_notifier_email_from: arvados@example.com
155 new_user_notification_recipients: [ ]
156 new_inactive_user_notification_recipients: [ ]
160 ### Limits, timeouts and durations
163 # Lifetime (in seconds) of blob permission signatures generated by
164 # the API server. This determines how long a client can take (after
165 # retrieving a collection record) to retrieve the collection data
166 # from Keep. If the client needs more time than that (assuming the
167 # collection still has the same content and the relevant user/token
168 # still has permission) the client can retrieve the collection again
169 # to get fresh signatures.
171 # This must be exactly equal to the -blob-signature-ttl flag used by
172 # keepstore servers. Otherwise, reading data blocks and saving
173 # collections will fail with HTTP 403 permission errors.
175 # Modifying blob_signature_ttl invalidates existing signatures; see
176 # blob_signing_key note above.
178 # The default is 2 weeks.
179 blob_signature_ttl: 1209600
181 # Default lifetime for ephemeral collections: 2 weeks. This must not
182 # be less than blob_signature_ttl.
183 default_trash_lifetime: 1209600
185 # Interval (seconds) between trash sweeps. During a trash sweep,
186 # collections are marked as trash if their trash_at time has
187 # arrived, and deleted if their delete_at time has arrived.
188 trash_sweep_interval: 60
190 # Maximum characters of (JSON-encoded) query parameters to include
191 # in each request log entry. When params exceed this size, they will
192 # be JSON-encoded, truncated to this size, and logged as
194 max_request_log_params_size: 2000
196 # Maximum size (in bytes) allowed for a single API request. This
197 # limit is published in the discovery document for use by clients.
198 # Note: You must separately configure the upstream web server or
199 # proxy to actually enforce the desired maximum request size on the
201 max_request_size: 134217728
203 # Limit the number of bytes read from the database during an index
204 # request (by retrieving and returning fewer rows than would
205 # normally be returned in a single response).
206 # Note 1: This setting never reduces the number of returned rows to
207 # zero, no matter how big the first data row is.
208 # Note 2: Currently, this is only checked against a specific set of
209 # columns that tend to get large (collections.manifest_text,
210 # containers.mounts, workflows.definition). Other fields (e.g.,
211 # "properties" hashes) are not counted against this limit.
212 max_index_database_read: 134217728
214 # Maximum number of items to return when responding to a APIs that
215 # can return partial result sets using limit and offset parameters
216 # (e.g., *.index, groups.contents). If a request specifies a "limit"
217 # parameter higher than this value, this value is used instead.
218 max_items_per_response: 1000
220 # When you run the db:delete_old_job_logs task, it will find jobs that
221 # have been finished for at least this many seconds, and delete their
222 # stderr logs from the logs table.
223 clean_job_log_rows_after: <%= 30.days %>
225 # When you run the db:delete_old_container_logs task, it will find
226 # containers that have been finished for at least this many seconds,
227 # and delete their stdout, stderr, arv-mount, crunch-run, and
228 # crunchstat logs from the logs table.
229 clean_container_log_rows_after: <%= 30.days %>
231 # Time to keep audit logs, in seconds. (An audit log is a row added
232 # to the "logs" table in the PostgreSQL database each time an
233 # Arvados object is created, modified, or deleted.)
235 # Currently, websocket event notifications rely on audit logs, so
236 # this should not be set lower than 600 (5 minutes).
237 max_audit_log_age: 1209600
239 # Maximum number of log rows to delete in a single SQL transaction.
241 # If max_audit_log_delete_batch is 0, log entries will never be
242 # deleted by Arvados. Cleanup can be done by an external process
243 # without affecting any Arvados system processes, as long as very
244 # recent (<5 minutes old) logs are not deleted.
246 # 100000 is a reasonable batch size for most sites.
247 max_audit_log_delete_batch: 0
249 # The maximum number of compute nodes that can be in use simultaneously
250 # If this limit is reduced, any existing nodes with slot number >= new limit
251 # will not be counted against the new limit. In other words, the new limit
252 # won't be strictly enforced until those nodes with higher slot numbers
254 max_compute_nodes: 64
256 # These two settings control how frequently log events are flushed to the
257 # database. Log lines are buffered until either crunch_log_bytes_per_event
258 # has been reached or crunch_log_seconds_between_events has elapsed since
260 crunch_log_bytes_per_event: 4096
261 crunch_log_seconds_between_events: 1
263 # The sample period for throttling logs, in seconds.
264 crunch_log_throttle_period: 60
266 # Maximum number of bytes that job can log over crunch_log_throttle_period
267 # before being silenced until the end of the period.
268 crunch_log_throttle_bytes: 65536
270 # Maximum number of lines that job can log over crunch_log_throttle_period
271 # before being silenced until the end of the period.
272 crunch_log_throttle_lines: 1024
274 # Maximum bytes that may be logged by a single job. Log bytes that are
275 # silenced by throttling are not counted against this total.
276 crunch_limit_log_bytes_per_job: 67108864
278 crunch_log_partial_line_throttle_period: 5
280 # Attributes to suppress in events and audit logs. Notably,
281 # specifying ["manifest_text"] here typically makes the database
282 # smaller and faster.
284 # Warning: Using any non-empty value here can have undesirable side
285 # effects for any client or component that relies on event logs.
286 # Use at your own risk.
287 unlogged_attributes: []
289 # API methods to disable. Disabled methods are not listed in the
290 # discovery document, and respond 404 to all requests.
291 # Example: ["jobs.create", "pipeline_instances.create"]
292 disable_api_methods: []
295 ### Crunch, DNS & compute node management
298 # Preemptible instance support (e.g. AWS Spot Instances)
299 # When true, child containers will get created with the preemptible
300 # scheduling parameter parameter set.
301 preemptible_instances: false
303 # Docker image to be used when none found in runtime_constraints of a job
304 default_docker_image_for_jobs: false
306 # List of supported Docker Registry image formats that compute nodes
307 # are able to use. `arv keep docker` will error out if a user tries
308 # to store an image with an unsupported format. Use an empty array
309 # to skip the compatibility check (and display a warning message to
312 # Example for sites running docker < 1.10: ["v1"]
313 # Example for sites running docker >= 1.10: ["v2"]
314 # Example for disabling check: []
315 docker_image_formats: ["v2"]
317 # :none or :slurm_immediate
318 crunch_job_wrapper: :none
320 # username, or false = do not set uid when running jobs.
321 crunch_job_user: crunch
323 # The web service must be able to create/write this file, and
324 # crunch-job must be able to stat() it.
325 crunch_refresh_trigger: /tmp/crunch_refresh_trigger
327 # Path to dns server configuration directory
328 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
329 # files or touch restart.txt (see below).
330 dns_server_conf_dir: false
332 # Template file for the dns server host snippets. See
333 # unbound.template in this directory for an example. If false, do
334 # not write any config files.
335 dns_server_conf_template: false
337 # String to write to {dns_server_conf_dir}/restart.txt (with a
338 # trailing newline) after updating local data. If false, do not
339 # open or write the restart.txt file.
340 dns_server_reload_command: false
342 # Command to run after each DNS update. Template variables will be
343 # substituted; see the "unbound" example below. If false, do not run
345 dns_server_update_command: false
347 ## Example for unbound:
348 #dns_server_conf_dir: /etc/unbound/conf.d
349 #dns_server_conf_template: /path/to/your/api/server/config/unbound.template
350 ## ...plus one of the following two methods of reloading:
351 #dns_server_reload_command: unbound-control reload
352 #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
354 compute_node_domain: false
355 compute_node_nameservers:
358 # Hostname to assign to a compute node when it sends a "ping" and the
359 # hostname in its Node record is nil.
360 # During bootstrapping, the "ping" script is expected to notice the
361 # hostname given in the ping response, and update its unix hostname
363 # If false, leave the hostname alone (this is appropriate if your compute
364 # nodes' hostnames are already assigned by some other mechanism).
366 # One way or another, the hostnames of your node records should agree
367 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
369 # Example for compute0000, compute0001, ....:
370 # assign_node_hostname: compute%<slot_number>04d
371 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
372 assign_node_hostname: compute%<slot_number>d
376 ### Job and container reuse logic.
379 # Include details about job reuse decisions in the server log. This
380 # causes additional database queries to run, so it should not be
381 # enabled unless you expect to examine the resulting logs for
382 # troubleshooting purposes.
383 log_reuse_decisions: false
385 # Control job reuse behavior when two completed jobs match the
386 # search criteria and have different outputs.
388 # If true, in case of a conflict, reuse the earliest job (this is
389 # similar to container reuse behavior).
391 # If false, in case of a conflict, do not reuse any completed job,
392 # but do reuse an already-running job if available (this is the
393 # original job reuse behavior, and is still the default).
394 reuse_job_if_outputs_differ: false
397 ### Federation support.
400 # You can enable use of this cluster by users who are authenticated
401 # by a remote Arvados site. Control which remote hosts are trusted
402 # to authenticate which user IDs by configuring remote_hosts,
403 # remote_hosts_via_dns, or both. The default configuration disables
404 # remote authentication.
406 # Map known prefixes to hosts. For example, if user IDs beginning
407 # with "zzzzz-" should be authenticated by the Arvados server at
408 # "zzzzz.example.com", use:
411 # zzzzz: zzzzz.example.com
414 # Use {prefix}.arvadosapi.com for any prefix not given in
415 # remote_hosts above.
416 remote_hosts_via_dns: false
418 # List of cluster prefixes. These are "trusted" clusters, users
419 # from the clusters listed here will be automatically setup and
420 # activated. This is separate from the settings
421 # auto_setup_new_users and new_users_are_active.
422 auto_activate_users_from: []
425 ### Remaining assorted configuration options.
428 arvados_theme: default
430 # Permit insecure (OpenSSL::SSL::VERIFY_NONE) connections to the
431 # Single Sign On (sso) server and remote Arvados sites. Should only
432 # be enabled during development when the SSO server is using a
436 ## Set Time.zone default to the specified zone and make Active
437 ## Record auto-convert to this zone. Run "rake -D time" for a list
438 ## of tasks for finding time zone names. Default is UTC.
439 #time_zone: Central Time (US & Canada)
441 ## Default encoding used in templates for Ruby 1.9.
444 # Enable the asset pipeline
447 # Version of your assets, change this if you want to expire all your assets
448 assets.version: "1.0"
450 # Allow clients to create collections by providing a manifest with
451 # unsigned data blob locators. IMPORTANT: This effectively disables
452 # access controls for data stored in Keep: a client who knows a hash
453 # can write a manifest that references the hash, pass it to
454 # collections.create (which will create a permission link), use
455 # collections.get to obtain a signature for that data locator, and
456 # use that signed locator to retrieve the data from Keep. Therefore,
457 # do not turn this on if your users expect to keep data private from
459 permit_create_collection_with_unsigned_manifest: false
461 default_openid_prefix: https://www.google.com/accounts/o8/id
463 # Override the automatic version string. With the default value of
464 # false, the version string is read from git-commit.version in
465 # Rails.root (included in vendor packages) or determined by invoking
467 source_version: false
469 # Override the automatic package version string. With the default version of
470 # false, the package version is read from package-build.version in Rails.root
471 # (included in vendor packages).
472 package_version: false
474 # Enable asynchronous permission graph rebuild. Must run
475 # script/permission-updater.rb as a separate process. When the permission
476 # cache is invalidated, the background process will update the permission
477 # graph cache. This feature is experimental!
478 async_permissions_update: false
480 # Default value for container_count_max for container requests. This is the
481 # number of times Arvados will create a new container to satisfy a container
482 # request. If a container is cancelled it will retry a new container if
483 # container_count < container_count_max on any container requests associated
484 # with the cancelled container.
485 container_count_max: 3
487 # Default value for keep_cache_ram of a container's runtime_constraints.
488 container_default_keep_cache_ram: 268435456
490 # Token to be included in all healthcheck requests. Disabled by default.
491 # Server expects request header of the format "Authorization: Bearer xxx"
492 ManagementToken: false
494 # URL of keep-web service. Provides read/write access to collections via
495 # HTTP and WebDAV protocols.
498 # keep_web_service_url: https://download.uuid_prefix.arvadosapi.com/
499 keep_web_service_url: false
505 consider_all_requests_local: true
506 action_controller.perform_caching: false
507 action_mailer.raise_delivery_errors: false
508 action_mailer.perform_deliveries: false
509 active_support.deprecation: :log
510 action_dispatch.best_standards_support: :builtin
511 active_record.auto_explain_threshold_in_seconds: 0.5
512 assets.compress: false
518 consider_all_requests_local: false
519 action_controller.perform_caching: true
520 serve_static_files: false
521 assets.compress: true
522 assets.compile: false
528 serve_static_files: true
529 static_cache_control: public, max-age=3600
531 consider_all_requests_local: true
532 action_controller.perform_caching: false
533 action_dispatch.show_exceptions: false
534 action_controller.allow_forgery_protection: false
535 action_mailer.delivery_method: :test
536 active_support.deprecation: :stderr
538 sso_app_id: arvados-server
539 sso_app_secret: <%= rand(2**512).to_s(36) %>
540 sso_provider_url: http://localhost:3002
541 secret_token: <%= rand(2**512).to_s(36) %>
542 blob_signing_key: zfhgfenhffzltr9dixws36j1yhksjoll2grmku38mi7yxd66h5j4q9w4jzanezacp8s6q0ro3hxakfye02152hncy6zml2ed0uc
543 user_profile_notification_address: arvados@example.com
544 workbench_address: https://localhost:3001/
545 git_repositories_dir: <%= Rails.root.join 'tmp', 'git', 'test' %>
546 git_internal_dir: <%= Rails.root.join 'tmp', 'internal.git' %>
547 websocket_address: "wss://0.0.0.0:<%= ENV['ARVADOS_TEST_WSS_PORT'] %>/websocket"
548 trash_sweep_interval: -1
549 docker_image_formats: ["v1"]