17755: Merge branch 'main' into 17755-add-singularity-to-compute-image
[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     # Token used internally by Arvados components to authenticate to
22     # one another. Use a string of at least 50 random alphanumerics.
23     SystemRootToken: ""
24
25     # Token to be included in all healthcheck requests. Disabled by default.
26     # Server expects request header of the format "Authorization: Bearer xxx"
27     ManagementToken: ""
28
29     Services:
30
31       # In each of the service sections below, the keys under
32       # InternalURLs are the endpoints where the service should be
33       # listening, and reachable from other hosts in the
34       # cluster. Example:
35       #
36       # InternalURLs:
37       #   "http://host1.example:12345": {}
38       #   "http://host2.example:12345": {}
39
40       RailsAPI:
41         InternalURLs: {SAMPLE: {}}
42         ExternalURL: "-"
43       Controller:
44         InternalURLs: {SAMPLE: {}}
45         ExternalURL: ""
46       Websocket:
47         InternalURLs: {SAMPLE: {}}
48         ExternalURL: ""
49       Keepbalance:
50         InternalURLs: {SAMPLE: {}}
51         ExternalURL: "-"
52       GitHTTP:
53         InternalURLs: {SAMPLE: {}}
54         ExternalURL: ""
55       GitSSH:
56         InternalURLs: {SAMPLE: {}}
57         ExternalURL: ""
58       DispatchCloud:
59         InternalURLs: {SAMPLE: {}}
60         ExternalURL: "-"
61       DispatchLSF:
62         InternalURLs: {SAMPLE: {}}
63         ExternalURL: "-"
64       Keepproxy:
65         InternalURLs: {SAMPLE: {}}
66         ExternalURL: ""
67       WebDAV:
68         InternalURLs: {SAMPLE: {}}
69         # Base URL for Workbench inline preview.  If blank, use
70         # WebDAVDownload instead, and disable inline preview.
71         # If both are empty, downloading collections from workbench
72         # will be impossible.
73         #
74         # It is important to properly configure the download service
75         # to migitate cross-site-scripting (XSS) attacks.  A HTML page
76         # can be stored in collection.  If an attacker causes a victim
77         # to visit that page through Workbench, it will be rendered by
78         # the browser.  If all collections are served at the same
79         # domain, the browser will consider collections as coming from
80         # the same origin and having access to the same browsing data,
81         # enabling malicious Javascript on that page to access Arvados
82         # on behalf of the victim.
83         #
84         # This is mitigating by having separate domains for each
85         # collection, or limiting preview to circumstances where the
86         # collection is not accessed with the user's regular
87         # full-access token.
88         #
89         # Serve preview links using uuid or pdh in subdomain
90         # (requires wildcard DNS and TLS certificate)
91         #   https://*.collections.uuid_prefix.arvadosapi.com
92         #
93         # Serve preview links using uuid or pdh in main domain
94         # (requires wildcard DNS and TLS certificate)
95         #   https://*--collections.uuid_prefix.arvadosapi.com
96         #
97         # Serve preview links by setting uuid or pdh in the path.
98         # This configuration only allows previews of public data or
99         # collection-sharing links, because these use the anonymous
100         # user token or the token is already embedded in the URL.
101         # Other data must be handled as downloads via WebDAVDownload:
102         #   https://collections.uuid_prefix.arvadosapi.com
103         #
104         ExternalURL: ""
105
106       WebDAVDownload:
107         InternalURLs: {SAMPLE: {}}
108         # Base URL for download links. If blank, serve links to WebDAV
109         # with disposition=attachment query param.  Unlike preview links,
110         # browsers do not render attachments, so there is no risk of XSS.
111         #
112         # If WebDAVDownload is blank, and WebDAV uses a
113         # single-origin form, then Workbench will show an error page
114         #
115         # Serve download links by setting uuid or pdh in the path:
116         #   https://download.uuid_prefix.arvadosapi.com
117         #
118         ExternalURL: ""
119
120       Keepstore:
121         InternalURLs:
122           SAMPLE:
123             # Rendezvous is normally empty/omitted. When changing the
124             # URL of a Keepstore service, Rendezvous should be set to
125             # the old URL (with trailing slash omitted) to preserve
126             # rendezvous ordering.
127             Rendezvous: ""
128         ExternalURL: "-"
129       Composer:
130         InternalURLs: {SAMPLE: {}}
131         ExternalURL: ""
132       WebShell:
133         InternalURLs: {SAMPLE: {}}
134         # ShellInABox service endpoint URL for a given VM.  If empty, do not
135         # offer web shell logins.
136         #
137         # E.g., using a path-based proxy server to forward connections to shell hosts:
138         # https://webshell.uuid_prefix.arvadosapi.com
139         #
140         # E.g., using a name-based proxy server to forward connections to shell hosts:
141         # https://*.webshell.uuid_prefix.arvadosapi.com
142         ExternalURL: ""
143       Workbench1:
144         InternalURLs: {SAMPLE: {}}
145         ExternalURL: ""
146       Workbench2:
147         InternalURLs: {SAMPLE: {}}
148         ExternalURL: ""
149       Health:
150         InternalURLs: {SAMPLE: {}}
151         ExternalURL: "-"
152
153     PostgreSQL:
154       # max concurrent connections per arvados server daemon
155       ConnectionPool: 32
156       Connection:
157         # All parameters here are passed to the PG client library in a connection string;
158         # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
159         host: ""
160         port: ""
161         user: ""
162         password: ""
163         dbname: ""
164         SAMPLE: ""
165     API:
166       # Limits for how long a client token created by regular users can be valid,
167       # and also is used as a default expiration policy when no expiration date is
168       # specified.
169       # Default value zero means token expirations don't get clamped and no
170       # default expiration is set.
171       MaxTokenLifetime: 0s
172
173       # Maximum size (in bytes) allowed for a single API request.  This
174       # limit is published in the discovery document for use by clients.
175       # Note: You must separately configure the upstream web server or
176       # proxy to actually enforce the desired maximum request size on the
177       # server side.
178       MaxRequestSize: 134217728
179
180       # Limit the number of bytes read from the database during an index
181       # request (by retrieving and returning fewer rows than would
182       # normally be returned in a single response).
183       # Note 1: This setting never reduces the number of returned rows to
184       # zero, no matter how big the first data row is.
185       # Note 2: Currently, this is only checked against a specific set of
186       # columns that tend to get large (collections.manifest_text,
187       # containers.mounts, workflows.definition). Other fields (e.g.,
188       # "properties" hashes) are not counted against this limit.
189       MaxIndexDatabaseRead: 134217728
190
191       # Maximum number of items to return when responding to a APIs that
192       # can return partial result sets using limit and offset parameters
193       # (e.g., *.index, groups.contents). If a request specifies a "limit"
194       # parameter higher than this value, this value is used instead.
195       MaxItemsPerResponse: 1000
196
197       # Maximum number of concurrent requests to accept in a single
198       # service process, or 0 for no limit.
199       MaxConcurrentRequests: 0
200
201       # Maximum number of 64MiB memory buffers per Keepstore server process, or
202       # 0 for no limit. When this limit is reached, up to
203       # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
204       # buffers (like GET and PUT) will wait for buffer space to be released.
205       # Any HTTP requests beyond MaxConcurrentRequests will receive an
206       # immediate 503 response.
207       #
208       # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
209       # * 1.1) fits comfortably in memory. On a host dedicated to running
210       # Keepstore, divide total memory by 88MiB to suggest a suitable value.
211       # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
212       # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
213       MaxKeepBlobBuffers: 128
214
215       # API methods to disable. Disabled methods are not listed in the
216       # discovery document, and respond 404 to all requests.
217       # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
218       DisabledAPIs: {}
219
220       # Interval (seconds) between asynchronous permission view updates. Any
221       # permission-updating API called with the 'async' parameter schedules a an
222       # update on the permission view in the future, if not already scheduled.
223       AsyncPermissionsUpdateInterval: 20s
224
225       # Maximum number of concurrent outgoing requests to make while
226       # serving a single incoming multi-cluster (federated) request.
227       MaxRequestAmplification: 4
228
229       # Maximum wall clock time to spend handling an incoming request.
230       RequestTimeout: 5m
231
232       # Websocket will send a periodic empty event after 'SendTimeout'
233       # if there is no other activity to maintain the connection /
234       # detect dropped connections.
235       SendTimeout: 60s
236
237       WebsocketClientEventQueue: 64
238       WebsocketServerEventQueue: 4
239
240       # Timeout on requests to internal Keep services.
241       KeepServiceRequestTimeout: 15s
242
243     Users:
244       # Config parameters to automatically setup new users.  If enabled,
245       # this users will be able to self-activate.  Enable this if you want
246       # to run an open instance where anyone can create an account and use
247       # the system without requiring manual approval.
248       #
249       # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
250       # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
251       AutoSetupNewUsers: false
252       AutoSetupNewUsersWithVmUUID: ""
253       AutoSetupNewUsersWithRepository: false
254       AutoSetupUsernameBlacklist:
255         arvados: {}
256         git: {}
257         gitolite: {}
258         gitolite-admin: {}
259         root: {}
260         syslog: {}
261         SAMPLE: {}
262
263       # When NewUsersAreActive is set to true, new users will be active
264       # immediately.  This skips the "self-activate" step which enforces
265       # user agreements.  Should only be enabled for development.
266       NewUsersAreActive: false
267
268       # The e-mail address of the user you would like to become marked as an admin
269       # user on their first login.
270       AutoAdminUserWithEmail: ""
271
272       # If AutoAdminFirstUser is set to true, the first user to log in when no
273       # other admin users exist will automatically become an admin user.
274       AutoAdminFirstUser: false
275
276       # Email address to notify whenever a user creates a profile for the
277       # first time
278       UserProfileNotificationAddress: ""
279       AdminNotifierEmailFrom: arvados@example.com
280       EmailSubjectPrefix: "[ARVADOS] "
281       UserNotifierEmailFrom: arvados@example.com
282       UserNotifierEmailBcc: {}
283       NewUserNotificationRecipients: {}
284       NewInactiveUserNotificationRecipients: {}
285
286       # Set AnonymousUserToken to enable anonymous user access. Populate this
287       # field with a long random string. Then run "bundle exec
288       # ./script/get_anonymous_user_token.rb" in the directory where your API
289       # server is running to record the token in the database.
290       AnonymousUserToken: ""
291
292       # If a new user has an alternate email address (local@domain)
293       # with the domain given here, its local part becomes the new
294       # user's default username. Otherwise, the user's primary email
295       # address is used.
296       PreferDomainForUsername: ""
297
298       UserSetupMailText: |
299         <% if not @user.full_name.empty? -%>
300         <%= @user.full_name %>,
301         <% else -%>
302         Hi there,
303         <% end -%>
304
305         Your Arvados account has been set up.  You can log in at
306
307         <%= Rails.configuration.Services.Workbench1.ExternalURL %>
308
309         Thanks,
310         Your Arvados administrator.
311
312     AuditLogs:
313       # Time to keep audit logs, in seconds. (An audit log is a row added
314       # to the "logs" table in the PostgreSQL database each time an
315       # Arvados object is created, modified, or deleted.)
316       #
317       # Currently, websocket event notifications rely on audit logs, so
318       # this should not be set lower than 300 (5 minutes).
319       MaxAge: 336h
320
321       # Maximum number of log rows to delete in a single SQL transaction.
322       #
323       # If MaxDeleteBatch is 0, log entries will never be
324       # deleted by Arvados. Cleanup can be done by an external process
325       # without affecting any Arvados system processes, as long as very
326       # recent (<5 minutes old) logs are not deleted.
327       #
328       # 100000 is a reasonable batch size for most sites.
329       MaxDeleteBatch: 0
330
331       # Attributes to suppress in events and audit logs.  Notably,
332       # specifying {"manifest_text": {}} here typically makes the database
333       # smaller and faster.
334       #
335       # Warning: Using any non-empty value here can have undesirable side
336       # effects for any client or component that relies on event logs.
337       # Use at your own risk.
338       UnloggedAttributes: {}
339
340     SystemLogs:
341
342       # Logging threshold: panic, fatal, error, warn, info, debug, or
343       # trace
344       LogLevel: info
345
346       # Logging format: json or text
347       Format: json
348
349       # Maximum characters of (JSON-encoded) query parameters to include
350       # in each request log entry. When params exceed this size, they will
351       # be JSON-encoded, truncated to this size, and logged as
352       # params_truncated.
353       MaxRequestLogParamsSize: 2000
354
355     Collections:
356
357       # Enable access controls for data stored in Keep. This should
358       # always be set to true on a production cluster.
359       BlobSigning: true
360
361       # BlobSigningKey is a string of alphanumeric characters used to
362       # generate permission signatures for Keep locators. It must be
363       # identical to the permission key given to Keep. IMPORTANT: This
364       # is a site secret. It should be at least 50 characters.
365       #
366       # Modifying BlobSigningKey will invalidate all existing
367       # signatures, which can cause programs to fail (e.g., arv-put,
368       # arv-get, and Crunch jobs).  To avoid errors, rotate keys only
369       # when no such processes are running.
370       BlobSigningKey: ""
371
372       # Enable garbage collection of unreferenced blobs in Keep.
373       BlobTrash: true
374
375       # Time to leave unreferenced blobs in "trashed" state before
376       # deleting them, or 0 to skip the "trashed" state entirely and
377       # delete unreferenced blobs.
378       #
379       # If you use any Amazon S3 buckets as storage volumes, this
380       # must be at least 24h to avoid occasional data loss.
381       BlobTrashLifetime: 336h
382
383       # How often to check for (and delete) trashed blocks whose
384       # BlobTrashLifetime has expired.
385       BlobTrashCheckInterval: 24h
386
387       # Maximum number of concurrent "trash blob" and "delete trashed
388       # blob" operations conducted by a single keepstore process. Each
389       # of these can be set to 0 to disable the respective operation.
390       #
391       # If BlobTrashLifetime is zero, "trash" and "delete trash"
392       # happen at once, so only the lower of these two values is used.
393       BlobTrashConcurrency: 4
394       BlobDeleteConcurrency: 4
395
396       # Maximum number of concurrent "create additional replica of
397       # existing blob" operations conducted by a single keepstore
398       # process.
399       BlobReplicateConcurrency: 4
400
401       # Default replication level for collections. This is used when a
402       # collection's replication_desired attribute is nil.
403       DefaultReplication: 2
404
405       # BlobSigningTTL determines the minimum lifetime of transient
406       # data, i.e., blocks that are not referenced by
407       # collections. Unreferenced blocks exist for two reasons:
408       #
409       # 1) A data block must be written to a disk/cloud backend device
410       # before a collection can be created/updated with a reference to
411       # it.
412       #
413       # 2) Deleting or updating a collection can remove the last
414       # remaining reference to a data block.
415       #
416       # If BlobSigningTTL is too short, long-running
417       # processes/containers will fail when they take too long (a)
418       # between writing blocks and writing collections that reference
419       # them, or (b) between reading collections and reading the
420       # referenced blocks.
421       #
422       # If BlobSigningTTL is too long, data will still be stored long
423       # after the referring collections are deleted, and you will
424       # needlessly fill up disks or waste money on cloud storage.
425       #
426       # Modifying BlobSigningTTL invalidates existing signatures; see
427       # BlobSigningKey note above.
428       #
429       # The default is 2 weeks.
430       BlobSigningTTL: 336h
431
432       # When running keep-balance, this is the destination filename for
433       # the list of lost block hashes if there are any, one per line.
434       # Updated automically during each successful run.
435       BlobMissingReport: ""
436
437       # keep-balance operates periodically, i.e.: do a
438       # scan/balance operation, sleep, repeat.
439       #
440       # BalancePeriod determines the interval between start times of
441       # successive scan/balance operations. If a scan/balance operation
442       # takes longer than BalancePeriod, the next one will follow it
443       # immediately.
444       #
445       # If SIGUSR1 is received during an idle period between operations,
446       # the next operation will start immediately.
447       BalancePeriod: 10m
448
449       # Limits the number of collections retrieved by keep-balance per
450       # API transaction. If this is zero, page size is
451       # determined by the API server's own page size limits (see
452       # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
453       BalanceCollectionBatch: 0
454
455       # The size of keep-balance's internal queue of
456       # collections. Higher values use more memory and improve throughput
457       # by allowing keep-balance to fetch the next page of collections
458       # while the current page is still being processed. If this is zero
459       # or omitted, pages are processed serially.
460       BalanceCollectionBuffers: 1000
461
462       # Maximum time for a rebalancing run. This ensures keep-balance
463       # eventually gives up and retries if, for example, a network
464       # error causes a hung connection that is never closed by the
465       # OS. It should be long enough that it doesn't interrupt a
466       # long-running balancing operation.
467       BalanceTimeout: 6h
468
469       # Maximum number of replication_confirmed /
470       # storage_classes_confirmed updates to write to the database
471       # after a rebalancing run. When many updates are needed, this
472       # spreads them over a few runs rather than applying them all at
473       # once.
474       BalanceUpdateLimit: 100000
475
476       # Default lifetime for ephemeral collections: 2 weeks. This must not
477       # be less than BlobSigningTTL.
478       DefaultTrashLifetime: 336h
479
480       # Interval (seconds) between trash sweeps. During a trash sweep,
481       # collections are marked as trash if their trash_at time has
482       # arrived, and deleted if their delete_at time has arrived.
483       TrashSweepInterval: 60s
484
485       # If true, enable collection versioning.
486       # When a collection's preserve_version field is true or the current version
487       # is older than the amount of seconds defined on PreserveVersionIfIdle,
488       # a snapshot of the collection's previous state is created and linked to
489       # the current collection.
490       CollectionVersioning: false
491
492       #   0s = auto-create a new version on every update.
493       #  -1s = never auto-create new versions.
494       # > 0s = auto-create a new version when older than the specified number of seconds.
495       PreserveVersionIfIdle: -1s
496
497       # If non-empty, allow project and collection names to contain
498       # the "/" character (slash/stroke/solidus), and replace "/" with
499       # the given string in the filesystem hierarchy presented by
500       # WebDAV. Example values are "%2f" and "{slash}". Names that
501       # contain the substitution string itself may result in confusing
502       # behavior, so a value like "_" is not recommended.
503       #
504       # If the default empty value is used, the server will reject
505       # requests to create or rename a collection when the new name
506       # contains "/".
507       #
508       # If the value "/" is used, project and collection names
509       # containing "/" will be allowed, but they will not be
510       # accessible via WebDAV.
511       #
512       # Use of this feature is not recommended, if it can be avoided.
513       ForwardSlashNameSubstitution: ""
514
515       # Include "folder objects" in S3 ListObjects responses.
516       S3FolderObjects: true
517
518       # Managed collection properties. At creation time, if the client didn't
519       # provide the listed keys, they will be automatically populated following
520       # one of the following behaviors:
521       #
522       # * UUID of the user who owns the containing project.
523       #   responsible_person_uuid: {Function: original_owner, Protected: true}
524       #
525       # * Default concrete value.
526       #   foo_bar: {Value: baz, Protected: false}
527       #
528       # If Protected is true, only an admin user can modify its value.
529       ManagedProperties:
530         SAMPLE: {Function: original_owner, Protected: true}
531
532       # In "trust all content" mode, Workbench will redirect download
533       # requests to WebDAV preview link, even in the cases when
534       # WebDAV would have to expose XSS vulnerabilities in order to
535       # handle the redirect (see discussion on Services.WebDAV).
536       #
537       # This setting has no effect in the recommended configuration, where the
538       # WebDAV service is configured to have a separate domain for every
539       # collection and XSS protection is provided by browsers' same-origin
540       # policy.
541       #
542       # The default setting (false) is appropriate for a multi-user site.
543       TrustAllContent: false
544
545       # Cache parameters for WebDAV content serving:
546       WebDAVCache:
547         # Time to cache manifests, permission checks, and sessions.
548         TTL: 300s
549
550         # Time to cache collection state.
551         UUIDTTL: 5s
552
553         # Block cache entries. Each block consumes up to 64 MiB RAM.
554         MaxBlockEntries: 20
555
556         # Collection cache entries.
557         MaxCollectionEntries: 1000
558
559         # Approximate memory limit (in bytes) for collection cache.
560         MaxCollectionBytes: 100000000
561
562         # Permission cache entries.
563         MaxPermissionEntries: 1000
564
565         # UUID cache entries.
566         MaxUUIDEntries: 1000
567
568         # Persistent sessions.
569         MaxSessions: 100
570
571       # Selectively set permissions for regular users and admins to
572       # download or upload data files using the upload/download
573       # features for Workbench, WebDAV and S3 API support.
574       WebDAVPermission:
575         User:
576           Download: true
577           Upload: true
578         Admin:
579           Download: true
580           Upload: true
581
582       # Selectively set permissions for regular users and admins to be
583       # able to download or upload blocks using arv-put and
584       # arv-get from outside the cluster.
585       KeepproxyPermission:
586         User:
587           Download: true
588           Upload: true
589         Admin:
590           Download: true
591           Upload: true
592
593       # Post upload / download events to the API server logs table, so
594       # that they can be included in the arv-user-activity report.
595       # You can disable this if you find that it is creating excess
596       # load on the API server and you don't need it.
597       WebDAVLogEvents: true
598
599     Login:
600       # One of the following mechanisms (Google, PAM, LDAP, or
601       # LoginCluster) should be enabled; see
602       # https://doc.arvados.org/install/setup-login.html
603
604       Google:
605         # Authenticate with Google.
606         Enable: false
607
608         # Use the Google Cloud console to enable the People API (APIs
609         # and Services > Enable APIs and services > Google People API
610         # > Enable), generate a Client ID and secret (APIs and
611         # Services > Credentials > Create credentials > OAuth client
612         # ID > Web application) and add your controller's /login URL
613         # (e.g., "https://zzzzz.example.com/login") as an authorized
614         # redirect URL.
615         ClientID: ""
616         ClientSecret: ""
617
618         # Allow users to log in to existing accounts using any verified
619         # email address listed by their Google account. If true, the
620         # Google People API must be enabled in order for Google login to
621         # work. If false, only the primary email address will be used.
622         AlternateEmailAddresses: true
623
624         # Send additional parameters with authentication requests. See
625         # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
626         # for a list of supported parameters.
627         AuthenticationRequestParameters:
628           # Show the "choose which Google account" page, even if the
629           # client is currently logged in to exactly one Google
630           # account.
631           prompt: select_account
632
633           SAMPLE: ""
634
635       OpenIDConnect:
636         # Authenticate with an OpenID Connect provider.
637         Enable: false
638
639         # Issuer URL, e.g., "https://login.example.com".
640         #
641         # This must be exactly equal to the URL returned by the issuer
642         # itself in its config response ("isser" key). If the
643         # configured value is "https://example" and the provider
644         # returns "https://example:443" or "https://example/" then
645         # login will fail, even though those URLs are equivalent
646         # (RFC3986).
647         Issuer: ""
648
649         # Your client ID and client secret (supplied by the provider).
650         ClientID: ""
651         ClientSecret: ""
652
653         # OpenID claim field containing the user's email
654         # address. Normally "email"; see
655         # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
656         EmailClaim: "email"
657
658         # OpenID claim field containing the email verification
659         # flag. Normally "email_verified".  To accept every returned
660         # email address without checking a "verified" field at all,
661         # use the empty string "".
662         EmailVerifiedClaim: "email_verified"
663
664         # OpenID claim field containing the user's preferred
665         # username. If empty, use the mailbox part of the user's email
666         # address.
667         UsernameClaim: ""
668
669         # Send additional parameters with authentication requests,
670         # like {display: page, prompt: consent}. See
671         # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
672         # and refer to your provider's documentation for supported
673         # parameters.
674         AuthenticationRequestParameters:
675           SAMPLE: ""
676
677         # Accept an OIDC access token as an API token if the OIDC
678         # provider's UserInfo endpoint accepts it.
679         #
680         # AcceptAccessTokenScope should also be used when enabling
681         # this feature.
682         AcceptAccessToken: false
683
684         # Before accepting an OIDC access token as an API token, first
685         # check that it is a JWT whose "scope" value includes this
686         # value. Example: "https://zzzzz.example.com/" (your Arvados
687         # API endpoint).
688         #
689         # If this value is empty and AcceptAccessToken is true, all
690         # access tokens will be accepted regardless of scope,
691         # including non-JWT tokens. This is not recommended.
692         AcceptAccessTokenScope: ""
693
694       PAM:
695         # (Experimental) Use PAM to authenticate users.
696         Enable: false
697
698         # PAM service name. PAM will apply the policy in the
699         # corresponding config file (e.g., /etc/pam.d/arvados) or, if
700         # there is none, the default "other" config.
701         Service: arvados
702
703         # Domain name (e.g., "example.com") to use to construct the
704         # user's email address if PAM authentication returns a
705         # username with no "@". If empty, use the PAM username as the
706         # user's email address, whether or not it contains "@".
707         #
708         # Note that the email address is used as the primary key for
709         # user records when logging in. Therefore, if you change
710         # PAMDefaultEmailDomain after the initial installation, you
711         # should also update existing user records to reflect the new
712         # domain. Otherwise, next time those users log in, they will
713         # be given new accounts instead of accessing their existing
714         # accounts.
715         DefaultEmailDomain: ""
716
717       LDAP:
718         # Use an LDAP service to authenticate users.
719         Enable: false
720
721         # Server URL, like "ldap://ldapserver.example.com:389" or
722         # "ldaps://ldapserver.example.com:636".
723         URL: "ldap://ldap:389"
724
725         # Use StartTLS upon connecting to the server.
726         StartTLS: true
727
728         # Skip TLS certificate name verification.
729         InsecureTLS: false
730
731         # Strip the @domain part if a user supplies an email-style
732         # username with this domain. If "*", strip any user-provided
733         # domain. If "", never strip the domain part. Example:
734         # "example.com"
735         StripDomain: ""
736
737         # If, after applying StripDomain, the username contains no "@"
738         # character, append this domain to form an email-style
739         # username. Example: "example.com"
740         AppendDomain: ""
741
742         # The LDAP attribute to filter on when looking up a username
743         # (after applying StripDomain and AppendDomain).
744         SearchAttribute: uid
745
746         # Bind with this username (DN or UPN) and password when
747         # looking up the user record.
748         #
749         # Example user: "cn=admin,dc=example,dc=com"
750         SearchBindUser: ""
751         SearchBindPassword: ""
752
753         # Directory base for username lookup. Example:
754         # "ou=Users,dc=example,dc=com"
755         SearchBase: ""
756
757         # Additional filters to apply when looking up users' LDAP
758         # entries. This can be used to restrict access to a subset of
759         # LDAP users, or to disambiguate users from other directory
760         # entries that have the SearchAttribute present.
761         #
762         # Special characters in assertion values must be escaped (see
763         # RFC4515).
764         #
765         # Example: "(objectClass=person)"
766         SearchFilters: ""
767
768         # LDAP attribute to use as the user's email address.
769         #
770         # Important: This must not be an attribute whose value can be
771         # edited in the directory by the users themselves. Otherwise,
772         # users can take over other users' Arvados accounts trivially
773         # (email address is the primary key for Arvados accounts.)
774         EmailAttribute: mail
775
776         # LDAP attribute to use as the preferred Arvados username. If
777         # no value is found (or this config is empty) the username
778         # originally supplied by the user will be used.
779         UsernameAttribute: uid
780
781       Test:
782         # Authenticate users listed here in the config file. This
783         # feature is intended to be used in test environments, and
784         # should not be used in production.
785         Enable: false
786         Users:
787           SAMPLE:
788             Email: alice@example.com
789             Password: xyzzy
790
791       # The cluster ID to delegate the user database.  When set,
792       # logins on this cluster will be redirected to the login cluster
793       # (login cluster must appear in RemoteClusters with Proxy: true)
794       LoginCluster: ""
795
796       # How long a cached token belonging to a remote cluster will
797       # remain valid before it needs to be revalidated.
798       RemoteTokenRefresh: 5m
799
800       # How long a client token created from a login flow will be valid without
801       # asking the user to re-login. Example values: 60m, 8h.
802       # Default value zero means tokens don't have expiration.
803       TokenLifetime: 0s
804
805       # If true (default) tokens issued through login are allowed to create
806       # new tokens.
807       # If false, tokens issued through login are not allowed to
808       # viewing/creating other tokens.  New tokens can only be created
809       # by going through login again.
810       IssueTrustedTokens: true
811
812       # When the token is returned to a client, the token itself may
813       # be restricted from viewing/creating other tokens based on whether
814       # the client is "trusted" or not.  The local Workbench1 and
815       # Workbench2 are trusted by default, but if this is a
816       # LoginCluster, you probably want to include the other Workbench
817       # instances in the federation in this list.
818       TrustedClients:
819         SAMPLE:
820           "https://workbench.federate1.example": {}
821           "https://workbench.federate2.example": {}
822
823     Git:
824       # Path to git or gitolite-shell executable. Each authenticated
825       # request will execute this program with the single argument "http-backend"
826       GitCommand: /usr/bin/git
827
828       # Path to Gitolite's home directory. If a non-empty path is given,
829       # the CGI environment will be set up to support the use of
830       # gitolite-shell as a GitCommand: for example, if GitoliteHome is
831       # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
832       # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
833       GitoliteHome: ""
834
835       # Git repositories must be readable by api server, or you won't be
836       # able to submit crunch jobs. To pass the test suites, put a clone
837       # of the arvados tree in {git_repositories_dir}/arvados.git or
838       # {git_repositories_dir}/arvados/.git
839       Repositories: /var/lib/arvados/git/repositories
840
841     TLS:
842       Certificate: ""
843       Key: ""
844       Insecure: false
845
846     Containers:
847       # List of supported Docker Registry image formats that compute nodes
848       # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
849       # to store an image with an unsupported format. Use an empty array
850       # to skip the compatibility check (and display a warning message to
851       # that effect).
852       #
853       # Example for sites running docker < 1.10: {"v1": {}}
854       # Example for sites running docker >= 1.10: {"v2": {}}
855       # Example for disabling check: {}
856       SupportedDockerImageFormats:
857         "v2": {}
858         SAMPLE: {}
859
860       # Include details about job reuse decisions in the server log. This
861       # causes additional database queries to run, so it should not be
862       # enabled unless you expect to examine the resulting logs for
863       # troubleshooting purposes.
864       LogReuseDecisions: false
865
866       # Default value for keep_cache_ram of a container's runtime_constraints.
867       DefaultKeepCacheRAM: 268435456
868
869       # Number of times a container can be unlocked before being
870       # automatically cancelled.
871       MaxDispatchAttempts: 5
872
873       # Default value for container_count_max for container requests.  This is the
874       # number of times Arvados will create a new container to satisfy a container
875       # request.  If a container is cancelled it will retry a new container if
876       # container_count < container_count_max on any container requests associated
877       # with the cancelled container.
878       MaxRetryAttempts: 3
879
880       # The maximum number of compute nodes that can be in use simultaneously
881       # If this limit is reduced, any existing nodes with slot number >= new limit
882       # will not be counted against the new limit. In other words, the new limit
883       # won't be strictly enforced until those nodes with higher slot numbers
884       # go down.
885       MaxComputeVMs: 64
886
887       # Preemptible instance support (e.g. AWS Spot Instances)
888       # When true, child containers will get created with the preemptible
889       # scheduling parameter parameter set.
890       UsePreemptibleInstances: false
891
892       # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
893       # (experimental) cloud dispatcher for executing containers on
894       # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
895       # and ends with "\n-----END RSA PRIVATE KEY-----\n".
896       DispatchPrivateKey: ""
897
898       # Maximum time to wait for workers to come up before abandoning
899       # stale locks from a previous dispatch process.
900       StaleLockTimeout: 1m
901
902       # The crunch-run command used to start a container on a worker node.
903       #
904       # When dispatching to cloud VMs, this is used only if
905       # DeployRunnerBinary in the CloudVMs section is set to the empty
906       # string.
907       CrunchRunCommand: "crunch-run"
908
909       # Extra arguments to add to crunch-run invocation
910       # Example: ["--cgroup-parent-subsystem=memory"]
911       CrunchRunArgumentsList: []
912
913       # Extra RAM to reserve on the node, in addition to
914       # the amount specified in the container's RuntimeConstraints
915       ReserveExtraRAM: 256MiB
916
917       # Minimum time between two attempts to run the same container
918       MinRetryPeriod: 0s
919
920       # Container runtime: "docker" (default) or "singularity" (experimental)
921       RuntimeEngine: docker
922
923       Logging:
924         # When you run the db:delete_old_container_logs task, it will find
925         # containers that have been finished for at least this many seconds,
926         # and delete their stdout, stderr, arv-mount, crunch-run, and
927         # crunchstat logs from the logs table.
928         MaxAge: 720h
929
930         # These two settings control how frequently log events are flushed to the
931         # database.  Log lines are buffered until either crunch_log_bytes_per_event
932         # has been reached or crunch_log_seconds_between_events has elapsed since
933         # the last flush.
934         LogBytesPerEvent: 4096
935         LogSecondsBetweenEvents: 5s
936
937         # The sample period for throttling logs.
938         LogThrottlePeriod: 60s
939
940         # Maximum number of bytes that job can log over crunch_log_throttle_period
941         # before being silenced until the end of the period.
942         LogThrottleBytes: 65536
943
944         # Maximum number of lines that job can log over crunch_log_throttle_period
945         # before being silenced until the end of the period.
946         LogThrottleLines: 1024
947
948         # Maximum bytes that may be logged by a single job.  Log bytes that are
949         # silenced by throttling are not counted against this total.
950         LimitLogBytesPerJob: 67108864
951
952         LogPartialLineThrottlePeriod: 5s
953
954         # Container logs are written to Keep and saved in a
955         # collection, which is updated periodically while the
956         # container runs.  This value sets the interval between
957         # collection updates.
958         LogUpdatePeriod: 30m
959
960         # The log collection is also updated when the specified amount of
961         # log data (given in bytes) is produced in less than one update
962         # period.
963         LogUpdateSize: 32MiB
964
965       ShellAccess:
966         # An admin user can use "arvados-client shell" to start an
967         # interactive shell (with any user ID) in any running
968         # container.
969         Admin: false
970
971         # Any user can use "arvados-client shell" to start an
972         # interactive shell (with any user ID) in any running
973         # container that they started, provided it isn't also
974         # associated with a different user's container request.
975         #
976         # Interactive sessions make it easy to alter the container's
977         # runtime environment in ways that aren't recorded or
978         # reproducible. Consider the implications for automatic
979         # container reuse before enabling and using this feature. In
980         # particular, note that starting an interactive session does
981         # not disqualify a container from being reused by a different
982         # user/workflow in the future.
983         User: false
984
985       SLURM:
986         PrioritySpread: 0
987         SbatchArgumentsList: []
988         SbatchEnvironmentVariables:
989           SAMPLE: ""
990         Managed:
991           # Path to dns server configuration directory
992           # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
993           # files or touch restart.txt (see below).
994           DNSServerConfDir: ""
995
996           # Template file for the dns server host snippets. See
997           # unbound.template in this directory for an example. If false, do
998           # not write any config files.
999           DNSServerConfTemplate: ""
1000
1001           # String to write to {dns_server_conf_dir}/restart.txt (with a
1002           # trailing newline) after updating local data. If false, do not
1003           # open or write the restart.txt file.
1004           DNSServerReloadCommand: ""
1005
1006           # Command to run after each DNS update. Template variables will be
1007           # substituted; see the "unbound" example below. If false, do not run
1008           # a command.
1009           DNSServerUpdateCommand: ""
1010
1011           ComputeNodeDomain: ""
1012           ComputeNodeNameservers:
1013             "192.168.1.1": {}
1014             SAMPLE: {}
1015
1016           # Hostname to assign to a compute node when it sends a "ping" and the
1017           # hostname in its Node record is nil.
1018           # During bootstrapping, the "ping" script is expected to notice the
1019           # hostname given in the ping response, and update its unix hostname
1020           # accordingly.
1021           # If false, leave the hostname alone (this is appropriate if your compute
1022           # nodes' hostnames are already assigned by some other mechanism).
1023           #
1024           # One way or another, the hostnames of your node records should agree
1025           # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1026           #
1027           # Example for compute0000, compute0001, ....:
1028           # assign_node_hostname: compute%<slot_number>04d
1029           # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1030           AssignNodeHostname: "compute%<slot_number>d"
1031
1032       LSF:
1033         # Additional arguments to bsub when submitting Arvados
1034         # containers as LSF jobs.
1035         BsubArgumentsList: []
1036
1037         # Use sudo to switch to this user account when submitting LSF
1038         # jobs.
1039         #
1040         # This account must exist on the hosts where LSF jobs run
1041         # ("execution hosts"), as well as on the host where the
1042         # Arvados LSF dispatcher runs ("submission host").
1043         BsubSudoUser: "crunch"
1044
1045       JobsAPI:
1046         # Enable the legacy 'jobs' API (crunch v1).  This value must be a string.
1047         #
1048         # Note: this only enables read-only access, creating new
1049         # legacy jobs and pipelines is not supported.
1050         #
1051         # 'auto' -- (default) enable the Jobs API only if it has been used before
1052         #         (i.e., there are job records in the database)
1053         # 'true' -- enable the Jobs API despite lack of existing records.
1054         # 'false' -- disable the Jobs API despite presence of existing records.
1055         Enable: 'auto'
1056
1057         # Git repositories must be readable by api server, or you won't be
1058         # able to submit crunch jobs. To pass the test suites, put a clone
1059         # of the arvados tree in {git_repositories_dir}/arvados.git or
1060         # {git_repositories_dir}/arvados/.git
1061         GitInternalDir: /var/lib/arvados/internal.git
1062
1063       CloudVMs:
1064         # Enable the cloud scheduler (experimental).
1065         Enable: false
1066
1067         # Name/number of port where workers' SSH services listen.
1068         SSHPort: "22"
1069
1070         # Interval between queue polls.
1071         PollInterval: 10s
1072
1073         # Shell command to execute on each worker to determine whether
1074         # the worker is booted and ready to run containers. It should
1075         # exit zero if the worker is ready.
1076         BootProbeCommand: "docker ps -q"
1077
1078         # Minimum interval between consecutive probes to a single
1079         # worker.
1080         ProbeInterval: 10s
1081
1082         # Maximum probes per second, across all workers in a pool.
1083         MaxProbesPerSecond: 10
1084
1085         # Time before repeating SIGTERM when killing a container.
1086         TimeoutSignal: 5s
1087
1088         # Time to give up on a process (most likely arv-mount) that
1089         # still holds a container lockfile after its main supervisor
1090         # process has exited, and declare the instance broken.
1091         TimeoutStaleRunLock: 5s
1092
1093         # Time to give up on SIGTERM and write off the worker.
1094         TimeoutTERM: 2m
1095
1096         # Maximum create/destroy-instance operations per second (0 =
1097         # unlimited).
1098         MaxCloudOpsPerSecond: 0
1099
1100         # Maximum concurrent node creation operations (0 = unlimited). This is
1101         # recommended by Azure in certain scenarios (see
1102         # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
1103         # and can be used with other cloud providers too, if desired.
1104         MaxConcurrentInstanceCreateOps: 0
1105
1106         # Interval between cloud provider syncs/updates ("list all
1107         # instances").
1108         SyncInterval: 1m
1109
1110         # Time to leave an idle worker running (in case new containers
1111         # appear in the queue that it can run) before shutting it
1112         # down.
1113         TimeoutIdle: 1m
1114
1115         # Time to wait for a new worker to boot (i.e., pass
1116         # BootProbeCommand) before giving up and shutting it down.
1117         TimeoutBooting: 10m
1118
1119         # Maximum time a worker can stay alive with no successful
1120         # probes before being automatically shut down.
1121         TimeoutProbe: 10m
1122
1123         # Time after shutting down a worker to retry the
1124         # shutdown/destroy operation.
1125         TimeoutShutdown: 10s
1126
1127         # Worker VM image ID.
1128         # (aws) AMI identifier
1129         # (azure) managed disks: the name of the managed disk image
1130         # (azure) shared image gallery: the name of the image definition. Also
1131         # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1132         # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1133         # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1134         ImageID: ""
1135
1136         # An executable file (located on the dispatcher host) to be
1137         # copied to cloud instances at runtime and used as the
1138         # container runner/supervisor. The default value is the
1139         # dispatcher program itself.
1140         #
1141         # Use the empty string to disable this step: nothing will be
1142         # copied, and cloud instances are assumed to have a suitable
1143         # version of crunch-run installed; see CrunchRunCommand above.
1144         DeployRunnerBinary: "/proc/self/exe"
1145
1146         # Tags to add on all resources (VMs, NICs, disks) created by
1147         # the container dispatcher. (Arvados's own tags --
1148         # InstanceType, IdleBehavior, and InstanceSecret -- will also
1149         # be added.)
1150         ResourceTags:
1151           SAMPLE: "tag value"
1152
1153         # Prefix for predefined tags used by Arvados (InstanceSetID,
1154         # InstanceType, InstanceSecret, IdleBehavior). With the
1155         # default value "Arvados", tags are "ArvadosInstanceSetID",
1156         # "ArvadosInstanceSecret", etc.
1157         #
1158         # This should only be changed while no cloud resources are in
1159         # use and the cloud dispatcher is not running. Otherwise,
1160         # VMs/resources that were added using the old tag prefix will
1161         # need to be detected and cleaned up manually.
1162         TagKeyPrefix: Arvados
1163
1164         # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1165         Driver: ec2
1166
1167         # Cloud-specific driver parameters.
1168         DriverParameters:
1169
1170           # (ec2) Credentials. Omit or leave blank if using IAM role.
1171           AccessKeyID: ""
1172           SecretAccessKey: ""
1173
1174           # (ec2) Instance configuration.
1175           SecurityGroupIDs:
1176             "SAMPLE": {}
1177           SubnetID: ""
1178           Region: ""
1179           EBSVolumeType: gp2
1180           AdminUsername: debian
1181
1182           # (azure) Credentials.
1183           SubscriptionID: ""
1184           ClientID: ""
1185           ClientSecret: ""
1186           TenantID: ""
1187
1188           # (azure) Instance configuration.
1189           CloudEnvironment: AzurePublicCloud
1190           Location: centralus
1191
1192           # (azure) The resource group where the VM and virtual NIC will be
1193           # created.
1194           ResourceGroup: ""
1195
1196           # (azure) The resource group of the Network to use for the virtual
1197           # NIC (if different from ResourceGroup)
1198           NetworkResourceGroup: ""
1199           Network: ""
1200           Subnet: ""
1201
1202           # (azure) managed disks: The resource group where the managed disk
1203           # image can be found (if different from ResourceGroup).
1204           ImageResourceGroup: ""
1205
1206           # (azure) shared image gallery: the name of the gallery
1207           SharedImageGalleryName: ""
1208           # (azure) shared image gallery: the version of the image definition
1209           SharedImageGalleryImageVersion: ""
1210
1211           # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1212           StorageAccount: ""
1213           BlobContainer: ""
1214
1215           # (azure) How long to wait before deleting VHD and NIC
1216           # objects that are no longer being used.
1217           DeleteDanglingResourcesAfter: 20s
1218
1219           # Account (that already exists in the VM image) that will be
1220           # set up with an ssh authorized key to allow the compute
1221           # dispatcher to connect.
1222           AdminUsername: arvados
1223
1224     InstanceTypes:
1225
1226       # Use the instance type name as the key (in place of "SAMPLE" in
1227       # this sample entry).
1228       SAMPLE:
1229         # Cloud provider's instance type. Defaults to the configured type name.
1230         ProviderType: ""
1231         VCPUs: 1
1232         RAM: 128MiB
1233         IncludedScratch: 16GB
1234         AddedScratch: 0
1235         Price: 0.1
1236         Preemptible: false
1237
1238     StorageClasses:
1239
1240       # If you use multiple storage classes, specify them here, using
1241       # the storage class name as the key (in place of "SAMPLE" in
1242       # this sample entry).
1243       #
1244       # Further info/examples:
1245       # https://doc.arvados.org/admin/storage-classes.html
1246       SAMPLE:
1247
1248         # Priority determines the order volumes should be searched
1249         # when reading data, in cases where a keepstore server has
1250         # access to multiple volumes with different storage classes.
1251         Priority: 0
1252
1253         # Default determines which storage class(es) should be used
1254         # when a user/client writes data or saves a new collection
1255         # without specifying storage classes.
1256         #
1257         # If any StorageClasses are configured, at least one of them
1258         # must have Default: true.
1259         Default: true
1260
1261     Volumes:
1262       SAMPLE:
1263         # AccessViaHosts specifies which keepstore processes can read
1264         # and write data on the volume.
1265         #
1266         # For a local filesystem, AccessViaHosts has one entry,
1267         # indicating which server the filesystem is located on.
1268         #
1269         # For a network-attached backend accessible by all keepstore
1270         # servers, like a cloud storage bucket or an NFS mount,
1271         # AccessViaHosts can be empty/omitted.
1272         #
1273         # Further info/examples:
1274         # https://doc.arvados.org/install/configure-fs-storage.html
1275         # https://doc.arvados.org/install/configure-s3-object-storage.html
1276         # https://doc.arvados.org/install/configure-azure-blob-storage.html
1277         AccessViaHosts:
1278           SAMPLE:
1279             ReadOnly: false
1280           "http://host1.example:25107": {}
1281         ReadOnly: false
1282         Replication: 1
1283         StorageClasses:
1284           # If you have configured storage classes (see StorageClasses
1285           # section above), add an entry here for each storage class
1286           # satisfied by this volume.
1287           SAMPLE: true
1288         Driver: S3
1289         DriverParameters:
1290           # for s3 driver -- see
1291           # https://doc.arvados.org/install/configure-s3-object-storage.html
1292           IAMRole: aaaaa
1293           AccessKeyID: aaaaa
1294           SecretAccessKey: aaaaa
1295           Endpoint: ""
1296           Region: us-east-1a
1297           Bucket: aaaaa
1298           LocationConstraint: false
1299           V2Signature: false
1300           IndexPageSize: 1000
1301           ConnectTimeout: 1m
1302           ReadTimeout: 10m
1303           RaceWindow: 24h
1304           # Use aws-s3-go (v2) instead of goamz
1305           UseAWSS3v2Driver: false
1306
1307           # For S3 driver, potentially unsafe tuning parameter,
1308           # intentionally excluded from main documentation.
1309           #
1310           # Enable deletion (garbage collection) even when the
1311           # configured BlobTrashLifetime is zero.  WARNING: eventual
1312           # consistency may result in race conditions that can cause
1313           # data loss.  Do not enable this unless you understand and
1314           # accept the risk.
1315           UnsafeDelete: false
1316
1317           # for azure driver -- see
1318           # https://doc.arvados.org/install/configure-azure-blob-storage.html
1319           StorageAccountName: aaaaa
1320           StorageAccountKey: aaaaa
1321           StorageBaseURL: core.windows.net
1322           ContainerName: aaaaa
1323           RequestTimeout: 30s
1324           ListBlobsRetryDelay: 10s
1325           ListBlobsMaxAttempts: 10
1326           MaxGetBytes: 0
1327           WriteRaceInterval: 15s
1328           WriteRacePollTime: 1s
1329
1330           # for local directory driver -- see
1331           # https://doc.arvados.org/install/configure-fs-storage.html
1332           Root: /var/lib/arvados/keep-data
1333
1334           # For local directory driver, potentially confusing tuning
1335           # parameter, intentionally excluded from main documentation.
1336           #
1337           # When true, read and write operations (for whole 64MiB
1338           # blocks) on an individual volume will queued and issued
1339           # serially.  When false, read and write operations will be
1340           # issued concurrently.
1341           #
1342           # May possibly improve throughput if you have physical spinning disks
1343           # and experience contention when there are multiple requests
1344           # to the same volume.
1345           #
1346           # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1347           # should leave this alone.
1348           Serialize: false
1349
1350     Mail:
1351       MailchimpAPIKey: ""
1352       MailchimpListID: ""
1353       SendUserSetupNotificationEmail: true
1354
1355       # Bug/issue report notification to and from addresses
1356       IssueReporterEmailFrom: "arvados@example.com"
1357       IssueReporterEmailTo: "arvados@example.com"
1358       SupportEmailAddress: "arvados@example.com"
1359
1360       # Generic issue email from
1361       EmailFrom: "arvados@example.com"
1362     RemoteClusters:
1363       "*":
1364         Host: ""
1365         Proxy: false
1366         Scheme: https
1367         Insecure: false
1368         ActivateUsers: false
1369       SAMPLE:
1370         # API endpoint host or host:port; default is {id}.arvadosapi.com
1371         Host: sample.arvadosapi.com
1372
1373         # Perform a proxy request when a local client requests an
1374         # object belonging to this remote.
1375         Proxy: false
1376
1377         # Default "https". Can be set to "http" for testing.
1378         Scheme: https
1379
1380         # Disable TLS verify. Can be set to true for testing.
1381         Insecure: false
1382
1383         # When users present tokens issued by this remote cluster, and
1384         # their accounts are active on the remote cluster, activate
1385         # them on this cluster too.
1386         ActivateUsers: false
1387
1388     Workbench:
1389       # Workbench1 configs
1390       Theme: default
1391       ActivationContactLink: mailto:info@arvados.org
1392       ArvadosDocsite: https://doc.arvados.org
1393       ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1394       ShowUserAgreementInline: false
1395       SecretKeyBase: ""
1396
1397       # Scratch directory used by the remote repository browsing
1398       # feature. If it doesn't exist, it (and any missing parents) will be
1399       # created using mkdir_p.
1400       RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1401
1402       # Below is a sample setting of user_profile_form_fields config parameter.
1403       # This configuration parameter should be set to either false (to disable) or
1404       # to a map as shown below.
1405       # Configure the map of input fields to be displayed in the profile page
1406       # using the attribute "key" for each of the input fields.
1407       # This sample shows configuration with one required and one optional form fields.
1408       # For each of these input fields:
1409       #   You can specify "Type" as "text" or "select".
1410       #   List the "Options" to be displayed for each of the "select" menu.
1411       #   Set "Required" as "true" for any of these fields to make them required.
1412       # If any of the required fields are missing in the user's profile, the user will be
1413       # redirected to the profile page before they can access any Workbench features.
1414       UserProfileFormFields:
1415         SAMPLE:
1416           Type: select
1417           FormFieldTitle: Best color
1418           FormFieldDescription: your favorite color
1419           Required: false
1420           Position: 1
1421           Options:
1422             red: {}
1423             blue: {}
1424             green: {}
1425             SAMPLE: {}
1426
1427         # exampleTextValue:  # key that will be set in properties
1428         #   Type: text  #
1429         #   FormFieldTitle: ""
1430         #   FormFieldDescription: ""
1431         #   Required: true
1432         #   Position: 1
1433         # exampleOptionsValue:
1434         #   Type: select
1435         #   FormFieldTitle: ""
1436         #   FormFieldDescription: ""
1437         #   Required: true
1438         #   Position: 1
1439         #   Options:
1440         #     red: {}
1441         #     blue: {}
1442         #     yellow: {}
1443
1444       # Use "UserProfileFormMessage to configure the message you want
1445       # to display on the profile page.
1446       UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1447
1448       # Mimetypes of applications for which the view icon
1449       # would be enabled in a collection's show page.
1450       # It is sufficient to list only applications here.
1451       # No need to list text and image types.
1452       ApplicationMimetypesWithViewIcon:
1453         cwl: {}
1454         fasta: {}
1455         go: {}
1456         javascript: {}
1457         json: {}
1458         pdf: {}
1459         python: {}
1460         x-python: {}
1461         r: {}
1462         rtf: {}
1463         sam: {}
1464         x-sh: {}
1465         vnd.realvnc.bed: {}
1466         xml: {}
1467         xsl: {}
1468         SAMPLE: {}
1469
1470       # The maximum number of bytes to load in the log viewer
1471       LogViewerMaxBytes: 1M
1472
1473       # When anonymous_user_token is configured, show public projects page
1474       EnablePublicProjectsPage: true
1475
1476       # By default, disable the "Getting Started" popup which is specific to Arvados playground
1477       EnableGettingStartedPopup: false
1478
1479       # Ask Arvados API server to compress its response payloads.
1480       APIResponseCompression: true
1481
1482       # Timeouts for API requests.
1483       APIClientConnectTimeout: 2m
1484       APIClientReceiveTimeout: 5m
1485
1486       # Maximum number of historic log records of a running job to fetch
1487       # and display in the Log tab, while subscribing to web sockets.
1488       RunningJobLogRecordsToFetch: 2000
1489
1490       # In systems with many shared projects, loading of dashboard and topnav
1491       # can be slow due to collections indexing; use the following parameters
1492       # to suppress these properties
1493       ShowRecentCollectionsOnDashboard: true
1494       ShowUserNotifications: true
1495
1496       # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1497       # a link to the multi-site search page on a "home" Workbench site.
1498       #
1499       # Example:
1500       #   https://workbench.zzzzz.arvadosapi.com/collections/multisite
1501       MultiSiteSearch: ""
1502
1503       # Should workbench allow management of local git repositories? Set to false if
1504       # the jobs api is disabled and there are no local git repositories.
1505       Repositories: true
1506
1507       SiteName: Arvados Workbench
1508       ProfilingEnabled: false
1509
1510       # This is related to obsolete Google OpenID 1.0 login
1511       # but some workbench stuff still expects it to be set.
1512       DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1513
1514       # Workbench2 configs
1515       VocabularyURL: ""
1516       FileViewersConfigURL: ""
1517
1518       # Idle time after which the user's session will be auto closed.
1519       # This feature is disabled when set to zero.
1520       IdleTimeout: 0s
1521
1522       # Workbench welcome screen, this is HTML text that will be
1523       # incorporated directly onto the page.
1524       WelcomePageHTML: |
1525         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1526         <h2>Please log in.</h2>
1527
1528         <p>If you have never used Arvados Workbench before, logging in
1529         for the first time will automatically create a new
1530         account.</p>
1531
1532         <i>Arvados Workbench uses your information only for
1533         identification, and does not retrieve any other personal
1534         information.</i>
1535
1536       # Workbench screen displayed to inactive users.  This is HTML
1537       # text that will be incorporated directly onto the page.
1538       InactivePageHTML: |
1539         <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1540         <h3>Hi! You're logged in, but...</h3>
1541         <p>Your account is inactive.</p>
1542         <p>An administrator must activate your account before you can get
1543         any further.</p>
1544
1545       # Connecting to Arvados shell VMs tends to be site-specific.
1546       # Put any special instructions here. This is HTML text that will
1547       # be incorporated directly onto the Workbench page.
1548       SSHHelpPageHTML: |
1549         <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1550         Site configurations vary.  Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1551
1552       # Sample text if you are using a "switchyard" ssh proxy.
1553       # Replace "zzzzz" with your Cluster ID.
1554       #SSHHelpPageHTML: |
1555       # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1556       # <pre>Host *.zzzzz
1557       #  TCPKeepAlive yes
1558       #  ServerAliveInterval 60
1559       #  ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1560       # </pre>
1561
1562       # If you are using a switchyard ssh proxy, shell node hostnames
1563       # may require a special hostname suffix.  In the sample ssh
1564       # configuration above, this would be ".zzzzz"
1565       # This is added to the hostname in the "command line" column
1566       # the Workbench "shell VMs" page.
1567       #
1568       # If your shell nodes are directly accessible by users without a
1569       # proxy and have fully qualified host names, you should leave
1570       # this blank.
1571       SSHHelpHostSuffix: ""
1572
1573 # (Experimental) Restart services automatically when config file
1574 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1575 # dev/test mode.
1576 AutoReloadConfig: false
1577 `)