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