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
23 # Token to be included in all healthcheck requests. Disabled by default.
24 # Server expects request header of the format "Authorization: Bearer xxx"
29 # In each of the service sections below, the keys under
30 # InternalURLs are the endpoints where the service should be
31 # listening, and reachable from other hosts in the cluster.
34 "http://host1.example:12345": {}
35 "http://host2.example:12345":
36 # Rendezvous is normally empty/omitted. When changing the
37 # URL of a Keepstore service, Rendezvous should be set to
38 # the old URL (with trailing slash omitted) to preserve
39 # rendezvous ordering.
74 # Base URL for Workbench inline preview. If blank, use
75 # WebDAVDownload instead, and disable inline preview.
76 # If both are empty, downloading collections from workbench
79 # It is important to properly configure the download service
80 # to migitate cross-site-scripting (XSS) attacks. A HTML page
81 # can be stored in collection. If an attacker causes a victim
82 # to visit that page through Workbench, it will be rendered by
83 # the browser. If all collections are served at the same
84 # domain, the browser will consider collections as coming from
85 # the same origin and having access to the same browsing data,
86 # enabling malicious Javascript on that page to access Arvados
87 # on behalf of the victim.
89 # This is mitigating by having separate domains for each
90 # collection, or limiting preview to circumstances where the
91 # collection is not accessed with the user's regular
94 # Serve preview links using uuid or pdh in subdomain
95 # (requires wildcard DNS and TLS certificate)
96 # https://*.collections.uuid_prefix.arvadosapi.com
98 # Serve preview links using uuid or pdh in main domain
99 # (requires wildcard DNS and TLS certificate)
100 # https://*--collections.uuid_prefix.arvadosapi.com
102 # Serve preview links by setting uuid or pdh in the path.
103 # This configuration only allows previews of public data or
104 # collection-sharing links, because these use the anonymous
105 # user token or the token is already embedded in the URL.
106 # Other data must be handled as downloads via WebDAVDownload:
107 # https://collections.uuid_prefix.arvadosapi.com
113 # Base URL for download links. If blank, serve links to WebDAV
114 # with disposition=attachment query param. Unlike preview links,
115 # browsers do not render attachments, so there is no risk of XSS.
117 # If WebDAVDownload is blank, and WebDAV uses a
118 # single-origin form, then Workbench will show an error page
120 # Serve download links by setting uuid or pdh in the path:
121 # https://download.uuid_prefix.arvadosapi.com
133 # ShellInABox service endpoint URL for a given VM. If empty, do not
134 # offer web shell logins.
136 # E.g., using a path-based proxy server to forward connections to shell hosts:
137 # https://webshell.uuid_prefix.arvadosapi.com
139 # E.g., using a name-based proxy server to forward connections to shell hosts:
140 # https://*.webshell.uuid_prefix.arvadosapi.com
153 # max concurrent connections per arvados server daemon
156 # All parameters here are passed to the PG client library in a connection string;
157 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
165 # Maximum size (in bytes) allowed for a single API request. This
166 # limit is published in the discovery document for use by clients.
167 # Note: You must separately configure the upstream web server or
168 # proxy to actually enforce the desired maximum request size on the
170 MaxRequestSize: 134217728
172 # Limit the number of bytes read from the database during an index
173 # request (by retrieving and returning fewer rows than would
174 # normally be returned in a single response).
175 # Note 1: This setting never reduces the number of returned rows to
176 # zero, no matter how big the first data row is.
177 # Note 2: Currently, this is only checked against a specific set of
178 # columns that tend to get large (collections.manifest_text,
179 # containers.mounts, workflows.definition). Other fields (e.g.,
180 # "properties" hashes) are not counted against this limit.
181 MaxIndexDatabaseRead: 134217728
183 # Maximum number of items to return when responding to a APIs that
184 # can return partial result sets using limit and offset parameters
185 # (e.g., *.index, groups.contents). If a request specifies a "limit"
186 # parameter higher than this value, this value is used instead.
187 MaxItemsPerResponse: 1000
189 # Maximum number of concurrent requests to accept in a single
190 # service process, or 0 for no limit.
191 MaxConcurrentRequests: 0
193 # Maximum number of 64MiB memory buffers per Keepstore server process, or
194 # 0 for no limit. When this limit is reached, up to
195 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
196 # buffers (like GET and PUT) will wait for buffer space to be released.
197 # Any HTTP requests beyond MaxConcurrentRequests will receive an
198 # immediate 503 response.
200 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
201 # * 1.1) fits comfortably in memory. On a host dedicated to running
202 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
203 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
204 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
205 MaxKeepBlobBuffers: 128
207 # API methods to disable. Disabled methods are not listed in the
208 # discovery document, and respond 404 to all requests.
209 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
212 # Interval (seconds) between asynchronous permission view updates. Any
213 # permission-updating API called with the 'async' parameter schedules a an
214 # update on the permission view in the future, if not already scheduled.
215 AsyncPermissionsUpdateInterval: 20s
217 # Maximum number of concurrent outgoing requests to make while
218 # serving a single incoming multi-cluster (federated) request.
219 MaxRequestAmplification: 4
221 # Maximum wall clock time to spend handling an incoming request.
224 # Websocket will send a periodic empty event after 'SendTimeout'
225 # if there is no other activity to maintain the connection /
226 # detect dropped connections.
229 WebsocketClientEventQueue: 64
230 WebsocketServerEventQueue: 4
232 # Timeout on requests to internal Keep services.
233 KeepServiceRequestTimeout: 15s
236 # Config parameters to automatically setup new users. If enabled,
237 # this users will be able to self-activate. Enable this if you want
238 # to run an open instance where anyone can create an account and use
239 # the system without requiring manual approval.
241 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
242 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
243 AutoSetupNewUsers: false
244 AutoSetupNewUsersWithVmUUID: ""
245 AutoSetupNewUsersWithRepository: false
246 AutoSetupUsernameBlacklist:
255 # When NewUsersAreActive is set to true, new users will be active
256 # immediately. This skips the "self-activate" step which enforces
257 # user agreements. Should only be enabled for development.
258 NewUsersAreActive: false
260 # The e-mail address of the user you would like to become marked as an admin
261 # user on their first login.
262 AutoAdminUserWithEmail: ""
264 # If AutoAdminFirstUser is set to true, the first user to log in when no
265 # other admin users exist will automatically become an admin user.
266 AutoAdminFirstUser: false
268 # Email address to notify whenever a user creates a profile for the
270 UserProfileNotificationAddress: ""
271 AdminNotifierEmailFrom: arvados@example.com
272 EmailSubjectPrefix: "[ARVADOS] "
273 UserNotifierEmailFrom: arvados@example.com
274 NewUserNotificationRecipients: {}
275 NewInactiveUserNotificationRecipients: {}
277 # Set AnonymousUserToken to enable anonymous user access. Populate this
278 # field with a long random string. Then run "bundle exec
279 # ./script/get_anonymous_user_token.rb" in the directory where your API
280 # server is running to record the token in the database.
281 AnonymousUserToken: ""
283 # If a new user has an alternate email address (local@domain)
284 # with the domain given here, its local part becomes the new
285 # user's default username. Otherwise, the user's primary email
287 PreferDomainForUsername: ""
290 <% if not @user.full_name.empty? -%>
291 <%= @user.full_name %>,
296 Your Arvados account has been set up. You can log in at
298 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
301 Your Arvados administrator.
304 # Time to keep audit logs, in seconds. (An audit log is a row added
305 # to the "logs" table in the PostgreSQL database each time an
306 # Arvados object is created, modified, or deleted.)
308 # Currently, websocket event notifications rely on audit logs, so
309 # this should not be set lower than 300 (5 minutes).
312 # Maximum number of log rows to delete in a single SQL transaction.
314 # If MaxDeleteBatch is 0, log entries will never be
315 # deleted by Arvados. Cleanup can be done by an external process
316 # without affecting any Arvados system processes, as long as very
317 # recent (<5 minutes old) logs are not deleted.
319 # 100000 is a reasonable batch size for most sites.
322 # Attributes to suppress in events and audit logs. Notably,
323 # specifying {"manifest_text": {}} here typically makes the database
324 # smaller and faster.
326 # Warning: Using any non-empty value here can have undesirable side
327 # effects for any client or component that relies on event logs.
328 # Use at your own risk.
329 UnloggedAttributes: {}
333 # Logging threshold: panic, fatal, error, warn, info, debug, or
337 # Logging format: json or text
340 # Maximum characters of (JSON-encoded) query parameters to include
341 # in each request log entry. When params exceed this size, they will
342 # be JSON-encoded, truncated to this size, and logged as
344 MaxRequestLogParamsSize: 2000
348 # Enable access controls for data stored in Keep. This should
349 # always be set to true on a production cluster.
352 # BlobSigningKey is a string of alphanumeric characters used to
353 # generate permission signatures for Keep locators. It must be
354 # identical to the permission key given to Keep. IMPORTANT: This
355 # is a site secret. It should be at least 50 characters.
357 # Modifying BlobSigningKey will invalidate all existing
358 # signatures, which can cause programs to fail (e.g., arv-put,
359 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
360 # when no such processes are running.
363 # Enable garbage collection of unreferenced blobs in Keep.
366 # Time to leave unreferenced blobs in "trashed" state before
367 # deleting them, or 0 to skip the "trashed" state entirely and
368 # delete unreferenced blobs.
370 # If you use any Amazon S3 buckets as storage volumes, this
371 # must be at least 24h to avoid occasional data loss.
372 BlobTrashLifetime: 336h
374 # How often to check for (and delete) trashed blocks whose
375 # BlobTrashLifetime has expired.
376 BlobTrashCheckInterval: 24h
378 # Maximum number of concurrent "trash blob" and "delete trashed
379 # blob" operations conducted by a single keepstore process. Each
380 # of these can be set to 0 to disable the respective operation.
382 # If BlobTrashLifetime is zero, "trash" and "delete trash"
383 # happen at once, so only the lower of these two values is used.
384 BlobTrashConcurrency: 4
385 BlobDeleteConcurrency: 4
387 # Maximum number of concurrent "create additional replica of
388 # existing blob" operations conducted by a single keepstore
390 BlobReplicateConcurrency: 4
392 # Default replication level for collections. This is used when a
393 # collection's replication_desired attribute is nil.
394 DefaultReplication: 2
396 # BlobSigningTTL determines the minimum lifetime of transient
397 # data, i.e., blocks that are not referenced by
398 # collections. Unreferenced blocks exist for two reasons:
400 # 1) A data block must be written to a disk/cloud backend device
401 # before a collection can be created/updated with a reference to
404 # 2) Deleting or updating a collection can remove the last
405 # remaining reference to a data block.
407 # If BlobSigningTTL is too short, long-running
408 # processes/containers will fail when they take too long (a)
409 # between writing blocks and writing collections that reference
410 # them, or (b) between reading collections and reading the
413 # If BlobSigningTTL is too long, data will still be stored long
414 # after the referring collections are deleted, and you will
415 # needlessly fill up disks or waste money on cloud storage.
417 # Modifying BlobSigningTTL invalidates existing signatures; see
418 # BlobSigningKey note above.
420 # The default is 2 weeks.
423 # When running keep-balance, this is the destination filename for
424 # the list of lost block hashes if there are any, one per line.
425 # Updated automically during each successful run.
426 BlobMissingReport: ""
428 # keep-balance operates periodically, i.e.: do a
429 # scan/balance operation, sleep, repeat.
431 # BalancePeriod determines the interval between start times of
432 # successive scan/balance operations. If a scan/balance operation
433 # takes longer than RunPeriod, the next one will follow it
436 # If SIGUSR1 is received during an idle period between operations,
437 # the next operation will start immediately.
440 # Limits the number of collections retrieved by keep-balance per
441 # API transaction. If this is zero, page size is
442 # determined by the API server's own page size limits (see
443 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
444 BalanceCollectionBatch: 0
446 # The size of keep-balance's internal queue of
447 # collections. Higher values use more memory and improve throughput
448 # by allowing keep-balance to fetch the next page of collections
449 # while the current page is still being processed. If this is zero
450 # or omitted, pages are processed serially.
451 BalanceCollectionBuffers: 1000
453 # Maximum time for a rebalancing run. This ensures keep-balance
454 # eventually gives up and retries if, for example, a network
455 # error causes a hung connection that is never closed by the
456 # OS. It should be long enough that it doesn't interrupt a
457 # long-running balancing operation.
460 # Default lifetime for ephemeral collections: 2 weeks. This must not
461 # be less than BlobSigningTTL.
462 DefaultTrashLifetime: 336h
464 # Interval (seconds) between trash sweeps. During a trash sweep,
465 # collections are marked as trash if their trash_at time has
466 # arrived, and deleted if their delete_at time has arrived.
467 TrashSweepInterval: 60s
469 # If true, enable collection versioning.
470 # When a collection's preserve_version field is true or the current version
471 # is older than the amount of seconds defined on PreserveVersionIfIdle,
472 # a snapshot of the collection's previous state is created and linked to
473 # the current collection.
474 CollectionVersioning: false
476 # 0s = auto-create a new version on every update.
477 # -1s = never auto-create new versions.
478 # > 0s = auto-create a new version when older than the specified number of seconds.
479 PreserveVersionIfIdle: -1s
481 # If non-empty, allow project and collection names to contain
482 # the "/" character (slash/stroke/solidus), and replace "/" with
483 # the given string in the filesystem hierarchy presented by
484 # WebDAV. Example values are "%2f" and "{slash}". Names that
485 # contain the substitution string itself may result in confusing
486 # behavior, so a value like "_" is not recommended.
488 # If the default empty value is used, the server will reject
489 # requests to create or rename a collection when the new name
492 # If the value "/" is used, project and collection names
493 # containing "/" will be allowed, but they will not be
494 # accessible via WebDAV.
496 # Use of this feature is not recommended, if it can be avoided.
497 ForwardSlashNameSubstitution: ""
499 # Include "folder objects" in S3 ListObjects responses.
500 S3FolderObjects: true
502 # Managed collection properties. At creation time, if the client didn't
503 # provide the listed keys, they will be automatically populated following
504 # one of the following behaviors:
506 # * UUID of the user who owns the containing project.
507 # responsible_person_uuid: {Function: original_owner, Protected: true}
509 # * Default concrete value.
510 # foo_bar: {Value: baz, Protected: false}
512 # If Protected is true, only an admin user can modify its value.
514 SAMPLE: {Function: original_owner, Protected: true}
516 # In "trust all content" mode, Workbench will redirect download
517 # requests to WebDAV preview link, even in the cases when
518 # WebDAV would have to expose XSS vulnerabilities in order to
519 # handle the redirect (see discussion on Services.WebDAV).
521 # This setting has no effect in the recommended configuration,
522 # where the WebDAV is configured to have a separate domain for
523 # every collection; in this case XSS protection is provided by
524 # browsers' same-origin policy.
526 # The default setting (false) is appropriate for a multi-user site.
527 TrustAllContent: false
529 # Cache parameters for WebDAV content serving:
530 # * TTL: Maximum time to cache manifests and permission checks.
531 # * UUIDTTL: Maximum time to cache collection state.
532 # * MaxBlockEntries: Maximum number of block cache entries.
533 # * MaxCollectionEntries: Maximum number of collection cache entries.
534 # * MaxCollectionBytes: Approximate memory limit for collection cache.
535 # * MaxPermissionEntries: Maximum number of permission cache entries.
536 # * MaxUUIDEntries: Maximum number of UUID cache entries.
541 MaxCollectionEntries: 1000
542 MaxCollectionBytes: 100000000
543 MaxPermissionEntries: 1000
547 # One of the following mechanisms (SSO, Google, PAM, LDAP, or
548 # LoginCluster) should be enabled; see
549 # https://doc.arvados.org/install/setup-login.html
552 # Authenticate with Google.
555 # Use the Google Cloud console to enable the People API (APIs
556 # and Services > Enable APIs and services > Google People API
557 # > Enable), generate a Client ID and secret (APIs and
558 # Services > Credentials > Create credentials > OAuth client
559 # ID > Web application) and add your controller's /login URL
560 # (e.g., "https://zzzzz.example.com/login") as an authorized
563 # Incompatible with ForceLegacyAPI14. ProviderAppID must be
568 # Allow users to log in to existing accounts using any verified
569 # email address listed by their Google account. If true, the
570 # Google People API must be enabled in order for Google login to
571 # work. If false, only the primary email address will be used.
572 AlternateEmailAddresses: true
574 # Send additional parameters with authentication requests. See
575 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
576 # for a list of supported parameters.
577 AuthenticationRequestParameters:
578 # Show the "choose which Google account" page, even if the
579 # client is currently logged in to exactly one Google
581 prompt: select_account
586 # Authenticate with an OpenID Connect provider.
589 # Issuer URL, e.g., "https://login.example.com".
591 # This must be exactly equal to the URL returned by the issuer
592 # itself in its config response ("isser" key). If the
593 # configured value is "https://example" and the provider
594 # returns "https://example:443" or "https://example/" then
595 # login will fail, even though those URLs are equivalent
599 # Your client ID and client secret (supplied by the provider).
603 # OpenID claim field containing the user's email
604 # address. Normally "email"; see
605 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
608 # OpenID claim field containing the email verification
609 # flag. Normally "email_verified". To accept every returned
610 # email address without checking a "verified" field at all,
611 # use the empty string "".
612 EmailVerifiedClaim: "email_verified"
614 # OpenID claim field containing the user's preferred
615 # username. If empty, use the mailbox part of the user's email
619 # Send additional parameters with authentication requests,
620 # like {display: page, prompt: consent}. See
621 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
622 # and refer to your provider's documentation for supported
624 AuthenticationRequestParameters:
628 # (Experimental) Use PAM to authenticate users.
631 # PAM service name. PAM will apply the policy in the
632 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
633 # there is none, the default "other" config.
636 # Domain name (e.g., "example.com") to use to construct the
637 # user's email address if PAM authentication returns a
638 # username with no "@". If empty, use the PAM username as the
639 # user's email address, whether or not it contains "@".
641 # Note that the email address is used as the primary key for
642 # user records when logging in. Therefore, if you change
643 # PAMDefaultEmailDomain after the initial installation, you
644 # should also update existing user records to reflect the new
645 # domain. Otherwise, next time those users log in, they will
646 # be given new accounts instead of accessing their existing
648 DefaultEmailDomain: ""
651 # Use an LDAP service to authenticate users.
654 # Server URL, like "ldap://ldapserver.example.com:389" or
655 # "ldaps://ldapserver.example.com:636".
656 URL: "ldap://ldap:389"
658 # Use StartTLS upon connecting to the server.
661 # Skip TLS certificate name verification.
664 # Strip the @domain part if a user supplies an email-style
665 # username with this domain. If "*", strip any user-provided
666 # domain. If "", never strip the domain part. Example:
670 # If, after applying StripDomain, the username contains no "@"
671 # character, append this domain to form an email-style
672 # username. Example: "example.com"
675 # The LDAP attribute to filter on when looking up a username
676 # (after applying StripDomain and AppendDomain).
679 # Bind with this username (DN or UPN) and password when
680 # looking up the user record.
682 # Example user: "cn=admin,dc=example,dc=com"
684 SearchBindPassword: ""
686 # Directory base for username lookup. Example:
687 # "ou=Users,dc=example,dc=com"
690 # Additional filters to apply when looking up users' LDAP
691 # entries. This can be used to restrict access to a subset of
692 # LDAP users, or to disambiguate users from other directory
693 # entries that have the SearchAttribute present.
695 # Special characters in assertion values must be escaped (see
698 # Example: "(objectClass=person)"
701 # LDAP attribute to use as the user's email address.
703 # Important: This must not be an attribute whose value can be
704 # edited in the directory by the users themselves. Otherwise,
705 # users can take over other users' Arvados accounts trivially
706 # (email address is the primary key for Arvados accounts.)
709 # LDAP attribute to use as the preferred Arvados username. If
710 # no value is found (or this config is empty) the username
711 # originally supplied by the user will be used.
712 UsernameAttribute: uid
715 # Authenticate with a separate SSO server. (Deprecated)
718 # ProviderAppID and ProviderAppSecret are generated during SSO
720 # https://doc.arvados.org/v2.0/install/install-sso.html#update-config
722 ProviderAppSecret: ""
725 # Authenticate users listed here in the config file. This
726 # feature is intended to be used in test environments, and
727 # should not be used in production.
731 Email: alice@example.com
734 # The cluster ID to delegate the user database. When set,
735 # logins on this cluster will be redirected to the login cluster
736 # (login cluster must appear in RemoteClusters with Proxy: true)
739 # How long a cached token belonging to a remote cluster will
740 # remain valid before it needs to be revalidated.
741 RemoteTokenRefresh: 5m
743 # How long a client token created from a login flow will be valid without
744 # asking the user to re-login. Example values: 60m, 8h.
745 # Default value zero means tokens don't have expiration.
748 # When the token is returned to a client, the token itself may
749 # be restricted from manipulating other tokens based on whether
750 # the client is "trusted" or not. The local Workbench1 and
751 # Workbench2 are trusted by default, but if this is a
752 # LoginCluster, you probably want to include the other Workbench
753 # instances in the federation in this list.
756 "https://workbench.federate1.example": {}
757 "https://workbench.federate2.example": {}
760 # Path to git or gitolite-shell executable. Each authenticated
761 # request will execute this program with the single argument "http-backend"
762 GitCommand: /usr/bin/git
764 # Path to Gitolite's home directory. If a non-empty path is given,
765 # the CGI environment will be set up to support the use of
766 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
767 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
768 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
771 # Git repositories must be readable by api server, or you won't be
772 # able to submit crunch jobs. To pass the test suites, put a clone
773 # of the arvados tree in {git_repositories_dir}/arvados.git or
774 # {git_repositories_dir}/arvados/.git
775 Repositories: /var/lib/arvados/git/repositories
783 # List of supported Docker Registry image formats that compute nodes
784 # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
785 # to store an image with an unsupported format. Use an empty array
786 # to skip the compatibility check (and display a warning message to
789 # Example for sites running docker < 1.10: {"v1": {}}
790 # Example for sites running docker >= 1.10: {"v2": {}}
791 # Example for disabling check: {}
792 SupportedDockerImageFormats:
796 # Include details about job reuse decisions in the server log. This
797 # causes additional database queries to run, so it should not be
798 # enabled unless you expect to examine the resulting logs for
799 # troubleshooting purposes.
800 LogReuseDecisions: false
802 # Default value for keep_cache_ram of a container's runtime_constraints.
803 DefaultKeepCacheRAM: 268435456
805 # Number of times a container can be unlocked before being
806 # automatically cancelled.
807 MaxDispatchAttempts: 5
809 # Default value for container_count_max for container requests. This is the
810 # number of times Arvados will create a new container to satisfy a container
811 # request. If a container is cancelled it will retry a new container if
812 # container_count < container_count_max on any container requests associated
813 # with the cancelled container.
816 # The maximum number of compute nodes that can be in use simultaneously
817 # If this limit is reduced, any existing nodes with slot number >= new limit
818 # will not be counted against the new limit. In other words, the new limit
819 # won't be strictly enforced until those nodes with higher slot numbers
823 # Preemptible instance support (e.g. AWS Spot Instances)
824 # When true, child containers will get created with the preemptible
825 # scheduling parameter parameter set.
826 UsePreemptibleInstances: false
828 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
829 # (experimental) cloud dispatcher for executing containers on
830 # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
831 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
832 DispatchPrivateKey: ""
834 # Maximum time to wait for workers to come up before abandoning
835 # stale locks from a previous dispatch process.
838 # The crunch-run command used to start a container on a worker node.
840 # When dispatching to cloud VMs, this is used only if
841 # DeployRunnerBinary in the CloudVMs section is set to the empty
843 CrunchRunCommand: "crunch-run"
845 # Extra arguments to add to crunch-run invocation
846 # Example: ["--cgroup-parent-subsystem=memory"]
847 CrunchRunArgumentsList: []
849 # Extra RAM to reserve on the node, in addition to
850 # the amount specified in the container's RuntimeConstraints
851 ReserveExtraRAM: 256MiB
853 # Minimum time between two attempts to run the same container
857 # When you run the db:delete_old_container_logs task, it will find
858 # containers that have been finished for at least this many seconds,
859 # and delete their stdout, stderr, arv-mount, crunch-run, and
860 # crunchstat logs from the logs table.
863 # These two settings control how frequently log events are flushed to the
864 # database. Log lines are buffered until either crunch_log_bytes_per_event
865 # has been reached or crunch_log_seconds_between_events has elapsed since
867 LogBytesPerEvent: 4096
868 LogSecondsBetweenEvents: 5s
870 # The sample period for throttling logs.
871 LogThrottlePeriod: 60s
873 # Maximum number of bytes that job can log over crunch_log_throttle_period
874 # before being silenced until the end of the period.
875 LogThrottleBytes: 65536
877 # Maximum number of lines that job can log over crunch_log_throttle_period
878 # before being silenced until the end of the period.
879 LogThrottleLines: 1024
881 # Maximum bytes that may be logged by a single job. Log bytes that are
882 # silenced by throttling are not counted against this total.
883 LimitLogBytesPerJob: 67108864
885 LogPartialLineThrottlePeriod: 5s
887 # Container logs are written to Keep and saved in a
888 # collection, which is updated periodically while the
889 # container runs. This value sets the interval between
890 # collection updates.
893 # The log collection is also updated when the specified amount of
894 # log data (given in bytes) is produced in less than one update
900 SbatchArgumentsList: []
901 SbatchEnvironmentVariables:
904 # Path to dns server configuration directory
905 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
906 # files or touch restart.txt (see below).
909 # Template file for the dns server host snippets. See
910 # unbound.template in this directory for an example. If false, do
911 # not write any config files.
912 DNSServerConfTemplate: ""
914 # String to write to {dns_server_conf_dir}/restart.txt (with a
915 # trailing newline) after updating local data. If false, do not
916 # open or write the restart.txt file.
917 DNSServerReloadCommand: ""
919 # Command to run after each DNS update. Template variables will be
920 # substituted; see the "unbound" example below. If false, do not run
922 DNSServerUpdateCommand: ""
924 ComputeNodeDomain: ""
925 ComputeNodeNameservers:
929 # Hostname to assign to a compute node when it sends a "ping" and the
930 # hostname in its Node record is nil.
931 # During bootstrapping, the "ping" script is expected to notice the
932 # hostname given in the ping response, and update its unix hostname
934 # If false, leave the hostname alone (this is appropriate if your compute
935 # nodes' hostnames are already assigned by some other mechanism).
937 # One way or another, the hostnames of your node records should agree
938 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
940 # Example for compute0000, compute0001, ....:
941 # assign_node_hostname: compute%<slot_number>04d
942 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
943 AssignNodeHostname: "compute%<slot_number>d"
946 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
948 # Note: this only enables read-only access, creating new
949 # legacy jobs and pipelines is not supported.
951 # 'auto' -- (default) enable the Jobs API only if it has been used before
952 # (i.e., there are job records in the database)
953 # 'true' -- enable the Jobs API despite lack of existing records.
954 # 'false' -- disable the Jobs API despite presence of existing records.
957 # Git repositories must be readable by api server, or you won't be
958 # able to submit crunch jobs. To pass the test suites, put a clone
959 # of the arvados tree in {git_repositories_dir}/arvados.git or
960 # {git_repositories_dir}/arvados/.git
961 GitInternalDir: /var/lib/arvados/internal.git
964 # Enable the cloud scheduler (experimental).
967 # Name/number of port where workers' SSH services listen.
970 # Interval between queue polls.
973 # Shell command to execute on each worker to determine whether
974 # the worker is booted and ready to run containers. It should
975 # exit zero if the worker is ready.
976 BootProbeCommand: "docker ps -q"
978 # Minimum interval between consecutive probes to a single
982 # Maximum probes per second, across all workers in a pool.
983 MaxProbesPerSecond: 10
985 # Time before repeating SIGTERM when killing a container.
988 # Time to give up on a process (most likely arv-mount) that
989 # still holds a container lockfile after its main supervisor
990 # process has exited, and declare the instance broken.
991 TimeoutStaleRunLock: 5s
993 # Time to give up on SIGTERM and write off the worker.
996 # Maximum create/destroy-instance operations per second (0 =
998 MaxCloudOpsPerSecond: 0
1000 # Maximum concurrent node creation operations (0 = unlimited). This is
1001 # recommended by Azure in certain scenarios (see
1002 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image)
1003 # and can be used with other cloud providers too, if desired.
1004 MaxConcurrentInstanceCreateOps: 0
1006 # Interval between cloud provider syncs/updates ("list all
1010 # Time to leave an idle worker running (in case new containers
1011 # appear in the queue that it can run) before shutting it
1015 # Time to wait for a new worker to boot (i.e., pass
1016 # BootProbeCommand) before giving up and shutting it down.
1019 # Maximum time a worker can stay alive with no successful
1020 # probes before being automatically shut down.
1023 # Time after shutting down a worker to retry the
1024 # shutdown/destroy operation.
1025 TimeoutShutdown: 10s
1027 # Worker VM image ID.
1028 # (aws) AMI identifier
1029 # (azure) managed disks: the name of the managed disk image
1030 # (azure) shared image gallery: the name of the image definition. Also
1031 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1032 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1033 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1036 # An executable file (located on the dispatcher host) to be
1037 # copied to cloud instances at runtime and used as the
1038 # container runner/supervisor. The default value is the
1039 # dispatcher program itself.
1041 # Use the empty string to disable this step: nothing will be
1042 # copied, and cloud instances are assumed to have a suitable
1043 # version of crunch-run installed; see CrunchRunCommand above.
1044 DeployRunnerBinary: "/proc/self/exe"
1046 # Tags to add on all resources (VMs, NICs, disks) created by
1047 # the container dispatcher. (Arvados's own tags --
1048 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1053 # Prefix for predefined tags used by Arvados (InstanceSetID,
1054 # InstanceType, InstanceSecret, IdleBehavior). With the
1055 # default value "Arvados", tags are "ArvadosInstanceSetID",
1056 # "ArvadosInstanceSecret", etc.
1058 # This should only be changed while no cloud resources are in
1059 # use and the cloud dispatcher is not running. Otherwise,
1060 # VMs/resources that were added using the old tag prefix will
1061 # need to be detected and cleaned up manually.
1062 TagKeyPrefix: Arvados
1064 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1067 # Cloud-specific driver parameters.
1070 # (ec2) Credentials. Omit or leave blank if using IAM role.
1074 # (ec2) Instance configuration.
1080 AdminUsername: debian
1082 # (azure) Credentials.
1088 # (azure) Instance configuration.
1089 CloudEnvironment: AzurePublicCloud
1092 # (azure) The resource group where the VM and virtual NIC will be
1096 # (azure) The resource group of the Network to use for the virtual
1097 # NIC (if different from ResourceGroup)
1098 NetworkResourceGroup: ""
1102 # (azure) managed disks: The resource group where the managed disk
1103 # image can be found (if different from ResourceGroup).
1104 ImageResourceGroup: ""
1106 # (azure) shared image gallery: the name of the gallery
1107 SharedImageGalleryName: ""
1108 # (azure) shared image gallery: the version of the image definition
1109 SharedImageGalleryImageVersion: ""
1111 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1115 # (azure) How long to wait before deleting VHD and NIC
1116 # objects that are no longer being used.
1117 DeleteDanglingResourcesAfter: 20s
1119 # Account (that already exists in the VM image) that will be
1120 # set up with an ssh authorized key to allow the compute
1121 # dispatcher to connect.
1122 AdminUsername: arvados
1126 # Use the instance type name as the key (in place of "SAMPLE" in
1127 # this sample entry).
1129 # Cloud provider's instance type. Defaults to the configured type name.
1133 IncludedScratch: 16GB
1140 # AccessViaHosts specifies which keepstore processes can read
1141 # and write data on the volume.
1143 # For a local filesystem, AccessViaHosts has one entry,
1144 # indicating which server the filesystem is located on.
1146 # For a network-attached backend accessible by all keepstore
1147 # servers, like a cloud storage bucket or an NFS mount,
1148 # AccessViaHosts can be empty/omitted.
1150 # Further info/examples:
1151 # https://doc.arvados.org/install/configure-fs-storage.html
1152 # https://doc.arvados.org/install/configure-s3-object-storage.html
1153 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1157 "http://host1.example:25107": {}
1165 # for s3 driver -- see
1166 # https://doc.arvados.org/install/configure-s3-object-storage.html
1173 LocationConstraint: false
1179 # Use aws-s3-go (v2) instead of goamz
1180 UseAWSS3v2Driver: false
1182 # For S3 driver, potentially unsafe tuning parameter,
1183 # intentionally excluded from main documentation.
1185 # Enable deletion (garbage collection) even when the
1186 # configured BlobTrashLifetime is zero. WARNING: eventual
1187 # consistency may result in race conditions that can cause
1188 # data loss. Do not enable this unless you understand and
1192 # for azure driver -- see
1193 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1194 StorageAccountName: aaaaa
1195 StorageAccountKey: aaaaa
1196 StorageBaseURL: core.windows.net
1197 ContainerName: aaaaa
1199 ListBlobsRetryDelay: 10s
1200 ListBlobsMaxAttempts: 10
1202 WriteRaceInterval: 15s
1203 WriteRacePollTime: 1s
1205 # for local directory driver -- see
1206 # https://doc.arvados.org/install/configure-fs-storage.html
1207 Root: /var/lib/arvados/keep-data
1209 # For local directory driver, potentially confusing tuning
1210 # parameter, intentionally excluded from main documentation.
1212 # When true, read and write operations (for whole 64MiB
1213 # blocks) on an individual volume will queued and issued
1214 # serially. When false, read and write operations will be
1215 # issued concurrently.
1217 # May possibly improve throughput if you have physical spinning disks
1218 # and experience contention when there are multiple requests
1219 # to the same volume.
1221 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1222 # should leave this alone.
1228 SendUserSetupNotificationEmail: true
1230 # Bug/issue report notification to and from addresses
1231 IssueReporterEmailFrom: "arvados@example.com"
1232 IssueReporterEmailTo: "arvados@example.com"
1233 SupportEmailAddress: "arvados@example.com"
1235 # Generic issue email from
1236 EmailFrom: "arvados@example.com"
1243 ActivateUsers: false
1245 # API endpoint host or host:port; default is {id}.arvadosapi.com
1246 Host: sample.arvadosapi.com
1248 # Perform a proxy request when a local client requests an
1249 # object belonging to this remote.
1252 # Default "https". Can be set to "http" for testing.
1255 # Disable TLS verify. Can be set to true for testing.
1258 # When users present tokens issued by this remote cluster, and
1259 # their accounts are active on the remote cluster, activate
1260 # them on this cluster too.
1261 ActivateUsers: false
1264 # Workbench1 configs
1266 ActivationContactLink: mailto:info@arvados.org
1267 ArvadosDocsite: https://doc.arvados.org
1268 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1269 ShowUserAgreementInline: false
1272 # Scratch directory used by the remote repository browsing
1273 # feature. If it doesn't exist, it (and any missing parents) will be
1274 # created using mkdir_p.
1275 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1277 # Below is a sample setting of user_profile_form_fields config parameter.
1278 # This configuration parameter should be set to either false (to disable) or
1279 # to a map as shown below.
1280 # Configure the map of input fields to be displayed in the profile page
1281 # using the attribute "key" for each of the input fields.
1282 # This sample shows configuration with one required and one optional form fields.
1283 # For each of these input fields:
1284 # You can specify "Type" as "text" or "select".
1285 # List the "Options" to be displayed for each of the "select" menu.
1286 # Set "Required" as "true" for any of these fields to make them required.
1287 # If any of the required fields are missing in the user's profile, the user will be
1288 # redirected to the profile page before they can access any Workbench features.
1289 UserProfileFormFields:
1292 FormFieldTitle: Best color
1293 FormFieldDescription: your favorite color
1302 # exampleTextValue: # key that will be set in properties
1304 # FormFieldTitle: ""
1305 # FormFieldDescription: ""
1308 # exampleOptionsValue:
1310 # FormFieldTitle: ""
1311 # FormFieldDescription: ""
1319 # Use "UserProfileFormMessage to configure the message you want
1320 # to display on the profile page.
1321 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1323 # Mimetypes of applications for which the view icon
1324 # would be enabled in a collection's show page.
1325 # It is sufficient to list only applications here.
1326 # No need to list text and image types.
1327 ApplicationMimetypesWithViewIcon:
1345 # The maximum number of bytes to load in the log viewer
1346 LogViewerMaxBytes: 1M
1348 # When anonymous_user_token is configured, show public projects page
1349 EnablePublicProjectsPage: true
1351 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1352 EnableGettingStartedPopup: false
1354 # Ask Arvados API server to compress its response payloads.
1355 APIResponseCompression: true
1357 # Timeouts for API requests.
1358 APIClientConnectTimeout: 2m
1359 APIClientReceiveTimeout: 5m
1361 # Maximum number of historic log records of a running job to fetch
1362 # and display in the Log tab, while subscribing to web sockets.
1363 RunningJobLogRecordsToFetch: 2000
1365 # In systems with many shared projects, loading of dashboard and topnav
1366 # can be slow due to collections indexing; use the following parameters
1367 # to suppress these properties
1368 ShowRecentCollectionsOnDashboard: true
1369 ShowUserNotifications: true
1371 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1372 # a link to the multi-site search page on a "home" Workbench site.
1375 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1378 # Should workbench allow management of local git repositories? Set to false if
1379 # the jobs api is disabled and there are no local git repositories.
1382 SiteName: Arvados Workbench
1383 ProfilingEnabled: false
1385 # This is related to obsolete Google OpenID 1.0 login
1386 # but some workbench stuff still expects it to be set.
1387 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1389 # Workbench2 configs
1391 FileViewersConfigURL: ""
1393 # Idle time after which the user's session will be auto closed.
1394 # This feature is disabled when set to zero.
1397 # Workbench welcome screen, this is HTML text that will be
1398 # incorporated directly onto the page.
1400 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1401 <h2>Please log in.</h2>
1403 <p>The "Log in" button below will show you a sign-in
1404 page. After you log in, you will be redirected back to
1405 Arvados Workbench.</p>
1407 <p>If you have never used Arvados Workbench before, logging in
1408 for the first time will automatically create a new
1411 <i>Arvados Workbench uses your name and email address only for
1412 identification, and does not retrieve any other personal
1415 # Workbench screen displayed to inactive users. This is HTML
1416 # text that will be incorporated directly onto the page.
1418 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1419 <h3>Hi! You're logged in, but...</h3>
1420 <p>Your account is inactive.</p>
1421 <p>An administrator must activate your account before you can get
1424 # Connecting to Arvados shell VMs tends to be site-specific.
1425 # Put any special instructions here. This is HTML text that will
1426 # be incorporated directly onto the Workbench page.
1428 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1429 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1431 # Sample text if you are using a "switchyard" ssh proxy.
1432 # Replace "zzzzz" with your Cluster ID.
1434 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1437 # ServerAliveInterval 60
1438 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1441 # If you are using a switchyard ssh proxy, shell node hostnames
1442 # may require a special hostname suffix. In the sample ssh
1443 # configuration above, this would be ".zzzzz"
1444 # This is added to the hostname in the "command line" column
1445 # the Workbench "shell VMs" page.
1447 # If your shell nodes are directly accessible by users without a
1448 # proxy and have fully qualified host names, you should leave
1450 SSHHelpHostSuffix: ""
1452 # Bypass new (Arvados 1.5) API implementations, and hand off
1453 # requests directly to Rails instead. This can provide a temporary
1454 # workaround for clients that are incompatible with the new API
1455 # implementation. Note that it also disables some new federation
1456 # features and will be removed in a future release.
1457 ForceLegacyAPI14: false
1459 # (Experimental) Restart services automatically when config file
1460 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1462 AutoReloadConfig: false