* Add a basic Slurm config
[arvados-k8s.git] / charts / arvados / config / api-server / application.yml
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 # Do not use this file for site configuration. Create application.yml
6 # instead (see application.yml.example).
7 #
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"
14
15 common:
16   ###
17   ### Essential site configuration
18   ###
19
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).
23   uuid_prefix: vwxyz
24
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.
28   secret_token: changeme
29
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.
34   #
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.
39   blob_signing_key: key
40
41   # These settings are provided by your OAuth2 provider (e.g.,
42   # sso-provider).
43   sso_app_secret: app_secret
44   sso_app_id: arvados-server
45   sso_provider_url: https://{{ .Values.externalIP }}:3002
46
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
50   # to log in.
51   workbench_address: false
52
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
56   #
57   # If websocket_address is false (which is the default), no websocket
58   # server will be advertised to clients. This configuration is not
59   # supported.
60   #
61   # Example:
62   #websocket_address: wss://ws.zzzzz.arvadosapi.com/websocket
63   websocket_address: wss://{{ .Values.externalIP }}:9003/websocket
64
65   # Maximum number of websocket connections allowed
66   websocket_max_connections: 500
67
68   # Maximum number of events a single connection can be backlogged
69   websocket_max_notify_backlog: 1000
70
71   # Maximum number of subscriptions a single websocket connection can have
72   # active.
73   websocket_max_filters: 10
74
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
80
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
86
87   # Default replication level for collections. This is used when a
88   # collection's replication_desired attribute is nil.
89   default_collection_replication: 2
90
91
92   ###
93   ### Overriding default advertised hostnames/URLs
94   ###
95
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.
99   host: false
100
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
106
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
114
115
116   ###
117   ### New user and & email settings
118   ###
119
120   # Config parameters to automatically setup new users.
121   # The params auto_setup_new_users_with_* are meaningful only when auto_setup_new_users is turned on.
122   # auto_setup_name_blacklist is a list of usernames to be blacklisted for auto setup.
123   auto_setup_new_users: true
124   auto_setup_new_users_with_vm_uuid: false
125   auto_setup_new_users_with_repository: false
126   auto_setup_name_blacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
127
128   # When new_users_are_active is set to true, the user agreement check is skipped.
129   new_users_are_active: true
130
131   # The e-mail address of the user you would like to become marked as an admin
132   # user on their first login.
133   # In the default configuration, authentication happens through the Arvados SSO
134   # server, which uses OAuth2 against Google's servers, so in that case this
135   # should be an address associated with a Google account.
136   auto_admin_user: false
137
138   # If auto_admin_first_user is set to true, the first user to log in when no
139   # other admin users exist will automatically become an admin user.
140   auto_admin_first_user: true
141
142   # Email address to notify whenever a user creates a profile for the
143   # first time
144   user_profile_notification_address: false
145
146   admin_notifier_email_from: arvados@example.com
147   email_subject_prefix: "[ARVADOS] "
148   user_notifier_email_from: arvados@example.com
149   new_user_notification_recipients: [ ]
150   new_inactive_user_notification_recipients: [ ]
151
152
153   ###
154   ### Limits, timeouts and durations
155   ###
156
157   # Lifetime (in seconds) of blob permission signatures generated by
158   # the API server. This determines how long a client can take (after
159   # retrieving a collection record) to retrieve the collection data
160   # from Keep. If the client needs more time than that (assuming the
161   # collection still has the same content and the relevant user/token
162   # still has permission) the client can retrieve the collection again
163   # to get fresh signatures.
164   #
165   # This must be exactly equal to the -blob-signature-ttl flag used by
166   # keepstore servers.  Otherwise, reading data blocks and saving
167   # collections will fail with HTTP 403 permission errors.
168   #
169   # Modifying blob_signature_ttl invalidates existing signatures; see
170   # blob_signing_key note above.
171   #
172   # The default is 2 weeks.
173   blob_signature_ttl: 1209600
174
175   # Default lifetime for ephemeral collections: 2 weeks. This must not
176   # be less than blob_signature_ttl.
177   default_trash_lifetime: 1209600
178
179   # Interval (seconds) between trash sweeps. During a trash sweep,
180   # collections are marked as trash if their trash_at time has
181   # arrived, and deleted if their delete_at time has arrived.
182   trash_sweep_interval: 60
183
184   # Maximum characters of (JSON-encoded) query parameters to include
185   # in each request log entry. When params exceed this size, they will
186   # be JSON-encoded, truncated to this size, and logged as
187   # params_truncated.
188   max_request_log_params_size: 2000
189
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
194   # server side.
195   max_request_size: 134217728
196
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 is only checked against a specific set of
203   # columns that tend to get large (collections.manifest_text,
204   # containers.mounts, workflows.definition). Other fields (e.g.,
205   # "properties" hashes) are not counted against this limit.
206   max_index_database_read: 134217728
207
208   # Maximum number of items to return when responding to a APIs that
209   # can return partial result sets using limit and offset parameters
210   # (e.g., *.index, groups.contents). If a request specifies a "limit"
211   # parameter higher than this value, this value is used instead.
212   max_items_per_response: 1000
213
214   # When you run the db:delete_old_job_logs task, it will find jobs that
215   # have been finished for at least this many seconds, and delete their
216   # stderr logs from the logs table.
217   clean_job_log_rows_after: <%= 30.days %>
218
219   # When you run the db:delete_old_container_logs task, it will find
220   # containers that have been finished for at least this many seconds,
221   # and delete their stdout, stderr, arv-mount, crunch-run, and
222   # crunchstat logs from the logs table.
223   clean_container_log_rows_after: <%= 30.days %>
224
225   # Time to keep audit logs, in seconds. (An audit log is a row added
226   # to the "logs" table in the PostgreSQL database each time an
227   # Arvados object is created, modified, or deleted.)
228   #
229   # Currently, websocket event notifications rely on audit logs, so
230   # this should not be set lower than 600 (5 minutes).
231   max_audit_log_age: 1209600
232
233   # Maximum number of log rows to delete in a single SQL transaction.
234   #
235   # If max_audit_log_delete_batch is 0, log entries will never be
236   # deleted by Arvados. Cleanup can be done by an external process
237   # without affecting any Arvados system processes, as long as very
238   # recent (<5 minutes old) logs are not deleted.
239   #
240   # 100000 is a reasonable batch size for most sites.
241   max_audit_log_delete_batch: 0
242
243   # The maximum number of compute nodes that can be in use simultaneously
244   # If this limit is reduced, any existing nodes with slot number >= new limit
245   # will not be counted against the new limit. In other words, the new limit
246   # won't be strictly enforced until those nodes with higher slot numbers
247   # go down.
248   max_compute_nodes: 64
249
250   # These two settings control how frequently log events are flushed to the
251   # database.  Log lines are buffered until either crunch_log_bytes_per_event
252   # has been reached or crunch_log_seconds_between_events has elapsed since
253   # the last flush.
254   crunch_log_bytes_per_event: 4096
255   crunch_log_seconds_between_events: 1
256
257   # The sample period for throttling logs, in seconds.
258   crunch_log_throttle_period: 60
259
260   # Maximum number of bytes that job can log over crunch_log_throttle_period
261   # before being silenced until the end of the period.
262   crunch_log_throttle_bytes: 65536
263
264   # Maximum number of lines that job can log over crunch_log_throttle_period
265   # before being silenced until the end of the period.
266   crunch_log_throttle_lines: 1024
267
268   # Maximum bytes that may be logged by a single job.  Log bytes that are
269   # silenced by throttling are not counted against this total.
270   crunch_limit_log_bytes_per_job: 67108864
271
272   crunch_log_partial_line_throttle_period: 5
273
274   # Attributes to suppress in events and audit logs.  Notably,
275   # specifying ["manifest_text"] here typically makes the database
276   # smaller and faster.
277   #
278   # Warning: Using any non-empty value here can have undesirable side
279   # effects for any client or component that relies on event logs.
280   # Use at your own risk.
281   unlogged_attributes: []
282
283   # API methods to disable. Disabled methods are not listed in the
284   # discovery document, and respond 404 to all requests.
285   # Example: ["jobs.create", "pipeline_instances.create"]
286   disable_api_methods: []
287
288   ###
289   ### Crunch, DNS & compute node management
290   ###
291
292   # Docker image to be used when none found in runtime_constraints of a job
293   default_docker_image_for_jobs: false
294
295   # List of supported Docker Registry image formats that compute nodes
296   # are able to use. `arv keep docker` will error out if a user tries
297   # to store an image with an unsupported format. Use an empty array
298   # to skip the compatibility check (and display a warning message to
299   # that effect).
300   #
301   # Example for sites running docker < 1.10: ["v1"]
302   # Example for sites running docker >= 1.10: ["v2"]
303   # Example for disabling check: []
304   docker_image_formats: ["v2"]
305
306   # :none or :slurm_immediate
307   crunch_job_wrapper: :slurm_immediate
308
309   # username, or false = do not set uid when running jobs.
310   crunch_job_user: crunch
311
312   # The web service must be able to create/write this file, and
313   # crunch-job must be able to stat() it.
314   crunch_refresh_trigger: /tmp/crunch_refresh_trigger
315
316   # Path to dns server configuration directory
317   # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
318   # files or touch restart.txt (see below).
319   dns_server_conf_dir: false
320
321   # Template file for the dns server host snippets. See
322   # unbound.template in this directory for an example. If false, do
323   # not write any config files.
324   dns_server_conf_template: false
325
326   # String to write to {dns_server_conf_dir}/restart.txt (with a
327   # trailing newline) after updating local data. If false, do not
328   # open or write the restart.txt file.
329   dns_server_reload_command: false
330
331   # Command to run after each DNS update. Template variables will be
332   # substituted; see the "unbound" example below. If false, do not run
333   # a command.
334   dns_server_update_command: false
335
336   ## Example for unbound:
337   #dns_server_conf_dir: /etc/unbound/conf.d
338   #dns_server_conf_template: /path/to/your/api/server/config/unbound.template
339   ## ...plus one of the following two methods of reloading:
340   #dns_server_reload_command: unbound-control reload
341   #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
342
343   compute_node_domain: false
344   compute_node_nameservers:
345     - 192.168.1.1
346
347   # Hostname to assign to a compute node when it sends a "ping" and the
348   # hostname in its Node record is nil.
349   # During bootstrapping, the "ping" script is expected to notice the
350   # hostname given in the ping response, and update its unix hostname
351   # accordingly.
352   # If false, leave the hostname alone (this is appropriate if your compute
353   # nodes' hostnames are already assigned by some other mechanism).
354   #
355   # One way or another, the hostnames of your node records should agree
356   # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
357   #
358   # Example for compute0000, compute0001, ....:
359   # assign_node_hostname: compute%<slot_number>04d
360   # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
361   assign_node_hostname: compute%<slot_number>d
362
363
364   ###
365   ### Job and container reuse logic.
366   ###
367
368   # Include details about job reuse decisions in the server log. This
369   # causes additional database queries to run, so it should not be
370   # enabled unless you expect to examine the resulting logs for
371   # troubleshooting purposes.
372   log_reuse_decisions: false
373
374   # Control job reuse behavior when two completed jobs match the
375   # search criteria and have different outputs.
376   #
377   # If true, in case of a conflict, reuse the earliest job (this is
378   # similar to container reuse behavior).
379   #
380   # If false, in case of a conflict, do not reuse any completed job,
381   # but do reuse an already-running job if available (this is the
382   # original job reuse behavior, and is still the default).
383   reuse_job_if_outputs_differ: false
384
385   ###
386   ### Federation support.
387   ###
388
389   # You can enable use of this cluster by users who are authenticated
390   # by a remote Arvados site. Control which remote hosts are trusted
391   # to authenticate which user IDs by configuring remote_hosts,
392   # remote_hosts_via_dns, or both. The default configuration disables
393   # remote authentication.
394
395   # Map known prefixes to hosts. For example, if user IDs beginning
396   # with "zzzzz-" should be authenticated by the Arvados server at
397   # "zzzzz.example.com", use:
398   #
399   # remote_hosts:
400   #   zzzzz: zzzzz.example.com
401   remote_hosts: {}
402
403   # Use {prefix}.arvadosapi.com for any prefix not given in
404   # remote_hosts above.
405   remote_hosts_via_dns: false
406
407   ###
408   ### Remaining assorted configuration options.
409   ###
410
411   arvados_theme: default
412
413   # Permit insecure (OpenSSL::SSL::VERIFY_NONE) connections to the
414   # Single Sign On (sso) server and remote Arvados sites.  Should only
415   # be enabled during development when the SSO server is using a
416   # self-signed cert.
417   sso_insecure: true # TODO: Make this false.
418
419   ## Set Time.zone default to the specified zone and make Active
420   ## Record auto-convert to this zone.  Run "rake -D time" for a list
421   ## of tasks for finding time zone names. Default is UTC.
422   #time_zone: Central Time (US & Canada)
423
424   ## Default encoding used in templates for Ruby 1.9.
425   encoding: utf-8
426
427   # Enable the asset pipeline
428   assets.enabled: true
429
430   # Version of your assets, change this if you want to expire all your assets
431   assets.version: "1.0"
432
433   # Allow clients to create collections by providing a manifest with
434   # unsigned data blob locators. IMPORTANT: This effectively disables
435   # access controls for data stored in Keep: a client who knows a hash
436   # can write a manifest that references the hash, pass it to
437   # collections.create (which will create a permission link), use
438   # collections.get to obtain a signature for that data locator, and
439   # use that signed locator to retrieve the data from Keep. Therefore,
440   # do not turn this on if your users expect to keep data private from
441   # one another!
442   permit_create_collection_with_unsigned_manifest: false
443
444   default_openid_prefix: https://www.google.com/accounts/o8/id
445
446   # Override the automatic version string. With the default value of
447   # false, the version string is read from git-commit.version in
448   # Rails.root (included in vendor packages) or determined by invoking
449   # "git log".
450   source_version: false
451
452   # Enable asynchronous permission graph rebuild.  Must run
453   # script/permission-updater.rb as a separate process.  When the permission
454   # cache is invalidated, the background process will update the permission
455   # graph cache.  This feature is experimental!
456   async_permissions_update: false
457
458   # Default value for container_count_max for container requests.  This is the
459   # number of times Arvados will create a new container to satisfy a container
460   # request.  If a container is cancelled it will retry a new container if
461   # container_count < container_count_max on any container requests associated
462   # with the cancelled container.
463   container_count_max: 3
464
465   # Default value for keep_cache_ram of a container's runtime_constraints.
466   container_default_keep_cache_ram: 268435456
467
468   # Token to be included in all healthcheck requests. Disabled by default.
469   # Server expects request header of the format "Authorization: Bearer xxx"
470   ManagementToken: false
471
472   # URL of keep-web service.  Provides read/write access to collections via
473   # HTTP and WebDAV protocols.
474   #
475   # Example:
476   # keep_web_service_url: https://download.uuid_prefix.arvadosapi.com/
477   keep_web_service_url: false
478
479 development:
480   force_ssl: false
481   cache_classes: false
482   whiny_nils: true
483   consider_all_requests_local: true
484   action_controller.perform_caching: false
485   action_mailer.raise_delivery_errors: false
486   action_mailer.perform_deliveries: false
487   active_support.deprecation: :log
488   action_dispatch.best_standards_support: :builtin
489   active_record.auto_explain_threshold_in_seconds: 0.5
490   assets.compress: false
491   assets.debug: true
492
493 production:
494   force_ssl: true
495   cache_classes: true
496   consider_all_requests_local: false
497   action_controller.perform_caching: true
498   serve_static_files: false
499   assets.compress: true
500   assets.compile: false
501   assets.digest: true
502
503 test:
504   force_ssl: false
505   cache_classes: true
506   serve_static_files: true
507   static_cache_control: public, max-age=3600
508   whiny_nils: true
509   consider_all_requests_local: true
510   action_controller.perform_caching: false
511   action_dispatch.show_exceptions: false
512   action_controller.allow_forgery_protection: false
513   action_mailer.delivery_method: :test
514   active_support.deprecation: :stderr
515   uuid_prefix: zzzzz
516   sso_app_id: arvados-server
517   sso_app_secret: <%= rand(2**512).to_s(36) %>
518   sso_provider_url: http://localhost:3002
519   secret_token: <%= rand(2**512).to_s(36) %>
520   blob_signing_key: zfhgfenhffzltr9dixws36j1yhksjoll2grmku38mi7yxd66h5j4q9w4jzanezacp8s6q0ro3hxakfye02152hncy6zml2ed0uc
521   user_profile_notification_address: arvados@example.com
522   workbench_address: https://localhost:3001/
523   git_repositories_dir: <%= Rails.root.join 'tmp', 'git', 'test' %>
524   git_internal_dir: <%= Rails.root.join 'tmp', 'internal.git' %>
525   websocket_address: "wss://0.0.0.0:<%= ENV['ARVADOS_TEST_WSS_PORT'] %>/websocket"
526   trash_sweep_interval: -1
527   docker_image_formats: ["v2"]