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