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
156 # max concurrent connections per arvados server daemon
159 # All parameters here are passed to the PG client library in a connection string;
160 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
168 # Maximum size (in bytes) allowed for a single API request. This
169 # limit is published in the discovery document for use by clients.
170 # Note: You must separately configure the upstream web server or
171 # proxy to actually enforce the desired maximum request size on the
173 MaxRequestSize: 134217728
175 # Limit the number of bytes read from the database during an index
176 # request (by retrieving and returning fewer rows than would
177 # normally be returned in a single response).
178 # Note 1: This setting never reduces the number of returned rows to
179 # zero, no matter how big the first data row is.
180 # Note 2: Currently, this is only checked against a specific set of
181 # columns that tend to get large (collections.manifest_text,
182 # containers.mounts, workflows.definition). Other fields (e.g.,
183 # "properties" hashes) are not counted against this limit.
184 MaxIndexDatabaseRead: 134217728
186 # Maximum number of items to return when responding to a APIs that
187 # can return partial result sets using limit and offset parameters
188 # (e.g., *.index, groups.contents). If a request specifies a "limit"
189 # parameter higher than this value, this value is used instead.
190 MaxItemsPerResponse: 1000
192 # Maximum number of concurrent requests to accept in a single
193 # service process, or 0 for no limit.
194 MaxConcurrentRequests: 0
196 # Maximum number of 64MiB memory buffers per Keepstore server process, or
197 # 0 for no limit. When this limit is reached, up to
198 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
199 # buffers (like GET and PUT) will wait for buffer space to be released.
200 # Any HTTP requests beyond MaxConcurrentRequests will receive an
201 # immediate 503 response.
203 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
204 # * 1.1) fits comfortably in memory. On a host dedicated to running
205 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
206 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
207 # kB, compute 7125440 / (88 * 1024)=79 and configure MaxBuffers: 79
208 MaxKeepBlobBuffers: 128
210 # API methods to disable. Disabled methods are not listed in the
211 # discovery document, and respond 404 to all requests.
212 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
215 # Interval (seconds) between asynchronous permission view updates. Any
216 # permission-updating API called with the 'async' parameter schedules a an
217 # update on the permission view in the future, if not already scheduled.
218 AsyncPermissionsUpdateInterval: 20s
220 # Maximum number of concurrent outgoing requests to make while
221 # serving a single incoming multi-cluster (federated) request.
222 MaxRequestAmplification: 4
224 # RailsSessionSecretToken is a string of alphanumeric characters
225 # used by Rails to sign session tokens. IMPORTANT: This is a
226 # site secret. It should be at least 50 characters.
227 RailsSessionSecretToken: ""
229 # Maximum wall clock time to spend handling an incoming request.
232 # Websocket will send a periodic empty event after 'SendTimeout'
233 # if there is no other activity to maintain the connection /
234 # detect dropped connections.
237 WebsocketClientEventQueue: 64
238 WebsocketServerEventQueue: 4
240 # Timeout on requests to internal Keep services.
241 KeepServiceRequestTimeout: 15s
244 # Config parameters to automatically setup new users. If enabled,
245 # this users will be able to self-activate. Enable this if you want
246 # to run an open instance where anyone can create an account and use
247 # the system without requiring manual approval.
249 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
250 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
251 AutoSetupNewUsers: false
252 AutoSetupNewUsersWithVmUUID: ""
253 AutoSetupNewUsersWithRepository: false
254 AutoSetupUsernameBlacklist:
263 # When NewUsersAreActive is set to true, new users will be active
264 # immediately. This skips the "self-activate" step which enforces
265 # user agreements. Should only be enabled for development.
266 NewUsersAreActive: false
268 # The e-mail address of the user you would like to become marked as an admin
269 # user on their first login.
270 # In the default configuration, authentication happens through the Arvados SSO
271 # server, which uses OAuth2 against Google's servers, so in that case this
272 # should be an address associated with a Google account.
273 AutoAdminUserWithEmail: ""
275 # If AutoAdminFirstUser is set to true, the first user to log in when no
276 # other admin users exist will automatically become an admin user.
277 AutoAdminFirstUser: false
279 # Email address to notify whenever a user creates a profile for the
281 UserProfileNotificationAddress: ""
282 AdminNotifierEmailFrom: arvados@example.com
283 EmailSubjectPrefix: "[ARVADOS] "
284 UserNotifierEmailFrom: arvados@example.com
285 NewUserNotificationRecipients: {}
286 NewInactiveUserNotificationRecipients: {}
288 # Set AnonymousUserToken to enable anonymous user access. You can get
289 # the token by running "bundle exec ./script/get_anonymous_user_token.rb"
290 # in the directory where your API server is running.
291 AnonymousUserToken: ""
293 # If a new user has an alternate email address (local@domain)
294 # with the domain given here, its local part becomes the new
295 # user's default username. Otherwise, the user's primary email
297 PreferDomainForUsername: ""
300 # Time to keep audit logs, in seconds. (An audit log is a row added
301 # to the "logs" table in the PostgreSQL database each time an
302 # Arvados object is created, modified, or deleted.)
304 # Currently, websocket event notifications rely on audit logs, so
305 # this should not be set lower than 300 (5 minutes).
308 # Maximum number of log rows to delete in a single SQL transaction.
310 # If MaxDeleteBatch is 0, log entries will never be
311 # deleted by Arvados. Cleanup can be done by an external process
312 # without affecting any Arvados system processes, as long as very
313 # recent (<5 minutes old) logs are not deleted.
315 # 100000 is a reasonable batch size for most sites.
318 # Attributes to suppress in events and audit logs. Notably,
319 # specifying {"manifest_text": {}} here typically makes the database
320 # smaller and faster.
322 # Warning: Using any non-empty value here can have undesirable side
323 # effects for any client or component that relies on event logs.
324 # Use at your own risk.
325 UnloggedAttributes: {}
329 # Logging threshold: panic, fatal, error, warn, info, debug, or
333 # Logging format: json or text
336 # Maximum characters of (JSON-encoded) query parameters to include
337 # in each request log entry. When params exceed this size, they will
338 # be JSON-encoded, truncated to this size, and logged as
340 MaxRequestLogParamsSize: 2000
344 # Enable access controls for data stored in Keep. This should
345 # always be set to true on a production cluster.
348 # BlobSigningKey is a string of alphanumeric characters used to
349 # generate permission signatures for Keep locators. It must be
350 # identical to the permission key given to Keep. IMPORTANT: This
351 # is a site secret. It should be at least 50 characters.
353 # Modifying BlobSigningKey will invalidate all existing
354 # signatures, which can cause programs to fail (e.g., arv-put,
355 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
356 # when no such processes are running.
359 # Enable garbage collection of unreferenced blobs in Keep.
362 # Time to leave unreferenced blobs in "trashed" state before
363 # deleting them, or 0 to skip the "trashed" state entirely and
364 # delete unreferenced blobs.
366 # If you use any Amazon S3 buckets as storage volumes, this
367 # must be at least 24h to avoid occasional data loss.
368 BlobTrashLifetime: 336h
370 # How often to check for (and delete) trashed blocks whose
371 # BlobTrashLifetime has expired.
372 BlobTrashCheckInterval: 24h
374 # Maximum number of concurrent "trash blob" and "delete trashed
375 # blob" operations conducted by a single keepstore process. Each
376 # of these can be set to 0 to disable the respective operation.
378 # If BlobTrashLifetime is zero, "trash" and "delete trash"
379 # happen at once, so only the lower of these two values is used.
380 BlobTrashConcurrency: 4
381 BlobDeleteConcurrency: 4
383 # Maximum number of concurrent "create additional replica of
384 # existing blob" operations conducted by a single keepstore
386 BlobReplicateConcurrency: 4
388 # Default replication level for collections. This is used when a
389 # collection's replication_desired attribute is nil.
390 DefaultReplication: 2
392 # BlobSigningTTL determines the minimum lifetime of transient
393 # data, i.e., blocks that are not referenced by
394 # collections. Unreferenced blocks exist for two reasons:
396 # 1) A data block must be written to a disk/cloud backend device
397 # before a collection can be created/updated with a reference to
400 # 2) Deleting or updating a collection can remove the last
401 # remaining reference to a data block.
403 # If BlobSigningTTL is too short, long-running
404 # processes/containers will fail when they take too long (a)
405 # between writing blocks and writing collections that reference
406 # them, or (b) between reading collections and reading the
409 # If BlobSigningTTL is too long, data will still be stored long
410 # after the referring collections are deleted, and you will
411 # needlessly fill up disks or waste money on cloud storage.
413 # Modifying BlobSigningTTL invalidates existing signatures; see
414 # BlobSigningKey note above.
416 # The default is 2 weeks.
419 # When running keep-balance, this is the destination filename for
420 # the list of lost block hashes if there are any, one per line.
421 # Updated automically during each successful run.
422 BlobMissingReport: ""
424 # keep-balance operates periodically, i.e.: do a
425 # scan/balance operation, sleep, repeat.
427 # BalancePeriod determines the interval between start times of
428 # successive scan/balance operations. If a scan/balance operation
429 # takes longer than RunPeriod, the next one will follow it
432 # If SIGUSR1 is received during an idle period between operations,
433 # the next operation will start immediately.
436 # Limits the number of collections retrieved by keep-balance per
437 # API transaction. If this is zero, page size is
438 # determined by the API server's own page size limits (see
439 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
440 BalanceCollectionBatch: 0
442 # The size of keep-balance's internal queue of
443 # collections. Higher values use more memory and improve throughput
444 # by allowing keep-balance to fetch the next page of collections
445 # while the current page is still being processed. If this is zero
446 # or omitted, pages are processed serially.
447 BalanceCollectionBuffers: 1000
449 # Default lifetime for ephemeral collections: 2 weeks. This must not
450 # be less than BlobSigningTTL.
451 DefaultTrashLifetime: 336h
453 # Interval (seconds) between trash sweeps. During a trash sweep,
454 # collections are marked as trash if their trash_at time has
455 # arrived, and deleted if their delete_at time has arrived.
456 TrashSweepInterval: 60s
458 # If true, enable collection versioning.
459 # When a collection's preserve_version field is true or the current version
460 # is older than the amount of seconds defined on PreserveVersionIfIdle,
461 # a snapshot of the collection's previous state is created and linked to
462 # the current collection.
463 CollectionVersioning: false
465 # 0s = auto-create a new version on every update.
466 # -1s = never auto-create new versions.
467 # > 0s = auto-create a new version when older than the specified number of seconds.
468 PreserveVersionIfIdle: -1s
470 # If non-empty, allow project and collection names to contain
471 # the "/" character (slash/stroke/solidus), and replace "/" with
472 # the given string in the filesystem hierarchy presented by
473 # WebDAV. Example values are "%2f" and "{slash}". Names that
474 # contain the substitution string itself may result in confusing
475 # behavior, so a value like "_" is not recommended.
477 # If the default empty value is used, the server will reject
478 # requests to create or rename a collection when the new name
481 # If the value "/" is used, project and collection names
482 # containing "/" will be allowed, but they will not be
483 # accessible via WebDAV.
485 # Use of this feature is not recommended, if it can be avoided.
486 ForwardSlashNameSubstitution: ""
488 # Managed collection properties. At creation time, if the client didn't
489 # provide the listed keys, they will be automatically populated following
490 # one of the following behaviors:
492 # * UUID of the user who owns the containing project.
493 # responsible_person_uuid: {Function: original_owner, Protected: true}
495 # * Default concrete value.
496 # foo_bar: {Value: baz, Protected: false}
498 # If Protected is true, only an admin user can modify its value.
500 SAMPLE: {Function: original_owner, Protected: true}
502 # In "trust all content" mode, Workbench will redirect download
503 # requests to WebDAV preview link, even in the cases when
504 # WebDAV would have to expose XSS vulnerabilities in order to
505 # handle the redirect (see discussion on Services.WebDAV).
507 # This setting has no effect in the recommended configuration,
508 # where the WebDAV is configured to have a separate domain for
509 # every collection; in this case XSS protection is provided by
510 # browsers' same-origin policy.
512 # The default setting (false) is appropriate for a multi-user site.
513 TrustAllContent: false
515 # Cache parameters for WebDAV content serving:
516 # * TTL: Maximum time to cache manifests and permission checks.
517 # * UUIDTTL: Maximum time to cache collection state.
518 # * MaxBlockEntries: Maximum number of block cache entries.
519 # * MaxCollectionEntries: Maximum number of collection cache entries.
520 # * MaxCollectionBytes: Approximate memory limit for collection cache.
521 # * MaxPermissionEntries: Maximum number of permission cache entries.
522 # * MaxUUIDEntries: Maximum number of UUID cache entries.
527 MaxCollectionEntries: 1000
528 MaxCollectionBytes: 100000000
529 MaxPermissionEntries: 1000
533 # One of the following mechanisms (SSO, Google, PAM, LDAP, or
534 # LoginCluster) should be enabled; see
535 # https://doc.arvados.org/install/setup-login.html
538 # Authenticate with Google.
541 # Use the Google Cloud console to enable the People API (APIs
542 # and Services > Enable APIs and services > Google People API
543 # > Enable), generate a Client ID and secret (APIs and
544 # Services > Credentials > Create credentials > OAuth client
545 # ID > Web application) and add your controller's /login URL
546 # (e.g., "https://zzzzz.example.com/login") as an authorized
549 # Incompatible with ForceLegacyAPI14. ProviderAppID must be
554 # Allow users to log in to existing accounts using any verified
555 # email address listed by their Google account. If true, the
556 # Google People API must be enabled in order for Google login to
557 # work. If false, only the primary email address will be used.
558 AlternateEmailAddresses: true
561 # Authenticate with an OpenID Connect provider.
564 # Issuer URL, e.g., "https://login.example.com".
566 # This must be exactly equal to the URL returned by the issuer
567 # itself in its config response ("isser" key). If the
568 # configured value is "https://example" and the provider
569 # returns "https://example:443" or "https://example/" then
570 # login will fail, even though those URLs are equivalent
574 # Your client ID and client secret (supplied by the provider).
578 # OpenID claim field containing the user's email
579 # address. Normally "email"; see
580 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
583 # OpenID claim field containing the email verification
584 # flag. Normally "email_verified". To accept every returned
585 # email address without checking a "verified" field at all,
586 # use the empty string "".
587 EmailVerifiedClaim: "email_verified"
589 # OpenID claim field containing the user's preferred
590 # username. If empty, use the mailbox part of the user's email
595 # (Experimental) Use PAM to authenticate users.
598 # PAM service name. PAM will apply the policy in the
599 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
600 # there is none, the default "other" config.
603 # Domain name (e.g., "example.com") to use to construct the
604 # user's email address if PAM authentication returns a
605 # username with no "@". If empty, use the PAM username as the
606 # user's email address, whether or not it contains "@".
608 # Note that the email address is used as the primary key for
609 # user records when logging in. Therefore, if you change
610 # PAMDefaultEmailDomain after the initial installation, you
611 # should also update existing user records to reflect the new
612 # domain. Otherwise, next time those users log in, they will
613 # be given new accounts instead of accessing their existing
615 DefaultEmailDomain: ""
618 # Use an LDAP service to authenticate users.
621 # Server URL, like "ldap://ldapserver.example.com:389" or
622 # "ldaps://ldapserver.example.com:636".
623 URL: "ldap://ldap:389"
625 # Use StartTLS upon connecting to the server.
628 # Skip TLS certificate name verification.
631 # Strip the @domain part if a user supplies an email-style
632 # username with this domain. If "*", strip any user-provided
633 # domain. If "", never strip the domain part. Example:
637 # If, after applying StripDomain, the username contains no "@"
638 # character, append this domain to form an email-style
639 # username. Example: "example.com"
642 # The LDAP attribute to filter on when looking up a username
643 # (after applying StripDomain and AppendDomain).
646 # Bind with this username (DN or UPN) and password when
647 # looking up the user record.
649 # Example user: "cn=admin,dc=example,dc=com"
651 SearchBindPassword: ""
653 # Directory base for username lookup. Example:
654 # "ou=Users,dc=example,dc=com"
657 # Additional filters to apply when looking up users' LDAP
658 # entries. This can be used to restrict access to a subset of
659 # LDAP users, or to disambiguate users from other directory
660 # entries that have the SearchAttribute present.
662 # Special characters in assertion values must be escaped (see
665 # Example: "(objectClass=person)"
668 # LDAP attribute to use as the user's email address.
670 # Important: This must not be an attribute whose value can be
671 # edited in the directory by the users themselves. Otherwise,
672 # users can take over other users' Arvados accounts trivially
673 # (email address is the primary key for Arvados accounts.)
676 # LDAP attribute to use as the preferred Arvados username. If
677 # no value is found (or this config is empty) the username
678 # originally supplied by the user will be used.
679 UsernameAttribute: uid
682 # Authenticate with a separate SSO server. (Deprecated)
685 # ProviderAppID and ProviderAppSecret are generated during SSO
687 # https://doc.arvados.org/v2.0/install/install-sso.html#update-config
689 ProviderAppSecret: ""
691 # The cluster ID to delegate the user database. When set,
692 # logins on this cluster will be redirected to the login cluster
693 # (login cluster must appear in RemoteClusters with Proxy: true)
696 # How long a cached token belonging to a remote cluster will
697 # remain valid before it needs to be revalidated.
698 RemoteTokenRefresh: 5m
701 # Path to git or gitolite-shell executable. Each authenticated
702 # request will execute this program with the single argument "http-backend"
703 GitCommand: /usr/bin/git
705 # Path to Gitolite's home directory. If a non-empty path is given,
706 # the CGI environment will be set up to support the use of
707 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
708 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
709 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
712 # Git repositories must be readable by api server, or you won't be
713 # able to submit crunch jobs. To pass the test suites, put a clone
714 # of the arvados tree in {git_repositories_dir}/arvados.git or
715 # {git_repositories_dir}/arvados/.git
716 Repositories: /var/lib/arvados/git/repositories
724 # List of supported Docker Registry image formats that compute nodes
725 # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
726 # to store an image with an unsupported format. Use an empty array
727 # to skip the compatibility check (and display a warning message to
730 # Example for sites running docker < 1.10: {"v1": {}}
731 # Example for sites running docker >= 1.10: {"v2": {}}
732 # Example for disabling check: {}
733 SupportedDockerImageFormats:
737 # Include details about job reuse decisions in the server log. This
738 # causes additional database queries to run, so it should not be
739 # enabled unless you expect to examine the resulting logs for
740 # troubleshooting purposes.
741 LogReuseDecisions: false
743 # Default value for keep_cache_ram of a container's runtime_constraints.
744 DefaultKeepCacheRAM: 268435456
746 # Number of times a container can be unlocked before being
747 # automatically cancelled.
748 MaxDispatchAttempts: 5
750 # Default value for container_count_max for container requests. This is the
751 # number of times Arvados will create a new container to satisfy a container
752 # request. If a container is cancelled it will retry a new container if
753 # container_count < container_count_max on any container requests associated
754 # with the cancelled container.
757 # The maximum number of compute nodes that can be in use simultaneously
758 # If this limit is reduced, any existing nodes with slot number >= new limit
759 # will not be counted against the new limit. In other words, the new limit
760 # won't be strictly enforced until those nodes with higher slot numbers
764 # Preemptible instance support (e.g. AWS Spot Instances)
765 # When true, child containers will get created with the preemptible
766 # scheduling parameter parameter set.
767 UsePreemptibleInstances: false
769 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
770 # (experimental) cloud dispatcher for executing containers on
771 # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
772 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
773 DispatchPrivateKey: ""
775 # Maximum time to wait for workers to come up before abandoning
776 # stale locks from a previous dispatch process.
779 # The crunch-run command to manage the container on a node
780 CrunchRunCommand: "crunch-run"
782 # Extra arguments to add to crunch-run invocation
783 # Example: ["--cgroup-parent-subsystem=memory"]
784 CrunchRunArgumentsList: []
786 # Extra RAM to reserve on the node, in addition to
787 # the amount specified in the container's RuntimeConstraints
788 ReserveExtraRAM: 256MiB
790 # Minimum time between two attempts to run the same container
794 # When you run the db:delete_old_container_logs task, it will find
795 # containers that have been finished for at least this many seconds,
796 # and delete their stdout, stderr, arv-mount, crunch-run, and
797 # crunchstat logs from the logs table.
800 # These two settings control how frequently log events are flushed to the
801 # database. Log lines are buffered until either crunch_log_bytes_per_event
802 # has been reached or crunch_log_seconds_between_events has elapsed since
804 LogBytesPerEvent: 4096
805 LogSecondsBetweenEvents: 5s
807 # The sample period for throttling logs.
808 LogThrottlePeriod: 60s
810 # Maximum number of bytes that job can log over crunch_log_throttle_period
811 # before being silenced until the end of the period.
812 LogThrottleBytes: 65536
814 # Maximum number of lines that job can log over crunch_log_throttle_period
815 # before being silenced until the end of the period.
816 LogThrottleLines: 1024
818 # Maximum bytes that may be logged by a single job. Log bytes that are
819 # silenced by throttling are not counted against this total.
820 LimitLogBytesPerJob: 67108864
822 LogPartialLineThrottlePeriod: 5s
824 # Container logs are written to Keep and saved in a
825 # collection, which is updated periodically while the
826 # container runs. This value sets the interval between
827 # collection updates.
830 # The log collection is also updated when the specified amount of
831 # log data (given in bytes) is produced in less than one update
837 SbatchArgumentsList: []
838 SbatchEnvironmentVariables:
841 # Path to dns server configuration directory
842 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
843 # files or touch restart.txt (see below).
846 # Template file for the dns server host snippets. See
847 # unbound.template in this directory for an example. If false, do
848 # not write any config files.
849 DNSServerConfTemplate: ""
851 # String to write to {dns_server_conf_dir}/restart.txt (with a
852 # trailing newline) after updating local data. If false, do not
853 # open or write the restart.txt file.
854 DNSServerReloadCommand: ""
856 # Command to run after each DNS update. Template variables will be
857 # substituted; see the "unbound" example below. If false, do not run
859 DNSServerUpdateCommand: ""
861 ComputeNodeDomain: ""
862 ComputeNodeNameservers:
866 # Hostname to assign to a compute node when it sends a "ping" and the
867 # hostname in its Node record is nil.
868 # During bootstrapping, the "ping" script is expected to notice the
869 # hostname given in the ping response, and update its unix hostname
871 # If false, leave the hostname alone (this is appropriate if your compute
872 # nodes' hostnames are already assigned by some other mechanism).
874 # One way or another, the hostnames of your node records should agree
875 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
877 # Example for compute0000, compute0001, ....:
878 # assign_node_hostname: compute%<slot_number>04d
879 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
880 AssignNodeHostname: "compute%<slot_number>d"
883 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
885 # Note: this only enables read-only access, creating new
886 # legacy jobs and pipelines is not supported.
888 # 'auto' -- (default) enable the Jobs API only if it has been used before
889 # (i.e., there are job records in the database)
890 # 'true' -- enable the Jobs API despite lack of existing records.
891 # 'false' -- disable the Jobs API despite presence of existing records.
894 # Git repositories must be readable by api server, or you won't be
895 # able to submit crunch jobs. To pass the test suites, put a clone
896 # of the arvados tree in {git_repositories_dir}/arvados.git or
897 # {git_repositories_dir}/arvados/.git
898 GitInternalDir: /var/lib/arvados/internal.git
901 # Enable the cloud scheduler (experimental).
904 # Name/number of port where workers' SSH services listen.
907 # Interval between queue polls.
910 # Shell command to execute on each worker to determine whether
911 # the worker is booted and ready to run containers. It should
912 # exit zero if the worker is ready.
913 BootProbeCommand: "docker ps -q"
915 # Minimum interval between consecutive probes to a single
919 # Maximum probes per second, across all workers in a pool.
920 MaxProbesPerSecond: 10
922 # Time before repeating SIGTERM when killing a container.
925 # Time to give up on SIGTERM and write off the worker.
928 # Maximum create/destroy-instance operations per second (0 =
930 MaxCloudOpsPerSecond: 0
932 # Interval between cloud provider syncs/updates ("list all
936 # Time to leave an idle worker running (in case new containers
937 # appear in the queue that it can run) before shutting it
941 # Time to wait for a new worker to boot (i.e., pass
942 # BootProbeCommand) before giving up and shutting it down.
945 # Maximum time a worker can stay alive with no successful
946 # probes before being automatically shut down.
949 # Time after shutting down a worker to retry the
950 # shutdown/destroy operation.
953 # Worker VM image ID.
956 # An executable file (located on the dispatcher host) to be
957 # copied to cloud instances at runtime and used as the
958 # container runner/supervisor. The default value is the
959 # dispatcher program itself.
961 # Use the empty string to disable this step: nothing will be
962 # copied, and cloud instances are assumed to have a suitable
963 # version of crunch-run installed.
964 DeployRunnerBinary: "/proc/self/exe"
966 # Tags to add on all resources (VMs, NICs, disks) created by
967 # the container dispatcher. (Arvados's own tags --
968 # InstanceType, IdleBehavior, and InstanceSecret -- will also
973 # Prefix for predefined tags used by Arvados (InstanceSetID,
974 # InstanceType, InstanceSecret, IdleBehavior). With the
975 # default value "Arvados", tags are "ArvadosInstanceSetID",
976 # "ArvadosInstanceSecret", etc.
978 # This should only be changed while no cloud resources are in
979 # use and the cloud dispatcher is not running. Otherwise,
980 # VMs/resources that were added using the old tag prefix will
981 # need to be detected and cleaned up manually.
982 TagKeyPrefix: Arvados
984 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
987 # Cloud-specific driver parameters.
994 # (ec2) Instance configuration.
1000 AdminUsername: debian
1002 # (azure) Credentials.
1008 # (azure) Instance configuration.
1009 CloudEnvironment: AzurePublicCloud
1016 DeleteDanglingResourcesAfter: 20s
1017 AdminUsername: arvados
1021 # Use the instance type name as the key (in place of "SAMPLE" in
1022 # this sample entry).
1024 # Cloud provider's instance type. Defaults to the configured type name.
1028 IncludedScratch: 16GB
1035 # AccessViaHosts specifies which keepstore processes can read
1036 # and write data on the volume.
1038 # For a local filesystem, AccessViaHosts has one entry,
1039 # indicating which server the filesystem is located on.
1041 # For a network-attached backend accessible by all keepstore
1042 # servers, like a cloud storage bucket or an NFS mount,
1043 # AccessViaHosts can be empty/omitted.
1045 # Further info/examples:
1046 # https://doc.arvados.org/install/configure-fs-storage.html
1047 # https://doc.arvados.org/install/configure-s3-object-storage.html
1048 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1052 "http://host1.example:25107": {}
1060 # for s3 driver -- see
1061 # https://doc.arvados.org/install/configure-s3-object-storage.html
1068 LocationConstraint: false
1075 # For S3 driver, potentially unsafe tuning parameter,
1076 # intentionally excluded from main documentation.
1078 # Enable deletion (garbage collection) even when the
1079 # configured BlobTrashLifetime is zero. WARNING: eventual
1080 # consistency may result in race conditions that can cause
1081 # data loss. Do not enable this unless you understand and
1085 # for azure driver -- see
1086 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1087 StorageAccountName: aaaaa
1088 StorageAccountKey: aaaaa
1089 StorageBaseURL: core.windows.net
1090 ContainerName: aaaaa
1092 ListBlobsRetryDelay: 10s
1093 ListBlobsMaxAttempts: 10
1095 WriteRaceInterval: 15s
1096 WriteRacePollTime: 1s
1098 # for local directory driver -- see
1099 # https://doc.arvados.org/install/configure-fs-storage.html
1100 Root: /var/lib/arvados/keep-data
1102 # For local directory driver, potentially confusing tuning
1103 # parameter, intentionally excluded from main documentation.
1105 # When true, read and write operations (for whole 64MiB
1106 # blocks) on an individual volume will queued and issued
1107 # serially. When false, read and write operations will be
1108 # issued concurrently.
1110 # May possibly improve throughput if you have physical spinning disks
1111 # and experience contention when there are multiple requests
1112 # to the same volume.
1114 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1115 # should leave this alone.
1121 SendUserSetupNotificationEmail: true
1123 # Bug/issue report notification to and from addresses
1124 IssueReporterEmailFrom: "arvados@example.com"
1125 IssueReporterEmailTo: "arvados@example.com"
1126 SupportEmailAddress: "arvados@example.com"
1128 # Generic issue email from
1129 EmailFrom: "arvados@example.com"
1136 ActivateUsers: false
1138 # API endpoint host or host:port; default is {id}.arvadosapi.com
1139 Host: sample.arvadosapi.com
1141 # Perform a proxy request when a local client requests an
1142 # object belonging to this remote.
1145 # Default "https". Can be set to "http" for testing.
1148 # Disable TLS verify. Can be set to true for testing.
1151 # When users present tokens issued by this remote cluster, and
1152 # their accounts are active on the remote cluster, activate
1153 # them on this cluster too.
1154 ActivateUsers: false
1157 # Workbench1 configs
1159 ActivationContactLink: mailto:info@arvados.org
1160 ArvadosDocsite: https://doc.arvados.org
1161 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1162 ShowUserAgreementInline: false
1165 # Scratch directory used by the remote repository browsing
1166 # feature. If it doesn't exist, it (and any missing parents) will be
1167 # created using mkdir_p.
1168 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1170 # Below is a sample setting of user_profile_form_fields config parameter.
1171 # This configuration parameter should be set to either false (to disable) or
1172 # to a map as shown below.
1173 # Configure the map of input fields to be displayed in the profile page
1174 # using the attribute "key" for each of the input fields.
1175 # This sample shows configuration with one required and one optional form fields.
1176 # For each of these input fields:
1177 # You can specify "Type" as "text" or "select".
1178 # List the "Options" to be displayed for each of the "select" menu.
1179 # Set "Required" as "true" for any of these fields to make them required.
1180 # If any of the required fields are missing in the user's profile, the user will be
1181 # redirected to the profile page before they can access any Workbench features.
1182 UserProfileFormFields:
1185 FormFieldTitle: Best color
1186 FormFieldDescription: your favorite color
1195 # exampleTextValue: # key that will be set in properties
1197 # FormFieldTitle: ""
1198 # FormFieldDescription: ""
1201 # exampleOptionsValue:
1203 # FormFieldTitle: ""
1204 # FormFieldDescription: ""
1212 # Use "UserProfileFormMessage to configure the message you want
1213 # to display on the profile page.
1214 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1216 # Mimetypes of applications for which the view icon
1217 # would be enabled in a collection's show page.
1218 # It is sufficient to list only applications here.
1219 # No need to list text and image types.
1220 ApplicationMimetypesWithViewIcon:
1238 # The maximum number of bytes to load in the log viewer
1239 LogViewerMaxBytes: 1M
1241 # When anonymous_user_token is configured, show public projects page
1242 EnablePublicProjectsPage: true
1244 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1245 EnableGettingStartedPopup: false
1247 # Ask Arvados API server to compress its response payloads.
1248 APIResponseCompression: true
1250 # Timeouts for API requests.
1251 APIClientConnectTimeout: 2m
1252 APIClientReceiveTimeout: 5m
1254 # Maximum number of historic log records of a running job to fetch
1255 # and display in the Log tab, while subscribing to web sockets.
1256 RunningJobLogRecordsToFetch: 2000
1258 # In systems with many shared projects, loading of dashboard and topnav
1259 # can be slow due to collections indexing; use the following parameters
1260 # to suppress these properties
1261 ShowRecentCollectionsOnDashboard: true
1262 ShowUserNotifications: true
1264 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1265 # a link to the multi-site search page on a "home" Workbench site.
1268 # https://workbench.qr1hi.arvadosapi.com/collections/multisite
1271 # Should workbench allow management of local git repositories? Set to false if
1272 # the jobs api is disabled and there are no local git repositories.
1275 SiteName: Arvados Workbench
1276 ProfilingEnabled: false
1278 # This is related to obsolete Google OpenID 1.0 login
1279 # but some workbench stuff still expects it to be set.
1280 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1282 # Workbench2 configs
1284 FileViewersConfigURL: ""
1286 # Workbench welcome screen, this is HTML text that will be
1287 # incorporated directly onto the page.
1289 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1290 <h2>Please log in.</h2>
1292 <p>The "Log in" button below will show you a sign-in
1293 page. After you log in, you will be redirected back to
1294 Arvados Workbench.</p>
1296 <p>If you have never used Arvados Workbench before, logging in
1297 for the first time will automatically create a new
1300 <i>Arvados Workbench uses your name and email address only for
1301 identification, and does not retrieve any other personal
1304 # Workbench screen displayed to inactive users. This is HTML
1305 # text that will be incorporated directly onto the page.
1307 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1308 <h3>Hi! You're logged in, but...</h3>
1309 <p>Your account is inactive.</p>
1310 <p>An administrator must activate your account before you can get
1313 # Connecting to Arvados shell VMs tends to be site-specific.
1314 # Put any special instructions here. This is HTML text that will
1315 # be incorporated directly onto the Workbench page.
1317 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1318 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1320 # Sample text if you are using a "switchyard" ssh proxy.
1321 # Replace "zzzzz" with your Cluster ID.
1323 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1326 # ServerAliveInterval 60
1327 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1330 # If you are using a switchyard ssh proxy, shell node hostnames
1331 # may require a special hostname suffix. In the sample ssh
1332 # configuration above, this would be ".zzzzz"
1333 # This is added to the hostname in the "command line" column
1334 # the Workbench "shell VMs" page.
1336 # If your shell nodes are directly accessible by users without a
1337 # proxy and have fully qualified host names, you should leave
1339 SSHHelpHostSuffix: ""
1341 # Bypass new (Arvados 1.5) API implementations, and hand off
1342 # requests directly to Rails instead. This can provide a temporary
1343 # workaround for clients that are incompatible with the new API
1344 # implementation. Note that it also disables some new federation
1345 # features and will be removed in a future release.
1346 ForceLegacyAPI14: false
1348 # (Experimental) Restart services automatically when config file
1349 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1351 AutoReloadConfig: false