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