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