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