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