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