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