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