Fix test
[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://example.host:12345": {}
29           SAMPLE: {}
30         ExternalURL: "-"
31
32       RailsAPI:
33         InternalURLs: {}
34         ExternalURL: "-"
35       Controller:
36         InternalURLs: {}
37         ExternalURL: ""
38       Websocket:
39         InternalURLs: {}
40         ExternalURL: ""
41       Keepbalance:
42         InternalURLs: {}
43         ExternalURL: "-"
44       GitHTTP:
45         InternalURLs: {}
46         ExternalURL: ""
47       GitSSH:
48         InternalURLs: {}
49         ExternalURL: ""
50       DispatchCloud:
51         InternalURLs: {}
52         ExternalURL: "-"
53       SSO:
54         InternalURLs: {}
55         ExternalURL: ""
56       Keepproxy:
57         InternalURLs: {}
58         ExternalURL: ""
59       WebDAV:
60         InternalURLs: {}
61         # Base URL for Workbench inline preview.  If blank, use
62         # WebDAVDownload instead, and disable inline preview.
63         # If both are empty, downloading collections from workbench
64         # will be impossible.
65         #
66         # It is important to properly configure the download service
67         # to migitate cross-site-scripting (XSS) attacks.  A HTML page
68         # can be stored in collection.  If an attacker causes a victim
69         # to visit that page through Workbench, it will be rendered by
70         # the browser.  If all collections are served at the same
71         # domain, the browser will consider collections as coming from
72         # the same origin and having access to the same browsing data,
73         # enabling malicious Javascript on that page to access Arvados
74         # on behalf of the victim.
75         #
76         # This is mitigating by having separate domains for each
77         # collection, or limiting preview to circumstances where the
78         # collection is not accessed with the user's regular
79         # full-access token.
80         #
81         # Serve preview links using uuid or pdh in subdomain
82         # (requires wildcard DNS and TLS certificate)
83         #   https://*.collections.uuid_prefix.arvadosapi.com
84         #
85         # Serve preview links using uuid or pdh in main domain
86         # (requires wildcard DNS and TLS certificate)
87         #   https://*--collections.uuid_prefix.arvadosapi.com
88         #
89         # Serve preview links by setting uuid or pdh in the path.
90         # This configuration only allows previews of public data or
91         # collection-sharing links, because these use the anonymous
92         # user token or the token is already embedded in the URL.
93         # Other data must be handled as downloads via WebDAVDownload:
94         #   https://collections.uuid_prefix.arvadosapi.com
95         #
96         ExternalURL: ""
97
98       WebDAVDownload:
99         InternalURLs: {}
100         # Base URL for download links. If blank, serve links to WebDAV
101         # with disposition=attachment query param.  Unlike preview links,
102         # browsers do not render attachments, so there is no risk of XSS.
103         #
104         # If WebDAVDownload is blank, and WebDAV uses a
105         # single-origin form, then Workbench will show an error page
106         #
107         # Serve download links by setting uuid or pdh in the path:
108         #   https://download.uuid_prefix.arvadosapi.com
109         #
110         ExternalURL: ""
111
112       Keepstore:
113         InternalURLs: {}
114         ExternalURL: "-"
115       Composer:
116         InternalURLs: {}
117         ExternalURL: ""
118       WebShell:
119         InternalURLs: {}
120         # ShellInABox service endpoint URL for a given VM.  If empty, do not
121         # offer web shell logins.
122         #
123         # E.g., using a path-based proxy server to forward connections to shell hosts:
124         # https://webshell.uuid_prefix.arvadosapi.com
125         #
126         # E.g., using a name-based proxy server to forward connections to shell hosts:
127         # https://*.webshell.uuid_prefix.arvadosapi.com
128         ExternalURL: ""
129       Workbench1:
130         InternalURLs: {}
131         ExternalURL: ""
132       Workbench2:
133         InternalURLs: {}
134         ExternalURL: ""
135       Nodemanager:
136         InternalURLs: {}
137         ExternalURL: "-"
138       Health:
139         InternalURLs: {}
140         ExternalURL: "-"
141
142     PostgreSQL:
143       # max concurrent connections per arvados server daemon
144       ConnectionPool: 32
145       Connection:
146         # All parameters here are passed to the PG client library in a connection string;
147         # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
148         host: ""
149         port: ""
150         user: ""
151         password: ""
152         dbname: ""
153         SAMPLE: ""
154     API:
155       # Maximum size (in bytes) allowed for a single API request.  This
156       # limit is published in the discovery document for use by clients.
157       # Note: You must separately configure the upstream web server or
158       # proxy to actually enforce the desired maximum request size on the
159       # server side.
160       MaxRequestSize: 134217728
161
162       # Limit the number of bytes read from the database during an index
163       # request (by retrieving and returning fewer rows than would
164       # normally be returned in a single response).
165       # Note 1: This setting never reduces the number of returned rows to
166       # zero, no matter how big the first data row is.
167       # Note 2: Currently, this is only checked against a specific set of
168       # columns that tend to get large (collections.manifest_text,
169       # containers.mounts, workflows.definition). Other fields (e.g.,
170       # "properties" hashes) are not counted against this limit.
171       MaxIndexDatabaseRead: 134217728
172
173       # Maximum number of items to return when responding to a APIs that
174       # can return partial result sets using limit and offset parameters
175       # (e.g., *.index, groups.contents). If a request specifies a "limit"
176       # parameter higher than this value, this value is used instead.
177       MaxItemsPerResponse: 1000
178
179       # API methods to disable. Disabled methods are not listed in the
180       # discovery document, and respond 404 to all requests.
181       # Example: ["jobs.create", "pipeline_instances.create"]
182       DisabledAPIs: []
183
184       # Interval (seconds) between asynchronous permission view updates. Any
185       # permission-updating API called with the 'async' parameter schedules a an
186       # update on the permission view in the future, if not already scheduled.
187       AsyncPermissionsUpdateInterval: 20s
188
189       # Maximum number of concurrent outgoing requests to make while
190       # serving a single incoming multi-cluster (federated) request.
191       MaxRequestAmplification: 4
192
193       # RailsSessionSecretToken is a string of alphanumeric characters
194       # used by Rails to sign session tokens. IMPORTANT: This is a
195       # site secret. It should be at least 50 characters.
196       RailsSessionSecretToken: ""
197
198       # Maximum wall clock time to spend handling an incoming request.
199       RequestTimeout: 5m
200
201     Users:
202       # Config parameters to automatically setup new users.  If enabled,
203       # this users will be able to self-activate.  Enable this if you want
204       # to run an open instance where anyone can create an account and use
205       # the system without requiring manual approval.
206       #
207       # The params auto_setup_new_users_with_* are meaningful only when auto_setup_new_users is turned on.
208       # auto_setup_name_blacklist is a list of usernames to be blacklisted for auto setup.
209       AutoSetupNewUsers: false
210       AutoSetupNewUsersWithVmUUID: ""
211       AutoSetupNewUsersWithRepository: false
212       AutoSetupUsernameBlacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
213
214       # When new_users_are_active is set to true, new users will be active
215       # immediately.  This skips the "self-activate" step which enforces
216       # user agreements.  Should only be enabled for development.
217       NewUsersAreActive: false
218
219       # The e-mail address of the user you would like to become marked as an admin
220       # user on their first login.
221       # In the default configuration, authentication happens through the Arvados SSO
222       # server, which uses OAuth2 against Google's servers, so in that case this
223       # should be an address associated with a Google account.
224       AutoAdminUserWithEmail: ""
225
226       # If auto_admin_first_user is set to true, the first user to log in when no
227       # other admin users exist will automatically become an admin user.
228       AutoAdminFirstUser: false
229
230       # Email address to notify whenever a user creates a profile for the
231       # first time
232       UserProfileNotificationAddress: ""
233       AdminNotifierEmailFrom: arvados@example.com
234       EmailSubjectPrefix: "[ARVADOS] "
235       UserNotifierEmailFrom: arvados@example.com
236       NewUserNotificationRecipients: []
237       NewInactiveUserNotificationRecipients: []
238
239       # Set anonymous_user_token to enable anonymous user access. You can get
240       # the token by running "bundle exec ./script/get_anonymous_user_token.rb"
241       # in the directory where your API server is running.
242       AnonymousUserToken: ""
243
244     AuditLogs:
245       # Time to keep audit logs, in seconds. (An audit log is a row added
246       # to the "logs" table in the PostgreSQL database each time an
247       # Arvados object is created, modified, or deleted.)
248       #
249       # Currently, websocket event notifications rely on audit logs, so
250       # this should not be set lower than 300 (5 minutes).
251       MaxAge: 336h
252
253       # Maximum number of log rows to delete in a single SQL transaction.
254       #
255       # If max_audit_log_delete_batch is 0, log entries will never be
256       # deleted by Arvados. Cleanup can be done by an external process
257       # without affecting any Arvados system processes, as long as very
258       # recent (<5 minutes old) logs are not deleted.
259       #
260       # 100000 is a reasonable batch size for most sites.
261       MaxDeleteBatch: 0
262
263       # Attributes to suppress in events and audit logs.  Notably,
264       # specifying ["manifest_text"] here typically makes the database
265       # smaller and faster.
266       #
267       # Warning: Using any non-empty value here can have undesirable side
268       # effects for any client or component that relies on event logs.
269       # Use at your own risk.
270       UnloggedAttributes: []
271
272     SystemLogs:
273
274       # Logging threshold: panic, fatal, error, warn, info, debug, or
275       # trace
276       LogLevel: info
277
278       # Logging format: json or text
279       Format: json
280
281       # Maximum characters of (JSON-encoded) query parameters to include
282       # in each request log entry. When params exceed this size, they will
283       # be JSON-encoded, truncated to this size, and logged as
284       # params_truncated.
285       MaxRequestLogParamsSize: 2000
286
287     Collections:
288       # Allow clients to create collections by providing a manifest with
289       # unsigned data blob locators. IMPORTANT: This effectively disables
290       # access controls for data stored in Keep: a client who knows a hash
291       # can write a manifest that references the hash, pass it to
292       # collections.create (which will create a permission link), use
293       # collections.get to obtain a signature for that data locator, and
294       # use that signed locator to retrieve the data from Keep. Therefore,
295       # do not turn this on if your users expect to keep data private from
296       # one another!
297       BlobSigning: true
298
299       # BlobSigningKey is a string of alphanumeric characters used to
300       # generate permission signatures for Keep locators. It must be
301       # identical to the permission key given to Keep. IMPORTANT: This is
302       # a site secret. It should be at least 50 characters.
303       #
304       # Modifying blob_signing_key will invalidate all existing
305       # signatures, which can cause programs to fail (e.g., arv-put,
306       # arv-get, and Crunch jobs).  To avoid errors, rotate keys only when
307       # no such processes are running.
308       BlobSigningKey: ""
309
310       # Default replication level for collections. This is used when a
311       # collection's replication_desired attribute is nil.
312       DefaultReplication: 2
313
314       # Lifetime (in seconds) of blob permission signatures generated by
315       # the API server. This determines how long a client can take (after
316       # retrieving a collection record) to retrieve the collection data
317       # from Keep. If the client needs more time than that (assuming the
318       # collection still has the same content and the relevant user/token
319       # still has permission) the client can retrieve the collection again
320       # to get fresh signatures.
321       #
322       # This must be exactly equal to the -blob-signature-ttl flag used by
323       # keepstore servers.  Otherwise, reading data blocks and saving
324       # collections will fail with HTTP 403 permission errors.
325       #
326       # Modifying blob_signature_ttl invalidates existing signatures; see
327       # blob_signing_key note above.
328       #
329       # The default is 2 weeks.
330       BlobSigningTTL: 336h
331
332       # Default lifetime for ephemeral collections: 2 weeks. This must not
333       # be less than blob_signature_ttl.
334       DefaultTrashLifetime: 336h
335
336       # Interval (seconds) between trash sweeps. During a trash sweep,
337       # collections are marked as trash if their trash_at time has
338       # arrived, and deleted if their delete_at time has arrived.
339       TrashSweepInterval: 60s
340
341       # If true, enable collection versioning.
342       # When a collection's preserve_version field is true or the current version
343       # is older than the amount of seconds defined on preserve_version_if_idle,
344       # a snapshot of the collection's previous state is created and linked to
345       # the current collection.
346       CollectionVersioning: false
347
348       #   0s = auto-create a new version on every update.
349       #  -1s = never auto-create new versions.
350       # > 0s = auto-create a new version when older than the specified number of seconds.
351       PreserveVersionIfIdle: -1s
352
353       # Managed collection properties. At creation time, if the client didn't
354       # provide the listed keys, they will be automatically populated following
355       # one of the following behaviors:
356       #
357       # * UUID of the user who owns the containing project.
358       #   responsible_person_uuid: {Function: original_owner, Protected: true}
359       #
360       # * Default concrete value.
361       #   foo_bar: {Value: baz, Protected: false}
362       #
363       # If Protected is true, only an admin user can modify its value.
364       ManagedProperties:
365         SAMPLE: {Function: original_owner, Protected: true}
366
367       # In "trust all content" mode, Workbench will redirect download
368       # requests to WebDAV preview link, even in the cases when
369       # WebDAV would have to expose XSS vulnerabilities in order to
370       # handle the redirect (see discussion on Services.WebDAV).
371       #
372       # This setting has no effect in the recommended configuration,
373       # where the WebDAV is configured to have a separate domain for
374       # every collection; in this case XSS protection is provided by
375       # browsers' same-origin policy.
376       #
377       # The default setting (false) is appropriate for a multi-user site.
378       TrustAllContent: false
379
380     Login:
381       # These settings are provided by your OAuth2 provider (e.g.,
382       # sso-provider).
383       ProviderAppSecret: ""
384       ProviderAppID: ""
385
386     Git:
387       # Git repositories must be readable by api server, or you won't be
388       # able to submit crunch jobs. To pass the test suites, put a clone
389       # of the arvados tree in {git_repositories_dir}/arvados.git or
390       # {git_repositories_dir}/arvados/.git
391       Repositories: /var/lib/arvados/git/repositories
392
393     TLS:
394       Certificate: ""
395       Key: ""
396       Insecure: false
397
398     Containers:
399       # List of supported Docker Registry image formats that compute nodes
400       # are able to use. `arv keep docker` will error out if a user tries
401       # to store an image with an unsupported format. Use an empty array
402       # to skip the compatibility check (and display a warning message to
403       # that effect).
404       #
405       # Example for sites running docker < 1.10: ["v1"]
406       # Example for sites running docker >= 1.10: ["v2"]
407       # Example for disabling check: []
408       SupportedDockerImageFormats: ["v2"]
409
410       # Include details about job reuse decisions in the server log. This
411       # causes additional database queries to run, so it should not be
412       # enabled unless you expect to examine the resulting logs for
413       # troubleshooting purposes.
414       LogReuseDecisions: false
415
416       # Default value for keep_cache_ram of a container's runtime_constraints.
417       DefaultKeepCacheRAM: 268435456
418
419       # Number of times a container can be unlocked before being
420       # automatically cancelled.
421       MaxDispatchAttempts: 5
422
423       # Default value for container_count_max for container requests.  This is the
424       # number of times Arvados will create a new container to satisfy a container
425       # request.  If a container is cancelled it will retry a new container if
426       # container_count < container_count_max on any container requests associated
427       # with the cancelled container.
428       MaxRetryAttempts: 3
429
430       # The maximum number of compute nodes that can be in use simultaneously
431       # If this limit is reduced, any existing nodes with slot number >= new limit
432       # will not be counted against the new limit. In other words, the new limit
433       # won't be strictly enforced until those nodes with higher slot numbers
434       # go down.
435       MaxComputeVMs: 64
436
437       # Preemptible instance support (e.g. AWS Spot Instances)
438       # When true, child containers will get created with the preemptible
439       # scheduling parameter parameter set.
440       UsePreemptibleInstances: false
441
442       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
443       # (experimental) cloud dispatcher for executing containers on
444       # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
445       # and ends with "\n-----END RSA PRIVATE KEY-----\n".
446       DispatchPrivateKey: none
447
448       # Maximum time to wait for workers to come up before abandoning
449       # stale locks from a previous dispatch process.
450       StaleLockTimeout: 1m
451
452       # The crunch-run command to manage the container on a node
453       CrunchRunCommand: "crunch-run"
454
455       # Extra arguments to add to crunch-run invocation
456       # Example: ["--cgroup-parent-subsystem=memory"]
457       CrunchRunArgumentsList: []
458
459       # Extra RAM to reserve on the node, in addition to
460       # the amount specified in the container's RuntimeConstraints
461       ReserveExtraRAM: 256MiB
462
463       # Minimum time between two attempts to run the same container
464       MinRetryPeriod: 0s
465
466       Logging:
467         # When you run the db:delete_old_container_logs task, it will find
468         # containers that have been finished for at least this many seconds,
469         # and delete their stdout, stderr, arv-mount, crunch-run, and
470         # crunchstat logs from the logs table.
471         MaxAge: 720h
472
473         # These two settings control how frequently log events are flushed to the
474         # database.  Log lines are buffered until either crunch_log_bytes_per_event
475         # has been reached or crunch_log_seconds_between_events has elapsed since
476         # the last flush.
477         LogBytesPerEvent: 4096
478         LogSecondsBetweenEvents: 1
479
480         # The sample period for throttling logs.
481         LogThrottlePeriod: 60s
482
483         # Maximum number of bytes that job can log over crunch_log_throttle_period
484         # before being silenced until the end of the period.
485         LogThrottleBytes: 65536
486
487         # Maximum number of lines that job can log over crunch_log_throttle_period
488         # before being silenced until the end of the period.
489         LogThrottleLines: 1024
490
491         # Maximum bytes that may be logged by a single job.  Log bytes that are
492         # silenced by throttling are not counted against this total.
493         LimitLogBytesPerJob: 67108864
494
495         LogPartialLineThrottlePeriod: 5s
496
497         # Container logs are written to Keep and saved in a
498         # collection, which is updated periodically while the
499         # container runs.  This value sets the interval between
500         # collection updates.
501         LogUpdatePeriod: 30m
502
503         # The log collection is also updated when the specified amount of
504         # log data (given in bytes) is produced in less than one update
505         # period.
506         LogUpdateSize: 32MiB
507
508       SLURM:
509         PrioritySpread: 0
510         SbatchArgumentsList: []
511         Managed:
512           # Path to dns server configuration directory
513           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
514           # files or touch restart.txt (see below).
515           DNSServerConfDir: ""
516
517           # Template file for the dns server host snippets. See
518           # unbound.template in this directory for an example. If false, do
519           # not write any config files.
520           DNSServerConfTemplate: ""
521
522           # String to write to {dns_server_conf_dir}/restart.txt (with a
523           # trailing newline) after updating local data. If false, do not
524           # open or write the restart.txt file.
525           DNSServerReloadCommand: ""
526
527           # Command to run after each DNS update. Template variables will be
528           # substituted; see the "unbound" example below. If false, do not run
529           # a command.
530           DNSServerUpdateCommand: ""
531
532           ComputeNodeDomain: ""
533           ComputeNodeNameservers:
534             - 192.168.1.1
535
536           # Hostname to assign to a compute node when it sends a "ping" and the
537           # hostname in its Node record is nil.
538           # During bootstrapping, the "ping" script is expected to notice the
539           # hostname given in the ping response, and update its unix hostname
540           # accordingly.
541           # If false, leave the hostname alone (this is appropriate if your compute
542           # nodes' hostnames are already assigned by some other mechanism).
543           #
544           # One way or another, the hostnames of your node records should agree
545           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
546           #
547           # Example for compute0000, compute0001, ....:
548           # assign_node_hostname: compute%<slot_number>04d
549           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
550           AssignNodeHostname: "compute%<slot_number>d"
551
552       JobsAPI:
553         # Enable the legacy Jobs API.  This value must be a string.
554         # 'auto' -- (default) enable the Jobs API only if it has been used before
555         #         (i.e., there are job records in the database)
556         # 'true' -- enable the Jobs API despite lack of existing records.
557         # 'false' -- disable the Jobs API despite presence of existing records.
558         Enable: 'auto'
559
560         # Git repositories must be readable by api server, or you won't be
561         # able to submit crunch jobs. To pass the test suites, put a clone
562         # of the arvados tree in {git_repositories_dir}/arvados.git or
563         # {git_repositories_dir}/arvados/.git
564         GitInternalDir: /var/lib/arvados/internal.git
565
566         # Docker image to be used when none found in runtime_constraints of a job
567         DefaultDockerImage: ""
568
569         # none or slurm_immediate
570         CrunchJobWrapper: none
571
572         # username, or false = do not set uid when running jobs.
573         CrunchJobUser: crunch
574
575         # The web service must be able to create/write this file, and
576         # crunch-job must be able to stat() it.
577         CrunchRefreshTrigger: /tmp/crunch_refresh_trigger
578
579         # Control job reuse behavior when two completed jobs match the
580         # search criteria and have different outputs.
581         #
582         # If true, in case of a conflict, reuse the earliest job (this is
583         # similar to container reuse behavior).
584         #
585         # If false, in case of a conflict, do not reuse any completed job,
586         # but do reuse an already-running job if available (this is the
587         # original job reuse behavior, and is still the default).
588         ReuseJobIfOutputsDiffer: false
589
590       CloudVMs:
591         # Enable the cloud scheduler (experimental).
592         Enable: false
593
594         # Name/number of port where workers' SSH services listen.
595         SSHPort: "22"
596
597         # Interval between queue polls.
598         PollInterval: 10s
599
600         # Shell command to execute on each worker to determine whether
601         # the worker is booted and ready to run containers. It should
602         # exit zero if the worker is ready.
603         BootProbeCommand: "docker ps -q"
604
605         # Minimum interval between consecutive probes to a single
606         # worker.
607         ProbeInterval: 10s
608
609         # Maximum probes per second, across all workers in a pool.
610         MaxProbesPerSecond: 10
611
612         # Time before repeating SIGTERM when killing a container.
613         TimeoutSignal: 5s
614
615         # Time to give up on SIGTERM and write off the worker.
616         TimeoutTERM: 2m
617
618         # Maximum create/destroy-instance operations per second (0 =
619         # unlimited).
620         MaxCloudOpsPerSecond: 0
621
622         # Interval between cloud provider syncs/updates ("list all
623         # instances").
624         SyncInterval: 1m
625
626         # Time to leave an idle worker running (in case new containers
627         # appear in the queue that it can run) before shutting it
628         # down.
629         TimeoutIdle: 1m
630
631         # Time to wait for a new worker to boot (i.e., pass
632         # BootProbeCommand) before giving up and shutting it down.
633         TimeoutBooting: 10m
634
635         # Maximum time a worker can stay alive with no successful
636         # probes before being automatically shut down.
637         TimeoutProbe: 10m
638
639         # Time after shutting down a worker to retry the
640         # shutdown/destroy operation.
641         TimeoutShutdown: 10s
642
643         # Worker VM image ID.
644         ImageID: ""
645
646         # Tags to add on all resources (VMs, NICs, disks) created by
647         # the container dispatcher. (Arvados's own tags --
648         # InstanceType, IdleBehavior, and InstanceSecret -- will also
649         # be added.)
650         ResourceTags:
651           SAMPLE: "tag value"
652
653         # Prefix for predefined tags used by Arvados (InstanceSetID,
654         # InstanceType, InstanceSecret, IdleBehavior). With the
655         # default value "Arvados", tags are "ArvadosInstanceSetID",
656         # "ArvadosInstanceSecret", etc.
657         #
658         # This should only be changed while no cloud resources are in
659         # use and the cloud dispatcher is not running. Otherwise,
660         # VMs/resources that were added using the old tag prefix will
661         # need to be detected and cleaned up manually.
662         TagKeyPrefix: Arvados
663
664         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
665         Driver: ec2
666
667         # Cloud-specific driver parameters.
668         DriverParameters:
669
670           # (ec2) Credentials.
671           AccessKeyID: ""
672           SecretAccessKey: ""
673
674           # (ec2) Instance configuration.
675           SecurityGroupIDs:
676             - ""
677           SubnetID: ""
678           Region: ""
679           EBSVolumeType: gp2
680           AdminUsername: debian
681
682           # (azure) Credentials.
683           SubscriptionID: ""
684           ClientID: ""
685           ClientSecret: ""
686           TenantID: ""
687
688           # (azure) Instance configuration.
689           CloudEnvironment: AzurePublicCloud
690           ResourceGroup: ""
691           Location: centralus
692           Network: ""
693           Subnet: ""
694           StorageAccount: ""
695           BlobContainer: ""
696           DeleteDanglingResourcesAfter: 20s
697           AdminUsername: arvados
698
699     InstanceTypes:
700
701       # Use the instance type name as the key (in place of "SAMPLE" in
702       # this sample entry).
703       SAMPLE:
704         # Cloud provider's instance type. Defaults to the configured type name.
705         ProviderType: ""
706         VCPUs: 1
707         RAM: 128MiB
708         IncludedScratch: 16GB
709         AddedScratch: 0
710         Price: 0.1
711         Preemptible: false
712
713     Mail:
714       MailchimpAPIKey: ""
715       MailchimpListID: ""
716       SendUserSetupNotificationEmail: true
717
718       # Bug/issue report notification to and from addresses
719       IssueReporterEmailFrom: "arvados@example.com"
720       IssueReporterEmailTo: "arvados@example.com"
721       SupportEmailAddress: "arvados@example.com"
722
723       # Generic issue email from
724       EmailFrom: "arvados@example.com"
725     RemoteClusters:
726       "*":
727         Host: ""
728         Proxy: false
729         Scheme: https
730         Insecure: false
731         ActivateUsers: false
732       SAMPLE:
733         # API endpoint host or host:port; default is {id}.arvadosapi.com
734         Host: sample.arvadosapi.com
735
736         # Perform a proxy request when a local client requests an
737         # object belonging to this remote.
738         Proxy: false
739
740         # Default "https". Can be set to "http" for testing.
741         Scheme: https
742
743         # Disable TLS verify. Can be set to true for testing.
744         Insecure: false
745
746         # When users present tokens issued by this remote cluster, and
747         # their accounts are active on the remote cluster, activate
748         # them on this cluster too.
749         ActivateUsers: false
750
751     Workbench:
752       # Workbench1 configs
753       Theme: default
754       ActivationContactLink: mailto:info@arvados.org
755       ArvadosDocsite: https://doc.arvados.org
756       ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
757       ShowUserAgreementInline: false
758       SecretKeyBase: ""
759
760       # Scratch directory used by the remote repository browsing
761       # feature. If it doesn't exist, it (and any missing parents) will be
762       # created using mkdir_p.
763       RepositoryCache: /var/www/arvados-workbench/current/tmp/git
764
765       # Below is a sample setting of user_profile_form_fields config parameter.
766       # This configuration parameter should be set to either false (to disable) or
767       # to a map as shown below.
768       # Configure the map of input fields to be displayed in the profile page
769       # using the attribute "key" for each of the input fields.
770       # This sample shows configuration with one required and one optional form fields.
771       # For each of these input fields:
772       #   You can specify "Type" as "text" or "select".
773       #   List the "Options" to be displayed for each of the "select" menu.
774       #   Set "Required" as "true" for any of these fields to make them required.
775       # If any of the required fields are missing in the user's profile, the user will be
776       # redirected to the profile page before they can access any Workbench features.
777       UserProfileFormFields:
778         SAMPLE:
779           Type: select
780           FormFieldTitle: Best color
781           FormFieldDescription: your favorite color
782           Required: false
783           Position: 1
784           Options:
785             red: {}
786             blue: {}
787             green: {}
788             SAMPLE: {}
789
790         # exampleTextValue:  # key that will be set in properties
791         #   Type: text  #
792         #   FormFieldTitle: ""
793         #   FormFieldDescription: ""
794         #   Required: true
795         #   Position: 1
796         # exampleOptionsValue:
797         #   Type: select
798         #   FormFieldTitle: ""
799         #   FormFieldDescription: ""
800         #   Required: true
801         #   Position: 1
802         #   Options:
803         #     red: {}
804         #     blue: {}
805         #     yellow: {}
806
807       # Use "UserProfileFormMessage to configure the message you want
808       # to display on the profile page.
809       UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
810
811       # Mimetypes of applications for which the view icon
812       # would be enabled in a collection's show page.
813       # It is sufficient to list only applications here.
814       # No need to list text and image types.
815       ApplicationMimetypesWithViewIcon:
816         cwl: {}
817         fasta: {}
818         go: {}
819         javascript: {}
820         json: {}
821         pdf: {}
822         python: {}
823         x-python: {}
824         r: {}
825         rtf: {}
826         sam: {}
827         x-sh: {}
828         vnd.realvnc.bed: {}
829         xml: {}
830         xsl: {}
831         SAMPLE: {}
832
833       # The maximum number of bytes to load in the log viewer
834       LogViewerMaxBytes: 1M
835
836       # When anonymous_user_token is configured, show public projects page
837       EnablePublicProjectsPage: true
838
839       # By default, disable the "Getting Started" popup which is specific to Arvados playground
840       EnableGettingStartedPopup: false
841
842       # Ask Arvados API server to compress its response payloads.
843       APIResponseCompression: true
844
845       # Timeouts for API requests.
846       APIClientConnectTimeout: 2m
847       APIClientReceiveTimeout: 5m
848
849       # Maximum number of historic log records of a running job to fetch
850       # and display in the Log tab, while subscribing to web sockets.
851       RunningJobLogRecordsToFetch: 2000
852
853       # In systems with many shared projects, loading of dashboard and topnav
854       # cab be slow due to collections indexing; use the following parameters
855       # to suppress these properties
856       ShowRecentCollectionsOnDashboard: true
857       ShowUserNotifications: true
858
859       # Enable/disable "multi-site search" in top nav ("true"/"false"), or
860       # a link to the multi-site search page on a "home" Workbench site.
861       #
862       # Example:
863       #   https://workbench.qr1hi.arvadosapi.com/collections/multisite
864       MultiSiteSearch: ""
865
866       # Should workbench allow management of local git repositories? Set to false if
867       # the jobs api is disabled and there are no local git repositories.
868       Repositories: true
869
870       SiteName: Arvados Workbench
871       ProfilingEnabled: false
872
873       # This is related to obsolete Google OpenID 1.0 login
874       # but some workbench stuff still expects it to be set.
875       DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
876
877       # Workbench2 configs
878       VocabularyURL: ""
879       FileViewersConfigURL: ""
880
881     # Use experimental controller code (see https://dev.arvados.org/issues/14287)
882     EnableBetaController14287: false