1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
7 var DefaultYAML = []byte(`# Copyright (C) The Arvados Authors. All rights reserved.
9 # SPDX-License-Identifier: AGPL-3.0
11 # Do not use this file for site configuration. Create
12 # /etc/arvados/config.yml instead.
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
21 # Token used internally by Arvados components to authenticate to
22 # one another. Use a string of at least 50 random alphanumerics.
25 # Token to be included in all healthcheck requests. Disabled by default.
26 # Server expects request header of the format "Authorization: Bearer xxx"
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 cluster.
36 "http://host1.example:12345": {}
37 "http://host2.example:12345":
38 # Rendezvous is normally empty/omitted. When changing the
39 # URL of a Keepstore service, Rendezvous should be set to
40 # the old URL (with trailing slash omitted) to preserve
41 # rendezvous ordering.
76 # Base URL for Workbench inline preview. If blank, use
77 # WebDAVDownload instead, and disable inline preview.
78 # If both are empty, downloading collections from workbench
81 # It is important to properly configure the download service
82 # to migitate cross-site-scripting (XSS) attacks. A HTML page
83 # can be stored in collection. If an attacker causes a victim
84 # to visit that page through Workbench, it will be rendered by
85 # the browser. If all collections are served at the same
86 # domain, the browser will consider collections as coming from
87 # the same origin and having access to the same browsing data,
88 # enabling malicious Javascript on that page to access Arvados
89 # on behalf of the victim.
91 # This is mitigating by having separate domains for each
92 # collection, or limiting preview to circumstances where the
93 # collection is not accessed with the user's regular
96 # Serve preview links using uuid or pdh in subdomain
97 # (requires wildcard DNS and TLS certificate)
98 # https://*.collections.uuid_prefix.arvadosapi.com
100 # Serve preview links using uuid or pdh in main domain
101 # (requires wildcard DNS and TLS certificate)
102 # https://*--collections.uuid_prefix.arvadosapi.com
104 # Serve preview links by setting uuid or pdh in the path.
105 # This configuration only allows previews of public data or
106 # collection-sharing links, because these use the anonymous
107 # user token or the token is already embedded in the URL.
108 # Other data must be handled as downloads via WebDAVDownload:
109 # https://collections.uuid_prefix.arvadosapi.com
115 # Base URL for download links. If blank, serve links to WebDAV
116 # with disposition=attachment query param. Unlike preview links,
117 # browsers do not render attachments, so there is no risk of XSS.
119 # If WebDAVDownload is blank, and WebDAV uses a
120 # single-origin form, then Workbench will show an error page
122 # Serve download links by setting uuid or pdh in the path:
123 # https://download.uuid_prefix.arvadosapi.com
135 # ShellInABox service endpoint URL for a given VM. If empty, do not
136 # offer web shell logins.
138 # E.g., using a path-based proxy server to forward connections to shell hosts:
139 # https://webshell.uuid_prefix.arvadosapi.com
141 # E.g., using a name-based proxy server to forward connections to shell hosts:
142 # https://*.webshell.uuid_prefix.arvadosapi.com
155 # max concurrent connections per arvados server daemon
158 # All parameters here are passed to the PG client library in a connection string;
159 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
167 # Limits for how long a client token created by regular users can be valid,
168 # and also is used as a default expiration policy when no expiration date is
170 # Default value zero means token expirations don't get clamped and no
171 # default expiration is set.
174 # Maximum size (in bytes) allowed for a single API request. This
175 # limit is published in the discovery document for use by clients.
176 # Note: You must separately configure the upstream web server or
177 # proxy to actually enforce the desired maximum request size on the
179 MaxRequestSize: 134217728
181 # Limit the number of bytes read from the database during an index
182 # request (by retrieving and returning fewer rows than would
183 # normally be returned in a single response).
184 # Note 1: This setting never reduces the number of returned rows to
185 # zero, no matter how big the first data row is.
186 # Note 2: Currently, this is only checked against a specific set of
187 # columns that tend to get large (collections.manifest_text,
188 # containers.mounts, workflows.definition). Other fields (e.g.,
189 # "properties" hashes) are not counted against this limit.
190 MaxIndexDatabaseRead: 134217728
192 # Maximum number of items to return when responding to a APIs that
193 # can return partial result sets using limit and offset parameters
194 # (e.g., *.index, groups.contents). If a request specifies a "limit"
195 # parameter higher than this value, this value is used instead.
196 MaxItemsPerResponse: 1000
198 # Maximum number of concurrent requests to accept in a single
199 # service process, or 0 for no limit.
200 MaxConcurrentRequests: 0
202 # Maximum number of 64MiB memory buffers per Keepstore server process, or
203 # 0 for no limit. When this limit is reached, up to
204 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
205 # buffers (like GET and PUT) will wait for buffer space to be released.
206 # Any HTTP requests beyond MaxConcurrentRequests will receive an
207 # immediate 503 response.
209 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
210 # * 1.1) fits comfortably in memory. On a host dedicated to running
211 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
212 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
213 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
214 MaxKeepBlobBuffers: 128
216 # API methods to disable. Disabled methods are not listed in the
217 # discovery document, and respond 404 to all requests.
218 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
221 # Interval (seconds) between asynchronous permission view updates. Any
222 # permission-updating API called with the 'async' parameter schedules a an
223 # update on the permission view in the future, if not already scheduled.
224 AsyncPermissionsUpdateInterval: 20s
226 # Maximum number of concurrent outgoing requests to make while
227 # serving a single incoming multi-cluster (federated) request.
228 MaxRequestAmplification: 4
230 # Maximum wall clock time to spend handling an incoming request.
233 # Websocket will send a periodic empty event after 'SendTimeout'
234 # if there is no other activity to maintain the connection /
235 # detect dropped connections.
238 WebsocketClientEventQueue: 64
239 WebsocketServerEventQueue: 4
241 # Timeout on requests to internal Keep services.
242 KeepServiceRequestTimeout: 15s
245 # Config parameters to automatically setup new users. If enabled,
246 # this users will be able to self-activate. Enable this if you want
247 # to run an open instance where anyone can create an account and use
248 # the system without requiring manual approval.
250 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
251 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
252 AutoSetupNewUsers: false
253 AutoSetupNewUsersWithVmUUID: ""
254 AutoSetupNewUsersWithRepository: false
255 AutoSetupUsernameBlacklist:
264 # When NewUsersAreActive is set to true, new users will be active
265 # immediately. This skips the "self-activate" step which enforces
266 # user agreements. Should only be enabled for development.
267 NewUsersAreActive: false
269 # The e-mail address of the user you would like to become marked as an admin
270 # user on their first login.
271 AutoAdminUserWithEmail: ""
273 # If AutoAdminFirstUser is set to true, the first user to log in when no
274 # other admin users exist will automatically become an admin user.
275 AutoAdminFirstUser: false
277 # Email address to notify whenever a user creates a profile for the
279 UserProfileNotificationAddress: ""
280 AdminNotifierEmailFrom: arvados@example.com
281 EmailSubjectPrefix: "[ARVADOS] "
282 UserNotifierEmailFrom: arvados@example.com
283 NewUserNotificationRecipients: {}
284 NewInactiveUserNotificationRecipients: {}
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: ""
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
296 PreferDomainForUsername: ""
299 <% if not @user.full_name.empty? -%>
300 <%= @user.full_name %>,
305 Your Arvados account has been set up. You can log in at
307 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
310 Your Arvados administrator.
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.)
317 # Currently, websocket event notifications rely on audit logs, so
318 # this should not be set lower than 300 (5 minutes).
321 # Maximum number of log rows to delete in a single SQL transaction.
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.
328 # 100000 is a reasonable batch size for most sites.
331 # Attributes to suppress in events and audit logs. Notably,
332 # specifying {"manifest_text": {}} here typically makes the database
333 # smaller and faster.
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: {}
342 # Logging threshold: panic, fatal, error, warn, info, debug, or
346 # Logging format: json or text
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
353 MaxRequestLogParamsSize: 2000
357 # Enable access controls for data stored in Keep. This should
358 # always be set to true on a production cluster.
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.
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.
372 # Enable garbage collection of unreferenced blobs in Keep.
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.
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
383 # How often to check for (and delete) trashed blocks whose
384 # BlobTrashLifetime has expired.
385 BlobTrashCheckInterval: 24h
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.
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
396 # Maximum number of concurrent "create additional replica of
397 # existing blob" operations conducted by a single keepstore
399 BlobReplicateConcurrency: 4
401 # Default replication level for collections. This is used when a
402 # collection's replication_desired attribute is nil.
403 DefaultReplication: 2
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:
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
413 # 2) Deleting or updating a collection can remove the last
414 # remaining reference to a data block.
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
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.
426 # Modifying BlobSigningTTL invalidates existing signatures; see
427 # BlobSigningKey note above.
429 # The default is 2 weeks.
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: ""
437 # keep-balance operates periodically, i.e.: do a
438 # scan/balance operation, sleep, repeat.
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
445 # If SIGUSR1 is received during an idle period between operations,
446 # the next operation will start immediately.
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
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
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.
469 # Default lifetime for ephemeral collections: 2 weeks. This must not
470 # be less than BlobSigningTTL.
471 DefaultTrashLifetime: 336h
473 # Interval (seconds) between trash sweeps. During a trash sweep,
474 # collections are marked as trash if their trash_at time has
475 # arrived, and deleted if their delete_at time has arrived.
476 TrashSweepInterval: 60s
478 # If true, enable collection versioning.
479 # When a collection's preserve_version field is true or the current version
480 # is older than the amount of seconds defined on PreserveVersionIfIdle,
481 # a snapshot of the collection's previous state is created and linked to
482 # the current collection.
483 CollectionVersioning: false
485 # 0s = auto-create a new version on every update.
486 # -1s = never auto-create new versions.
487 # > 0s = auto-create a new version when older than the specified number of seconds.
488 PreserveVersionIfIdle: -1s
490 # If non-empty, allow project and collection names to contain
491 # the "/" character (slash/stroke/solidus), and replace "/" with
492 # the given string in the filesystem hierarchy presented by
493 # WebDAV. Example values are "%2f" and "{slash}". Names that
494 # contain the substitution string itself may result in confusing
495 # behavior, so a value like "_" is not recommended.
497 # If the default empty value is used, the server will reject
498 # requests to create or rename a collection when the new name
501 # If the value "/" is used, project and collection names
502 # containing "/" will be allowed, but they will not be
503 # accessible via WebDAV.
505 # Use of this feature is not recommended, if it can be avoided.
506 ForwardSlashNameSubstitution: ""
508 # Include "folder objects" in S3 ListObjects responses.
509 S3FolderObjects: true
511 # Managed collection properties. At creation time, if the client didn't
512 # provide the listed keys, they will be automatically populated following
513 # one of the following behaviors:
515 # * UUID of the user who owns the containing project.
516 # responsible_person_uuid: {Function: original_owner, Protected: true}
518 # * Default concrete value.
519 # foo_bar: {Value: baz, Protected: false}
521 # If Protected is true, only an admin user can modify its value.
523 SAMPLE: {Function: original_owner, Protected: true}
525 # In "trust all content" mode, Workbench will redirect download
526 # requests to WebDAV preview link, even in the cases when
527 # WebDAV would have to expose XSS vulnerabilities in order to
528 # handle the redirect (see discussion on Services.WebDAV).
530 # This setting has no effect in the recommended configuration,
531 # where the WebDAV is configured to have a separate domain for
532 # every collection; in this case XSS protection is provided by
533 # browsers' same-origin policy.
535 # The default setting (false) is appropriate for a multi-user site.
536 TrustAllContent: false
538 # Cache parameters for WebDAV content serving:
540 # Time to cache manifests, permission checks, and sessions.
543 # Time to cache collection state.
546 # Block cache entries. Each block consumes up to 64 MiB RAM.
549 # Collection cache entries.
550 MaxCollectionEntries: 1000
552 # Approximate memory limit (in bytes) for collection cache.
553 MaxCollectionBytes: 100000000
555 # Permission cache entries.
556 MaxPermissionEntries: 1000
558 # UUID cache entries.
561 # Persistent sessions.
565 # One of the following mechanisms (SSO, Google, PAM, LDAP, or
566 # LoginCluster) should be enabled; see
567 # https://doc.arvados.org/install/setup-login.html
570 # Authenticate with Google.
573 # Use the Google Cloud console to enable the People API (APIs
574 # and Services > Enable APIs and services > Google People API
575 # > Enable), generate a Client ID and secret (APIs and
576 # Services > Credentials > Create credentials > OAuth client
577 # ID > Web application) and add your controller's /login URL
578 # (e.g., "https://zzzzz.example.com/login") as an authorized
583 # Allow users to log in to existing accounts using any verified
584 # email address listed by their Google account. If true, the
585 # Google People API must be enabled in order for Google login to
586 # work. If false, only the primary email address will be used.
587 AlternateEmailAddresses: true
589 # Send additional parameters with authentication requests. See
590 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
591 # for a list of supported parameters.
592 AuthenticationRequestParameters:
593 # Show the "choose which Google account" page, even if the
594 # client is currently logged in to exactly one Google
596 prompt: select_account
601 # Authenticate with an OpenID Connect provider.
604 # Issuer URL, e.g., "https://login.example.com".
606 # This must be exactly equal to the URL returned by the issuer
607 # itself in its config response ("isser" key). If the
608 # configured value is "https://example" and the provider
609 # returns "https://example:443" or "https://example/" then
610 # login will fail, even though those URLs are equivalent
614 # Your client ID and client secret (supplied by the provider).
618 # OpenID claim field containing the user's email
619 # address. Normally "email"; see
620 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
623 # OpenID claim field containing the email verification
624 # flag. Normally "email_verified". To accept every returned
625 # email address without checking a "verified" field at all,
626 # use the empty string "".
627 EmailVerifiedClaim: "email_verified"
629 # OpenID claim field containing the user's preferred
630 # username. If empty, use the mailbox part of the user's email
634 # Send additional parameters with authentication requests,
635 # like {display: page, prompt: consent}. See
636 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
637 # and refer to your provider's documentation for supported
639 AuthenticationRequestParameters:
642 # Accept an OIDC access token as an API token if the OIDC
643 # provider's UserInfo endpoint accepts it.
645 # AcceptAccessTokenScope should also be used when enabling
647 AcceptAccessToken: false
649 # Before accepting an OIDC access token as an API token, first
650 # check that it is a JWT whose "scope" value includes this
651 # value. Example: "https://zzzzz.example.com/" (your Arvados
654 # If this value is empty and AcceptAccessToken is true, all
655 # access tokens will be accepted regardless of scope,
656 # including non-JWT tokens. This is not recommended.
657 AcceptAccessTokenScope: ""
660 # (Experimental) Use PAM to authenticate users.
663 # PAM service name. PAM will apply the policy in the
664 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
665 # there is none, the default "other" config.
668 # Domain name (e.g., "example.com") to use to construct the
669 # user's email address if PAM authentication returns a
670 # username with no "@". If empty, use the PAM username as the
671 # user's email address, whether or not it contains "@".
673 # Note that the email address is used as the primary key for
674 # user records when logging in. Therefore, if you change
675 # PAMDefaultEmailDomain after the initial installation, you
676 # should also update existing user records to reflect the new
677 # domain. Otherwise, next time those users log in, they will
678 # be given new accounts instead of accessing their existing
680 DefaultEmailDomain: ""
683 # Use an LDAP service to authenticate users.
686 # Server URL, like "ldap://ldapserver.example.com:389" or
687 # "ldaps://ldapserver.example.com:636".
688 URL: "ldap://ldap:389"
690 # Use StartTLS upon connecting to the server.
693 # Skip TLS certificate name verification.
696 # Strip the @domain part if a user supplies an email-style
697 # username with this domain. If "*", strip any user-provided
698 # domain. If "", never strip the domain part. Example:
702 # If, after applying StripDomain, the username contains no "@"
703 # character, append this domain to form an email-style
704 # username. Example: "example.com"
707 # The LDAP attribute to filter on when looking up a username
708 # (after applying StripDomain and AppendDomain).
711 # Bind with this username (DN or UPN) and password when
712 # looking up the user record.
714 # Example user: "cn=admin,dc=example,dc=com"
716 SearchBindPassword: ""
718 # Directory base for username lookup. Example:
719 # "ou=Users,dc=example,dc=com"
722 # Additional filters to apply when looking up users' LDAP
723 # entries. This can be used to restrict access to a subset of
724 # LDAP users, or to disambiguate users from other directory
725 # entries that have the SearchAttribute present.
727 # Special characters in assertion values must be escaped (see
730 # Example: "(objectClass=person)"
733 # LDAP attribute to use as the user's email address.
735 # Important: This must not be an attribute whose value can be
736 # edited in the directory by the users themselves. Otherwise,
737 # users can take over other users' Arvados accounts trivially
738 # (email address is the primary key for Arvados accounts.)
741 # LDAP attribute to use as the preferred Arvados username. If
742 # no value is found (or this config is empty) the username
743 # originally supplied by the user will be used.
744 UsernameAttribute: uid
747 # Authenticate with a separate SSO server. (Deprecated)
750 # ProviderAppID and ProviderAppSecret are generated during SSO
752 # https://doc.arvados.org/v2.0/install/install-sso.html#update-config
754 ProviderAppSecret: ""
757 # Authenticate users listed here in the config file. This
758 # feature is intended to be used in test environments, and
759 # should not be used in production.
763 Email: alice@example.com
766 # The cluster ID to delegate the user database. When set,
767 # logins on this cluster will be redirected to the login cluster
768 # (login cluster must appear in RemoteClusters with Proxy: true)
771 # How long a cached token belonging to a remote cluster will
772 # remain valid before it needs to be revalidated.
773 RemoteTokenRefresh: 5m
775 # How long a client token created from a login flow will be valid without
776 # asking the user to re-login. Example values: 60m, 8h.
777 # Default value zero means tokens don't have expiration.
780 # If true (default) tokens issued through login are allowed to create
782 # If false, tokens issued through login are not allowed to
783 # viewing/creating other tokens. New tokens can only be created
784 # by going through login again.
785 IssueTrustedTokens: true
787 # When the token is returned to a client, the token itself may
788 # be restricted from viewing/creating other tokens based on whether
789 # the client is "trusted" or not. The local Workbench1 and
790 # Workbench2 are trusted by default, but if this is a
791 # LoginCluster, you probably want to include the other Workbench
792 # instances in the federation in this list.
795 "https://workbench.federate1.example": {}
796 "https://workbench.federate2.example": {}
799 # Path to git or gitolite-shell executable. Each authenticated
800 # request will execute this program with the single argument "http-backend"
801 GitCommand: /usr/bin/git
803 # Path to Gitolite's home directory. If a non-empty path is given,
804 # the CGI environment will be set up to support the use of
805 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
806 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
807 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
810 # Git repositories must be readable by api server, or you won't be
811 # able to submit crunch jobs. To pass the test suites, put a clone
812 # of the arvados tree in {git_repositories_dir}/arvados.git or
813 # {git_repositories_dir}/arvados/.git
814 Repositories: /var/lib/arvados/git/repositories
822 # List of supported Docker Registry image formats that compute nodes
823 # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
824 # to store an image with an unsupported format. Use an empty array
825 # to skip the compatibility check (and display a warning message to
828 # Example for sites running docker < 1.10: {"v1": {}}
829 # Example for sites running docker >= 1.10: {"v2": {}}
830 # Example for disabling check: {}
831 SupportedDockerImageFormats:
835 # Include details about job reuse decisions in the server log. This
836 # causes additional database queries to run, so it should not be
837 # enabled unless you expect to examine the resulting logs for
838 # troubleshooting purposes.
839 LogReuseDecisions: false
841 # Default value for keep_cache_ram of a container's runtime_constraints.
842 DefaultKeepCacheRAM: 268435456
844 # Number of times a container can be unlocked before being
845 # automatically cancelled.
846 MaxDispatchAttempts: 5
848 # Default value for container_count_max for container requests. This is the
849 # number of times Arvados will create a new container to satisfy a container
850 # request. If a container is cancelled it will retry a new container if
851 # container_count < container_count_max on any container requests associated
852 # with the cancelled container.
855 # The maximum number of compute nodes that can be in use simultaneously
856 # If this limit is reduced, any existing nodes with slot number >= new limit
857 # will not be counted against the new limit. In other words, the new limit
858 # won't be strictly enforced until those nodes with higher slot numbers
862 # Preemptible instance support (e.g. AWS Spot Instances)
863 # When true, child containers will get created with the preemptible
864 # scheduling parameter parameter set.
865 UsePreemptibleInstances: false
867 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
868 # (experimental) cloud dispatcher for executing containers on
869 # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
870 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
871 DispatchPrivateKey: ""
873 # Maximum time to wait for workers to come up before abandoning
874 # stale locks from a previous dispatch process.
877 # The crunch-run command used to start a container on a worker node.
879 # When dispatching to cloud VMs, this is used only if
880 # DeployRunnerBinary in the CloudVMs section is set to the empty
882 CrunchRunCommand: "crunch-run"
884 # Extra arguments to add to crunch-run invocation
885 # Example: ["--cgroup-parent-subsystem=memory"]
886 CrunchRunArgumentsList: []
888 # Extra RAM to reserve on the node, in addition to
889 # the amount specified in the container's RuntimeConstraints
890 ReserveExtraRAM: 256MiB
892 # Minimum time between two attempts to run the same container
895 # Container runtime: "docker" (default) or "singularity" (experimental)
896 RuntimeEngine: docker
899 # When you run the db:delete_old_container_logs task, it will find
900 # containers that have been finished for at least this many seconds,
901 # and delete their stdout, stderr, arv-mount, crunch-run, and
902 # crunchstat logs from the logs table.
905 # These two settings control how frequently log events are flushed to the
906 # database. Log lines are buffered until either crunch_log_bytes_per_event
907 # has been reached or crunch_log_seconds_between_events has elapsed since
909 LogBytesPerEvent: 4096
910 LogSecondsBetweenEvents: 5s
912 # The sample period for throttling logs.
913 LogThrottlePeriod: 60s
915 # Maximum number of bytes that job can log over crunch_log_throttle_period
916 # before being silenced until the end of the period.
917 LogThrottleBytes: 65536
919 # Maximum number of lines that job can log over crunch_log_throttle_period
920 # before being silenced until the end of the period.
921 LogThrottleLines: 1024
923 # Maximum bytes that may be logged by a single job. Log bytes that are
924 # silenced by throttling are not counted against this total.
925 LimitLogBytesPerJob: 67108864
927 LogPartialLineThrottlePeriod: 5s
929 # Container logs are written to Keep and saved in a
930 # collection, which is updated periodically while the
931 # container runs. This value sets the interval between
932 # collection updates.
935 # The log collection is also updated when the specified amount of
936 # log data (given in bytes) is produced in less than one update
941 # An admin user can use "arvados-client shell" to start an
942 # interactive shell (with any user ID) in any running
946 # Any user can use "arvados-client shell" to start an
947 # interactive shell (with any user ID) in any running
948 # container that they started, provided it isn't also
949 # associated with a different user's container request.
951 # Interactive sessions make it easy to alter the container's
952 # runtime environment in ways that aren't recorded or
953 # reproducible. Consider the implications for automatic
954 # container reuse before enabling and using this feature. In
955 # particular, note that starting an interactive session does
956 # not disqualify a container from being reused by a different
957 # user/workflow in the future.
962 SbatchArgumentsList: []
963 SbatchEnvironmentVariables:
966 # Path to dns server configuration directory
967 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
968 # files or touch restart.txt (see below).
971 # Template file for the dns server host snippets. See
972 # unbound.template in this directory for an example. If false, do
973 # not write any config files.
974 DNSServerConfTemplate: ""
976 # String to write to {dns_server_conf_dir}/restart.txt (with a
977 # trailing newline) after updating local data. If false, do not
978 # open or write the restart.txt file.
979 DNSServerReloadCommand: ""
981 # Command to run after each DNS update. Template variables will be
982 # substituted; see the "unbound" example below. If false, do not run
984 DNSServerUpdateCommand: ""
986 ComputeNodeDomain: ""
987 ComputeNodeNameservers:
991 # Hostname to assign to a compute node when it sends a "ping" and the
992 # hostname in its Node record is nil.
993 # During bootstrapping, the "ping" script is expected to notice the
994 # hostname given in the ping response, and update its unix hostname
996 # If false, leave the hostname alone (this is appropriate if your compute
997 # nodes' hostnames are already assigned by some other mechanism).
999 # One way or another, the hostnames of your node records should agree
1000 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1002 # Example for compute0000, compute0001, ....:
1003 # assign_node_hostname: compute%<slot_number>04d
1004 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1005 AssignNodeHostname: "compute%<slot_number>d"
1008 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1010 # Note: this only enables read-only access, creating new
1011 # legacy jobs and pipelines is not supported.
1013 # 'auto' -- (default) enable the Jobs API only if it has been used before
1014 # (i.e., there are job records in the database)
1015 # 'true' -- enable the Jobs API despite lack of existing records.
1016 # 'false' -- disable the Jobs API despite presence of existing records.
1019 # Git repositories must be readable by api server, or you won't be
1020 # able to submit crunch jobs. To pass the test suites, put a clone
1021 # of the arvados tree in {git_repositories_dir}/arvados.git or
1022 # {git_repositories_dir}/arvados/.git
1023 GitInternalDir: /var/lib/arvados/internal.git
1026 # Enable the cloud scheduler (experimental).
1029 # Name/number of port where workers' SSH services listen.
1032 # Interval between queue polls.
1035 # Shell command to execute on each worker to determine whether
1036 # the worker is booted and ready to run containers. It should
1037 # exit zero if the worker is ready.
1038 BootProbeCommand: "docker ps -q"
1040 # Minimum interval between consecutive probes to a single
1044 # Maximum probes per second, across all workers in a pool.
1045 MaxProbesPerSecond: 10
1047 # Time before repeating SIGTERM when killing a container.
1050 # Time to give up on a process (most likely arv-mount) that
1051 # still holds a container lockfile after its main supervisor
1052 # process has exited, and declare the instance broken.
1053 TimeoutStaleRunLock: 5s
1055 # Time to give up on SIGTERM and write off the worker.
1058 # Maximum create/destroy-instance operations per second (0 =
1060 MaxCloudOpsPerSecond: 0
1062 # Maximum concurrent node creation operations (0 = unlimited). This is
1063 # recommended by Azure in certain scenarios (see
1064 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
1065 # and can be used with other cloud providers too, if desired.
1066 MaxConcurrentInstanceCreateOps: 0
1068 # Interval between cloud provider syncs/updates ("list all
1072 # Time to leave an idle worker running (in case new containers
1073 # appear in the queue that it can run) before shutting it
1077 # Time to wait for a new worker to boot (i.e., pass
1078 # BootProbeCommand) before giving up and shutting it down.
1081 # Maximum time a worker can stay alive with no successful
1082 # probes before being automatically shut down.
1085 # Time after shutting down a worker to retry the
1086 # shutdown/destroy operation.
1087 TimeoutShutdown: 10s
1089 # Worker VM image ID.
1090 # (aws) AMI identifier
1091 # (azure) managed disks: the name of the managed disk image
1092 # (azure) shared image gallery: the name of the image definition. Also
1093 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1094 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1095 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1098 # An executable file (located on the dispatcher host) to be
1099 # copied to cloud instances at runtime and used as the
1100 # container runner/supervisor. The default value is the
1101 # dispatcher program itself.
1103 # Use the empty string to disable this step: nothing will be
1104 # copied, and cloud instances are assumed to have a suitable
1105 # version of crunch-run installed; see CrunchRunCommand above.
1106 DeployRunnerBinary: "/proc/self/exe"
1108 # Tags to add on all resources (VMs, NICs, disks) created by
1109 # the container dispatcher. (Arvados's own tags --
1110 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1115 # Prefix for predefined tags used by Arvados (InstanceSetID,
1116 # InstanceType, InstanceSecret, IdleBehavior). With the
1117 # default value "Arvados", tags are "ArvadosInstanceSetID",
1118 # "ArvadosInstanceSecret", etc.
1120 # This should only be changed while no cloud resources are in
1121 # use and the cloud dispatcher is not running. Otherwise,
1122 # VMs/resources that were added using the old tag prefix will
1123 # need to be detected and cleaned up manually.
1124 TagKeyPrefix: Arvados
1126 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1129 # Cloud-specific driver parameters.
1132 # (ec2) Credentials. Omit or leave blank if using IAM role.
1136 # (ec2) Instance configuration.
1142 AdminUsername: debian
1144 # (azure) Credentials.
1150 # (azure) Instance configuration.
1151 CloudEnvironment: AzurePublicCloud
1154 # (azure) The resource group where the VM and virtual NIC will be
1158 # (azure) The resource group of the Network to use for the virtual
1159 # NIC (if different from ResourceGroup)
1160 NetworkResourceGroup: ""
1164 # (azure) managed disks: The resource group where the managed disk
1165 # image can be found (if different from ResourceGroup).
1166 ImageResourceGroup: ""
1168 # (azure) shared image gallery: the name of the gallery
1169 SharedImageGalleryName: ""
1170 # (azure) shared image gallery: the version of the image definition
1171 SharedImageGalleryImageVersion: ""
1173 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1177 # (azure) How long to wait before deleting VHD and NIC
1178 # objects that are no longer being used.
1179 DeleteDanglingResourcesAfter: 20s
1181 # Account (that already exists in the VM image) that will be
1182 # set up with an ssh authorized key to allow the compute
1183 # dispatcher to connect.
1184 AdminUsername: arvados
1188 # Use the instance type name as the key (in place of "SAMPLE" in
1189 # this sample entry).
1191 # Cloud provider's instance type. Defaults to the configured type name.
1195 IncludedScratch: 16GB
1202 # AccessViaHosts specifies which keepstore processes can read
1203 # and write data on the volume.
1205 # For a local filesystem, AccessViaHosts has one entry,
1206 # indicating which server the filesystem is located on.
1208 # For a network-attached backend accessible by all keepstore
1209 # servers, like a cloud storage bucket or an NFS mount,
1210 # AccessViaHosts can be empty/omitted.
1212 # Further info/examples:
1213 # https://doc.arvados.org/install/configure-fs-storage.html
1214 # https://doc.arvados.org/install/configure-s3-object-storage.html
1215 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1219 "http://host1.example:25107": {}
1227 # for s3 driver -- see
1228 # https://doc.arvados.org/install/configure-s3-object-storage.html
1231 SecretAccessKey: aaaaa
1235 LocationConstraint: false
1241 # Use aws-s3-go (v2) instead of goamz
1242 UseAWSS3v2Driver: false
1244 # For S3 driver, potentially unsafe tuning parameter,
1245 # intentionally excluded from main documentation.
1247 # Enable deletion (garbage collection) even when the
1248 # configured BlobTrashLifetime is zero. WARNING: eventual
1249 # consistency may result in race conditions that can cause
1250 # data loss. Do not enable this unless you understand and
1254 # for azure driver -- see
1255 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1256 StorageAccountName: aaaaa
1257 StorageAccountKey: aaaaa
1258 StorageBaseURL: core.windows.net
1259 ContainerName: aaaaa
1261 ListBlobsRetryDelay: 10s
1262 ListBlobsMaxAttempts: 10
1264 WriteRaceInterval: 15s
1265 WriteRacePollTime: 1s
1267 # for local directory driver -- see
1268 # https://doc.arvados.org/install/configure-fs-storage.html
1269 Root: /var/lib/arvados/keep-data
1271 # For local directory driver, potentially confusing tuning
1272 # parameter, intentionally excluded from main documentation.
1274 # When true, read and write operations (for whole 64MiB
1275 # blocks) on an individual volume will queued and issued
1276 # serially. When false, read and write operations will be
1277 # issued concurrently.
1279 # May possibly improve throughput if you have physical spinning disks
1280 # and experience contention when there are multiple requests
1281 # to the same volume.
1283 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1284 # should leave this alone.
1290 SendUserSetupNotificationEmail: true
1292 # Bug/issue report notification to and from addresses
1293 IssueReporterEmailFrom: "arvados@example.com"
1294 IssueReporterEmailTo: "arvados@example.com"
1295 SupportEmailAddress: "arvados@example.com"
1297 # Generic issue email from
1298 EmailFrom: "arvados@example.com"
1305 ActivateUsers: false
1307 # API endpoint host or host:port; default is {id}.arvadosapi.com
1308 Host: sample.arvadosapi.com
1310 # Perform a proxy request when a local client requests an
1311 # object belonging to this remote.
1314 # Default "https". Can be set to "http" for testing.
1317 # Disable TLS verify. Can be set to true for testing.
1320 # When users present tokens issued by this remote cluster, and
1321 # their accounts are active on the remote cluster, activate
1322 # them on this cluster too.
1323 ActivateUsers: false
1326 # Workbench1 configs
1328 ActivationContactLink: mailto:info@arvados.org
1329 ArvadosDocsite: https://doc.arvados.org
1330 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1331 ShowUserAgreementInline: false
1334 # Scratch directory used by the remote repository browsing
1335 # feature. If it doesn't exist, it (and any missing parents) will be
1336 # created using mkdir_p.
1337 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1339 # Below is a sample setting of user_profile_form_fields config parameter.
1340 # This configuration parameter should be set to either false (to disable) or
1341 # to a map as shown below.
1342 # Configure the map of input fields to be displayed in the profile page
1343 # using the attribute "key" for each of the input fields.
1344 # This sample shows configuration with one required and one optional form fields.
1345 # For each of these input fields:
1346 # You can specify "Type" as "text" or "select".
1347 # List the "Options" to be displayed for each of the "select" menu.
1348 # Set "Required" as "true" for any of these fields to make them required.
1349 # If any of the required fields are missing in the user's profile, the user will be
1350 # redirected to the profile page before they can access any Workbench features.
1351 UserProfileFormFields:
1354 FormFieldTitle: Best color
1355 FormFieldDescription: your favorite color
1364 # exampleTextValue: # key that will be set in properties
1366 # FormFieldTitle: ""
1367 # FormFieldDescription: ""
1370 # exampleOptionsValue:
1372 # FormFieldTitle: ""
1373 # FormFieldDescription: ""
1381 # Use "UserProfileFormMessage to configure the message you want
1382 # to display on the profile page.
1383 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1385 # Mimetypes of applications for which the view icon
1386 # would be enabled in a collection's show page.
1387 # It is sufficient to list only applications here.
1388 # No need to list text and image types.
1389 ApplicationMimetypesWithViewIcon:
1407 # The maximum number of bytes to load in the log viewer
1408 LogViewerMaxBytes: 1M
1410 # When anonymous_user_token is configured, show public projects page
1411 EnablePublicProjectsPage: true
1413 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1414 EnableGettingStartedPopup: false
1416 # Ask Arvados API server to compress its response payloads.
1417 APIResponseCompression: true
1419 # Timeouts for API requests.
1420 APIClientConnectTimeout: 2m
1421 APIClientReceiveTimeout: 5m
1423 # Maximum number of historic log records of a running job to fetch
1424 # and display in the Log tab, while subscribing to web sockets.
1425 RunningJobLogRecordsToFetch: 2000
1427 # In systems with many shared projects, loading of dashboard and topnav
1428 # can be slow due to collections indexing; use the following parameters
1429 # to suppress these properties
1430 ShowRecentCollectionsOnDashboard: true
1431 ShowUserNotifications: true
1433 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1434 # a link to the multi-site search page on a "home" Workbench site.
1437 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1440 # Should workbench allow management of local git repositories? Set to false if
1441 # the jobs api is disabled and there are no local git repositories.
1444 SiteName: Arvados Workbench
1445 ProfilingEnabled: false
1447 # This is related to obsolete Google OpenID 1.0 login
1448 # but some workbench stuff still expects it to be set.
1449 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1451 # Workbench2 configs
1453 FileViewersConfigURL: ""
1455 # Idle time after which the user's session will be auto closed.
1456 # This feature is disabled when set to zero.
1459 # Workbench welcome screen, this is HTML text that will be
1460 # incorporated directly onto the page.
1462 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1463 <h2>Please log in.</h2>
1465 <p>If you have never used Arvados Workbench before, logging in
1466 for the first time will automatically create a new
1469 <i>Arvados Workbench uses your information only for
1470 identification, and does not retrieve any other personal
1473 # Workbench screen displayed to inactive users. This is HTML
1474 # text that will be incorporated directly onto the page.
1476 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1477 <h3>Hi! You're logged in, but...</h3>
1478 <p>Your account is inactive.</p>
1479 <p>An administrator must activate your account before you can get
1482 # Connecting to Arvados shell VMs tends to be site-specific.
1483 # Put any special instructions here. This is HTML text that will
1484 # be incorporated directly onto the Workbench page.
1486 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1487 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1489 # Sample text if you are using a "switchyard" ssh proxy.
1490 # Replace "zzzzz" with your Cluster ID.
1492 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1495 # ServerAliveInterval 60
1496 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1499 # If you are using a switchyard ssh proxy, shell node hostnames
1500 # may require a special hostname suffix. In the sample ssh
1501 # configuration above, this would be ".zzzzz"
1502 # This is added to the hostname in the "command line" column
1503 # the Workbench "shell VMs" page.
1505 # If your shell nodes are directly accessible by users without a
1506 # proxy and have fully qualified host names, you should leave
1508 SSHHelpHostSuffix: ""
1510 # (Experimental) Restart services automatically when config file
1511 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1513 AutoReloadConfig: false