17756: Add lsf dispatcher.
[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       # Default lifetime for ephemeral collections: 2 weeks. This must not
469       # be less than BlobSigningTTL.
470       DefaultTrashLifetime: 336h
471
472       # Interval (seconds) between trash sweeps. During a trash sweep,
473       # collections are marked as trash if their trash_at time has
474       # arrived, and deleted if their delete_at time has arrived.
475       TrashSweepInterval: 60s
476
477       # If true, enable collection versioning.
478       # When a collection's preserve_version field is true or the current version
479       # is older than the amount of seconds defined on PreserveVersionIfIdle,
480       # a snapshot of the collection's previous state is created and linked to
481       # the current collection.
482       CollectionVersioning: false
483
484       #   0s = auto-create a new version on every update.
485       #  -1s = never auto-create new versions.
486       # > 0s = auto-create a new version when older than the specified number of seconds.
487       PreserveVersionIfIdle: -1s
488
489       # If non-empty, allow project and collection names to contain
490       # the "/" character (slash/stroke/solidus), and replace "/" with
491       # the given string in the filesystem hierarchy presented by
492       # WebDAV. Example values are "%2f" and "{slash}". Names that
493       # contain the substitution string itself may result in confusing
494       # behavior, so a value like "_" is not recommended.
495       #
496       # If the default empty value is used, the server will reject
497       # requests to create or rename a collection when the new name
498       # contains "/".
499       #
500       # If the value "/" is used, project and collection names
501       # containing "/" will be allowed, but they will not be
502       # accessible via WebDAV.
503       #
504       # Use of this feature is not recommended, if it can be avoided.
505       ForwardSlashNameSubstitution: ""
506
507       # Include "folder objects" in S3 ListObjects responses.
508       S3FolderObjects: true
509
510       # Managed collection properties. At creation time, if the client didn't
511       # provide the listed keys, they will be automatically populated following
512       # one of the following behaviors:
513       #
514       # * UUID of the user who owns the containing project.
515       #   responsible_person_uuid: {Function: original_owner, Protected: true}
516       #
517       # * Default concrete value.
518       #   foo_bar: {Value: baz, Protected: false}
519       #
520       # If Protected is true, only an admin user can modify its value.
521       ManagedProperties:
522         SAMPLE: {Function: original_owner, Protected: true}
523
524       # In "trust all content" mode, Workbench will redirect download
525       # requests to WebDAV preview link, even in the cases when
526       # WebDAV would have to expose XSS vulnerabilities in order to
527       # handle the redirect (see discussion on Services.WebDAV).
528       #
529       # This setting has no effect in the recommended configuration,
530       # where the WebDAV is configured to have a separate domain for
531       # every collection; in this case XSS protection is provided by
532       # browsers' same-origin policy.
533       #
534       # The default setting (false) is appropriate for a multi-user site.
535       TrustAllContent: false
536
537       # Cache parameters for WebDAV content serving:
538       WebDAVCache:
539         # Time to cache manifests, permission checks, and sessions.
540         TTL: 300s
541
542         # Time to cache collection state.
543         UUIDTTL: 5s
544
545         # Block cache entries. Each block consumes up to 64 MiB RAM.
546         MaxBlockEntries: 20
547
548         # Collection cache entries.
549         MaxCollectionEntries: 1000
550
551         # Approximate memory limit (in bytes) for collection cache.
552         MaxCollectionBytes: 100000000
553
554         # Permission cache entries.
555         MaxPermissionEntries: 1000
556
557         # UUID cache entries.
558         MaxUUIDEntries: 1000
559
560         # Persistent sessions.
561         MaxSessions: 100
562
563       # Selectively set permissions for regular users and admins to
564       # download or upload data files using the upload/download
565       # features for Workbench, WebDAV and S3 API support.
566       WebDAVPermission:
567         User:
568           Download: true
569           Upload: true
570         Admin:
571           Download: true
572           Upload: true
573
574       # Selectively set permissions for regular users and admins to be
575       # able to download or upload blocks using arv-put and
576       # arv-get from outside the cluster.
577       KeepproxyPermission:
578         User:
579           Download: true
580           Upload: true
581         Admin:
582           Download: true
583           Upload: true
584
585       # Post upload / download events to the API server logs table, so
586       # that they can be included in the arv-user-activity report.
587       # You can disable this if you find that it is creating excess
588       # load on the API server and you don't need it.
589       WebDAVLogEvents: true
590
591     Login:
592       # One of the following mechanisms (Google, PAM, LDAP, or
593       # LoginCluster) should be enabled; see
594       # https://doc.arvados.org/install/setup-login.html
595
596       Google:
597         # Authenticate with Google.
598         Enable: false
599
600         # Use the Google Cloud console to enable the People API (APIs
601         # and Services > Enable APIs and services > Google People API
602         # > Enable), generate a Client ID and secret (APIs and
603         # Services > Credentials > Create credentials > OAuth client
604         # ID > Web application) and add your controller's /login URL
605         # (e.g., "https://zzzzz.example.com/login") as an authorized
606         # redirect URL.
607         ClientID: ""
608         ClientSecret: ""
609
610         # Allow users to log in to existing accounts using any verified
611         # email address listed by their Google account. If true, the
612         # Google People API must be enabled in order for Google login to
613         # work. If false, only the primary email address will be used.
614         AlternateEmailAddresses: true
615
616         # Send additional parameters with authentication requests. See
617         # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
618         # for a list of supported parameters.
619         AuthenticationRequestParameters:
620           # Show the "choose which Google account" page, even if the
621           # client is currently logged in to exactly one Google
622           # account.
623           prompt: select_account
624
625           SAMPLE: ""
626
627       OpenIDConnect:
628         # Authenticate with an OpenID Connect provider.
629         Enable: false
630
631         # Issuer URL, e.g., "https://login.example.com".
632         #
633         # This must be exactly equal to the URL returned by the issuer
634         # itself in its config response ("isser" key). If the
635         # configured value is "https://example" and the provider
636         # returns "https://example:443" or "https://example/" then
637         # login will fail, even though those URLs are equivalent
638         # (RFC3986).
639         Issuer: ""
640
641         # Your client ID and client secret (supplied by the provider).
642         ClientID: ""
643         ClientSecret: ""
644
645         # OpenID claim field containing the user's email
646         # address. Normally "email"; see
647         # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
648         EmailClaim: "email"
649
650         # OpenID claim field containing the email verification
651         # flag. Normally "email_verified".  To accept every returned
652         # email address without checking a "verified" field at all,
653         # use the empty string "".
654         EmailVerifiedClaim: "email_verified"
655
656         # OpenID claim field containing the user's preferred
657         # username. If empty, use the mailbox part of the user's email
658         # address.
659         UsernameClaim: ""
660
661         # Send additional parameters with authentication requests,
662         # like {display: page, prompt: consent}. See
663         # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
664         # and refer to your provider's documentation for supported
665         # parameters.
666         AuthenticationRequestParameters:
667           SAMPLE: ""
668
669         # Accept an OIDC access token as an API token if the OIDC
670         # provider's UserInfo endpoint accepts it.
671         #
672         # AcceptAccessTokenScope should also be used when enabling
673         # this feature.
674         AcceptAccessToken: false
675
676         # Before accepting an OIDC access token as an API token, first
677         # check that it is a JWT whose "scope" value includes this
678         # value. Example: "https://zzzzz.example.com/" (your Arvados
679         # API endpoint).
680         #
681         # If this value is empty and AcceptAccessToken is true, all
682         # access tokens will be accepted regardless of scope,
683         # including non-JWT tokens. This is not recommended.
684         AcceptAccessTokenScope: ""
685
686       PAM:
687         # (Experimental) Use PAM to authenticate users.
688         Enable: false
689
690         # PAM service name. PAM will apply the policy in the
691         # corresponding config file (e.g., /etc/pam.d/arvados) or, if
692         # there is none, the default "other" config.
693         Service: arvados
694
695         # Domain name (e.g., "example.com") to use to construct the
696         # user's email address if PAM authentication returns a
697         # username with no "@". If empty, use the PAM username as the
698         # user's email address, whether or not it contains "@".
699         #
700         # Note that the email address is used as the primary key for
701         # user records when logging in. Therefore, if you change
702         # PAMDefaultEmailDomain after the initial installation, you
703         # should also update existing user records to reflect the new
704         # domain. Otherwise, next time those users log in, they will
705         # be given new accounts instead of accessing their existing
706         # accounts.
707         DefaultEmailDomain: ""
708
709       LDAP:
710         # Use an LDAP service to authenticate users.
711         Enable: false
712
713         # Server URL, like "ldap://ldapserver.example.com:389" or
714         # "ldaps://ldapserver.example.com:636".
715         URL: "ldap://ldap:389"
716
717         # Use StartTLS upon connecting to the server.
718         StartTLS: true
719
720         # Skip TLS certificate name verification.
721         InsecureTLS: false
722
723         # Strip the @domain part if a user supplies an email-style
724         # username with this domain. If "*", strip any user-provided
725         # domain. If "", never strip the domain part. Example:
726         # "example.com"
727         StripDomain: ""
728
729         # If, after applying StripDomain, the username contains no "@"
730         # character, append this domain to form an email-style
731         # username. Example: "example.com"
732         AppendDomain: ""
733
734         # The LDAP attribute to filter on when looking up a username
735         # (after applying StripDomain and AppendDomain).
736         SearchAttribute: uid
737
738         # Bind with this username (DN or UPN) and password when
739         # looking up the user record.
740         #
741         # Example user: "cn=admin,dc=example,dc=com"
742         SearchBindUser: ""
743         SearchBindPassword: ""
744
745         # Directory base for username lookup. Example:
746         # "ou=Users,dc=example,dc=com"
747         SearchBase: ""
748
749         # Additional filters to apply when looking up users' LDAP
750         # entries. This can be used to restrict access to a subset of
751         # LDAP users, or to disambiguate users from other directory
752         # entries that have the SearchAttribute present.
753         #
754         # Special characters in assertion values must be escaped (see
755         # RFC4515).
756         #
757         # Example: "(objectClass=person)"
758         SearchFilters: ""
759
760         # LDAP attribute to use as the user's email address.
761         #
762         # Important: This must not be an attribute whose value can be
763         # edited in the directory by the users themselves. Otherwise,
764         # users can take over other users' Arvados accounts trivially
765         # (email address is the primary key for Arvados accounts.)
766         EmailAttribute: mail
767
768         # LDAP attribute to use as the preferred Arvados username. If
769         # no value is found (or this config is empty) the username
770         # originally supplied by the user will be used.
771         UsernameAttribute: uid
772
773       Test:
774         # Authenticate users listed here in the config file. This
775         # feature is intended to be used in test environments, and
776         # should not be used in production.
777         Enable: false
778         Users:
779           SAMPLE:
780             Email: alice@example.com
781             Password: xyzzy
782
783       # The cluster ID to delegate the user database.  When set,
784       # logins on this cluster will be redirected to the login cluster
785       # (login cluster must appear in RemoteClusters with Proxy: true)
786       LoginCluster: ""
787
788       # How long a cached token belonging to a remote cluster will
789       # remain valid before it needs to be revalidated.
790       RemoteTokenRefresh: 5m
791
792       # How long a client token created from a login flow will be valid without
793       # asking the user to re-login. Example values: 60m, 8h.
794       # Default value zero means tokens don't have expiration.
795       TokenLifetime: 0s
796
797       # If true (default) tokens issued through login are allowed to create
798       # new tokens.
799       # If false, tokens issued through login are not allowed to
800       # viewing/creating other tokens.  New tokens can only be created
801       # by going through login again.
802       IssueTrustedTokens: true
803
804       # When the token is returned to a client, the token itself may
805       # be restricted from viewing/creating other tokens based on whether
806       # the client is "trusted" or not.  The local Workbench1 and
807       # Workbench2 are trusted by default, but if this is a
808       # LoginCluster, you probably want to include the other Workbench
809       # instances in the federation in this list.
810       TrustedClients:
811         SAMPLE:
812           "https://workbench.federate1.example": {}
813           "https://workbench.federate2.example": {}
814
815     Git:
816       # Path to git or gitolite-shell executable. Each authenticated
817       # request will execute this program with the single argument "http-backend"
818       GitCommand: /usr/bin/git
819
820       # Path to Gitolite's home directory. If a non-empty path is given,
821       # the CGI environment will be set up to support the use of
822       # gitolite-shell as a GitCommand: for example, if GitoliteHome is
823       # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
824       # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
825       GitoliteHome: ""
826
827       # Git repositories must be readable by api server, or you won't be
828       # able to submit crunch jobs. To pass the test suites, put a clone
829       # of the arvados tree in {git_repositories_dir}/arvados.git or
830       # {git_repositories_dir}/arvados/.git
831       Repositories: /var/lib/arvados/git/repositories
832
833     TLS:
834       Certificate: ""
835       Key: ""
836       Insecure: false
837
838     Containers:
839       # List of supported Docker Registry image formats that compute nodes
840       # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
841       # to store an image with an unsupported format. Use an empty array
842       # to skip the compatibility check (and display a warning message to
843       # that effect).
844       #
845       # Example for sites running docker < 1.10: {"v1": {}}
846       # Example for sites running docker >= 1.10: {"v2": {}}
847       # Example for disabling check: {}
848       SupportedDockerImageFormats:
849         "v2": {}
850         SAMPLE: {}
851
852       # Include details about job reuse decisions in the server log. This
853       # causes additional database queries to run, so it should not be
854       # enabled unless you expect to examine the resulting logs for
855       # troubleshooting purposes.
856       LogReuseDecisions: false
857
858       # Default value for keep_cache_ram of a container's runtime_constraints.
859       DefaultKeepCacheRAM: 268435456
860
861       # Number of times a container can be unlocked before being
862       # automatically cancelled.
863       MaxDispatchAttempts: 5
864
865       # Default value for container_count_max for container requests.  This is the
866       # number of times Arvados will create a new container to satisfy a container
867       # request.  If a container is cancelled it will retry a new container if
868       # container_count < container_count_max on any container requests associated
869       # with the cancelled container.
870       MaxRetryAttempts: 3
871
872       # The maximum number of compute nodes that can be in use simultaneously
873       # If this limit is reduced, any existing nodes with slot number >= new limit
874       # will not be counted against the new limit. In other words, the new limit
875       # won't be strictly enforced until those nodes with higher slot numbers
876       # go down.
877       MaxComputeVMs: 64
878
879       # Preemptible instance support (e.g. AWS Spot Instances)
880       # When true, child containers will get created with the preemptible
881       # scheduling parameter parameter set.
882       UsePreemptibleInstances: false
883
884       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
885       # (experimental) cloud dispatcher for executing containers on
886       # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
887       # and ends with "\n-----END RSA PRIVATE KEY-----\n".
888       DispatchPrivateKey: ""
889
890       # Maximum time to wait for workers to come up before abandoning
891       # stale locks from a previous dispatch process.
892       StaleLockTimeout: 1m
893
894       # The crunch-run command used to start a container on a worker node.
895       #
896       # When dispatching to cloud VMs, this is used only if
897       # DeployRunnerBinary in the CloudVMs section is set to the empty
898       # string.
899       CrunchRunCommand: "crunch-run"
900
901       # Extra arguments to add to crunch-run invocation
902       # Example: ["--cgroup-parent-subsystem=memory"]
903       CrunchRunArgumentsList: []
904
905       # Extra RAM to reserve on the node, in addition to
906       # the amount specified in the container's RuntimeConstraints
907       ReserveExtraRAM: 256MiB
908
909       # Minimum time between two attempts to run the same container
910       MinRetryPeriod: 0s
911
912       # Container runtime: "docker" (default) or "singularity" (experimental)
913       RuntimeEngine: docker
914
915       Logging:
916         # When you run the db:delete_old_container_logs task, it will find
917         # containers that have been finished for at least this many seconds,
918         # and delete their stdout, stderr, arv-mount, crunch-run, and
919         # crunchstat logs from the logs table.
920         MaxAge: 720h
921
922         # These two settings control how frequently log events are flushed to the
923         # database.  Log lines are buffered until either crunch_log_bytes_per_event
924         # has been reached or crunch_log_seconds_between_events has elapsed since
925         # the last flush.
926         LogBytesPerEvent: 4096
927         LogSecondsBetweenEvents: 5s
928
929         # The sample period for throttling logs.
930         LogThrottlePeriod: 60s
931
932         # Maximum number of bytes that job can log over crunch_log_throttle_period
933         # before being silenced until the end of the period.
934         LogThrottleBytes: 65536
935
936         # Maximum number of lines that job can log over crunch_log_throttle_period
937         # before being silenced until the end of the period.
938         LogThrottleLines: 1024
939
940         # Maximum bytes that may be logged by a single job.  Log bytes that are
941         # silenced by throttling are not counted against this total.
942         LimitLogBytesPerJob: 67108864
943
944         LogPartialLineThrottlePeriod: 5s
945
946         # Container logs are written to Keep and saved in a
947         # collection, which is updated periodically while the
948         # container runs.  This value sets the interval between
949         # collection updates.
950         LogUpdatePeriod: 30m
951
952         # The log collection is also updated when the specified amount of
953         # log data (given in bytes) is produced in less than one update
954         # period.
955         LogUpdateSize: 32MiB
956
957       ShellAccess:
958         # An admin user can use "arvados-client shell" to start an
959         # interactive shell (with any user ID) in any running
960         # container.
961         Admin: false
962
963         # Any user can use "arvados-client shell" to start an
964         # interactive shell (with any user ID) in any running
965         # container that they started, provided it isn't also
966         # associated with a different user's container request.
967         #
968         # Interactive sessions make it easy to alter the container's
969         # runtime environment in ways that aren't recorded or
970         # reproducible. Consider the implications for automatic
971         # container reuse before enabling and using this feature. In
972         # particular, note that starting an interactive session does
973         # not disqualify a container from being reused by a different
974         # user/workflow in the future.
975         User: false
976
977       SLURM:
978         PrioritySpread: 0
979         SbatchArgumentsList: []
980         SbatchEnvironmentVariables:
981           SAMPLE: ""
982         Managed:
983           # Path to dns server configuration directory
984           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
985           # files or touch restart.txt (see below).
986           DNSServerConfDir: ""
987
988           # Template file for the dns server host snippets. See
989           # unbound.template in this directory for an example. If false, do
990           # not write any config files.
991           DNSServerConfTemplate: ""
992
993           # String to write to {dns_server_conf_dir}/restart.txt (with a
994           # trailing newline) after updating local data. If false, do not
995           # open or write the restart.txt file.
996           DNSServerReloadCommand: ""
997
998           # Command to run after each DNS update. Template variables will be
999           # substituted; see the "unbound" example below. If false, do not run
1000           # a command.
1001           DNSServerUpdateCommand: ""
1002
1003           ComputeNodeDomain: ""
1004           ComputeNodeNameservers:
1005             "192.168.1.1": {}
1006             SAMPLE: {}
1007
1008           # Hostname to assign to a compute node when it sends a "ping" and the
1009           # hostname in its Node record is nil.
1010           # During bootstrapping, the "ping" script is expected to notice the
1011           # hostname given in the ping response, and update its unix hostname
1012           # accordingly.
1013           # If false, leave the hostname alone (this is appropriate if your compute
1014           # nodes' hostnames are already assigned by some other mechanism).
1015           #
1016           # One way or another, the hostnames of your node records should agree
1017           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1018           #
1019           # Example for compute0000, compute0001, ....:
1020           # assign_node_hostname: compute%<slot_number>04d
1021           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1022           AssignNodeHostname: "compute%<slot_number>d"
1023
1024       LSF:
1025         # Additional arguments to bsub when submitting Arvados
1026         # containers as LSF jobs.
1027         BsubArgumentsList: []
1028
1029         # Use sudo to switch to this user account when submitting LSF
1030         # jobs.
1031         BsubSudoUser: "crunch"
1032
1033       JobsAPI:
1034         # Enable the legacy 'jobs' API (crunch v1).  This value must be a string.
1035         #
1036         # Note: this only enables read-only access, creating new
1037         # legacy jobs and pipelines is not supported.
1038         #
1039         # 'auto' -- (default) enable the Jobs API only if it has been used before
1040         #         (i.e., there are job records in the database)
1041         # 'true' -- enable the Jobs API despite lack of existing records.
1042         # 'false' -- disable the Jobs API despite presence of existing records.
1043         Enable: 'auto'
1044
1045         # Git repositories must be readable by api server, or you won't be
1046         # able to submit crunch jobs. To pass the test suites, put a clone
1047         # of the arvados tree in {git_repositories_dir}/arvados.git or
1048         # {git_repositories_dir}/arvados/.git
1049         GitInternalDir: /var/lib/arvados/internal.git
1050
1051       CloudVMs:
1052         # Enable the cloud scheduler (experimental).
1053         Enable: false
1054
1055         # Name/number of port where workers' SSH services listen.
1056         SSHPort: "22"
1057
1058         # Interval between queue polls.
1059         PollInterval: 10s
1060
1061         # Shell command to execute on each worker to determine whether
1062         # the worker is booted and ready to run containers. It should
1063         # exit zero if the worker is ready.
1064         BootProbeCommand: "docker ps -q"
1065
1066         # Minimum interval between consecutive probes to a single
1067         # worker.
1068         ProbeInterval: 10s
1069
1070         # Maximum probes per second, across all workers in a pool.
1071         MaxProbesPerSecond: 10
1072
1073         # Time before repeating SIGTERM when killing a container.
1074         TimeoutSignal: 5s
1075
1076         # Time to give up on a process (most likely arv-mount) that
1077         # still holds a container lockfile after its main supervisor
1078         # process has exited, and declare the instance broken.
1079         TimeoutStaleRunLock: 5s
1080
1081         # Time to give up on SIGTERM and write off the worker.
1082         TimeoutTERM: 2m
1083
1084         # Maximum create/destroy-instance operations per second (0 =
1085         # unlimited).
1086         MaxCloudOpsPerSecond: 0
1087
1088         # Maximum concurrent node creation operations (0 = unlimited). This is
1089         # recommended by Azure in certain scenarios (see
1090         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
1091         # and can be used with other cloud providers too, if desired.
1092         MaxConcurrentInstanceCreateOps: 0
1093
1094         # Interval between cloud provider syncs/updates ("list all
1095         # instances").
1096         SyncInterval: 1m
1097
1098         # Time to leave an idle worker running (in case new containers
1099         # appear in the queue that it can run) before shutting it
1100         # down.
1101         TimeoutIdle: 1m
1102
1103         # Time to wait for a new worker to boot (i.e., pass
1104         # BootProbeCommand) before giving up and shutting it down.
1105         TimeoutBooting: 10m
1106
1107         # Maximum time a worker can stay alive with no successful
1108         # probes before being automatically shut down.
1109         TimeoutProbe: 10m
1110
1111         # Time after shutting down a worker to retry the
1112         # shutdown/destroy operation.
1113         TimeoutShutdown: 10s
1114
1115         # Worker VM image ID.
1116         # (aws) AMI identifier
1117         # (azure) managed disks: the name of the managed disk image
1118         # (azure) shared image gallery: the name of the image definition. Also
1119         # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1120         # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1121         # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1122         ImageID: ""
1123
1124         # An executable file (located on the dispatcher host) to be
1125         # copied to cloud instances at runtime and used as the
1126         # container runner/supervisor. The default value is the
1127         # dispatcher program itself.
1128         #
1129         # Use the empty string to disable this step: nothing will be
1130         # copied, and cloud instances are assumed to have a suitable
1131         # version of crunch-run installed; see CrunchRunCommand above.
1132         DeployRunnerBinary: "/proc/self/exe"
1133
1134         # Tags to add on all resources (VMs, NICs, disks) created by
1135         # the container dispatcher. (Arvados's own tags --
1136         # InstanceType, IdleBehavior, and InstanceSecret -- will also
1137         # be added.)
1138         ResourceTags:
1139           SAMPLE: "tag value"
1140
1141         # Prefix for predefined tags used by Arvados (InstanceSetID,
1142         # InstanceType, InstanceSecret, IdleBehavior). With the
1143         # default value "Arvados", tags are "ArvadosInstanceSetID",
1144         # "ArvadosInstanceSecret", etc.
1145         #
1146         # This should only be changed while no cloud resources are in
1147         # use and the cloud dispatcher is not running. Otherwise,
1148         # VMs/resources that were added using the old tag prefix will
1149         # need to be detected and cleaned up manually.
1150         TagKeyPrefix: Arvados
1151
1152         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1153         Driver: ec2
1154
1155         # Cloud-specific driver parameters.
1156         DriverParameters:
1157
1158           # (ec2) Credentials. Omit or leave blank if using IAM role.
1159           AccessKeyID: ""
1160           SecretAccessKey: ""
1161
1162           # (ec2) Instance configuration.
1163           SecurityGroupIDs:
1164             "SAMPLE": {}
1165           SubnetID: ""
1166           Region: ""
1167           EBSVolumeType: gp2
1168           AdminUsername: debian
1169
1170           # (azure) Credentials.
1171           SubscriptionID: ""
1172           ClientID: ""
1173           ClientSecret: ""
1174           TenantID: ""
1175
1176           # (azure) Instance configuration.
1177           CloudEnvironment: AzurePublicCloud
1178           Location: centralus
1179
1180           # (azure) The resource group where the VM and virtual NIC will be
1181           # created.
1182           ResourceGroup: ""
1183
1184           # (azure) The resource group of the Network to use for the virtual
1185           # NIC (if different from ResourceGroup)
1186           NetworkResourceGroup: ""
1187           Network: ""
1188           Subnet: ""
1189
1190           # (azure) managed disks: The resource group where the managed disk
1191           # image can be found (if different from ResourceGroup).
1192           ImageResourceGroup: ""
1193
1194           # (azure) shared image gallery: the name of the gallery
1195           SharedImageGalleryName: ""
1196           # (azure) shared image gallery: the version of the image definition
1197           SharedImageGalleryImageVersion: ""
1198
1199           # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1200           StorageAccount: ""
1201           BlobContainer: ""
1202
1203           # (azure) How long to wait before deleting VHD and NIC
1204           # objects that are no longer being used.
1205           DeleteDanglingResourcesAfter: 20s
1206
1207           # Account (that already exists in the VM image) that will be
1208           # set up with an ssh authorized key to allow the compute
1209           # dispatcher to connect.
1210           AdminUsername: arvados
1211
1212     InstanceTypes:
1213
1214       # Use the instance type name as the key (in place of "SAMPLE" in
1215       # this sample entry).
1216       SAMPLE:
1217         # Cloud provider's instance type. Defaults to the configured type name.
1218         ProviderType: ""
1219         VCPUs: 1
1220         RAM: 128MiB
1221         IncludedScratch: 16GB
1222         AddedScratch: 0
1223         Price: 0.1
1224         Preemptible: false
1225
1226     Volumes:
1227       SAMPLE:
1228         # AccessViaHosts specifies which keepstore processes can read
1229         # and write data on the volume.
1230         #
1231         # For a local filesystem, AccessViaHosts has one entry,
1232         # indicating which server the filesystem is located on.
1233         #
1234         # For a network-attached backend accessible by all keepstore
1235         # servers, like a cloud storage bucket or an NFS mount,
1236         # AccessViaHosts can be empty/omitted.
1237         #
1238         # Further info/examples:
1239         # https://doc.arvados.org/install/configure-fs-storage.html
1240         # https://doc.arvados.org/install/configure-s3-object-storage.html
1241         # https://doc.arvados.org/install/configure-azure-blob-storage.html
1242         AccessViaHosts:
1243           SAMPLE:
1244             ReadOnly: false
1245           "http://host1.example:25107": {}
1246         ReadOnly: false
1247         Replication: 1
1248         StorageClasses:
1249           default: true
1250           SAMPLE: true
1251         Driver: S3
1252         DriverParameters:
1253           # for s3 driver -- see
1254           # https://doc.arvados.org/install/configure-s3-object-storage.html
1255           IAMRole: aaaaa
1256           AccessKeyID: aaaaa
1257           SecretAccessKey: aaaaa
1258           Endpoint: ""
1259           Region: us-east-1a
1260           Bucket: aaaaa
1261           LocationConstraint: false
1262           V2Signature: false
1263           IndexPageSize: 1000
1264           ConnectTimeout: 1m
1265           ReadTimeout: 10m
1266           RaceWindow: 24h
1267           # Use aws-s3-go (v2) instead of goamz
1268           UseAWSS3v2Driver: false
1269
1270           # For S3 driver, potentially unsafe tuning parameter,
1271           # intentionally excluded from main documentation.
1272           #
1273           # Enable deletion (garbage collection) even when the
1274           # configured BlobTrashLifetime is zero.  WARNING: eventual
1275           # consistency may result in race conditions that can cause
1276           # data loss.  Do not enable this unless you understand and
1277           # accept the risk.
1278           UnsafeDelete: false
1279
1280           # for azure driver -- see
1281           # https://doc.arvados.org/install/configure-azure-blob-storage.html
1282           StorageAccountName: aaaaa
1283           StorageAccountKey: aaaaa
1284           StorageBaseURL: core.windows.net
1285           ContainerName: aaaaa
1286           RequestTimeout: 30s
1287           ListBlobsRetryDelay: 10s
1288           ListBlobsMaxAttempts: 10
1289           MaxGetBytes: 0
1290           WriteRaceInterval: 15s
1291           WriteRacePollTime: 1s
1292
1293           # for local directory driver -- see
1294           # https://doc.arvados.org/install/configure-fs-storage.html
1295           Root: /var/lib/arvados/keep-data
1296
1297           # For local directory driver, potentially confusing tuning
1298           # parameter, intentionally excluded from main documentation.
1299           #
1300           # When true, read and write operations (for whole 64MiB
1301           # blocks) on an individual volume will queued and issued
1302           # serially.  When false, read and write operations will be
1303           # issued concurrently.
1304           #
1305           # May possibly improve throughput if you have physical spinning disks
1306           # and experience contention when there are multiple requests
1307           # to the same volume.
1308           #
1309           # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1310           # should leave this alone.
1311           Serialize: false
1312
1313     Mail:
1314       MailchimpAPIKey: ""
1315       MailchimpListID: ""
1316       SendUserSetupNotificationEmail: true
1317
1318       # Bug/issue report notification to and from addresses
1319       IssueReporterEmailFrom: "arvados@example.com"
1320       IssueReporterEmailTo: "arvados@example.com"
1321       SupportEmailAddress: "arvados@example.com"
1322
1323       # Generic issue email from
1324       EmailFrom: "arvados@example.com"
1325     RemoteClusters:
1326       "*":
1327         Host: ""
1328         Proxy: false
1329         Scheme: https
1330         Insecure: false
1331         ActivateUsers: false
1332       SAMPLE:
1333         # API endpoint host or host:port; default is {id}.arvadosapi.com
1334         Host: sample.arvadosapi.com
1335
1336         # Perform a proxy request when a local client requests an
1337         # object belonging to this remote.
1338         Proxy: false
1339
1340         # Default "https". Can be set to "http" for testing.
1341         Scheme: https
1342
1343         # Disable TLS verify. Can be set to true for testing.
1344         Insecure: false
1345
1346         # When users present tokens issued by this remote cluster, and
1347         # their accounts are active on the remote cluster, activate
1348         # them on this cluster too.
1349         ActivateUsers: false
1350
1351     Workbench:
1352       # Workbench1 configs
1353       Theme: default
1354       ActivationContactLink: mailto:info@arvados.org
1355       ArvadosDocsite: https://doc.arvados.org
1356       ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1357       ShowUserAgreementInline: false
1358       SecretKeyBase: ""
1359
1360       # Scratch directory used by the remote repository browsing
1361       # feature. If it doesn't exist, it (and any missing parents) will be
1362       # created using mkdir_p.
1363       RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1364
1365       # Below is a sample setting of user_profile_form_fields config parameter.
1366       # This configuration parameter should be set to either false (to disable) or
1367       # to a map as shown below.
1368       # Configure the map of input fields to be displayed in the profile page
1369       # using the attribute "key" for each of the input fields.
1370       # This sample shows configuration with one required and one optional form fields.
1371       # For each of these input fields:
1372       #   You can specify "Type" as "text" or "select".
1373       #   List the "Options" to be displayed for each of the "select" menu.
1374       #   Set "Required" as "true" for any of these fields to make them required.
1375       # If any of the required fields are missing in the user's profile, the user will be
1376       # redirected to the profile page before they can access any Workbench features.
1377       UserProfileFormFields:
1378         SAMPLE:
1379           Type: select
1380           FormFieldTitle: Best color
1381           FormFieldDescription: your favorite color
1382           Required: false
1383           Position: 1
1384           Options:
1385             red: {}
1386             blue: {}
1387             green: {}
1388             SAMPLE: {}
1389
1390         # exampleTextValue:  # key that will be set in properties
1391         #   Type: text  #
1392         #   FormFieldTitle: ""
1393         #   FormFieldDescription: ""
1394         #   Required: true
1395         #   Position: 1
1396         # exampleOptionsValue:
1397         #   Type: select
1398         #   FormFieldTitle: ""
1399         #   FormFieldDescription: ""
1400         #   Required: true
1401         #   Position: 1
1402         #   Options:
1403         #     red: {}
1404         #     blue: {}
1405         #     yellow: {}
1406
1407       # Use "UserProfileFormMessage to configure the message you want
1408       # to display on the profile page.
1409       UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1410
1411       # Mimetypes of applications for which the view icon
1412       # would be enabled in a collection's show page.
1413       # It is sufficient to list only applications here.
1414       # No need to list text and image types.
1415       ApplicationMimetypesWithViewIcon:
1416         cwl: {}
1417         fasta: {}
1418         go: {}
1419         javascript: {}
1420         json: {}
1421         pdf: {}
1422         python: {}
1423         x-python: {}
1424         r: {}
1425         rtf: {}
1426         sam: {}
1427         x-sh: {}
1428         vnd.realvnc.bed: {}
1429         xml: {}
1430         xsl: {}
1431         SAMPLE: {}
1432
1433       # The maximum number of bytes to load in the log viewer
1434       LogViewerMaxBytes: 1M
1435
1436       # When anonymous_user_token is configured, show public projects page
1437       EnablePublicProjectsPage: true
1438
1439       # By default, disable the "Getting Started" popup which is specific to Arvados playground
1440       EnableGettingStartedPopup: false
1441
1442       # Ask Arvados API server to compress its response payloads.
1443       APIResponseCompression: true
1444
1445       # Timeouts for API requests.
1446       APIClientConnectTimeout: 2m
1447       APIClientReceiveTimeout: 5m
1448
1449       # Maximum number of historic log records of a running job to fetch
1450       # and display in the Log tab, while subscribing to web sockets.
1451       RunningJobLogRecordsToFetch: 2000
1452
1453       # In systems with many shared projects, loading of dashboard and topnav
1454       # can be slow due to collections indexing; use the following parameters
1455       # to suppress these properties
1456       ShowRecentCollectionsOnDashboard: true
1457       ShowUserNotifications: true
1458
1459       # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1460       # a link to the multi-site search page on a "home" Workbench site.
1461       #
1462       # Example:
1463       #   https://workbench.zzzzz.arvadosapi.com/collections/multisite
1464       MultiSiteSearch: ""
1465
1466       # Should workbench allow management of local git repositories? Set to false if
1467       # the jobs api is disabled and there are no local git repositories.
1468       Repositories: true
1469
1470       SiteName: Arvados Workbench
1471       ProfilingEnabled: false
1472
1473       # This is related to obsolete Google OpenID 1.0 login
1474       # but some workbench stuff still expects it to be set.
1475       DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1476
1477       # Workbench2 configs
1478       VocabularyURL: ""
1479       FileViewersConfigURL: ""
1480
1481       # Idle time after which the user's session will be auto closed.
1482       # This feature is disabled when set to zero.
1483       IdleTimeout: 0s
1484
1485       # Workbench welcome screen, this is HTML text that will be
1486       # incorporated directly onto the page.
1487       WelcomePageHTML: |
1488         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1489         <h2>Please log in.</h2>
1490
1491         <p>If you have never used Arvados Workbench before, logging in
1492         for the first time will automatically create a new
1493         account.</p>
1494
1495         <i>Arvados Workbench uses your information only for
1496         identification, and does not retrieve any other personal
1497         information.</i>
1498
1499       # Workbench screen displayed to inactive users.  This is HTML
1500       # text that will be incorporated directly onto the page.
1501       InactivePageHTML: |
1502         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1503         <h3>Hi! You're logged in, but...</h3>
1504         <p>Your account is inactive.</p>
1505         <p>An administrator must activate your account before you can get
1506         any further.</p>
1507
1508       # Connecting to Arvados shell VMs tends to be site-specific.
1509       # Put any special instructions here. This is HTML text that will
1510       # be incorporated directly onto the Workbench page.
1511       SSHHelpPageHTML: |
1512         <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1513         Site configurations vary.  Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1514
1515       # Sample text if you are using a "switchyard" ssh proxy.
1516       # Replace "zzzzz" with your Cluster ID.
1517       #SSHHelpPageHTML: |
1518       # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1519       # <pre>Host *.zzzzz
1520       #  TCPKeepAlive yes
1521       #  ServerAliveInterval 60
1522       #  ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1523       # </pre>
1524
1525       # If you are using a switchyard ssh proxy, shell node hostnames
1526       # may require a special hostname suffix.  In the sample ssh
1527       # configuration above, this would be ".zzzzz"
1528       # This is added to the hostname in the "command line" column
1529       # the Workbench "shell VMs" page.
1530       #
1531       # If your shell nodes are directly accessible by users without a
1532       # proxy and have fully qualified host names, you should leave
1533       # this blank.
1534       SSHHelpHostSuffix: ""
1535
1536 # (Experimental) Restart services automatically when config file
1537 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1538 # dev/test mode.
1539 AutoReloadConfig: false
1540 `)