15003: Merge branch 'master' into 15003-preprocess-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       RailsAPI:
29         InternalURLs: {}
30       GitHTTP:
31         InternalURLs: {}
32         ExternalURL: ""
33       Keepstore:
34         InternalURLs: {}
35       Controller:
36         InternalURLs: {}
37         ExternalURL: ""
38       Websocket:
39         InternalURLs: {}
40         ExternalURL: ""
41       Keepbalance:
42         InternalURLs: {}
43       GitHTTP:
44         InternalURLs: {}
45         ExternalURL: ""
46       GitSSH:
47         ExternalURL: ""
48       DispatchCloud:
49         InternalURLs: {}
50       SSO:
51         ExternalURL: ""
52       Keepproxy:
53         InternalURLs: {}
54         ExternalURL: ""
55       WebDAV:
56         InternalURLs: {}
57         ExternalURL: ""
58       WebDAVDownload:
59         InternalURLs: {}
60         ExternalURL: ""
61       Keepstore:
62         InternalURLs: {}
63       Composer:
64         ExternalURL: ""
65       WebShell:
66         ExternalURL: ""
67       Workbench1:
68         InternalURLs: {}
69         ExternalURL: ""
70       Workbench2:
71         ExternalURL: ""
72     PostgreSQL:
73       # max concurrent connections per arvados server daemon
74       ConnectionPool: 32
75       Connection:
76         # All parameters here are passed to the PG client library in a connection string;
77         # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
78         Host: ""
79         Port: ""
80         User: ""
81         Password: ""
82         DBName: ""
83     API:
84       # Maximum size (in bytes) allowed for a single API request.  This
85       # limit is published in the discovery document for use by clients.
86       # Note: You must separately configure the upstream web server or
87       # proxy to actually enforce the desired maximum request size on the
88       # server side.
89       MaxRequestSize: 134217728
90
91       # Limit the number of bytes read from the database during an index
92       # request (by retrieving and returning fewer rows than would
93       # normally be returned in a single response).
94       # Note 1: This setting never reduces the number of returned rows to
95       # zero, no matter how big the first data row is.
96       # Note 2: Currently, this is only checked against a specific set of
97       # columns that tend to get large (collections.manifest_text,
98       # containers.mounts, workflows.definition). Other fields (e.g.,
99       # "properties" hashes) are not counted against this limit.
100       MaxIndexDatabaseRead: 134217728
101
102       # Maximum number of items to return when responding to a APIs that
103       # can return partial result sets using limit and offset parameters
104       # (e.g., *.index, groups.contents). If a request specifies a "limit"
105       # parameter higher than this value, this value is used instead.
106       MaxItemsPerResponse: 1000
107
108       # API methods to disable. Disabled methods are not listed in the
109       # discovery document, and respond 404 to all requests.
110       # Example: ["jobs.create", "pipeline_instances.create"]
111       DisabledAPIs: []
112
113       # Interval (seconds) between asynchronous permission view updates. Any
114       # permission-updating API called with the 'async' parameter schedules a an
115       # update on the permission view in the future, if not already scheduled.
116       AsyncPermissionsUpdateInterval: 20
117
118       # Maximum number of concurrent outgoing requests to make while
119       # serving a single incoming multi-cluster (federated) request.
120       MaxRequestAmplification: 4
121
122       # RailsSessionSecretToken is a string of alphanumeric characters
123       # used by Rails to sign session tokens. IMPORTANT: This is a
124       # site secret. It should be at least 50 characters.
125       RailsSessionSecretToken: ""
126
127     Users:
128       # Config parameters to automatically setup new users.  If enabled,
129       # this users will be able to self-activate.  Enable this if you want
130       # to run an open instance where anyone can create an account and use
131       # the system without requiring manual approval.
132       #
133       # The params auto_setup_new_users_with_* are meaningful only when auto_setup_new_users is turned on.
134       # auto_setup_name_blacklist is a list of usernames to be blacklisted for auto setup.
135       AutoSetupNewUsers: false
136       AutoSetupNewUsersWithVmUUID: ""
137       AutoSetupNewUsersWithRepository: false
138       AutoSetupUsernameBlacklist: [arvados, git, gitolite, gitolite-admin, root, syslog]
139
140       # When new_users_are_active is set to true, new users will be active
141       # immediately.  This skips the "self-activate" step which enforces
142       # user agreements.  Should only be enabled for development.
143       NewUsersAreActive: false
144
145       # The e-mail address of the user you would like to become marked as an admin
146       # user on their first login.
147       # In the default configuration, authentication happens through the Arvados SSO
148       # server, which uses OAuth2 against Google's servers, so in that case this
149       # should be an address associated with a Google account.
150       AutoAdminUserWithEmail: ""
151
152       # If auto_admin_first_user is set to true, the first user to log in when no
153       # other admin users exist will automatically become an admin user.
154       AutoAdminFirstUser: false
155
156       # Email address to notify whenever a user creates a profile for the
157       # first time
158       UserProfileNotificationAddress: ""
159       AdminNotifierEmailFrom: arvados@example.com
160       EmailSubjectPrefix: "[ARVADOS] "
161       UserNotifierEmailFrom: arvados@example.com
162       NewUserNotificationRecipients: []
163       NewInactiveUserNotificationRecipients: []
164
165     AuditLogs:
166       # Time to keep audit logs, in seconds. (An audit log is a row added
167       # to the "logs" table in the PostgreSQL database each time an
168       # Arvados object is created, modified, or deleted.)
169       #
170       # Currently, websocket event notifications rely on audit logs, so
171       # this should not be set lower than 600 (5 minutes).
172       MaxAge: 1209600
173
174       # Maximum number of log rows to delete in a single SQL transaction.
175       #
176       # If max_audit_log_delete_batch is 0, log entries will never be
177       # deleted by Arvados. Cleanup can be done by an external process
178       # without affecting any Arvados system processes, as long as very
179       # recent (<5 minutes old) logs are not deleted.
180       #
181       # 100000 is a reasonable batch size for most sites.
182       MaxDeleteBatch: 0
183
184       # Attributes to suppress in events and audit logs.  Notably,
185       # specifying ["manifest_text"] here typically makes the database
186       # smaller and faster.
187       #
188       # Warning: Using any non-empty value here can have undesirable side
189       # effects for any client or component that relies on event logs.
190       # Use at your own risk.
191       UnloggedAttributes: []
192
193     SystemLogs:
194       # Maximum characters of (JSON-encoded) query parameters to include
195       # in each request log entry. When params exceed this size, they will
196       # be JSON-encoded, truncated to this size, and logged as
197       # params_truncated.
198       MaxRequestLogParamsSize: 2000
199
200     Collections:
201       # Allow clients to create collections by providing a manifest with
202       # unsigned data blob locators. IMPORTANT: This effectively disables
203       # access controls for data stored in Keep: a client who knows a hash
204       # can write a manifest that references the hash, pass it to
205       # collections.create (which will create a permission link), use
206       # collections.get to obtain a signature for that data locator, and
207       # use that signed locator to retrieve the data from Keep. Therefore,
208       # do not turn this on if your users expect to keep data private from
209       # one another!
210       BlobSigning: true
211
212       # blob_signing_key is a string of alphanumeric characters used to
213       # generate permission signatures for Keep locators. It must be
214       # identical to the permission key given to Keep. IMPORTANT: This is
215       # a site secret. It should be at least 50 characters.
216       #
217       # Modifying blob_signing_key will invalidate all existing
218       # signatures, which can cause programs to fail (e.g., arv-put,
219       # arv-get, and Crunch jobs).  To avoid errors, rotate keys only when
220       # no such processes are running.
221       BlobSigningKey: ""
222
223       # Default replication level for collections. This is used when a
224       # collection's replication_desired attribute is nil.
225       DefaultReplication: 2
226
227       # Lifetime (in seconds) of blob permission signatures generated by
228       # the API server. This determines how long a client can take (after
229       # retrieving a collection record) to retrieve the collection data
230       # from Keep. If the client needs more time than that (assuming the
231       # collection still has the same content and the relevant user/token
232       # still has permission) the client can retrieve the collection again
233       # to get fresh signatures.
234       #
235       # This must be exactly equal to the -blob-signature-ttl flag used by
236       # keepstore servers.  Otherwise, reading data blocks and saving
237       # collections will fail with HTTP 403 permission errors.
238       #
239       # Modifying blob_signature_ttl invalidates existing signatures; see
240       # blob_signing_key note above.
241       #
242       # The default is 2 weeks.
243       BlobSigningTTL: 1209600
244
245       # Default lifetime for ephemeral collections: 2 weeks. This must not
246       # be less than blob_signature_ttl.
247       DefaultTrashLifetime: 1209600
248
249       # Interval (seconds) between trash sweeps. During a trash sweep,
250       # collections are marked as trash if their trash_at time has
251       # arrived, and deleted if their delete_at time has arrived.
252       TrashSweepInterval: 60
253
254       # If true, enable collection versioning.
255       # When a collection's preserve_version field is true or the current version
256       # is older than the amount of seconds defined on preserve_version_if_idle,
257       # a snapshot of the collection's previous state is created and linked to
258       # the current collection.
259       CollectionVersioning: false
260
261       #   0 = auto-create a new version on every update.
262       #  -1 = never auto-create new versions.
263       # > 0 = auto-create a new version when older than the specified number of seconds.
264       PreserveVersionIfIdle: -1
265
266     Login:
267       # These settings are provided by your OAuth2 provider (e.g.,
268       # sso-provider).
269       ProviderAppSecret: ""
270       ProviderAppID: ""
271
272     Git:
273       # Git repositories must be readable by api server, or you won't be
274       # able to submit crunch jobs. To pass the test suites, put a clone
275       # of the arvados tree in {git_repositories_dir}/arvados.git or
276       # {git_repositories_dir}/arvados/.git
277       Repositories: /var/lib/arvados/git/repositories
278
279     TLS:
280       Insecure: false
281
282     Containers:
283       # List of supported Docker Registry image formats that compute nodes
284       # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
285       # to store an image with an unsupported format. Use an empty array
286       # to skip the compatibility check (and display a warning message to
287       # that effect).
288       #
289       # Example for sites running docker < 1.10: ["v1"]
290       # Example for sites running docker >= 1.10: ["v2"]
291       # Example for disabling check: []
292       SupportedDockerImageFormats: ["v2"]
293
294       # Include details about job reuse decisions in the server log. This
295       # causes additional database queries to run, so it should not be
296       # enabled unless you expect to examine the resulting logs for
297       # troubleshooting purposes.
298       LogReuseDecisions: false
299
300       # Default value for keep_cache_ram of a container's runtime_constraints.
301       DefaultKeepCacheRAM: 268435456
302
303       # Number of times a container can be unlocked before being
304       # automatically cancelled.
305       MaxDispatchAttempts: 5
306
307       # Default value for container_count_max for container requests.  This is the
308       # number of times Arvados will create a new container to satisfy a container
309       # request.  If a container is cancelled it will retry a new container if
310       # container_count < container_count_max on any container requests associated
311       # with the cancelled container.
312       MaxRetryAttempts: 3
313
314       # The maximum number of compute nodes that can be in use simultaneously
315       # If this limit is reduced, any existing nodes with slot number >= new limit
316       # will not be counted against the new limit. In other words, the new limit
317       # won't be strictly enforced until those nodes with higher slot numbers
318       # go down.
319       MaxComputeVMs: 64
320
321       # Preemptible instance support (e.g. AWS Spot Instances)
322       # When true, child containers will get created with the preemptible
323       # scheduling parameter parameter set.
324       UsePreemptibleInstances: false
325
326       # Include details about job reuse decisions in the server log. This
327       # causes additional database queries to run, so it should not be
328       # enabled unless you expect to examine the resulting logs for
329       # troubleshooting purposes.
330       LogReuseDecisions: false
331
332       Logging:
333         # When you run the db:delete_old_container_logs task, it will find
334         # containers that have been finished for at least this many seconds,
335         # and delete their stdout, stderr, arv-mount, crunch-run, and
336         # crunchstat logs from the logs table.
337         MaxAge: 720h
338
339         # These two settings control how frequently log events are flushed to the
340         # database.  Log lines are buffered until either crunch_log_bytes_per_event
341         # has been reached or crunch_log_seconds_between_events has elapsed since
342         # the last flush.
343         LogBytesPerEvent: 4096
344         LogSecondsBetweenEvents: 1
345
346         # The sample period for throttling logs, in seconds.
347         LogThrottlePeriod: 60
348
349         # Maximum number of bytes that job can log over crunch_log_throttle_period
350         # before being silenced until the end of the period.
351         LogThrottleBytes: 65536
352
353         # Maximum number of lines that job can log over crunch_log_throttle_period
354         # before being silenced until the end of the period.
355         LogThrottleLines: 1024
356
357         # Maximum bytes that may be logged by a single job.  Log bytes that are
358         # silenced by throttling are not counted against this total.
359         LimitLogBytesPerJob: 67108864
360
361         LogPartialLineThrottlePeriod: 5
362
363         # Container logs are written to Keep and saved in a collection,
364         # which is updated periodically while the container runs.  This
365         # value sets the interval (given in seconds) between collection
366         # updates.
367         LogUpdatePeriod: 1800
368
369         # The log collection is also updated when the specified amount of
370         # log data (given in bytes) is produced in less than one update
371         # period.
372         LogUpdateSize: 33554432
373
374       SLURM:
375         Managed:
376           # Path to dns server configuration directory
377           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
378           # files or touch restart.txt (see below).
379           DNSServerConfDir: ""
380
381           # Template file for the dns server host snippets. See
382           # unbound.template in this directory for an example. If false, do
383           # not write any config files.
384           DNSServerConfTemplate: ""
385
386           # String to write to {dns_server_conf_dir}/restart.txt (with a
387           # trailing newline) after updating local data. If false, do not
388           # open or write the restart.txt file.
389           DNSServerReloadCommand: ""
390
391           # Command to run after each DNS update. Template variables will be
392           # substituted; see the "unbound" example below. If false, do not run
393           # a command.
394           DNSServerUpdateCommand: ""
395
396           ComputeNodeDomain: ""
397           ComputeNodeNameservers:
398             - 192.168.1.1
399
400           # Hostname to assign to a compute node when it sends a "ping" and the
401           # hostname in its Node record is nil.
402           # During bootstrapping, the "ping" script is expected to notice the
403           # hostname given in the ping response, and update its unix hostname
404           # accordingly.
405           # If false, leave the hostname alone (this is appropriate if your compute
406           # nodes' hostnames are already assigned by some other mechanism).
407           #
408           # One way or another, the hostnames of your node records should agree
409           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
410           #
411           # Example for compute0000, compute0001, ....:
412           # assign_node_hostname: compute%<slot_number>04d
413           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
414           AssignNodeHostname: "compute%<slot_number>d"
415
416       JobsAPI:
417         # Enable the legacy Jobs API.  This value must be a string.
418         # 'auto' -- (default) enable the Jobs API only if it has been used before
419         #         (i.e., there are job records in the database)
420         # 'true' -- enable the Jobs API despite lack of existing records.
421         # 'false' -- disable the Jobs API despite presence of existing records.
422         Enable: 'auto'
423
424         # Git repositories must be readable by api server, or you won't be
425         # able to submit crunch jobs. To pass the test suites, put a clone
426         # of the arvados tree in {git_repositories_dir}/arvados.git or
427         # {git_repositories_dir}/arvados/.git
428         GitInternalDir: /var/lib/arvados/internal.git
429
430         # Docker image to be used when none found in runtime_constraints of a job
431         DefaultDockerImage: ""
432
433         # none or slurm_immediate
434         CrunchJobWrapper: none
435
436         # username, or false = do not set uid when running jobs.
437         CrunchJobUser: crunch
438
439         # The web service must be able to create/write this file, and
440         # crunch-job must be able to stat() it.
441         CrunchRefreshTrigger: /tmp/crunch_refresh_trigger
442
443         # Control job reuse behavior when two completed jobs match the
444         # search criteria and have different outputs.
445         #
446         # If true, in case of a conflict, reuse the earliest job (this is
447         # similar to container reuse behavior).
448         #
449         # If false, in case of a conflict, do not reuse any completed job,
450         # but do reuse an already-running job if available (this is the
451         # original job reuse behavior, and is still the default).
452         ReuseJobIfOutputsDiffer: false
453
454     Mail:
455       MailchimpAPIKey: ""
456       MailchimpListID: ""
457       SendUserSetupNotificationEmail: ""
458       IssueReporterEmailFrom: ""
459       IssueReporterEmailTo: ""
460       SupportEmailAddress: ""
461       EmailFrom: ""
462     RemoteClusters:
463       "*":
464         Proxy: false
465         ActivateUsers: false
466 `)