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