Merge branch '17936-arvput-batch-mode' into main. Closes #17936.
[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     # Token used internally by Arvados components to authenticate to
16     # one another. Use a string of at least 50 random alphanumerics.
17     SystemRootToken: ""
18
19     # Token to be included in all healthcheck requests. Disabled by default.
20     # Server expects request header of the format "Authorization: Bearer xxx"
21     ManagementToken: ""
22
23     Services:
24
25       # In each of the service sections below, the keys under
26       # InternalURLs are the endpoints where the service should be
27       # listening, and reachable from other hosts in the
28       # cluster. Example:
29       #
30       # InternalURLs:
31       #   "http://host1.example:12345": {}
32       #   "http://host2.example:12345": {}
33
34       RailsAPI:
35         InternalURLs: {SAMPLE: {}}
36         ExternalURL: "-"
37       Controller:
38         InternalURLs: {SAMPLE: {}}
39         ExternalURL: ""
40       Websocket:
41         InternalURLs: {SAMPLE: {}}
42         ExternalURL: ""
43       Keepbalance:
44         InternalURLs: {SAMPLE: {}}
45         ExternalURL: "-"
46       GitHTTP:
47         InternalURLs: {SAMPLE: {}}
48         ExternalURL: ""
49       GitSSH:
50         InternalURLs: {SAMPLE: {}}
51         ExternalURL: ""
52       DispatchCloud:
53         InternalURLs: {SAMPLE: {}}
54         ExternalURL: "-"
55       DispatchLSF:
56         InternalURLs: {SAMPLE: {}}
57         ExternalURL: "-"
58       Keepproxy:
59         InternalURLs: {SAMPLE: {}}
60         ExternalURL: ""
61       WebDAV:
62         InternalURLs: {SAMPLE: {}}
63         # Base URL for Workbench inline preview.  If blank, use
64         # WebDAVDownload instead, and disable inline preview.
65         # If both are empty, downloading collections from workbench
66         # will be impossible.
67         #
68         # It is important to properly configure the download service
69         # to migitate cross-site-scripting (XSS) attacks.  A HTML page
70         # can be stored in collection.  If an attacker causes a victim
71         # to visit that page through Workbench, it will be rendered by
72         # the browser.  If all collections are served at the same
73         # domain, the browser will consider collections as coming from
74         # the same origin and having access to the same browsing data,
75         # enabling malicious Javascript on that page to access Arvados
76         # on behalf of the victim.
77         #
78         # This is mitigating by having separate domains for each
79         # collection, or limiting preview to circumstances where the
80         # collection is not accessed with the user's regular
81         # full-access token.
82         #
83         # Serve preview links using uuid or pdh in subdomain
84         # (requires wildcard DNS and TLS certificate)
85         #   https://*.collections.uuid_prefix.arvadosapi.com
86         #
87         # Serve preview links using uuid or pdh in main domain
88         # (requires wildcard DNS and TLS certificate)
89         #   https://*--collections.uuid_prefix.arvadosapi.com
90         #
91         # Serve preview links by setting uuid or pdh in the path.
92         # This configuration only allows previews of public data or
93         # collection-sharing links, because these use the anonymous
94         # user token or the token is already embedded in the URL.
95         # Other data must be handled as downloads via WebDAVDownload:
96         #   https://collections.uuid_prefix.arvadosapi.com
97         #
98         ExternalURL: ""
99
100       WebDAVDownload:
101         InternalURLs: {SAMPLE: {}}
102         # Base URL for download links. If blank, serve links to WebDAV
103         # with disposition=attachment query param.  Unlike preview links,
104         # browsers do not render attachments, so there is no risk of XSS.
105         #
106         # If WebDAVDownload is blank, and WebDAV uses a
107         # single-origin form, then Workbench will show an error page
108         #
109         # Serve download links by setting uuid or pdh in the path:
110         #   https://download.uuid_prefix.arvadosapi.com
111         #
112         ExternalURL: ""
113
114       Keepstore:
115         InternalURLs:
116           SAMPLE:
117             # Rendezvous is normally empty/omitted. When changing the
118             # URL of a Keepstore service, Rendezvous should be set to
119             # the old URL (with trailing slash omitted) to preserve
120             # rendezvous ordering.
121             Rendezvous: ""
122         ExternalURL: "-"
123       Composer:
124         InternalURLs: {SAMPLE: {}}
125         ExternalURL: ""
126       WebShell:
127         InternalURLs: {SAMPLE: {}}
128         # ShellInABox service endpoint URL for a given VM.  If empty, do not
129         # offer web shell logins.
130         #
131         # E.g., using a path-based proxy server to forward connections to shell hosts:
132         # https://webshell.uuid_prefix.arvadosapi.com
133         #
134         # E.g., using a name-based proxy server to forward connections to shell hosts:
135         # https://*.webshell.uuid_prefix.arvadosapi.com
136         ExternalURL: ""
137       Workbench1:
138         InternalURLs: {SAMPLE: {}}
139         ExternalURL: ""
140       Workbench2:
141         InternalURLs: {SAMPLE: {}}
142         ExternalURL: ""
143       Health:
144         InternalURLs: {SAMPLE: {}}
145         ExternalURL: "-"
146
147     PostgreSQL:
148       # max concurrent connections per arvados server daemon
149       ConnectionPool: 32
150       Connection:
151         # All parameters here are passed to the PG client library in a connection string;
152         # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
153         host: ""
154         port: ""
155         user: ""
156         password: ""
157         dbname: ""
158         SAMPLE: ""
159     API:
160       # Limits for how long a client token created by regular users can be valid,
161       # and also is used as a default expiration policy when no expiration date is
162       # specified.
163       # Default value zero means token expirations don't get clamped and no
164       # default expiration is set.
165       MaxTokenLifetime: 0s
166
167       # Maximum size (in bytes) allowed for a single API request.  This
168       # limit is published in the discovery document for use by clients.
169       # Note: You must separately configure the upstream web server or
170       # proxy to actually enforce the desired maximum request size on the
171       # server side.
172       MaxRequestSize: 134217728
173
174       # Limit the number of bytes read from the database during an index
175       # request (by retrieving and returning fewer rows than would
176       # normally be returned in a single response).
177       # Note 1: This setting never reduces the number of returned rows to
178       # zero, no matter how big the first data row is.
179       # Note 2: Currently, this is only checked against a specific set of
180       # columns that tend to get large (collections.manifest_text,
181       # containers.mounts, workflows.definition). Other fields (e.g.,
182       # "properties" hashes) are not counted against this limit.
183       MaxIndexDatabaseRead: 134217728
184
185       # Maximum number of items to return when responding to a APIs that
186       # can return partial result sets using limit and offset parameters
187       # (e.g., *.index, groups.contents). If a request specifies a "limit"
188       # parameter higher than this value, this value is used instead.
189       MaxItemsPerResponse: 1000
190
191       # Maximum number of concurrent requests to accept in a single
192       # service process, or 0 for no limit.
193       MaxConcurrentRequests: 0
194
195       # Maximum number of 64MiB memory buffers per Keepstore server process, or
196       # 0 for no limit. When this limit is reached, up to
197       # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
198       # buffers (like GET and PUT) will wait for buffer space to be released.
199       # Any HTTP requests beyond MaxConcurrentRequests will receive an
200       # immediate 503 response.
201       #
202       # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
203       # * 1.1) fits comfortably in memory. On a host dedicated to running
204       # Keepstore, divide total memory by 88MiB to suggest a suitable value.
205       # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
206       # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
207       MaxKeepBlobBuffers: 128
208
209       # API methods to disable. Disabled methods are not listed in the
210       # discovery document, and respond 404 to all requests.
211       # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
212       DisabledAPIs: {}
213
214       # Interval (seconds) between asynchronous permission view updates. Any
215       # permission-updating API called with the 'async' parameter schedules a an
216       # update on the permission view in the future, if not already scheduled.
217       AsyncPermissionsUpdateInterval: 20s
218
219       # Maximum number of concurrent outgoing requests to make while
220       # serving a single incoming multi-cluster (federated) request.
221       MaxRequestAmplification: 4
222
223       # Maximum wall clock time to spend handling an incoming request.
224       RequestTimeout: 5m
225
226       # Websocket will send a periodic empty event after 'SendTimeout'
227       # if there is no other activity to maintain the connection /
228       # detect dropped connections.
229       SendTimeout: 60s
230
231       WebsocketClientEventQueue: 64
232       WebsocketServerEventQueue: 4
233
234       # Timeout on requests to internal Keep services.
235       KeepServiceRequestTimeout: 15s
236
237     Users:
238       # Config parameters to automatically setup new users.  If enabled,
239       # this users will be able to self-activate.  Enable this if you want
240       # to run an open instance where anyone can create an account and use
241       # the system without requiring manual approval.
242       #
243       # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
244       # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
245       AutoSetupNewUsers: false
246       AutoSetupNewUsersWithVmUUID: ""
247       AutoSetupNewUsersWithRepository: false
248       AutoSetupUsernameBlacklist:
249         arvados: {}
250         git: {}
251         gitolite: {}
252         gitolite-admin: {}
253         root: {}
254         syslog: {}
255         SAMPLE: {}
256
257       # When NewUsersAreActive is set to true, new users will be active
258       # immediately.  This skips the "self-activate" step which enforces
259       # user agreements.  Should only be enabled for development.
260       NewUsersAreActive: false
261
262       # The e-mail address of the user you would like to become marked as an admin
263       # user on their first login.
264       AutoAdminUserWithEmail: ""
265
266       # If AutoAdminFirstUser is set to true, the first user to log in when no
267       # other admin users exist will automatically become an admin user.
268       AutoAdminFirstUser: false
269
270       # Email address to notify whenever a user creates a profile for the
271       # first time
272       UserProfileNotificationAddress: ""
273       AdminNotifierEmailFrom: arvados@example.com
274       EmailSubjectPrefix: "[ARVADOS] "
275       UserNotifierEmailFrom: arvados@example.com
276       NewUserNotificationRecipients: {}
277       NewInactiveUserNotificationRecipients: {}
278
279       # Set AnonymousUserToken to enable anonymous user access. Populate this
280       # field with a long random string. Then run "bundle exec
281       # ./script/get_anonymous_user_token.rb" in the directory where your API
282       # server is running to record the token in the database.
283       AnonymousUserToken: ""
284
285       # If a new user has an alternate email address (local@domain)
286       # with the domain given here, its local part becomes the new
287       # user's default username. Otherwise, the user's primary email
288       # address is used.
289       PreferDomainForUsername: ""
290
291       UserSetupMailText: |
292         <% if not @user.full_name.empty? -%>
293         <%= @user.full_name %>,
294         <% else -%>
295         Hi there,
296         <% end -%>
297
298         Your Arvados account has been set up.  You can log in at
299
300         <%= Rails.configuration.Services.Workbench1.ExternalURL %>
301
302         Thanks,
303         Your Arvados administrator.
304
305     AuditLogs:
306       # Time to keep audit logs, in seconds. (An audit log is a row added
307       # to the "logs" table in the PostgreSQL database each time an
308       # Arvados object is created, modified, or deleted.)
309       #
310       # Currently, websocket event notifications rely on audit logs, so
311       # this should not be set lower than 300 (5 minutes).
312       MaxAge: 336h
313
314       # Maximum number of log rows to delete in a single SQL transaction.
315       #
316       # If MaxDeleteBatch is 0, log entries will never be
317       # deleted by Arvados. Cleanup can be done by an external process
318       # without affecting any Arvados system processes, as long as very
319       # recent (<5 minutes old) logs are not deleted.
320       #
321       # 100000 is a reasonable batch size for most sites.
322       MaxDeleteBatch: 0
323
324       # Attributes to suppress in events and audit logs.  Notably,
325       # specifying {"manifest_text": {}} here typically makes the database
326       # smaller and faster.
327       #
328       # Warning: Using any non-empty value here can have undesirable side
329       # effects for any client or component that relies on event logs.
330       # Use at your own risk.
331       UnloggedAttributes: {}
332
333     SystemLogs:
334
335       # Logging threshold: panic, fatal, error, warn, info, debug, or
336       # trace
337       LogLevel: info
338
339       # Logging format: json or text
340       Format: json
341
342       # Maximum characters of (JSON-encoded) query parameters to include
343       # in each request log entry. When params exceed this size, they will
344       # be JSON-encoded, truncated to this size, and logged as
345       # params_truncated.
346       MaxRequestLogParamsSize: 2000
347
348     Collections:
349
350       # Enable access controls for data stored in Keep. This should
351       # always be set to true on a production cluster.
352       BlobSigning: true
353
354       # BlobSigningKey is a string of alphanumeric characters used to
355       # generate permission signatures for Keep locators. It must be
356       # identical to the permission key given to Keep. IMPORTANT: This
357       # is a site secret. It should be at least 50 characters.
358       #
359       # Modifying BlobSigningKey will invalidate all existing
360       # signatures, which can cause programs to fail (e.g., arv-put,
361       # arv-get, and Crunch jobs).  To avoid errors, rotate keys only
362       # when no such processes are running.
363       BlobSigningKey: ""
364
365       # Enable garbage collection of unreferenced blobs in Keep.
366       BlobTrash: true
367
368       # Time to leave unreferenced blobs in "trashed" state before
369       # deleting them, or 0 to skip the "trashed" state entirely and
370       # delete unreferenced blobs.
371       #
372       # If you use any Amazon S3 buckets as storage volumes, this
373       # must be at least 24h to avoid occasional data loss.
374       BlobTrashLifetime: 336h
375
376       # How often to check for (and delete) trashed blocks whose
377       # BlobTrashLifetime has expired.
378       BlobTrashCheckInterval: 24h
379
380       # Maximum number of concurrent "trash blob" and "delete trashed
381       # blob" operations conducted by a single keepstore process. Each
382       # of these can be set to 0 to disable the respective operation.
383       #
384       # If BlobTrashLifetime is zero, "trash" and "delete trash"
385       # happen at once, so only the lower of these two values is used.
386       BlobTrashConcurrency: 4
387       BlobDeleteConcurrency: 4
388
389       # Maximum number of concurrent "create additional replica of
390       # existing blob" operations conducted by a single keepstore
391       # process.
392       BlobReplicateConcurrency: 4
393
394       # Default replication level for collections. This is used when a
395       # collection's replication_desired attribute is nil.
396       DefaultReplication: 2
397
398       # BlobSigningTTL determines the minimum lifetime of transient
399       # data, i.e., blocks that are not referenced by
400       # collections. Unreferenced blocks exist for two reasons:
401       #
402       # 1) A data block must be written to a disk/cloud backend device
403       # before a collection can be created/updated with a reference to
404       # it.
405       #
406       # 2) Deleting or updating a collection can remove the last
407       # remaining reference to a data block.
408       #
409       # If BlobSigningTTL is too short, long-running
410       # processes/containers will fail when they take too long (a)
411       # between writing blocks and writing collections that reference
412       # them, or (b) between reading collections and reading the
413       # referenced blocks.
414       #
415       # If BlobSigningTTL is too long, data will still be stored long
416       # after the referring collections are deleted, and you will
417       # needlessly fill up disks or waste money on cloud storage.
418       #
419       # Modifying BlobSigningTTL invalidates existing signatures; see
420       # BlobSigningKey note above.
421       #
422       # The default is 2 weeks.
423       BlobSigningTTL: 336h
424
425       # When running keep-balance, this is the destination filename for
426       # the list of lost block hashes if there are any, one per line.
427       # Updated automically during each successful run.
428       BlobMissingReport: ""
429
430       # keep-balance operates periodically, i.e.: do a
431       # scan/balance operation, sleep, repeat.
432       #
433       # BalancePeriod determines the interval between start times of
434       # successive scan/balance operations. If a scan/balance operation
435       # takes longer than BalancePeriod, the next one will follow it
436       # immediately.
437       #
438       # If SIGUSR1 is received during an idle period between operations,
439       # the next operation will start immediately.
440       BalancePeriod: 10m
441
442       # Limits the number of collections retrieved by keep-balance per
443       # API transaction. If this is zero, page size is
444       # determined by the API server's own page size limits (see
445       # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
446       BalanceCollectionBatch: 0
447
448       # The size of keep-balance's internal queue of
449       # collections. Higher values use more memory and improve throughput
450       # by allowing keep-balance to fetch the next page of collections
451       # while the current page is still being processed. If this is zero
452       # or omitted, pages are processed serially.
453       BalanceCollectionBuffers: 1000
454
455       # Maximum time for a rebalancing run. This ensures keep-balance
456       # eventually gives up and retries if, for example, a network
457       # error causes a hung connection that is never closed by the
458       # OS. It should be long enough that it doesn't interrupt a
459       # long-running balancing operation.
460       BalanceTimeout: 6h
461
462       # Maximum number of replication_confirmed /
463       # storage_classes_confirmed updates to write to the database
464       # after a rebalancing run. When many updates are needed, this
465       # spreads them over a few runs rather than applying them all at
466       # once.
467       BalanceUpdateLimit: 100000
468
469       # Default lifetime for ephemeral collections: 2 weeks. This must not
470       # be less than BlobSigningTTL.
471       DefaultTrashLifetime: 336h
472
473       # Interval (seconds) between trash sweeps. During a trash sweep,
474       # collections are marked as trash if their trash_at time has
475       # arrived, and deleted if their delete_at time has arrived.
476       TrashSweepInterval: 60s
477
478       # If true, enable collection versioning.
479       # When a collection's preserve_version field is true or the current version
480       # is older than the amount of seconds defined on PreserveVersionIfIdle,
481       # a snapshot of the collection's previous state is created and linked to
482       # the current collection.
483       CollectionVersioning: false
484
485       #   0s = auto-create a new version on every update.
486       #  -1s = never auto-create new versions.
487       # > 0s = auto-create a new version when older than the specified number of seconds.
488       PreserveVersionIfIdle: -1s
489
490       # If non-empty, allow project and collection names to contain
491       # the "/" character (slash/stroke/solidus), and replace "/" with
492       # the given string in the filesystem hierarchy presented by
493       # WebDAV. Example values are "%2f" and "{slash}". Names that
494       # contain the substitution string itself may result in confusing
495       # behavior, so a value like "_" is not recommended.
496       #
497       # If the default empty value is used, the server will reject
498       # requests to create or rename a collection when the new name
499       # contains "/".
500       #
501       # If the value "/" is used, project and collection names
502       # containing "/" will be allowed, but they will not be
503       # accessible via WebDAV.
504       #
505       # Use of this feature is not recommended, if it can be avoided.
506       ForwardSlashNameSubstitution: ""
507
508       # Include "folder objects" in S3 ListObjects responses.
509       S3FolderObjects: true
510
511       # Managed collection properties. At creation time, if the client didn't
512       # provide the listed keys, they will be automatically populated following
513       # one of the following behaviors:
514       #
515       # * UUID of the user who owns the containing project.
516       #   responsible_person_uuid: {Function: original_owner, Protected: true}
517       #
518       # * Default concrete value.
519       #   foo_bar: {Value: baz, Protected: false}
520       #
521       # If Protected is true, only an admin user can modify its value.
522       ManagedProperties:
523         SAMPLE: {Function: original_owner, Protected: true}
524
525       # In "trust all content" mode, Workbench will redirect download
526       # requests to WebDAV preview link, even in the cases when
527       # WebDAV would have to expose XSS vulnerabilities in order to
528       # handle the redirect (see discussion on Services.WebDAV).
529       #
530       # This setting has no effect in the recommended configuration, where the
531       # WebDAV service is configured to have a separate domain for every
532       # collection and XSS protection is provided by browsers' same-origin
533       # policy.
534       #
535       # The default setting (false) is appropriate for a multi-user site.
536       TrustAllContent: false
537
538       # Cache parameters for WebDAV content serving:
539       WebDAVCache:
540         # Time to cache manifests, permission checks, and sessions.
541         TTL: 300s
542
543         # Time to cache collection state.
544         UUIDTTL: 5s
545
546         # Block cache entries. Each block consumes up to 64 MiB RAM.
547         MaxBlockEntries: 20
548
549         # Collection cache entries.
550         MaxCollectionEntries: 1000
551
552         # Approximate memory limit (in bytes) for collection cache.
553         MaxCollectionBytes: 100000000
554
555         # Permission cache entries.
556         MaxPermissionEntries: 1000
557
558         # UUID cache entries.
559         MaxUUIDEntries: 1000
560
561         # Persistent sessions.
562         MaxSessions: 100
563
564       # Selectively set permissions for regular users and admins to
565       # download or upload data files using the upload/download
566       # features for Workbench, WebDAV and S3 API support.
567       WebDAVPermission:
568         User:
569           Download: true
570           Upload: true
571         Admin:
572           Download: true
573           Upload: true
574
575       # Selectively set permissions for regular users and admins to be
576       # able to download or upload blocks using arv-put and
577       # arv-get from outside the cluster.
578       KeepproxyPermission:
579         User:
580           Download: true
581           Upload: true
582         Admin:
583           Download: true
584           Upload: true
585
586       # Post upload / download events to the API server logs table, so
587       # that they can be included in the arv-user-activity report.
588       # You can disable this if you find that it is creating excess
589       # load on the API server and you don't need it.
590       WebDAVLogEvents: true
591
592     Login:
593       # One of the following mechanisms (Google, PAM, LDAP, or
594       # LoginCluster) should be enabled; see
595       # https://doc.arvados.org/install/setup-login.html
596
597       Google:
598         # Authenticate with Google.
599         Enable: false
600
601         # Use the Google Cloud console to enable the People API (APIs
602         # and Services > Enable APIs and services > Google People API
603         # > Enable), generate a Client ID and secret (APIs and
604         # Services > Credentials > Create credentials > OAuth client
605         # ID > Web application) and add your controller's /login URL
606         # (e.g., "https://zzzzz.example.com/login") as an authorized
607         # redirect URL.
608         ClientID: ""
609         ClientSecret: ""
610
611         # Allow users to log in to existing accounts using any verified
612         # email address listed by their Google account. If true, the
613         # Google People API must be enabled in order for Google login to
614         # work. If false, only the primary email address will be used.
615         AlternateEmailAddresses: true
616
617         # Send additional parameters with authentication requests. See
618         # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
619         # for a list of supported parameters.
620         AuthenticationRequestParameters:
621           # Show the "choose which Google account" page, even if the
622           # client is currently logged in to exactly one Google
623           # account.
624           prompt: select_account
625
626           SAMPLE: ""
627
628       OpenIDConnect:
629         # Authenticate with an OpenID Connect provider.
630         Enable: false
631
632         # Issuer URL, e.g., "https://login.example.com".
633         #
634         # This must be exactly equal to the URL returned by the issuer
635         # itself in its config response ("isser" key). If the
636         # configured value is "https://example" and the provider
637         # returns "https://example:443" or "https://example/" then
638         # login will fail, even though those URLs are equivalent
639         # (RFC3986).
640         Issuer: ""
641
642         # Your client ID and client secret (supplied by the provider).
643         ClientID: ""
644         ClientSecret: ""
645
646         # OpenID claim field containing the user's email
647         # address. Normally "email"; see
648         # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
649         EmailClaim: "email"
650
651         # OpenID claim field containing the email verification
652         # flag. Normally "email_verified".  To accept every returned
653         # email address without checking a "verified" field at all,
654         # use the empty string "".
655         EmailVerifiedClaim: "email_verified"
656
657         # OpenID claim field containing the user's preferred
658         # username. If empty, use the mailbox part of the user's email
659         # address.
660         UsernameClaim: ""
661
662         # Send additional parameters with authentication requests,
663         # like {display: page, prompt: consent}. See
664         # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
665         # and refer to your provider's documentation for supported
666         # parameters.
667         AuthenticationRequestParameters:
668           SAMPLE: ""
669
670         # Accept an OIDC access token as an API token if the OIDC
671         # provider's UserInfo endpoint accepts it.
672         #
673         # AcceptAccessTokenScope should also be used when enabling
674         # this feature.
675         AcceptAccessToken: false
676
677         # Before accepting an OIDC access token as an API token, first
678         # check that it is a JWT whose "scope" value includes this
679         # value. Example: "https://zzzzz.example.com/" (your Arvados
680         # API endpoint).
681         #
682         # If this value is empty and AcceptAccessToken is true, all
683         # access tokens will be accepted regardless of scope,
684         # including non-JWT tokens. This is not recommended.
685         AcceptAccessTokenScope: ""
686
687       PAM:
688         # (Experimental) Use PAM to authenticate users.
689         Enable: false
690
691         # PAM service name. PAM will apply the policy in the
692         # corresponding config file (e.g., /etc/pam.d/arvados) or, if
693         # there is none, the default "other" config.
694         Service: arvados
695
696         # Domain name (e.g., "example.com") to use to construct the
697         # user's email address if PAM authentication returns a
698         # username with no "@". If empty, use the PAM username as the
699         # user's email address, whether or not it contains "@".
700         #
701         # Note that the email address is used as the primary key for
702         # user records when logging in. Therefore, if you change
703         # PAMDefaultEmailDomain after the initial installation, you
704         # should also update existing user records to reflect the new
705         # domain. Otherwise, next time those users log in, they will
706         # be given new accounts instead of accessing their existing
707         # accounts.
708         DefaultEmailDomain: ""
709
710       LDAP:
711         # Use an LDAP service to authenticate users.
712         Enable: false
713
714         # Server URL, like "ldap://ldapserver.example.com:389" or
715         # "ldaps://ldapserver.example.com:636".
716         URL: "ldap://ldap:389"
717
718         # Use StartTLS upon connecting to the server.
719         StartTLS: true
720
721         # Skip TLS certificate name verification.
722         InsecureTLS: false
723
724         # Strip the @domain part if a user supplies an email-style
725         # username with this domain. If "*", strip any user-provided
726         # domain. If "", never strip the domain part. Example:
727         # "example.com"
728         StripDomain: ""
729
730         # If, after applying StripDomain, the username contains no "@"
731         # character, append this domain to form an email-style
732         # username. Example: "example.com"
733         AppendDomain: ""
734
735         # The LDAP attribute to filter on when looking up a username
736         # (after applying StripDomain and AppendDomain).
737         SearchAttribute: uid
738
739         # Bind with this username (DN or UPN) and password when
740         # looking up the user record.
741         #
742         # Example user: "cn=admin,dc=example,dc=com"
743         SearchBindUser: ""
744         SearchBindPassword: ""
745
746         # Directory base for username lookup. Example:
747         # "ou=Users,dc=example,dc=com"
748         SearchBase: ""
749
750         # Additional filters to apply when looking up users' LDAP
751         # entries. This can be used to restrict access to a subset of
752         # LDAP users, or to disambiguate users from other directory
753         # entries that have the SearchAttribute present.
754         #
755         # Special characters in assertion values must be escaped (see
756         # RFC4515).
757         #
758         # Example: "(objectClass=person)"
759         SearchFilters: ""
760
761         # LDAP attribute to use as the user's email address.
762         #
763         # Important: This must not be an attribute whose value can be
764         # edited in the directory by the users themselves. Otherwise,
765         # users can take over other users' Arvados accounts trivially
766         # (email address is the primary key for Arvados accounts.)
767         EmailAttribute: mail
768
769         # LDAP attribute to use as the preferred Arvados username. If
770         # no value is found (or this config is empty) the username
771         # originally supplied by the user will be used.
772         UsernameAttribute: uid
773
774       Test:
775         # Authenticate users listed here in the config file. This
776         # feature is intended to be used in test environments, and
777         # should not be used in production.
778         Enable: false
779         Users:
780           SAMPLE:
781             Email: alice@example.com
782             Password: xyzzy
783
784       # The cluster ID to delegate the user database.  When set,
785       # logins on this cluster will be redirected to the login cluster
786       # (login cluster must appear in RemoteClusters with Proxy: true)
787       LoginCluster: ""
788
789       # How long a cached token belonging to a remote cluster will
790       # remain valid before it needs to be revalidated.
791       RemoteTokenRefresh: 5m
792
793       # How long a client token created from a login flow will be valid without
794       # asking the user to re-login. Example values: 60m, 8h.
795       # Default value zero means tokens don't have expiration.
796       TokenLifetime: 0s
797
798       # If true (default) tokens issued through login are allowed to create
799       # new tokens.
800       # If false, tokens issued through login are not allowed to
801       # viewing/creating other tokens.  New tokens can only be created
802       # by going through login again.
803       IssueTrustedTokens: true
804
805       # When the token is returned to a client, the token itself may
806       # be restricted from viewing/creating other tokens based on whether
807       # the client is "trusted" or not.  The local Workbench1 and
808       # Workbench2 are trusted by default, but if this is a
809       # LoginCluster, you probably want to include the other Workbench
810       # instances in the federation in this list.
811       TrustedClients:
812         SAMPLE:
813           "https://workbench.federate1.example": {}
814           "https://workbench.federate2.example": {}
815
816     Git:
817       # Path to git or gitolite-shell executable. Each authenticated
818       # request will execute this program with the single argument "http-backend"
819       GitCommand: /usr/bin/git
820
821       # Path to Gitolite's home directory. If a non-empty path is given,
822       # the CGI environment will be set up to support the use of
823       # gitolite-shell as a GitCommand: for example, if GitoliteHome is
824       # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
825       # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
826       GitoliteHome: ""
827
828       # Git repositories must be readable by api server, or you won't be
829       # able to submit crunch jobs. To pass the test suites, put a clone
830       # of the arvados tree in {git_repositories_dir}/arvados.git or
831       # {git_repositories_dir}/arvados/.git
832       Repositories: /var/lib/arvados/git/repositories
833
834     TLS:
835       Certificate: ""
836       Key: ""
837       Insecure: false
838
839     Containers:
840       # List of supported Docker Registry image formats that compute nodes
841       # are able to use. `arv keep docker` will error out if a user tries
842       # to store an image with an unsupported format. Use an empty array
843       # to skip the compatibility check (and display a warning message to
844       # that effect).
845       #
846       # Example for sites running docker < 1.10: {"v1": {}}
847       # Example for sites running docker >= 1.10: {"v2": {}}
848       # Example for disabling check: {}
849       SupportedDockerImageFormats:
850         "v2": {}
851         SAMPLE: {}
852
853       # Include details about job reuse decisions in the server log. This
854       # causes additional database queries to run, so it should not be
855       # enabled unless you expect to examine the resulting logs for
856       # troubleshooting purposes.
857       LogReuseDecisions: false
858
859       # Default value for keep_cache_ram of a container's runtime_constraints.
860       DefaultKeepCacheRAM: 268435456
861
862       # Number of times a container can be unlocked before being
863       # automatically cancelled.
864       MaxDispatchAttempts: 5
865
866       # Default value for container_count_max for container requests.  This is the
867       # number of times Arvados will create a new container to satisfy a container
868       # request.  If a container is cancelled it will retry a new container if
869       # container_count < container_count_max on any container requests associated
870       # with the cancelled container.
871       MaxRetryAttempts: 3
872
873       # The maximum number of compute nodes that can be in use simultaneously
874       # If this limit is reduced, any existing nodes with slot number >= new limit
875       # will not be counted against the new limit. In other words, the new limit
876       # won't be strictly enforced until those nodes with higher slot numbers
877       # go down.
878       MaxComputeVMs: 64
879
880       # Preemptible instance support (e.g. AWS Spot Instances)
881       # When true, child containers will get created with the preemptible
882       # scheduling parameter parameter set.
883       UsePreemptibleInstances: false
884
885       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
886       # (experimental) cloud dispatcher for executing containers on
887       # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
888       # and ends with "\n-----END RSA PRIVATE KEY-----\n".
889       DispatchPrivateKey: ""
890
891       # Maximum time to wait for workers to come up before abandoning
892       # stale locks from a previous dispatch process.
893       StaleLockTimeout: 1m
894
895       # The crunch-run command used to start a container on a worker node.
896       #
897       # When dispatching to cloud VMs, this is used only if
898       # DeployRunnerBinary in the CloudVMs section is set to the empty
899       # string.
900       CrunchRunCommand: "crunch-run"
901
902       # Extra arguments to add to crunch-run invocation
903       # Example: ["--cgroup-parent-subsystem=memory"]
904       CrunchRunArgumentsList: []
905
906       # Extra RAM to reserve on the node, in addition to
907       # the amount specified in the container's RuntimeConstraints
908       ReserveExtraRAM: 256MiB
909
910       # Minimum time between two attempts to run the same container
911       MinRetryPeriod: 0s
912
913       # Container runtime: "docker" (default) or "singularity" (experimental)
914       RuntimeEngine: docker
915
916       Logging:
917         # When you run the db:delete_old_container_logs task, it will find
918         # containers that have been finished for at least this many seconds,
919         # and delete their stdout, stderr, arv-mount, crunch-run, and
920         # crunchstat logs from the logs table.
921         MaxAge: 720h
922
923         # These two settings control how frequently log events are flushed to the
924         # database.  Log lines are buffered until either crunch_log_bytes_per_event
925         # has been reached or crunch_log_seconds_between_events has elapsed since
926         # the last flush.
927         LogBytesPerEvent: 4096
928         LogSecondsBetweenEvents: 5s
929
930         # The sample period for throttling logs.
931         LogThrottlePeriod: 60s
932
933         # Maximum number of bytes that job can log over crunch_log_throttle_period
934         # before being silenced until the end of the period.
935         LogThrottleBytes: 65536
936
937         # Maximum number of lines that job can log over crunch_log_throttle_period
938         # before being silenced until the end of the period.
939         LogThrottleLines: 1024
940
941         # Maximum bytes that may be logged by a single job.  Log bytes that are
942         # silenced by throttling are not counted against this total.
943         LimitLogBytesPerJob: 67108864
944
945         LogPartialLineThrottlePeriod: 5s
946
947         # Container logs are written to Keep and saved in a
948         # collection, which is updated periodically while the
949         # container runs.  This value sets the interval between
950         # collection updates.
951         LogUpdatePeriod: 30m
952
953         # The log collection is also updated when the specified amount of
954         # log data (given in bytes) is produced in less than one update
955         # period.
956         LogUpdateSize: 32MiB
957
958       ShellAccess:
959         # An admin user can use "arvados-client shell" to start an
960         # interactive shell (with any user ID) in any running
961         # container.
962         Admin: false
963
964         # Any user can use "arvados-client shell" to start an
965         # interactive shell (with any user ID) in any running
966         # container that they started, provided it isn't also
967         # associated with a different user's container request.
968         #
969         # Interactive sessions make it easy to alter the container's
970         # runtime environment in ways that aren't recorded or
971         # reproducible. Consider the implications for automatic
972         # container reuse before enabling and using this feature. In
973         # particular, note that starting an interactive session does
974         # not disqualify a container from being reused by a different
975         # user/workflow in the future.
976         User: false
977
978       SLURM:
979         PrioritySpread: 0
980         SbatchArgumentsList: []
981         SbatchEnvironmentVariables:
982           SAMPLE: ""
983         Managed:
984           # Path to dns server configuration directory
985           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
986           # files or touch restart.txt (see below).
987           DNSServerConfDir: ""
988
989           # Template file for the dns server host snippets. See
990           # unbound.template in this directory for an example. If false, do
991           # not write any config files.
992           DNSServerConfTemplate: ""
993
994           # String to write to {dns_server_conf_dir}/restart.txt (with a
995           # trailing newline) after updating local data. If false, do not
996           # open or write the restart.txt file.
997           DNSServerReloadCommand: ""
998
999           # Command to run after each DNS update. Template variables will be
1000           # substituted; see the "unbound" example below. If false, do not run
1001           # a command.
1002           DNSServerUpdateCommand: ""
1003
1004           ComputeNodeDomain: ""
1005           ComputeNodeNameservers:
1006             "192.168.1.1": {}
1007             SAMPLE: {}
1008
1009           # Hostname to assign to a compute node when it sends a "ping" and the
1010           # hostname in its Node record is nil.
1011           # During bootstrapping, the "ping" script is expected to notice the
1012           # hostname given in the ping response, and update its unix hostname
1013           # accordingly.
1014           # If false, leave the hostname alone (this is appropriate if your compute
1015           # nodes' hostnames are already assigned by some other mechanism).
1016           #
1017           # One way or another, the hostnames of your node records should agree
1018           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1019           #
1020           # Example for compute0000, compute0001, ....:
1021           # assign_node_hostname: compute%<slot_number>04d
1022           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1023           AssignNodeHostname: "compute%<slot_number>d"
1024
1025       LSF:
1026         # Additional arguments to bsub when submitting Arvados
1027         # containers as LSF jobs.
1028         BsubArgumentsList: []
1029
1030         # Use sudo to switch to this user account when submitting LSF
1031         # jobs.
1032         #
1033         # This account must exist on the hosts where LSF jobs run
1034         # ("execution hosts"), as well as on the host where the
1035         # Arvados LSF dispatcher runs ("submission host").
1036         BsubSudoUser: "crunch"
1037
1038       JobsAPI:
1039         # Enable the legacy 'jobs' API (crunch v1).  This value must be a string.
1040         #
1041         # Note: this only enables read-only access, creating new
1042         # legacy jobs and pipelines is not supported.
1043         #
1044         # 'auto' -- (default) enable the Jobs API only if it has been used before
1045         #         (i.e., there are job records in the database)
1046         # 'true' -- enable the Jobs API despite lack of existing records.
1047         # 'false' -- disable the Jobs API despite presence of existing records.
1048         Enable: 'auto'
1049
1050         # Git repositories must be readable by api server, or you won't be
1051         # able to submit crunch jobs. To pass the test suites, put a clone
1052         # of the arvados tree in {git_repositories_dir}/arvados.git or
1053         # {git_repositories_dir}/arvados/.git
1054         GitInternalDir: /var/lib/arvados/internal.git
1055
1056       CloudVMs:
1057         # Enable the cloud scheduler (experimental).
1058         Enable: false
1059
1060         # Name/number of port where workers' SSH services listen.
1061         SSHPort: "22"
1062
1063         # Interval between queue polls.
1064         PollInterval: 10s
1065
1066         # Shell command to execute on each worker to determine whether
1067         # the worker is booted and ready to run containers. It should
1068         # exit zero if the worker is ready.
1069         BootProbeCommand: "docker ps -q"
1070
1071         # Minimum interval between consecutive probes to a single
1072         # worker.
1073         ProbeInterval: 10s
1074
1075         # Maximum probes per second, across all workers in a pool.
1076         MaxProbesPerSecond: 10
1077
1078         # Time before repeating SIGTERM when killing a container.
1079         TimeoutSignal: 5s
1080
1081         # Time to give up on a process (most likely arv-mount) that
1082         # still holds a container lockfile after its main supervisor
1083         # process has exited, and declare the instance broken.
1084         TimeoutStaleRunLock: 5s
1085
1086         # Time to give up on SIGTERM and write off the worker.
1087         TimeoutTERM: 2m
1088
1089         # Maximum create/destroy-instance operations per second (0 =
1090         # unlimited).
1091         MaxCloudOpsPerSecond: 0
1092
1093         # Maximum concurrent node creation operations (0 = unlimited). This is
1094         # recommended by Azure in certain scenarios (see
1095         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
1096         # and can be used with other cloud providers too, if desired.
1097         MaxConcurrentInstanceCreateOps: 0
1098
1099         # Interval between cloud provider syncs/updates ("list all
1100         # instances").
1101         SyncInterval: 1m
1102
1103         # Time to leave an idle worker running (in case new containers
1104         # appear in the queue that it can run) before shutting it
1105         # down.
1106         TimeoutIdle: 1m
1107
1108         # Time to wait for a new worker to boot (i.e., pass
1109         # BootProbeCommand) before giving up and shutting it down.
1110         TimeoutBooting: 10m
1111
1112         # Maximum time a worker can stay alive with no successful
1113         # probes before being automatically shut down.
1114         TimeoutProbe: 10m
1115
1116         # Time after shutting down a worker to retry the
1117         # shutdown/destroy operation.
1118         TimeoutShutdown: 10s
1119
1120         # Worker VM image ID.
1121         # (aws) AMI identifier
1122         # (azure) managed disks: the name of the managed disk image
1123         # (azure) shared image gallery: the name of the image definition. Also
1124         # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1125         # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1126         # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1127         ImageID: ""
1128
1129         # An executable file (located on the dispatcher host) to be
1130         # copied to cloud instances at runtime and used as the
1131         # container runner/supervisor. The default value is the
1132         # dispatcher program itself.
1133         #
1134         # Use the empty string to disable this step: nothing will be
1135         # copied, and cloud instances are assumed to have a suitable
1136         # version of crunch-run installed; see CrunchRunCommand above.
1137         DeployRunnerBinary: "/proc/self/exe"
1138
1139         # Tags to add on all resources (VMs, NICs, disks) created by
1140         # the container dispatcher. (Arvados's own tags --
1141         # InstanceType, IdleBehavior, and InstanceSecret -- will also
1142         # be added.)
1143         ResourceTags:
1144           SAMPLE: "tag value"
1145
1146         # Prefix for predefined tags used by Arvados (InstanceSetID,
1147         # InstanceType, InstanceSecret, IdleBehavior). With the
1148         # default value "Arvados", tags are "ArvadosInstanceSetID",
1149         # "ArvadosInstanceSecret", etc.
1150         #
1151         # This should only be changed while no cloud resources are in
1152         # use and the cloud dispatcher is not running. Otherwise,
1153         # VMs/resources that were added using the old tag prefix will
1154         # need to be detected and cleaned up manually.
1155         TagKeyPrefix: Arvados
1156
1157         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1158         Driver: ec2
1159
1160         # Cloud-specific driver parameters.
1161         DriverParameters:
1162
1163           # (ec2) Credentials. Omit or leave blank if using IAM role.
1164           AccessKeyID: ""
1165           SecretAccessKey: ""
1166
1167           # (ec2) Instance configuration.
1168           SecurityGroupIDs:
1169             "SAMPLE": {}
1170           SubnetID: ""
1171           Region: ""
1172           EBSVolumeType: gp2
1173           AdminUsername: debian
1174
1175           # (azure) Credentials.
1176           SubscriptionID: ""
1177           ClientID: ""
1178           ClientSecret: ""
1179           TenantID: ""
1180
1181           # (azure) Instance configuration.
1182           CloudEnvironment: AzurePublicCloud
1183           Location: centralus
1184
1185           # (azure) The resource group where the VM and virtual NIC will be
1186           # created.
1187           ResourceGroup: ""
1188
1189           # (azure) The resource group of the Network to use for the virtual
1190           # NIC (if different from ResourceGroup)
1191           NetworkResourceGroup: ""
1192           Network: ""
1193           Subnet: ""
1194
1195           # (azure) managed disks: The resource group where the managed disk
1196           # image can be found (if different from ResourceGroup).
1197           ImageResourceGroup: ""
1198
1199           # (azure) shared image gallery: the name of the gallery
1200           SharedImageGalleryName: ""
1201           # (azure) shared image gallery: the version of the image definition
1202           SharedImageGalleryImageVersion: ""
1203
1204           # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1205           StorageAccount: ""
1206           BlobContainer: ""
1207
1208           # (azure) How long to wait before deleting VHD and NIC
1209           # objects that are no longer being used.
1210           DeleteDanglingResourcesAfter: 20s
1211
1212           # Account (that already exists in the VM image) that will be
1213           # set up with an ssh authorized key to allow the compute
1214           # dispatcher to connect.
1215           AdminUsername: arvados
1216
1217     InstanceTypes:
1218
1219       # Use the instance type name as the key (in place of "SAMPLE" in
1220       # this sample entry).
1221       SAMPLE:
1222         # Cloud provider's instance type. Defaults to the configured type name.
1223         ProviderType: ""
1224         VCPUs: 1
1225         RAM: 128MiB
1226         IncludedScratch: 16GB
1227         AddedScratch: 0
1228         Price: 0.1
1229         Preemptible: false
1230
1231     StorageClasses:
1232
1233       # If you use multiple storage classes, specify them here, using
1234       # the storage class name as the key (in place of "SAMPLE" in
1235       # this sample entry).
1236       #
1237       # Further info/examples:
1238       # https://doc.arvados.org/admin/storage-classes.html
1239       SAMPLE:
1240
1241         # Priority determines the order volumes should be searched
1242         # when reading data, in cases where a keepstore server has
1243         # access to multiple volumes with different storage classes.
1244         Priority: 0
1245
1246         # Default determines which storage class(es) should be used
1247         # when a user/client writes data or saves a new collection
1248         # without specifying storage classes.
1249         #
1250         # If any StorageClasses are configured, at least one of them
1251         # must have Default: true.
1252         Default: true
1253
1254     Volumes:
1255       SAMPLE:
1256         # AccessViaHosts specifies which keepstore processes can read
1257         # and write data on the volume.
1258         #
1259         # For a local filesystem, AccessViaHosts has one entry,
1260         # indicating which server the filesystem is located on.
1261         #
1262         # For a network-attached backend accessible by all keepstore
1263         # servers, like a cloud storage bucket or an NFS mount,
1264         # AccessViaHosts can be empty/omitted.
1265         #
1266         # Further info/examples:
1267         # https://doc.arvados.org/install/configure-fs-storage.html
1268         # https://doc.arvados.org/install/configure-s3-object-storage.html
1269         # https://doc.arvados.org/install/configure-azure-blob-storage.html
1270         AccessViaHosts:
1271           SAMPLE:
1272             ReadOnly: false
1273           "http://host1.example:25107": {}
1274         ReadOnly: false
1275         Replication: 1
1276         StorageClasses:
1277           # If you have configured storage classes (see StorageClasses
1278           # section above), add an entry here for each storage class
1279           # satisfied by this volume.
1280           SAMPLE: true
1281         Driver: S3
1282         DriverParameters:
1283           # for s3 driver -- see
1284           # https://doc.arvados.org/install/configure-s3-object-storage.html
1285           IAMRole: aaaaa
1286           AccessKeyID: aaaaa
1287           SecretAccessKey: aaaaa
1288           Endpoint: ""
1289           Region: us-east-1a
1290           Bucket: aaaaa
1291           LocationConstraint: false
1292           V2Signature: false
1293           IndexPageSize: 1000
1294           ConnectTimeout: 1m
1295           ReadTimeout: 10m
1296           RaceWindow: 24h
1297           # Use aws-s3-go (v2) instead of goamz
1298           UseAWSS3v2Driver: false
1299
1300           # For S3 driver, potentially unsafe tuning parameter,
1301           # intentionally excluded from main documentation.
1302           #
1303           # Enable deletion (garbage collection) even when the
1304           # configured BlobTrashLifetime is zero.  WARNING: eventual
1305           # consistency may result in race conditions that can cause
1306           # data loss.  Do not enable this unless you understand and
1307           # accept the risk.
1308           UnsafeDelete: false
1309
1310           # for azure driver -- see
1311           # https://doc.arvados.org/install/configure-azure-blob-storage.html
1312           StorageAccountName: aaaaa
1313           StorageAccountKey: aaaaa
1314           StorageBaseURL: core.windows.net
1315           ContainerName: aaaaa
1316           RequestTimeout: 30s
1317           ListBlobsRetryDelay: 10s
1318           ListBlobsMaxAttempts: 10
1319           MaxGetBytes: 0
1320           WriteRaceInterval: 15s
1321           WriteRacePollTime: 1s
1322
1323           # for local directory driver -- see
1324           # https://doc.arvados.org/install/configure-fs-storage.html
1325           Root: /var/lib/arvados/keep-data
1326
1327           # For local directory driver, potentially confusing tuning
1328           # parameter, intentionally excluded from main documentation.
1329           #
1330           # When true, read and write operations (for whole 64MiB
1331           # blocks) on an individual volume will queued and issued
1332           # serially.  When false, read and write operations will be
1333           # issued concurrently.
1334           #
1335           # May possibly improve throughput if you have physical spinning disks
1336           # and experience contention when there are multiple requests
1337           # to the same volume.
1338           #
1339           # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1340           # should leave this alone.
1341           Serialize: false
1342
1343     Mail:
1344       MailchimpAPIKey: ""
1345       MailchimpListID: ""
1346       SendUserSetupNotificationEmail: true
1347
1348       # Bug/issue report notification to and from addresses
1349       IssueReporterEmailFrom: "arvados@example.com"
1350       IssueReporterEmailTo: "arvados@example.com"
1351       SupportEmailAddress: "arvados@example.com"
1352
1353       # Generic issue email from
1354       EmailFrom: "arvados@example.com"
1355     RemoteClusters:
1356       "*":
1357         Host: ""
1358         Proxy: false
1359         Scheme: https
1360         Insecure: false
1361         ActivateUsers: false
1362       SAMPLE:
1363         # API endpoint host or host:port; default is {id}.arvadosapi.com
1364         Host: sample.arvadosapi.com
1365
1366         # Perform a proxy request when a local client requests an
1367         # object belonging to this remote.
1368         Proxy: false
1369
1370         # Default "https". Can be set to "http" for testing.
1371         Scheme: https
1372
1373         # Disable TLS verify. Can be set to true for testing.
1374         Insecure: false
1375
1376         # When users present tokens issued by this remote cluster, and
1377         # their accounts are active on the remote cluster, activate
1378         # them on this cluster too.
1379         ActivateUsers: false
1380
1381     Workbench:
1382       # Workbench1 configs
1383       Theme: default
1384       ActivationContactLink: mailto:info@arvados.org
1385       ArvadosDocsite: https://doc.arvados.org
1386       ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1387       ShowUserAgreementInline: false
1388       SecretKeyBase: ""
1389
1390       # Scratch directory used by the remote repository browsing
1391       # feature. If it doesn't exist, it (and any missing parents) will be
1392       # created using mkdir_p.
1393       RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1394
1395       # Below is a sample setting of user_profile_form_fields config parameter.
1396       # This configuration parameter should be set to either false (to disable) or
1397       # to a map as shown below.
1398       # Configure the map of input fields to be displayed in the profile page
1399       # using the attribute "key" for each of the input fields.
1400       # This sample shows configuration with one required and one optional form fields.
1401       # For each of these input fields:
1402       #   You can specify "Type" as "text" or "select".
1403       #   List the "Options" to be displayed for each of the "select" menu.
1404       #   Set "Required" as "true" for any of these fields to make them required.
1405       # If any of the required fields are missing in the user's profile, the user will be
1406       # redirected to the profile page before they can access any Workbench features.
1407       UserProfileFormFields:
1408         SAMPLE:
1409           Type: select
1410           FormFieldTitle: Best color
1411           FormFieldDescription: your favorite color
1412           Required: false
1413           Position: 1
1414           Options:
1415             red: {}
1416             blue: {}
1417             green: {}
1418             SAMPLE: {}
1419
1420         # exampleTextValue:  # key that will be set in properties
1421         #   Type: text  #
1422         #   FormFieldTitle: ""
1423         #   FormFieldDescription: ""
1424         #   Required: true
1425         #   Position: 1
1426         # exampleOptionsValue:
1427         #   Type: select
1428         #   FormFieldTitle: ""
1429         #   FormFieldDescription: ""
1430         #   Required: true
1431         #   Position: 1
1432         #   Options:
1433         #     red: {}
1434         #     blue: {}
1435         #     yellow: {}
1436
1437       # Use "UserProfileFormMessage to configure the message you want
1438       # to display on the profile page.
1439       UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1440
1441       # Mimetypes of applications for which the view icon
1442       # would be enabled in a collection's show page.
1443       # It is sufficient to list only applications here.
1444       # No need to list text and image types.
1445       ApplicationMimetypesWithViewIcon:
1446         cwl: {}
1447         fasta: {}
1448         go: {}
1449         javascript: {}
1450         json: {}
1451         pdf: {}
1452         python: {}
1453         x-python: {}
1454         r: {}
1455         rtf: {}
1456         sam: {}
1457         x-sh: {}
1458         vnd.realvnc.bed: {}
1459         xml: {}
1460         xsl: {}
1461         SAMPLE: {}
1462
1463       # The maximum number of bytes to load in the log viewer
1464       LogViewerMaxBytes: 1M
1465
1466       # When anonymous_user_token is configured, show public projects page
1467       EnablePublicProjectsPage: true
1468
1469       # By default, disable the "Getting Started" popup which is specific to Arvados playground
1470       EnableGettingStartedPopup: false
1471
1472       # Ask Arvados API server to compress its response payloads.
1473       APIResponseCompression: true
1474
1475       # Timeouts for API requests.
1476       APIClientConnectTimeout: 2m
1477       APIClientReceiveTimeout: 5m
1478
1479       # Maximum number of historic log records of a running job to fetch
1480       # and display in the Log tab, while subscribing to web sockets.
1481       RunningJobLogRecordsToFetch: 2000
1482
1483       # In systems with many shared projects, loading of dashboard and topnav
1484       # can be slow due to collections indexing; use the following parameters
1485       # to suppress these properties
1486       ShowRecentCollectionsOnDashboard: true
1487       ShowUserNotifications: true
1488
1489       # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1490       # a link to the multi-site search page on a "home" Workbench site.
1491       #
1492       # Example:
1493       #   https://workbench.zzzzz.arvadosapi.com/collections/multisite
1494       MultiSiteSearch: ""
1495
1496       # Should workbench allow management of local git repositories? Set to false if
1497       # the jobs api is disabled and there are no local git repositories.
1498       Repositories: true
1499
1500       SiteName: Arvados Workbench
1501       ProfilingEnabled: false
1502
1503       # This is related to obsolete Google OpenID 1.0 login
1504       # but some workbench stuff still expects it to be set.
1505       DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1506
1507       # Workbench2 configs
1508       VocabularyURL: ""
1509       FileViewersConfigURL: ""
1510
1511       # Idle time after which the user's session will be auto closed.
1512       # This feature is disabled when set to zero.
1513       IdleTimeout: 0s
1514
1515       # Workbench welcome screen, this is HTML text that will be
1516       # incorporated directly onto the page.
1517       WelcomePageHTML: |
1518         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1519         <h2>Please log in.</h2>
1520
1521         <p>If you have never used Arvados Workbench before, logging in
1522         for the first time will automatically create a new
1523         account.</p>
1524
1525         <i>Arvados Workbench uses your information only for
1526         identification, and does not retrieve any other personal
1527         information.</i>
1528
1529       # Workbench screen displayed to inactive users.  This is HTML
1530       # text that will be incorporated directly onto the page.
1531       InactivePageHTML: |
1532         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1533         <h3>Hi! You're logged in, but...</h3>
1534         <p>Your account is inactive.</p>
1535         <p>An administrator must activate your account before you can get
1536         any further.</p>
1537
1538       # Connecting to Arvados shell VMs tends to be site-specific.
1539       # Put any special instructions here. This is HTML text that will
1540       # be incorporated directly onto the Workbench page.
1541       SSHHelpPageHTML: |
1542         <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1543         Site configurations vary.  Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1544
1545       # Sample text if you are using a "switchyard" ssh proxy.
1546       # Replace "zzzzz" with your Cluster ID.
1547       #SSHHelpPageHTML: |
1548       # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1549       # <pre>Host *.zzzzz
1550       #  TCPKeepAlive yes
1551       #  ServerAliveInterval 60
1552       #  ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1553       # </pre>
1554
1555       # If you are using a switchyard ssh proxy, shell node hostnames
1556       # may require a special hostname suffix.  In the sample ssh
1557       # configuration above, this would be ".zzzzz"
1558       # This is added to the hostname in the "command line" column
1559       # the Workbench "shell VMs" page.
1560       #
1561       # If your shell nodes are directly accessible by users without a
1562       # proxy and have fully qualified host names, you should leave
1563       # this blank.
1564       SSHHelpHostSuffix: ""
1565
1566 # (Experimental) Restart services automatically when config file
1567 # changes are detected. Only supported by `arvados-server boot` in
1568 # dev/test mode.
1569 AutoReloadConfig: false