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