15003: Merge branch 'master'
[arvados.git] / lib / config / config.default.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
6 # /etc/arvados/config.yml instead.
7 #
8 # The order of precedence (highest to lowest):
9 # 1. Legacy component-specific config files (deprecated)
10 # 2. /etc/arvados/config.yml
11 # 3. config.default.yml
12
13 Clusters:
14   xxxxx:
15     SystemRootToken: ""
16
17     # Token to be included in all healthcheck requests. Disabled by default.
18     # Server expects request header of the format "Authorization: Bearer xxx"
19     ManagementToken: ""
20
21     Services:
22       RailsAPI:
23         InternalURLs: {}
24         ExternalURL: "-"
25       Controller:
26         InternalURLs: {}
27         ExternalURL: ""
28       Websocket:
29         InternalURLs: {}
30         ExternalURL: ""
31       Keepbalance:
32         InternalURLs: {}
33         ExternalURL: "-"
34       GitHTTP:
35         InternalURLs: {}
36         ExternalURL: ""
37       GitSSH:
38         ExternalURL: ""
39       DispatchCloud:
40         InternalURLs: {}
41         ExternalURL: "-"
42       SSO:
43         ExternalURL: ""
44       Keepproxy:
45         InternalURLs: {}
46         ExternalURL: ""
47       WebDAV:
48         InternalURLs: {}
49         ExternalURL: ""
50       WebDAVDownload:
51         InternalURLs: {}
52         ExternalURL: ""
53       Keepstore:
54         InternalURLs: {}
55         ExternalURL: "-"
56       Composer:
57         ExternalURL: ""
58       WebShell:
59         ExternalURL: ""
60       Workbench1:
61         InternalURLs: {}
62         ExternalURL: ""
63       Workbench2:
64         ExternalURL: ""
65       Nodemanager:
66         InternalURLs: {}
67         ExternalURL: "-"
68       Health:
69         InternalURLs: {}
70         ExternalURL: "-"
71
72     PostgreSQL:
73       # max concurrent connections per arvados server daemon
74       ConnectionPool: 32
75       Connection:
76         # All parameters here are passed to the PG client library in a connection string;
77         # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
78         host: ""
79         port: ""
80         user: ""
81         password: ""
82         dbname: ""
83     API:
84       # Maximum size (in bytes) allowed for a single API request.  This
85       # limit is published in the discovery document for use by clients.
86       # Note: You must separately configure the upstream web server or
87       # proxy to actually enforce the desired maximum request size on the
88       # server side.
89       MaxRequestSize: 134217728
90
91       # Limit the number of bytes read from the database during an index
92       # request (by retrieving and returning fewer rows than would
93       # normally be returned in a single response).
94       # Note 1: This setting never reduces the number of returned rows to
95       # zero, no matter how big the first data row is.
96       # Note 2: Currently, this is only checked against a specific set of
97       # columns that tend to get large (collections.manifest_text,
98       # containers.mounts, workflows.definition). Other fields (e.g.,
99       # "properties" hashes) are not counted against this limit.
100       MaxIndexDatabaseRead: 134217728
101
102       # Maximum number of items to return when responding to a APIs that
103       # can return partial result sets using limit and offset parameters
104       # (e.g., *.index, groups.contents). If a request specifies a "limit"
105       # parameter higher than this value, this value is used instead.
106       MaxItemsPerResponse: 1000
107
108       # API methods to disable. Disabled methods are not listed in the
109       # discovery document, and respond 404 to all requests.
110       # Example: ["jobs.create", "pipeline_instances.create"]
111       DisabledAPIs: []
112
113       # Interval (seconds) between asynchronous permission view updates. Any
114       # permission-updating API called with the 'async' parameter schedules a an
115       # update on the permission view in the future, if not already scheduled.
116       AsyncPermissionsUpdateInterval: 20
117
118       # Maximum number of concurrent outgoing requests to make while
119       # serving a single incoming multi-cluster (federated) request.
120       MaxRequestAmplification: 4
121
122       # RailsSessionSecretToken is a string of alphanumeric characters
123       # used by Rails to sign session tokens. IMPORTANT: This is a
124       # site secret. It should be at least 50 characters.
125       RailsSessionSecretToken: ""
126
127       # Maximum wall clock time to spend handling an incoming request.
128       RequestTimeout: 5m
129
130     Users:
131       # Config parameters to automatically setup new users.  If enabled,
132       # this users will be able to self-activate.  Enable this if you want
133       # to run an open instance where anyone can create an account and use
134       # the system without requiring manual approval.
135       #
136       # The params auto_setup_new_users_with_* are meaningful only when auto_setup_new_users is turned on.
137       # auto_setup_name_blacklist is a list of usernames to be blacklisted for auto setup.
138       AutoSetupNewUsers: false
139       AutoSetupNewUsersWithVmUUID: ""
140       AutoSetupNewUsersWithRepository: false
141       AutoSetupUsernameBlacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
142
143       # When new_users_are_active is set to true, new users will be active
144       # immediately.  This skips the "self-activate" step which enforces
145       # user agreements.  Should only be enabled for development.
146       NewUsersAreActive: false
147
148       # The e-mail address of the user you would like to become marked as an admin
149       # user on their first login.
150       # In the default configuration, authentication happens through the Arvados SSO
151       # server, which uses OAuth2 against Google's servers, so in that case this
152       # should be an address associated with a Google account.
153       AutoAdminUserWithEmail: ""
154
155       # If auto_admin_first_user is set to true, the first user to log in when no
156       # other admin users exist will automatically become an admin user.
157       AutoAdminFirstUser: false
158
159       # Email address to notify whenever a user creates a profile for the
160       # first time
161       UserProfileNotificationAddress: ""
162       AdminNotifierEmailFrom: arvados@example.com
163       EmailSubjectPrefix: "[ARVADOS] "
164       UserNotifierEmailFrom: arvados@example.com
165       NewUserNotificationRecipients: []
166       NewInactiveUserNotificationRecipients: []
167
168     AuditLogs:
169       # Time to keep audit logs, in seconds. (An audit log is a row added
170       # to the "logs" table in the PostgreSQL database each time an
171       # Arvados object is created, modified, or deleted.)
172       #
173       # Currently, websocket event notifications rely on audit logs, so
174       # this should not be set lower than 300 (5 minutes).
175       MaxAge: 336h
176
177       # Maximum number of log rows to delete in a single SQL transaction.
178       #
179       # If max_audit_log_delete_batch is 0, log entries will never be
180       # deleted by Arvados. Cleanup can be done by an external process
181       # without affecting any Arvados system processes, as long as very
182       # recent (<5 minutes old) logs are not deleted.
183       #
184       # 100000 is a reasonable batch size for most sites.
185       MaxDeleteBatch: 0
186
187       # Attributes to suppress in events and audit logs.  Notably,
188       # specifying ["manifest_text"] here typically makes the database
189       # smaller and faster.
190       #
191       # Warning: Using any non-empty value here can have undesirable side
192       # effects for any client or component that relies on event logs.
193       # Use at your own risk.
194       UnloggedAttributes: []
195
196     SystemLogs:
197
198       # Logging threshold: panic, fatal, error, warn, info, debug, or
199       # trace
200       LogLevel: info
201
202       # Logging format: json or text
203       Format: json
204
205       # Maximum characters of (JSON-encoded) query parameters to include
206       # in each request log entry. When params exceed this size, they will
207       # be JSON-encoded, truncated to this size, and logged as
208       # params_truncated.
209       MaxRequestLogParamsSize: 2000
210
211     Collections:
212       # Allow clients to create collections by providing a manifest with
213       # unsigned data blob locators. IMPORTANT: This effectively disables
214       # access controls for data stored in Keep: a client who knows a hash
215       # can write a manifest that references the hash, pass it to
216       # collections.create (which will create a permission link), use
217       # collections.get to obtain a signature for that data locator, and
218       # use that signed locator to retrieve the data from Keep. Therefore,
219       # do not turn this on if your users expect to keep data private from
220       # one another!
221       BlobSigning: true
222
223       # blob_signing_key is a string of alphanumeric characters used to
224       # generate permission signatures for Keep locators. It must be
225       # identical to the permission key given to Keep. IMPORTANT: This is
226       # a site secret. It should be at least 50 characters.
227       #
228       # Modifying blob_signing_key will invalidate all existing
229       # signatures, which can cause programs to fail (e.g., arv-put,
230       # arv-get, and Crunch jobs).  To avoid errors, rotate keys only when
231       # no such processes are running.
232       BlobSigningKey: ""
233
234       # Default replication level for collections. This is used when a
235       # collection's replication_desired attribute is nil.
236       DefaultReplication: 2
237
238       # Lifetime (in seconds) of blob permission signatures generated by
239       # the API server. This determines how long a client can take (after
240       # retrieving a collection record) to retrieve the collection data
241       # from Keep. If the client needs more time than that (assuming the
242       # collection still has the same content and the relevant user/token
243       # still has permission) the client can retrieve the collection again
244       # to get fresh signatures.
245       #
246       # This must be exactly equal to the -blob-signature-ttl flag used by
247       # keepstore servers.  Otherwise, reading data blocks and saving
248       # collections will fail with HTTP 403 permission errors.
249       #
250       # Modifying blob_signature_ttl invalidates existing signatures; see
251       # blob_signing_key note above.
252       #
253       # The default is 2 weeks.
254       BlobSigningTTL: 336h
255
256       # Default lifetime for ephemeral collections: 2 weeks. This must not
257       # be less than blob_signature_ttl.
258       DefaultTrashLifetime: 336h
259
260       # Interval (seconds) between trash sweeps. During a trash sweep,
261       # collections are marked as trash if their trash_at time has
262       # arrived, and deleted if their delete_at time has arrived.
263       TrashSweepInterval: 60
264
265       # If true, enable collection versioning.
266       # When a collection's preserve_version field is true or the current version
267       # is older than the amount of seconds defined on preserve_version_if_idle,
268       # a snapshot of the collection's previous state is created and linked to
269       # the current collection.
270       CollectionVersioning: false
271
272       #   0 = auto-create a new version on every update.
273       #  -1 = never auto-create new versions.
274       # > 0 = auto-create a new version when older than the specified number of seconds.
275       PreserveVersionIfIdle: -1
276
277     Login:
278       # These settings are provided by your OAuth2 provider (e.g.,
279       # sso-provider).
280       ProviderAppSecret: ""
281       ProviderAppID: ""
282
283     Git:
284       # Git repositories must be readable by api server, or you won't be
285       # able to submit crunch jobs. To pass the test suites, put a clone
286       # of the arvados tree in {git_repositories_dir}/arvados.git or
287       # {git_repositories_dir}/arvados/.git
288       Repositories: /var/lib/arvados/git/repositories
289
290     TLS:
291       Certificate: ""
292       Key: ""
293       Insecure: false
294
295     Containers:
296       # List of supported Docker Registry image formats that compute nodes
297       # are able to use. `arv keep docker` will error out if a user tries
298       # to store an image with an unsupported format. Use an empty array
299       # to skip the compatibility check (and display a warning message to
300       # that effect).
301       #
302       # Example for sites running docker < 1.10: ["v1"]
303       # Example for sites running docker >= 1.10: ["v2"]
304       # Example for disabling check: []
305       SupportedDockerImageFormats: ["v2"]
306
307       # Include details about job reuse decisions in the server log. This
308       # causes additional database queries to run, so it should not be
309       # enabled unless you expect to examine the resulting logs for
310       # troubleshooting purposes.
311       LogReuseDecisions: false
312
313       # Default value for keep_cache_ram of a container's runtime_constraints.
314       DefaultKeepCacheRAM: 268435456
315
316       # Number of times a container can be unlocked before being
317       # automatically cancelled.
318       MaxDispatchAttempts: 5
319
320       # Default value for container_count_max for container requests.  This is the
321       # number of times Arvados will create a new container to satisfy a container
322       # request.  If a container is cancelled it will retry a new container if
323       # container_count < container_count_max on any container requests associated
324       # with the cancelled container.
325       MaxRetryAttempts: 3
326
327       # The maximum number of compute nodes that can be in use simultaneously
328       # If this limit is reduced, any existing nodes with slot number >= new limit
329       # will not be counted against the new limit. In other words, the new limit
330       # won't be strictly enforced until those nodes with higher slot numbers
331       # go down.
332       MaxComputeVMs: 64
333
334       # Preemptible instance support (e.g. AWS Spot Instances)
335       # When true, child containers will get created with the preemptible
336       # scheduling parameter parameter set.
337       UsePreemptibleInstances: false
338
339       # Include details about job reuse decisions in the server log. This
340       # causes additional database queries to run, so it should not be
341       # enabled unless you expect to examine the resulting logs for
342       # troubleshooting purposes.
343       LogReuseDecisions: false
344
345       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
346       # (experimental) cloud dispatcher for executing containers on
347       # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
348       # and ends with "\n-----END RSA PRIVATE KEY-----\n".
349       DispatchPrivateKey: none
350
351       # Maximum time to wait for workers to come up before abandoning
352       # stale locks from a previous dispatch process.
353       StaleLockTimeout: 1m
354
355       Logging:
356         # When you run the db:delete_old_container_logs task, it will find
357         # containers that have been finished for at least this many seconds,
358         # and delete their stdout, stderr, arv-mount, crunch-run, and
359         # crunchstat logs from the logs table.
360         MaxAge: 720h
361
362         # These two settings control how frequently log events are flushed to the
363         # database.  Log lines are buffered until either crunch_log_bytes_per_event
364         # has been reached or crunch_log_seconds_between_events has elapsed since
365         # the last flush.
366         LogBytesPerEvent: 4096
367         LogSecondsBetweenEvents: 1
368
369         # The sample period for throttling logs, in seconds.
370         LogThrottlePeriod: 60
371
372         # Maximum number of bytes that job can log over crunch_log_throttle_period
373         # before being silenced until the end of the period.
374         LogThrottleBytes: 65536
375
376         # Maximum number of lines that job can log over crunch_log_throttle_period
377         # before being silenced until the end of the period.
378         LogThrottleLines: 1024
379
380         # Maximum bytes that may be logged by a single job.  Log bytes that are
381         # silenced by throttling are not counted against this total.
382         LimitLogBytesPerJob: 67108864
383
384         LogPartialLineThrottlePeriod: 5
385
386         # Container logs are written to Keep and saved in a collection,
387         # which is updated periodically while the container runs.  This
388         # value sets the interval (given in seconds) between collection
389         # updates.
390         LogUpdatePeriod: 1800
391
392         # The log collection is also updated when the specified amount of
393         # log data (given in bytes) is produced in less than one update
394         # period.
395         LogUpdateSize: 33554432
396
397       SLURM:
398         Managed:
399           # Path to dns server configuration directory
400           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
401           # files or touch restart.txt (see below).
402           DNSServerConfDir: ""
403
404           # Template file for the dns server host snippets. See
405           # unbound.template in this directory for an example. If false, do
406           # not write any config files.
407           DNSServerConfTemplate: ""
408
409           # String to write to {dns_server_conf_dir}/restart.txt (with a
410           # trailing newline) after updating local data. If false, do not
411           # open or write the restart.txt file.
412           DNSServerReloadCommand: ""
413
414           # Command to run after each DNS update. Template variables will be
415           # substituted; see the "unbound" example below. If false, do not run
416           # a command.
417           DNSServerUpdateCommand: ""
418
419           ComputeNodeDomain: ""
420           ComputeNodeNameservers:
421             - 192.168.1.1
422
423           # Hostname to assign to a compute node when it sends a "ping" and the
424           # hostname in its Node record is nil.
425           # During bootstrapping, the "ping" script is expected to notice the
426           # hostname given in the ping response, and update its unix hostname
427           # accordingly.
428           # If false, leave the hostname alone (this is appropriate if your compute
429           # nodes' hostnames are already assigned by some other mechanism).
430           #
431           # One way or another, the hostnames of your node records should agree
432           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
433           #
434           # Example for compute0000, compute0001, ....:
435           # assign_node_hostname: compute%<slot_number>04d
436           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
437           AssignNodeHostname: "compute%<slot_number>d"
438
439       JobsAPI:
440         # Enable the legacy Jobs API.  This value must be a string.
441         # 'auto' -- (default) enable the Jobs API only if it has been used before
442         #         (i.e., there are job records in the database)
443         # 'true' -- enable the Jobs API despite lack of existing records.
444         # 'false' -- disable the Jobs API despite presence of existing records.
445         Enable: 'auto'
446
447         # Git repositories must be readable by api server, or you won't be
448         # able to submit crunch jobs. To pass the test suites, put a clone
449         # of the arvados tree in {git_repositories_dir}/arvados.git or
450         # {git_repositories_dir}/arvados/.git
451         GitInternalDir: /var/lib/arvados/internal.git
452
453         # Docker image to be used when none found in runtime_constraints of a job
454         DefaultDockerImage: ""
455
456         # none or slurm_immediate
457         CrunchJobWrapper: none
458
459         # username, or false = do not set uid when running jobs.
460         CrunchJobUser: crunch
461
462         # The web service must be able to create/write this file, and
463         # crunch-job must be able to stat() it.
464         CrunchRefreshTrigger: /tmp/crunch_refresh_trigger
465
466         # Control job reuse behavior when two completed jobs match the
467         # search criteria and have different outputs.
468         #
469         # If true, in case of a conflict, reuse the earliest job (this is
470         # similar to container reuse behavior).
471         #
472         # If false, in case of a conflict, do not reuse any completed job,
473         # but do reuse an already-running job if available (this is the
474         # original job reuse behavior, and is still the default).
475         ReuseJobIfOutputsDiffer: false
476
477       CloudVMs:
478         # Enable the cloud scheduler (experimental).
479         Enable: false
480
481         # Name/number of port where workers' SSH services listen.
482         SSHPort: "22"
483
484         # Interval between queue polls.
485         PollInterval: 10s
486
487         # Shell command to execute on each worker to determine whether
488         # the worker is booted and ready to run containers. It should
489         # exit zero if the worker is ready.
490         BootProbeCommand: "docker ps"
491
492         # Minimum interval between consecutive probes to a single
493         # worker.
494         ProbeInterval: 10s
495
496         # Maximum probes per second, across all workers in a pool.
497         MaxProbesPerSecond: 10
498
499         # Time before repeating SIGTERM when killing a container.
500         TimeoutSignal: 5s
501
502         # Time to give up on SIGTERM and write off the worker.
503         TimeoutTERM: 2m
504
505         # Maximum create/destroy-instance operations per second (0 =
506         # unlimited).
507         MaxCloudOpsPerSecond: 0
508
509         # Interval between cloud provider syncs/updates ("list all
510         # instances").
511         SyncInterval: 1m
512
513         # Time to leave an idle worker running (in case new containers
514         # appear in the queue that it can run) before shutting it
515         # down.
516         TimeoutIdle: 1m
517
518         # Time to wait for a new worker to boot (i.e., pass
519         # BootProbeCommand) before giving up and shutting it down.
520         TimeoutBooting: 10m
521
522         # Maximum time a worker can stay alive with no successful
523         # probes before being automatically shut down.
524         TimeoutProbe: 10m
525
526         # Time after shutting down a worker to retry the
527         # shutdown/destroy operation.
528         TimeoutShutdown: 10s
529
530         # Worker VM image ID.
531         ImageID: ami-01234567890abcdef
532
533         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
534         Driver: ec2
535
536         # Cloud-specific driver parameters.
537         DriverParameters:
538
539           # (ec2) Credentials.
540           AccessKeyID: ""
541           SecretAccessKey: ""
542
543           # (ec2) Instance configuration.
544           SecurityGroupIDs:
545             - ""
546           SubnetID: ""
547           Region: ""
548           EBSVolumeType: gp2
549           AdminUsername: debian
550
551           # (azure) Credentials.
552           SubscriptionID: ""
553           ClientID: ""
554           ClientSecret: ""
555           TenantID: ""
556
557           # (azure) Instance configuration.
558           CloudEnvironment: AzurePublicCloud
559           ResourceGroup: ""
560           Location: centralus
561           Network: ""
562           Subnet: ""
563           StorageAccount: ""
564           BlobContainer: ""
565           DeleteDanglingResourcesAfter: 20s
566           AdminUsername: arvados
567
568     InstanceTypes:
569
570       # Use the instance type name as the key (in place of "SAMPLE" in
571       # this sample entry).
572       SAMPLE:
573         # Cloud provider's instance type. Defaults to the configured type name.
574         ProviderType: ""
575         VCPUs: 1
576         RAM: 128MiB
577         IncludedScratch: 16GB
578         AddedScratch: 0
579         Price: 0.1
580         Preemptible: false
581
582     Mail:
583       MailchimpAPIKey: ""
584       MailchimpListID: ""
585       SendUserSetupNotificationEmail: ""
586       IssueReporterEmailFrom: ""
587       IssueReporterEmailTo: ""
588       SupportEmailAddress: ""
589       EmailFrom: ""
590     RemoteClusters:
591       "*":
592         Host: ""
593         Proxy: false
594         Scheme: https
595         Insecure: false
596         ActivateUsers: false
597       SAMPLE:
598         Host: sample.arvadosapi.com
599         Proxy: false
600         Scheme: https
601         Insecure: false
602         ActivateUsers: false