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