1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: AGPL-3.0
5 # Do not use this file for site configuration. Create
6 # /etc/arvados/config.yml instead.
8 # The order of precedence (highest to lowest):
9 # 1. Legacy component-specific config files (deprecated)
10 # 2. /etc/arvados/config.yml
11 # 3. config.default.yml
15 # Token used internally by Arvados components to authenticate to
16 # one another. Use a string of at least 50 random alphanumerics.
19 # Token to be included in all healthcheck requests. Disabled by default.
20 # Server expects request header of the format "Authorization: Bearer xxx"
25 # Each of the service sections below specifies InternalURLs
26 # (each with optional ListenURL) and ExternalURL.
28 # InternalURLs specify how other Arvados service processes will
29 # connect to the service. Typically these use internal hostnames
30 # and high port numbers. Example:
33 # "http://host1.internal.example:12345": {}
34 # "http://host2.internal.example:12345": {}
36 # ListenURL specifies the address and port the service process's
37 # HTTP server should listen on, if different from the
38 # InternalURL itself. Example, using an intermediate TLS proxy:
41 # "https://host1.internal.example":
42 # ListenURL: "http://10.0.0.7:12345"
44 # When there are multiple InternalURLs configured, the service
45 # process will try listening on each InternalURLs (using
46 # ListenURL if provided) until one works. If you use a ListenURL
47 # like "0.0.0.0" which can be bound on any machine, use an
48 # environment variable
49 # ARVADOS_SERVICE_INTERNAL_URL=http://host1.internal.example to
50 # control which entry to use.
52 # ExternalURL specifies how applications/clients will connect to
53 # the service, regardless of whether they are inside or outside
54 # the cluster. Example:
56 # ExternalURL: "https://keep.zzzzz.example.com/"
58 # To avoid routing internal traffic through external networks,
59 # use split-horizon DNS for ExternalURL host names: inside the
60 # cluster's private network "host.zzzzz.example.com" resolves to
61 # the host's private IP address, while outside the cluster
62 # "host.zzzzz.example.com" resolves to the host's public IP
63 # address (or its external gateway or load balancer).
66 InternalURLs: {SAMPLE: {ListenURL: ""}}
69 InternalURLs: {SAMPLE: {ListenURL: ""}}
72 InternalURLs: {SAMPLE: {ListenURL: ""}}
75 InternalURLs: {SAMPLE: {ListenURL: ""}}
78 InternalURLs: {SAMPLE: {ListenURL: ""}}
81 InternalURLs: {SAMPLE: {ListenURL: ""}}
84 InternalURLs: {SAMPLE: {ListenURL: ""}}
87 InternalURLs: {SAMPLE: {ListenURL: ""}}
90 InternalURLs: {SAMPLE: {ListenURL: ""}}
93 InternalURLs: {SAMPLE: {ListenURL: ""}}
96 InternalURLs: {SAMPLE: {ListenURL: ""}}
97 # Base URL for Workbench inline preview. If blank, use
98 # WebDAVDownload instead, and disable inline preview.
99 # If both are empty, downloading collections from workbench
100 # will be impossible.
102 # It is important to properly configure the download service
103 # to migitate cross-site-scripting (XSS) attacks. A HTML page
104 # can be stored in collection. If an attacker causes a victim
105 # to visit that page through Workbench, it will be rendered by
106 # the browser. If all collections are served at the same
107 # domain, the browser will consider collections as coming from
108 # the same origin and having access to the same browsing data,
109 # enabling malicious Javascript on that page to access Arvados
110 # on behalf of the victim.
112 # This is mitigating by having separate domains for each
113 # collection, or limiting preview to circumstances where the
114 # collection is not accessed with the user's regular
117 # Serve preview links using uuid or pdh in subdomain
118 # (requires wildcard DNS and TLS certificate)
119 # https://*.collections.uuid_prefix.arvadosapi.com
121 # Serve preview links using uuid or pdh in main domain
122 # (requires wildcard DNS and TLS certificate)
123 # https://*--collections.uuid_prefix.arvadosapi.com
125 # Serve preview links by setting uuid or pdh in the path.
126 # This configuration only allows previews of public data or
127 # collection-sharing links, because these use the anonymous
128 # user token or the token is already embedded in the URL.
129 # Other data must be handled as downloads via WebDAVDownload:
130 # https://collections.uuid_prefix.arvadosapi.com
135 InternalURLs: {SAMPLE: {ListenURL: ""}}
136 # Base URL for download links. If blank, serve links to WebDAV
137 # with disposition=attachment query param. Unlike preview links,
138 # browsers do not render attachments, so there is no risk of XSS.
140 # If WebDAVDownload is blank, and WebDAV uses a
141 # single-origin form, then Workbench will show an error page
143 # Serve download links by setting uuid or pdh in the path:
144 # https://download.uuid_prefix.arvadosapi.com
152 # Rendezvous is normally empty/omitted. When changing the
153 # URL of a Keepstore service, Rendezvous should be set to
154 # the old URL (with trailing slash omitted) to preserve
155 # rendezvous ordering.
159 InternalURLs: {SAMPLE: {ListenURL: ""}}
162 InternalURLs: {SAMPLE: {ListenURL: ""}}
163 # ShellInABox service endpoint URL for a given VM. If empty, do not
164 # offer web shell logins.
166 # E.g., using a path-based proxy server to forward connections to shell hosts:
167 # https://webshell.uuid_prefix.arvadosapi.com
169 # E.g., using a name-based proxy server to forward connections to shell hosts:
170 # https://*.webshell.uuid_prefix.arvadosapi.com
173 InternalURLs: {SAMPLE: {ListenURL: ""}}
176 InternalURLs: {SAMPLE: {ListenURL: ""}}
179 InternalURLs: {SAMPLE: {ListenURL: ""}}
183 # max concurrent connections per arvados server daemon
186 # All parameters here are passed to the PG client library in a connection string;
187 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
195 # Limits for how long a client token created by regular users can be valid,
196 # and also is used as a default expiration policy when no expiration date is
198 # Default value zero means token expirations don't get clamped and no
199 # default expiration is set.
202 # Maximum size (in bytes) allowed for a single API request. This
203 # limit is published in the discovery document for use by clients.
204 # Note: You must separately configure the upstream web server or
205 # proxy to actually enforce the desired maximum request size on the
207 MaxRequestSize: 134217728
209 # Limit the number of bytes read from the database during an index
210 # request (by retrieving and returning fewer rows than would
211 # normally be returned in a single response).
212 # Note 1: This setting never reduces the number of returned rows to
213 # zero, no matter how big the first data row is.
214 # Note 2: Currently, this is only checked against a specific set of
215 # columns that tend to get large (collections.manifest_text,
216 # containers.mounts, workflows.definition). Other fields (e.g.,
217 # "properties" hashes) are not counted against this limit.
218 MaxIndexDatabaseRead: 134217728
220 # Maximum number of items to return when responding to a APIs that
221 # can return partial result sets using limit and offset parameters
222 # (e.g., *.index, groups.contents). If a request specifies a "limit"
223 # parameter higher than this value, this value is used instead.
224 MaxItemsPerResponse: 1000
226 # Maximum number of concurrent requests to process concurrently
227 # in a single service process, or 0 for no limit.
229 # Note this applies to all Arvados services (controller, webdav,
230 # websockets, etc.). Concurrency in the controller service is
231 # also effectively limited by MaxConcurrentRailsRequests (see
232 # below) because most controller requests proxy through to the
235 # HTTP proxies and load balancers downstream of arvados services
236 # should be configured to allow at least {MaxConcurrentRequest +
237 # MaxQueuedRequests + MaxGatewayTunnels} concurrent requests.
238 MaxConcurrentRequests: 64
240 # Maximum number of concurrent requests to process concurrently
241 # in a single RailsAPI service process, or 0 for no limit.
242 MaxConcurrentRailsRequests: 8
244 # Maximum number of incoming requests to hold in a priority
245 # queue waiting for one of the MaxConcurrentRequests slots to be
246 # free. When the queue is longer than this, respond 503 to the
247 # lowest priority request.
249 # If MaxQueuedRequests is 0, respond 503 immediately to
250 # additional requests while at the MaxConcurrentRequests limit.
251 MaxQueuedRequests: 128
253 # Maximum time a "lock container" request is allowed to wait in
254 # the incoming request queue before returning 503.
255 MaxQueueTimeForLockRequests: 2s
257 # Maximum number of active gateway tunnel connections. One slot
258 # is consumed by each "container shell" connection. If using an
259 # HPC dispatcher (LSF or Slurm), one slot is consumed by each
260 # running container. These do not count toward
261 # MaxConcurrentRequests.
262 MaxGatewayTunnels: 1000
264 # Fraction of MaxConcurrentRequests that can be "log create"
265 # messages at any given time. This is to prevent logging
266 # updates from crowding out more important requests.
267 LogCreateRequestFraction: 0.50
269 # Maximum number of 64MiB memory buffers per Keepstore server process, or
270 # 0 for no limit. When this limit is reached, up to
271 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
272 # buffers (like GET and PUT) will wait for buffer space to be released.
273 # Any HTTP requests beyond MaxConcurrentRequests will receive an
274 # immediate 503 response.
276 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
277 # * 1.1) fits comfortably in memory. On a host dedicated to running
278 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
279 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
280 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
281 MaxKeepBlobBuffers: 128
283 # API methods to disable. Disabled methods are not listed in the
284 # discovery document, and respond 404 to all requests.
285 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
288 # Interval (seconds) between asynchronous permission view updates. Any
289 # permission-updating API called with the 'async' parameter schedules a an
290 # update on the permission view in the future, if not already scheduled.
291 AsyncPermissionsUpdateInterval: 20s
293 # Maximum number of concurrent outgoing requests to make while
294 # serving a single incoming multi-cluster (federated) request.
295 MaxRequestAmplification: 4
297 # Maximum wall clock time to spend handling an incoming request.
300 # Websocket will send a periodic empty event after 'SendTimeout'
301 # if there is no other activity to maintain the connection /
302 # detect dropped connections.
305 WebsocketClientEventQueue: 64
306 WebsocketServerEventQueue: 4
308 # Timeout on requests to internal Keep services.
309 KeepServiceRequestTimeout: 15s
311 # Vocabulary file path, local to the node running the controller.
312 # This JSON file should contain the description of what's allowed
313 # as object's metadata. Its format is described at:
314 # https://doc.arvados.org/admin/metadata-vocabulary.html
317 # If true, a project must have a non-empty description field in
318 # order to be frozen.
319 FreezeProjectRequiresDescription: false
321 # Project properties that must have non-empty values in order to
322 # freeze a project. Example: "property_name": {}
323 FreezeProjectRequiresProperties:
326 # If true, only an admin user can un-freeze a project. If false,
327 # any user with "manage" permission can un-freeze.
328 UnfreezeProjectRequiresAdmin: false
330 # (Experimental) Use row-level locking on update API calls.
331 LockBeforeUpdate: false
334 # Config parameters to automatically setup new users. If enabled,
335 # this users will be able to self-activate. Enable this if you want
336 # to run an open instance where anyone can create an account and use
337 # the system without requiring manual approval.
339 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
340 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
341 AutoSetupNewUsers: false
342 AutoSetupNewUsersWithVmUUID: ""
343 AutoSetupNewUsersWithRepository: false
344 AutoSetupUsernameBlacklist:
353 # When NewUsersAreActive is set to true, new users will be active
354 # immediately. This skips the "self-activate" step which enforces
355 # user agreements. Should only be enabled for development.
356 NewUsersAreActive: false
358 # Newly activated users (whether set up by an admin or via
359 # AutoSetupNewUsers) immediately become visible to other active
362 # On a multi-tenant cluster, where the intent is for users to be
363 # invisible to one another unless they have been added to the
364 # same group(s) via Workbench admin interface, change this to
366 ActivatedUsersAreVisibleToOthers: true
368 # If a user creates an account with this email address, they
369 # will be automatically set to admin.
370 AutoAdminUserWithEmail: ""
372 # If AutoAdminFirstUser is set to true, the first user to log in when no
373 # other admin users exist will automatically become an admin user.
374 AutoAdminFirstUser: false
376 # Recipient for notification email sent out when a user sets a
377 # profile on their account.
378 UserProfileNotificationAddress: ""
380 # When sending a NewUser, NewInactiveUser, or UserProfile
381 # notification, this is the 'From' address to use
382 AdminNotifierEmailFrom: arvados@example.com
384 # Prefix for email subjects for NewUser and NewInactiveUser emails
385 EmailSubjectPrefix: "[ARVADOS] "
387 # When sending a welcome email to the user, the 'From' address to use
388 UserNotifierEmailFrom: arvados@example.com
390 # The welcome email sent to new users will be blind copied to
392 UserNotifierEmailBcc:
395 # Recipients for notification email sent out when a user account
396 # is created and already set up to be able to log in
397 NewUserNotificationRecipients:
400 # Recipients for notification email sent out when a user account
401 # has been created but the user cannot log in until they are
402 # set up by an admin.
403 NewInactiveUserNotificationRecipients:
406 # Set AnonymousUserToken to enable anonymous user access. Populate this
407 # field with a random string at least 50 characters long.
408 AnonymousUserToken: ""
410 # The login provider for a user may supply a primary email
411 # address and one or more alternate email addresses. If a new
412 # user has an alternate email address with the domain given
413 # here, use the username from the alternate email to generate
414 # the user's Arvados username. Otherwise, the username from
415 # user's primary email address is used for the Arvados username.
416 # Currently implemented for OpenID Connect only.
417 PreferDomainForUsername: ""
419 # Ruby ERB template used for the email sent out to users when
420 # they have been set up.
422 <% if not @user.full_name.empty? -%>
423 <%= @user.full_name %>,
428 Your Arvados account has been set up. You can log in at
430 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
433 Your Arvados administrator.
435 # If RoleGroupsVisibleToAll is true, all role groups are visible
436 # to all active users.
438 # If false, users must be granted permission to role groups in
439 # order to see them. This is more appropriate for a multi-tenant
441 RoleGroupsVisibleToAll: true
443 # If CanCreateRoleGroups is true, regular (non-admin) users can
444 # create new role groups.
446 # If false, only admins can create new role groups.
447 CanCreateRoleGroups: true
449 # During each period, a log entry with event_type="activity"
450 # will be recorded for each user who is active during that
451 # period. The object_uuid attribute will indicate the user's
454 # Multiple log entries for the same user may be generated during
455 # a period if there are multiple controller processes or a
456 # controller process is restarted.
458 # Use 0 to disable activity logging.
459 ActivityLoggingPeriod: 24h
461 # The SyncUser* options control what system resources are managed by
462 # arvados-login-sync on shell nodes. They correspond to:
463 # * SyncUserAccounts: The user's Unix account on the shell node
464 # * SyncUserGroups: The group memberships of that account
465 # * SyncUserSSHKeys: Whether to authorize the user's Arvados SSH keys
466 # * SyncUserAPITokens: Whether to set up the user's Arvados API token
467 # All default to true.
468 SyncUserAccounts: true
470 SyncUserSSHKeys: true
471 SyncUserAPITokens: true
473 # If SyncUserGroups=true, then arvados-login-sync will ensure that all
474 # managed accounts are members of the Unix groups listed in
475 # SyncRequiredGroups, in addition to any groups listed in their Arvados
476 # login permission. The default list includes the "fuse" group so
477 # users can use arv-mount. You can require no groups by specifying an
478 # empty list (i.e., `SyncRequiredGroups: []`).
482 # SyncIgnoredGroups is a list of group names. arvados-login-sync will
483 # never modify these groups. If user login permissions list any groups
484 # in SyncIgnoredGroups, they will be ignored. If a user's Unix account
485 # belongs to any of these groups, arvados-login-sync will not remove
486 # the account from that group. The default is a set of particularly
487 # security-sensitive groups across Debian- and Red Hat-based
504 # Time to keep audit logs, in seconds. (An audit log is a row added
505 # to the "logs" table in the PostgreSQL database each time an
506 # Arvados object is created, modified, or deleted.)
508 # Currently, websocket event notifications rely on audit logs, so
509 # this should not be set lower than 300 (5 minutes).
512 # Maximum number of log rows to delete in a single SQL transaction.
514 # If MaxDeleteBatch is 0, log entries will never be
515 # deleted by Arvados. Cleanup can be done by an external process
516 # without affecting any Arvados system processes, as long as very
517 # recent (<5 minutes old) logs are not deleted.
519 # 100000 is a reasonable batch size for most sites.
522 # Attributes to suppress in events and audit logs. Notably,
523 # specifying {"manifest_text": {}} here typically makes the database
524 # smaller and faster.
526 # Warning: Using any non-empty value here can have undesirable side
527 # effects for any client or component that relies on event logs.
528 # Use at your own risk.
529 UnloggedAttributes: {}
533 # Logging threshold: panic, fatal, error, warn, info, debug, or
537 # Logging format: json or text
540 # Maximum characters of (JSON-encoded) query parameters to include
541 # in each request log entry. When params exceed this size, they will
542 # be JSON-encoded, truncated to this size, and logged as
544 MaxRequestLogParamsSize: 2000
546 # In all services except RailsAPI, periodically check whether
547 # the incoming HTTP request queue is nearly full (see
548 # MaxConcurrentRequests) and, if so, write a snapshot of the
549 # request queue to {service}-requests.json in the specified
552 # Leave blank to disable.
553 RequestQueueDumpDirectory: ""
557 # Enable access controls for data stored in Keep. This should
558 # always be set to true on a production cluster.
561 # BlobSigningKey is a string of alphanumeric characters used to
562 # generate permission signatures for Keep locators. It must be
563 # identical to the permission key given to Keep. IMPORTANT: This
564 # is a site secret. It should be at least 50 characters.
566 # Modifying BlobSigningKey will invalidate all existing
567 # signatures, which can cause programs to fail (e.g., arv-put,
568 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
569 # when no such processes are running.
572 # Enable garbage collection of unreferenced blobs in Keep.
575 # Time to leave unreferenced blobs in "trashed" state before
576 # deleting them, or 0 to skip the "trashed" state entirely and
577 # delete unreferenced blobs.
579 # If you use any Amazon S3 buckets as storage volumes, this
580 # must be at least 24h to avoid occasional data loss.
581 BlobTrashLifetime: 336h
583 # How often to check for (and delete) trashed blocks whose
584 # BlobTrashLifetime has expired.
585 BlobTrashCheckInterval: 24h
587 # Maximum number of concurrent "trash blob" and "delete trashed
588 # blob" operations conducted by a single keepstore process. Each
589 # of these can be set to 0 to disable the respective operation.
591 # If BlobTrashLifetime is zero, "trash" and "delete trash"
592 # happen at once, so only the lower of these two values is used.
593 BlobTrashConcurrency: 4
594 BlobDeleteConcurrency: 4
596 # Maximum number of concurrent "create additional replica of
597 # existing blob" operations conducted by a single keepstore
599 BlobReplicateConcurrency: 4
601 # Default replication level for collections. This is used when a
602 # collection's replication_desired attribute is nil.
603 DefaultReplication: 2
605 # BlobSigningTTL determines the minimum lifetime of transient
606 # data, i.e., blocks that are not referenced by
607 # collections. Unreferenced blocks exist for two reasons:
609 # 1) A data block must be written to a disk/cloud backend device
610 # before a collection can be created/updated with a reference to
613 # 2) Deleting or updating a collection can remove the last
614 # remaining reference to a data block.
616 # If BlobSigningTTL is too short, long-running
617 # processes/containers will fail when they take too long (a)
618 # between writing blocks and writing collections that reference
619 # them, or (b) between reading collections and reading the
622 # If BlobSigningTTL is too long, data will still be stored long
623 # after the referring collections are deleted, and you will
624 # needlessly fill up disks or waste money on cloud storage.
626 # Modifying BlobSigningTTL invalidates existing signatures; see
627 # BlobSigningKey note above.
629 # The default is 2 weeks.
632 # When running keep-balance, this is the destination filename for
633 # the list of lost block hashes if there are any, one per line.
634 # Updated automically during each successful run.
635 BlobMissingReport: ""
637 # keep-balance operates periodically, i.e.: do a
638 # scan/balance operation, sleep, repeat.
640 # BalancePeriod determines the interval between start times of
641 # successive scan/balance operations. If a scan/balance operation
642 # takes longer than BalancePeriod, the next one will follow it
645 # If SIGUSR1 is received during an idle period between operations,
646 # the next operation will start immediately.
649 # Limits the number of collections retrieved by keep-balance per
650 # API transaction. If this is zero, page size is
651 # determined by the API server's own page size limits (see
652 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
653 BalanceCollectionBatch: 0
655 # The size of keep-balance's internal queue of
656 # collections. Higher values may improve throughput by allowing
657 # keep-balance to fetch collections from the database while the
658 # current collection are still being processed, at the expense of
659 # using more memory. If this is zero or omitted, pages are
660 # processed serially.
661 BalanceCollectionBuffers: 4
663 # Maximum time for a rebalancing run. This ensures keep-balance
664 # eventually gives up and retries if, for example, a network
665 # error causes a hung connection that is never closed by the
666 # OS. It should be long enough that it doesn't interrupt a
667 # long-running balancing operation.
670 # Maximum number of replication_confirmed /
671 # storage_classes_confirmed updates to write to the database
672 # after a rebalancing run. When many updates are needed, this
673 # spreads them over a few runs rather than applying them all at
675 BalanceUpdateLimit: 100000
677 # Maximum number of "pull block from other server" and "trash
678 # block" requests to send to each keepstore server at a
679 # time. Smaller values use less memory in keepstore and
680 # keep-balance. Larger values allow more progress per
681 # keep-balance iteration. A zero value computes all of the
682 # needed changes but does not apply any.
683 BalancePullLimit: 100000
684 BalanceTrashLimit: 100000
686 # Default lifetime for ephemeral collections: 2 weeks. This must not
687 # be less than BlobSigningTTL.
688 DefaultTrashLifetime: 336h
690 # Interval (seconds) between trash sweeps. During a trash sweep,
691 # collections are marked as trash if their trash_at time has
692 # arrived, and deleted if their delete_at time has arrived.
693 TrashSweepInterval: 60s
695 # If true, enable collection versioning.
696 # When a collection's preserve_version field is true or the current version
697 # is older than the amount of seconds defined on PreserveVersionIfIdle,
698 # a snapshot of the collection's previous state is created and linked to
699 # the current collection.
700 CollectionVersioning: true
702 # 0s = auto-create a new version on every update.
703 # -1s = never auto-create new versions.
704 # > 0s = auto-create a new version when older than the specified number of seconds.
705 PreserveVersionIfIdle: 10s
707 # If non-empty, allow project and collection names to contain
708 # the "/" character (slash/stroke/solidus), and replace "/" with
709 # the given string in the filesystem hierarchy presented by
710 # WebDAV. Example values are "%2f" and "{slash}". Names that
711 # contain the substitution string itself may result in confusing
712 # behavior, so a value like "_" is not recommended.
714 # If the default empty value is used, the server will reject
715 # requests to create or rename a collection when the new name
718 # If the value "/" is used, project and collection names
719 # containing "/" will be allowed, but they will not be
720 # accessible via WebDAV.
722 # Use of this feature is not recommended, if it can be avoided.
723 ForwardSlashNameSubstitution: ""
725 # Include "folder objects" in S3 ListObjects responses.
726 S3FolderObjects: true
728 # Managed collection properties. At creation time, if the client didn't
729 # provide the listed keys, they will be automatically populated following
730 # one of the following behaviors:
732 # * UUID of the user who owns the containing project.
733 # responsible_person_uuid: {Function: original_owner, Protected: true}
735 # * Default concrete value.
736 # foo_bar: {Value: baz, Protected: false}
738 # If Protected is true, only an admin user can modify its value.
740 SAMPLE: {Function: original_owner, Protected: true}
742 # In "trust all content" mode, Workbench will redirect download
743 # requests to WebDAV preview link, even in the cases when
744 # WebDAV would have to expose XSS vulnerabilities in order to
745 # handle the redirect (see discussion on Services.WebDAV).
747 # This setting has no effect in the recommended configuration, where the
748 # WebDAV service is configured to have a separate domain for every
749 # collection and XSS protection is provided by browsers' same-origin
752 # The default setting (false) is appropriate for a multi-user site.
753 TrustAllContent: false
755 # Cache parameters for WebDAV content serving:
757 # Time to cache manifests, permission checks, and sessions.
760 # Maximum amount of data cached in /var/cache/arvados/keep.
761 # Can be given as a percentage ("10%") or a number of bytes
765 # Approximate memory limit (in bytes) for session cache.
767 # Note this applies to the in-memory representation of
768 # projects and collections -- metadata, block locators,
769 # filenames, etc. -- not the file data itself (see
771 MaxCollectionBytes: 100 MB
773 # Persistent sessions.
776 # Selectively set permissions for regular users and admins to
777 # download or upload data files using the upload/download
778 # features for Workbench, WebDAV and S3 API support.
787 # Selectively set permissions for regular users and admins to be
788 # able to download or upload blocks using arv-put and
789 # arv-get from outside the cluster.
798 # Post upload / download events to the API server logs table, so
799 # that they can be included in the arv-user-activity report.
800 # You can disable this if you find that it is creating excess
801 # load on the API server and you don't need it.
802 WebDAVLogEvents: true
804 # Per-connection output buffer for WebDAV downloads. May improve
805 # throughput for large files, particularly when storage volumes
808 # Size be specified as a number of bytes ("0") or with units
809 # ("128KiB", "1 MB").
810 WebDAVOutputBuffer: 0
813 # One of the following mechanisms (Google, PAM, LDAP, or
814 # LoginCluster) should be enabled; see
815 # https://doc.arvados.org/install/setup-login.html
818 # Authenticate with Google.
821 # Use the Google Cloud console to enable the People API (APIs
822 # and Services > Enable APIs and services > Google People API
823 # > Enable), generate a Client ID and secret (APIs and
824 # Services > Credentials > Create credentials > OAuth client
825 # ID > Web application) and add your controller's /login URL
826 # (e.g., "https://zzzzz.example.com/login") as an authorized
831 # Allow users to log in to existing accounts using any verified
832 # email address listed by their Google account. If true, the
833 # Google People API must be enabled in order for Google login to
834 # work. If false, only the primary email address will be used.
835 AlternateEmailAddresses: true
837 # Send additional parameters with authentication requests. See
838 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
839 # for a list of supported parameters.
840 AuthenticationRequestParameters:
841 # Show the "choose which Google account" page, even if the
842 # client is currently logged in to exactly one Google
844 prompt: select_account
849 # Authenticate with an OpenID Connect provider.
852 # Issuer URL, e.g., "https://login.example.com".
854 # This must be exactly equal to the URL returned by the issuer
855 # itself in its config response ("isser" key). If the
856 # configured value is "https://example" and the provider
857 # returns "https://example:443" or "https://example/" then
858 # login will fail, even though those URLs are equivalent
862 # Your client ID and client secret (supplied by the provider).
866 # OpenID claim field containing the user's email
867 # address. Normally "email"; see
868 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
871 # OpenID claim field containing the email verification
872 # flag. Normally "email_verified". To accept every returned
873 # email address without checking a "verified" field at all,
874 # use an empty string "".
875 EmailVerifiedClaim: "email_verified"
877 # OpenID claim field containing the user's preferred
878 # username. If empty, use the mailbox part of the user's email
882 # Send additional parameters with authentication requests,
883 # like {display: page, prompt: consent}. See
884 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
885 # and refer to your provider's documentation for supported
887 AuthenticationRequestParameters:
890 # Accept an OIDC access token as an API token if the OIDC
891 # provider's UserInfo endpoint accepts it.
893 # AcceptAccessTokenScope should also be used when enabling
895 AcceptAccessToken: false
897 # Before accepting an OIDC access token as an API token, first
898 # check that it is a JWT whose "scope" value includes this
899 # value. Example: "https://zzzzz.example.com/" (your Arvados
902 # If this value is empty and AcceptAccessToken is true, all
903 # access tokens will be accepted regardless of scope,
904 # including non-JWT tokens. This is not recommended.
905 AcceptAccessTokenScope: ""
908 # Use PAM to authenticate users.
911 # PAM service name. PAM will apply the policy in the
912 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
913 # there is none, the default "other" config.
916 # Domain name (e.g., "example.com") to use to construct the
917 # user's email address if PAM authentication returns a
918 # username with no "@". If empty, use the PAM username as the
919 # user's email address, whether or not it contains "@".
921 # Note that the email address is used as the primary key for
922 # user records when logging in. Therefore, if you change
923 # PAMDefaultEmailDomain after the initial installation, you
924 # should also update existing user records to reflect the new
925 # domain. Otherwise, next time those users log in, they will
926 # be given new accounts instead of accessing their existing
928 DefaultEmailDomain: ""
931 # Use an LDAP service to authenticate users.
934 # Server URL, like "ldap://ldapserver.example.com:389" or
935 # "ldaps://ldapserver.example.com:636".
936 URL: "ldap://ldap:389"
938 # Use StartTLS upon connecting to the server.
941 # Skip TLS certificate name verification.
944 # Mininum TLS version to negotiate when connecting to server
945 # (ldaps://... or StartTLS). It may be necessary to set this
946 # to "1.1" for compatibility with older LDAP servers that fail
947 # with 'LDAP Result Code 200 "Network Error": TLS handshake
948 # failed (tls: server selected unsupported protocol version
951 # If blank, use the recommended minimum version (1.2).
954 # Strip the @domain part if a user supplies an email-style
955 # username with this domain. If "*", strip any user-provided
956 # domain. If "", never strip the domain part. Example:
960 # If, after applying StripDomain, the username contains no "@"
961 # character, append this domain to form an email-style
962 # username. Example: "example.com"
965 # The LDAP attribute to filter on when looking up a username
966 # (after applying StripDomain and AppendDomain).
969 # Bind with this username (DN or UPN) and password when
970 # looking up the user record.
972 # Example user: "cn=admin,dc=example,dc=com"
974 SearchBindPassword: ""
976 # Directory base for username lookup. Example:
977 # "ou=Users,dc=example,dc=com"
980 # Additional filters to apply when looking up users' LDAP
981 # entries. This can be used to restrict access to a subset of
982 # LDAP users, or to disambiguate users from other directory
983 # entries that have the SearchAttribute present.
985 # Special characters in assertion values must be escaped (see
988 # Example: "(objectClass=person)"
991 # LDAP attribute to use as the user's email address.
993 # Important: This must not be an attribute whose value can be
994 # edited in the directory by the users themselves. Otherwise,
995 # users can take over other users' Arvados accounts trivially
996 # (email address is the primary key for Arvados accounts.)
999 # LDAP attribute to use as the preferred Arvados username. If
1000 # no value is found (or this config is empty) the username
1001 # originally supplied by the user will be used.
1002 UsernameAttribute: uid
1005 # Authenticate users listed here in the config file. This
1006 # feature is intended to be used in test environments, and
1007 # should not be used in production.
1011 Email: alice@example.com
1014 # The cluster ID to delegate the user database. When set,
1015 # logins on this cluster will be redirected to the login cluster
1016 # (login cluster must appear in RemoteClusters with Proxy: true)
1019 # How long a cached token belonging to a remote cluster will
1020 # remain valid before it needs to be revalidated.
1021 RemoteTokenRefresh: 5m
1023 # How long a client token created from a login flow will be valid without
1024 # asking the user to re-login. Example values: 60m, 8h.
1025 # Default value zero means tokens don't have expiration.
1028 # If true (default) tokens issued through login are allowed to create
1030 # If false, tokens issued through login are not allowed to
1031 # viewing/creating other tokens. New tokens can only be created
1032 # by going through login again.
1033 IssueTrustedTokens: true
1035 # Origins (scheme://host[:port]) of clients trusted to receive
1036 # new tokens via login process. The ExternalURLs of the local
1037 # Workbench1 and Workbench2 are trusted implicitly and do not
1038 # need to be listed here. If this is a LoginCluster, you
1039 # probably want to include the other Workbench instances in the
1040 # federation in this list.
1042 # A wildcard like "https://*.example" will match client URLs
1043 # like "https://a.example" and "https://a.b.c.example".
1048 # "https://workbench.other-cluster.example": {}
1049 # "https://workbench2.other-cluster.example": {}
1053 # Treat any origin whose host part is "localhost" or a private
1054 # IP address (e.g., http://10.0.0.123:3000/) as if it were
1055 # listed in TrustedClients.
1057 # Intended only for test/development use. Not appropriate for
1059 TrustPrivateNetworks: false
1062 # Path to git or gitolite-shell executable. Each authenticated
1063 # request will execute this program with the single argument "http-backend"
1064 GitCommand: /usr/bin/git
1066 # Path to Gitolite's home directory. If a non-empty path is given,
1067 # the CGI environment will be set up to support the use of
1068 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
1069 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
1070 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
1073 # Git repositories must be readable by api server, or you won't be
1074 # able to submit crunch jobs. To pass the test suites, put a clone
1075 # of the arvados tree in {git_repositories_dir}/arvados.git or
1076 # {git_repositories_dir}/arvados/.git
1077 Repositories: /var/lib/arvados/git/repositories
1080 # Use "file:///var/lib/acme/live/example.com/cert" and
1081 # ".../privkey" to load externally managed certificates.
1085 # Accept invalid certificates when connecting to servers. Never
1086 # use this in production.
1090 # Obtain certificates automatically for ExternalURL domains
1091 # using an ACME server and http-01 validation.
1093 # To use Let's Encrypt, specify "LE". To use the Let's
1094 # Encrypt staging environment, specify "LE-staging". To use a
1095 # different ACME server, specify the full directory URL
1098 # Note: this feature is not yet implemented in released
1099 # versions, only in the alpha/prerelease arvados-server-easy
1102 # Implies agreement with the server's terms of service.
1106 # List of supported Docker Registry image formats that compute nodes
1107 # are able to use. `arv keep docker` will error out if a user tries
1108 # to store an image with an unsupported format. Use an empty array
1109 # to skip the compatibility check (and display a warning message to
1112 # Example for sites running docker < 1.10: {"v1": {}}
1113 # Example for sites running docker >= 1.10: {"v2": {}}
1114 # Example for disabling check: {}
1115 SupportedDockerImageFormats:
1119 # Include details about job reuse decisions in the server log. This
1120 # causes additional database queries to run, so it should not be
1121 # enabled unless you expect to examine the resulting logs for
1122 # troubleshooting purposes.
1123 LogReuseDecisions: false
1125 # Default value for keep_cache_ram of a container's
1126 # runtime_constraints. Note: this gets added to the RAM request
1127 # used to allocate a VM or submit an HPC job.
1129 # If this is zero, container requests that don't specify RAM or
1130 # disk cache size will use a disk cache, sized to the
1131 # container's RAM requirement (but with minimum 2 GiB and
1134 # Note: If you change this value, containers that used the previous
1135 # default value will only be reused by container requests that
1136 # explicitly specify the previous value in their keep_cache_ram
1137 # runtime constraint.
1138 DefaultKeepCacheRAM: 0
1140 # Number of times a container can be unlocked before being
1141 # automatically cancelled.
1142 MaxDispatchAttempts: 10
1144 # Default value for container_count_max for container requests. This is the
1145 # number of times Arvados will create a new container to satisfy a container
1146 # request. If a container is cancelled it will retry a new container if
1147 # container_count < container_count_max on any container requests associated
1148 # with the cancelled container.
1151 # Schedule all child containers on preemptible instances (e.g. AWS
1152 # Spot Instances) even if not requested by the submitter.
1154 # If false, containers are scheduled on preemptible instances
1155 # only when requested by the submitter.
1157 # This flag is ignored if no preemptible instance types are
1158 # configured, and has no effect on top-level containers.
1159 AlwaysUsePreemptibleInstances: false
1161 # Automatically add a preemptible variant for every
1162 # non-preemptible entry in InstanceTypes below. The maximum bid
1163 # price for the preemptible variant will be the non-preemptible
1164 # price multiplied by PreemptiblePriceFactor. If 0, preemptible
1165 # variants are not added automatically.
1167 # A price factor of 1.0 is a reasonable starting point.
1168 PreemptiblePriceFactor: 0
1170 # When the lowest-priced instance type for a given container is
1171 # not available, try other instance types, up to the indicated
1172 # maximum price factor.
1174 # For example, with AvailabilityPriceFactor 1.5, if the
1175 # lowest-cost instance type A suitable for a given container
1176 # costs $2/h, Arvados may run the container on any instance type
1177 # B costing $3/h or less when instance type A is not available
1178 # or an idle instance of type B is already running.
1179 MaximumPriceFactor: 1.5
1181 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
1182 # cloud dispatcher for executing containers on worker VMs.
1183 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
1184 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
1186 # Use "file:///absolute/path/to/key" to load the key from a
1187 # separate file instead of embedding it in the configuration
1189 DispatchPrivateKey: ""
1191 # Maximum time to wait for workers to come up before abandoning
1192 # stale locks from a previous dispatch process.
1193 StaleLockTimeout: 1m
1195 # The crunch-run command used to start a container on a worker node.
1197 # When dispatching to cloud VMs, this is used only if
1198 # DeployRunnerBinary in the CloudVMs section is set to the empty
1200 CrunchRunCommand: "crunch-run"
1202 # Extra arguments to add to crunch-run invocation
1203 # Example: ["--cgroup-parent-subsystem=memory"]
1204 CrunchRunArgumentsList: []
1206 # Extra RAM to reserve on the node, in addition to
1207 # the amount specified in the container's RuntimeConstraints
1208 ReserveExtraRAM: 550MiB
1210 # Minimum time between two attempts to run the same container
1213 # Container runtime: "docker" (default) or "singularity"
1214 RuntimeEngine: docker
1216 # When running a container, run a dedicated keepstore process,
1217 # using the specified number of 64 MiB memory buffers per
1218 # allocated CPU core (VCPUs in the container's runtime
1219 # constraints). The dedicated keepstore handles I/O for
1220 # collections mounted in the container, as well as saving
1223 # A zero value disables this feature.
1225 # In order for this feature to be activated, no volume may use
1226 # AccessViaHosts, and no writable volume may have Replication
1227 # lower than Collections.DefaultReplication. If these
1228 # requirements are not satisfied, the feature is disabled
1229 # automatically regardless of the value given here.
1231 # When an HPC dispatcher is in use (see SLURM and LSF sections),
1232 # this feature depends on the operator to ensure an up-to-date
1233 # cluster configuration file (/etc/arvados/config.yml) is
1234 # available on all compute nodes. If it is missing or not
1235 # readable by the crunch-run user, the feature will be disabled
1236 # automatically. To read it from a different location, add a
1237 # "-config=/path/to/config.yml" argument to
1238 # CrunchRunArgumentsList above.
1240 # When the cloud dispatcher is in use (see CloudVMs section) and
1241 # this configuration is enabled, the entire cluster
1242 # configuration file, including the system root token, is copied
1243 # to the worker node and held in memory for the duration of the
1245 LocalKeepBlobBuffersPerVCPU: 1
1247 # When running a dedicated keepstore process for a container
1248 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
1249 # messages to keepstore.txt in the container's log collection.
1251 # These log messages can reveal some volume configuration
1252 # details, error messages from the cloud storage provider, etc.,
1253 # which are not otherwise visible to users.
1256 # * "none" -- no keepstore.txt file
1257 # * "all" -- all logs, including request and response lines
1258 # * "errors" -- all logs except "response" logs with 2xx
1259 # response codes and "request" logs
1260 LocalKeepLogsToContainerLog: none
1263 # Periodically (see SweepInterval) Arvados will check for
1264 # containers that have been finished for at least this long,
1265 # and delete their stdout, stderr, arv-mount, crunch-run, and
1266 # crunchstat logs from the logs table.
1269 # How often to delete cached log entries for finished
1270 # containers (see MaxAge).
1273 # These two settings control how frequently log events are flushed to the
1274 # database. Log lines are buffered until either crunch_log_bytes_per_event
1275 # has been reached or crunch_log_seconds_between_events has elapsed since
1277 LogBytesPerEvent: 4096
1278 LogSecondsBetweenEvents: 5s
1280 # The sample period for throttling logs.
1281 LogThrottlePeriod: 60s
1283 # Maximum number of bytes that job can log over crunch_log_throttle_period
1284 # before being silenced until the end of the period.
1285 LogThrottleBytes: 65536
1287 # Maximum number of lines that job can log over crunch_log_throttle_period
1288 # before being silenced until the end of the period.
1289 LogThrottleLines: 1024
1291 # Maximum bytes that may be logged as legacy log events
1292 # (records posted to the "logs" table). Starting with Arvados
1293 # 2.7, container live logging has migrated to a new system
1294 # (polling the container request live log endpoint) and this
1295 # value should be 0. As of this writing, the container will
1296 # still create a single log on the API server, noting for that
1297 # log events are throttled.
1298 LimitLogBytesPerJob: 0
1300 LogPartialLineThrottlePeriod: 5s
1302 # Container logs are written to Keep and saved in a
1303 # collection, which is updated periodically while the
1304 # container runs. This value sets the interval between
1305 # collection updates.
1306 LogUpdatePeriod: 30m
1308 # The log collection is also updated when the specified amount of
1309 # log data (given in bytes) is produced in less than one update
1311 LogUpdateSize: 32MiB
1314 # An admin user can use "arvados-client shell" to start an
1315 # interactive shell (with any user ID) in any running
1319 # Any user can use "arvados-client shell" to start an
1320 # interactive shell (with any user ID) in any running
1321 # container that they started, provided it isn't also
1322 # associated with a different user's container request.
1324 # Interactive sessions make it easy to alter the container's
1325 # runtime environment in ways that aren't recorded or
1326 # reproducible. Consider the implications for automatic
1327 # container reuse before enabling and using this feature. In
1328 # particular, note that starting an interactive session does
1329 # not disqualify a container from being reused by a different
1330 # user/workflow in the future.
1335 SbatchArgumentsList: []
1336 SbatchEnvironmentVariables:
1339 # Path to dns server configuration directory
1340 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1341 # files or touch restart.txt (see below).
1342 DNSServerConfDir: ""
1344 # Template file for the dns server host snippets. See
1345 # unbound.template in this directory for an example. If false, do
1346 # not write any config files.
1347 DNSServerConfTemplate: ""
1349 # String to write to {dns_server_conf_dir}/restart.txt (with a
1350 # trailing newline) after updating local data. If false, do not
1351 # open or write the restart.txt file.
1352 DNSServerReloadCommand: ""
1354 # Command to run after each DNS update. Template variables will be
1355 # substituted; see the "unbound" example below. If false, do not run
1357 DNSServerUpdateCommand: ""
1359 ComputeNodeDomain: ""
1360 ComputeNodeNameservers:
1364 # Hostname to assign to a compute node when it sends a "ping" and the
1365 # hostname in its Node record is nil.
1366 # During bootstrapping, the "ping" script is expected to notice the
1367 # hostname given in the ping response, and update its unix hostname
1369 # If false, leave the hostname alone (this is appropriate if your compute
1370 # nodes' hostnames are already assigned by some other mechanism).
1372 # One way or another, the hostnames of your node records should agree
1373 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1375 # Example for compute0000, compute0001, ....:
1376 # assign_node_hostname: compute%<slot_number>04d
1377 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1378 AssignNodeHostname: "compute%<slot_number>d"
1381 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1383 # Template variables starting with % will be substituted as follows:
1386 # %C number of VCPUs
1389 # %G number of GPU devices (runtime_constraints.cuda.device_count)
1390 # %W maximum run time in minutes (see MaxRunTimeOverhead and
1391 # MaxRunTimeDefault below)
1393 # Use %% to express a literal %. For example, the %%J in the
1394 # default argument list will be changed to %J, which is
1395 # interpreted by bsub itself.
1397 # Note that the default arguments cause LSF to write two files
1398 # in /tmp on the compute node each time an Arvados container
1399 # runs. Ensure you have something in place to delete old files
1400 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1402 # If ["-We", "%W"] or ["-W", "%W"] appear in this argument
1403 # list, and MaxRunTimeDefault is not set (see below), both of
1404 # those arguments will be dropped from the argument list when
1405 # running a container that has no max_run_time value.
1406 BsubArgumentsList: ["-o", "/tmp/crunch-run.%%J.out", "-e", "/tmp/crunch-run.%%J.err", "-J", "%U", "-n", "%C", "-D", "%MMB", "-R", "rusage[mem=%MMB:tmp=%TMB] span[hosts=1]", "-R", "select[mem>=%MMB]", "-R", "select[tmp>=%TMB]", "-R", "select[ncpus>=%C]", "-We", "%W"]
1408 # Arguments that will be appended to the bsub command line
1409 # when submitting Arvados containers as LSF jobs with
1410 # runtime_constraints.cuda.device_count > 0
1411 BsubCUDAArguments: ["-gpu", "num=%G"]
1413 # Use sudo to switch to this user account when submitting LSF
1416 # This account must exist on the hosts where LSF jobs run
1417 # ("execution hosts"), as well as on the host where the
1418 # Arvados LSF dispatcher runs ("submission host").
1419 BsubSudoUser: "crunch"
1421 # When passing the scheduling_constraints.max_run_time value
1422 # to LSF via "%W", add this much time to account for
1423 # crunch-run startup/shutdown overhead.
1424 MaxRunTimeOverhead: 5m
1426 # If non-zero, MaxRunTimeDefault is used as the default value
1427 # for max_run_time for containers that do not specify a time
1428 # limit. MaxRunTimeOverhead will be added to this.
1431 # MaxRunTimeDefault: 2h
1432 MaxRunTimeDefault: 0
1435 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1437 # Note: this only enables read-only access, creating new
1438 # legacy jobs and pipelines is not supported.
1440 # 'auto' -- (default) enable the Jobs API only if it has been used before
1441 # (i.e., there are job records in the database)
1442 # 'true' -- enable the Jobs API despite lack of existing records.
1443 # 'false' -- disable the Jobs API despite presence of existing records.
1446 # Git repositories must be readable by api server, or you won't be
1447 # able to submit crunch jobs. To pass the test suites, put a clone
1448 # of the arvados tree in {git_repositories_dir}/arvados.git or
1449 # {git_repositories_dir}/arvados/.git
1450 GitInternalDir: /var/lib/arvados/internal.git
1453 # Enable the cloud scheduler.
1456 # Name/number of port where workers' SSH services listen.
1459 # Interval between queue polls.
1462 # Shell command to execute on each worker to determine whether
1463 # the worker is booted and ready to run containers. It should
1464 # exit zero if the worker is ready.
1465 BootProbeCommand: "systemctl is-system-running"
1467 # Minimum interval between consecutive probes to a single
1471 # Maximum probes per second, across all workers in a pool.
1472 MaxProbesPerSecond: 10
1474 # Time before repeating SIGTERM when killing a container.
1477 # Time to give up on a process (most likely arv-mount) that
1478 # still holds a container lockfile after its main supervisor
1479 # process has exited, and declare the instance broken.
1480 TimeoutStaleRunLock: 5s
1482 # Time to give up on SIGTERM and write off the worker.
1485 # Maximum create/destroy-instance operations per second (0 =
1487 MaxCloudOpsPerSecond: 10
1489 # Maximum concurrent instance creation operations (0 = unlimited).
1491 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1492 # requests that can be in flight at any one time, whereas
1493 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1494 # that can be started per second.
1496 # Because the API for instance creation on Azure is synchronous, it is
1497 # recommended to increase MaxConcurrentInstanceCreateOps when running
1498 # on Azure. When using managed images, a value of 20 would be
1499 # appropriate. When using Azure Shared Image Galeries, it could be set
1500 # higher. For more information, see
1501 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1503 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1504 # providers too, if desired.
1505 MaxConcurrentInstanceCreateOps: 1
1507 # The maximum number of instances to run at a time, or 0 for
1510 # If more instances than this are already running and busy
1511 # when the dispatcher starts up, the running containers will
1512 # be allowed to finish before the excess instances are shut
1516 # The minimum number of instances expected to be runnable
1517 # without reaching a provider-imposed quota.
1519 # This is used as the initial value for the dispatcher's
1520 # dynamic instance limit, which increases (up to MaxInstances)
1521 # as containers start up successfully and decreases in
1522 # response to high API load and cloud quota errors.
1524 # Setting this to 0 means the dynamic instance limit will
1525 # start at MaxInstances.
1527 # Situations where you may want to set this (to a value less
1528 # than MaxInstances) would be when there is significant
1529 # variability or uncertainty in the actual cloud resources
1530 # available. Upon reaching InitialQuotaEstimate the
1531 # dispatcher will switch to a more conservative behavior with
1532 # slower instance start to avoid over-shooting cloud resource
1534 InitialQuotaEstimate: 0
1536 # Maximum fraction of available instance capacity allowed to
1537 # run "supervisor" containers at any given time. A supervisor
1538 # is a container whose purpose is mainly to submit and manage
1539 # other containers, such as arvados-cwl-runner workflow
1542 # If there is a hard limit on the amount of concurrent
1543 # containers that the cluster can run, it is important to
1544 # avoid crowding out the containers doing useful work with
1545 # containers who just create more work.
1547 # For example, with the default MaxInstances of 64, it will
1548 # schedule at most floor(64*0.50) = 32 concurrent workflow
1549 # runners, ensuring 32 slots are available for work.
1550 SupervisorFraction: 0.50
1552 # Interval between cloud provider syncs/updates ("list all
1556 # Time to leave an idle worker running (in case new containers
1557 # appear in the queue that it can run) before shutting it
1561 # Time to wait for a new worker to boot (i.e., pass
1562 # BootProbeCommand) before giving up and shutting it down.
1565 # Maximum time a worker can stay alive with no successful
1566 # probes before being automatically shut down.
1569 # Time after shutting down a worker to retry the
1570 # shutdown/destroy operation.
1571 TimeoutShutdown: 10s
1573 # Worker VM image ID.
1574 # (aws) AMI identifier
1575 # (azure) managed disks: the name of the managed disk image
1576 # (azure) shared image gallery: the name of the image definition. Also
1577 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1578 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1579 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1582 # Shell script to run on new instances using the cloud
1583 # provider's UserData (EC2) or CustomData (Azure) feature.
1585 # It is not necessary to include a #!/bin/sh line.
1586 InstanceInitCommand: ""
1588 # An executable file (located on the dispatcher host) to be
1589 # copied to cloud instances at runtime and used as the
1590 # container runner/supervisor. The default value is the
1591 # dispatcher program itself.
1593 # Use an empty string to disable this step: nothing will be
1594 # copied, and cloud instances are assumed to have a suitable
1595 # version of crunch-run installed; see CrunchRunCommand above.
1596 DeployRunnerBinary: "/proc/self/exe"
1598 # Install the Dispatcher's SSH public key (derived from
1599 # DispatchPrivateKey) when creating new cloud
1600 # instances. Change this to false if you are using a different
1601 # mechanism to pre-install the public key on new instances.
1602 DeployPublicKey: true
1604 # Tags to add on all resources (VMs, NICs, disks) created by
1605 # the container dispatcher. (Arvados's own tags --
1606 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1611 # Prefix for predefined tags used by Arvados (InstanceSetID,
1612 # InstanceType, InstanceSecret, IdleBehavior). With the
1613 # default value "Arvados", tags are "ArvadosInstanceSetID",
1614 # "ArvadosInstanceSecret", etc.
1616 # This should only be changed while no cloud resources are in
1617 # use and the cloud dispatcher is not running. Otherwise,
1618 # VMs/resources that were added using the old tag prefix will
1619 # need to be detected and cleaned up manually.
1620 TagKeyPrefix: Arvados
1622 # Cloud driver: "azure" (Microsoft Azure), "ec2" (Amazon AWS),
1623 # or "loopback" (run containers on dispatch host for testing
1627 # Cloud-specific driver parameters.
1630 # (ec2) Credentials. Omit or leave blank if using IAM role.
1634 # (ec2) Instance configuration.
1636 # (ec2) Region, like "us-east-1".
1639 # (ec2) Security group IDs. Omit or use {} to use the
1640 # default security group.
1644 # (ec2) One or more subnet IDs. Omit or leave empty to let
1645 # AWS choose a default subnet from your default VPC. If
1646 # multiple subnets are configured here (enclosed in brackets
1647 # like [subnet-abc123, subnet-def456]) the cloud dispatcher
1648 # will detect subnet-related errors and retry using a
1649 # different subnet. Most sites specify one subnet.
1653 AdminUsername: debian
1654 # (ec2) name of the IAMInstanceProfile for instances started by
1655 # the cloud dispatcher. Leave blank when not needed.
1656 IAMInstanceProfile: ""
1658 # (ec2) how often to look up spot instance pricing data
1659 # (only while running spot instances) for the purpose of
1660 # calculating container cost estimates. A value of 0
1661 # disables spot price lookups entirely.
1662 SpotPriceUpdateInterval: 24h
1664 # (ec2) per-GiB-month cost of EBS volumes. Matches
1665 # EBSVolumeType. Used to account for AddedScratch when
1666 # calculating container cost estimates. Note that
1667 # https://aws.amazon.com/ebs/pricing/ defines GB to mean
1668 # GiB, so an advertised price $0.10/GB indicates a real
1669 # price of $0.10/GiB and can be entered here as 0.10.
1672 # (azure) Credentials.
1678 # (azure) Instance configuration.
1679 CloudEnvironment: AzurePublicCloud
1682 # (azure) The resource group where the VM and virtual NIC will be
1686 # (azure) The resource group of the Network to use for the virtual
1687 # NIC (if different from ResourceGroup)
1688 NetworkResourceGroup: ""
1692 # (azure) managed disks: The resource group where the managed disk
1693 # image can be found (if different from ResourceGroup).
1694 ImageResourceGroup: ""
1696 # (azure) shared image gallery: the name of the gallery
1697 SharedImageGalleryName: ""
1698 # (azure) shared image gallery: the version of the image definition
1699 SharedImageGalleryImageVersion: ""
1701 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1705 # (azure) How long to wait before deleting VHD and NIC
1706 # objects that are no longer being used.
1707 DeleteDanglingResourcesAfter: 20s
1709 # Account (that already exists in the VM image) that will be
1710 # set up with an ssh authorized key to allow the compute
1711 # dispatcher to connect.
1712 AdminUsername: arvados
1716 # Use the instance type name as the key (in place of "SAMPLE" in
1717 # this sample entry).
1719 # Cloud provider's instance type. Defaults to the configured type name.
1723 IncludedScratch: 16GB
1725 # Hourly price ($), used to select node types for containers,
1726 # and to calculate estimated container costs. For spot
1727 # instances on EC2, this is also used as the maximum price
1728 # when launching spot instances, while the estimated container
1729 # cost is computed based on the current spot price according
1730 # to AWS. On Azure, and on-demand instances on EC2, the price
1731 # given here is used to compute container cost estimates.
1734 # Include this section if the node type includes GPU (CUDA) support
1736 DriverVersion: "11.0"
1737 HardwareCapability: "9.0"
1742 # If you use multiple storage classes, specify them here, using
1743 # the storage class name as the key (in place of "SAMPLE" in
1744 # this sample entry).
1746 # Further info/examples:
1747 # https://doc.arvados.org/admin/storage-classes.html
1750 # Priority determines the order volumes should be searched
1751 # when reading data, in cases where a keepstore server has
1752 # access to multiple volumes with different storage classes.
1755 # Default determines which storage class(es) should be used
1756 # when a user/client writes data or saves a new collection
1757 # without specifying storage classes.
1759 # If any StorageClasses are configured, at least one of them
1760 # must have Default: true.
1765 # AccessViaHosts specifies which keepstore processes can read
1766 # and write data on the volume.
1768 # For a local filesystem, AccessViaHosts has one entry,
1769 # indicating which server the filesystem is located on.
1771 # For a network-attached backend accessible by all keepstore
1772 # servers, like a cloud storage bucket or an NFS mount,
1773 # AccessViaHosts can be empty/omitted.
1775 # Further info/examples:
1776 # https://doc.arvados.org/install/configure-fs-storage.html
1777 # https://doc.arvados.org/install/configure-s3-object-storage.html
1778 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1782 "http://host1.example:25107": {}
1784 # AllowTrashWhenReadOnly enables unused and overreplicated
1785 # blocks to be trashed/deleted even when ReadOnly is
1786 # true. Normally, this is false and ReadOnly prevents all
1787 # trash/delete operations as well as writes.
1788 AllowTrashWhenReadOnly: false
1791 # If you have configured storage classes (see StorageClasses
1792 # section above), add an entry here for each storage class
1793 # satisfied by this volume.
1797 # for s3 driver -- see
1798 # https://doc.arvados.org/install/configure-s3-object-storage.html
1801 SecretAccessKey: aaaaa
1805 LocationConstraint: false
1813 # For S3 driver, potentially unsafe tuning parameter,
1814 # intentionally excluded from main documentation.
1816 # Enable deletion (garbage collection) even when the
1817 # configured BlobTrashLifetime is zero. WARNING: eventual
1818 # consistency may result in race conditions that can cause
1819 # data loss. Do not enable this unless you understand and
1823 # for azure driver -- see
1824 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1825 StorageAccountName: aaaaa
1826 StorageAccountKey: aaaaa
1827 StorageBaseURL: core.windows.net
1828 ContainerName: aaaaa
1830 ListBlobsRetryDelay: 10s
1831 ListBlobsMaxAttempts: 10
1833 WriteRaceInterval: 15s
1834 WriteRacePollTime: 1s
1836 # for local directory driver -- see
1837 # https://doc.arvados.org/install/configure-fs-storage.html
1838 Root: /var/lib/arvados/keep-data
1840 # For local directory driver, potentially confusing tuning
1841 # parameter, intentionally excluded from main documentation.
1843 # When true, read and write operations (for whole 64MiB
1844 # blocks) on an individual volume will queued and issued
1845 # serially. When false, read and write operations will be
1846 # issued concurrently.
1848 # May possibly improve throughput if you have physical spinning disks
1849 # and experience contention when there are multiple requests
1850 # to the same volume.
1852 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1853 # should leave this alone.
1857 # In order to send mail, Arvados expects a default SMTP server
1858 # on localhost:25. It cannot require authentication on
1859 # connections from localhost. That server should be configured
1860 # to relay mail to a "real" SMTP server that is able to send
1861 # email on behalf of your domain.
1863 # See also the "Users" configuration section for additional
1864 # email-related options.
1866 # When a user has been set up (meaning they are able to log in)
1867 # they will receive an email using the template specified
1868 # earlier in Users.UserSetupMailText
1869 SendUserSetupNotificationEmail: true
1871 # Bug/issue report notification to and from addresses
1872 IssueReporterEmailFrom: "arvados@example.com"
1873 IssueReporterEmailTo: "arvados@example.com"
1874 SupportEmailAddress: "arvados@example.com"
1876 # Generic issue email from
1877 EmailFrom: "arvados@example.com"
1879 # No longer supported, to be removed.
1888 ActivateUsers: false
1890 # API endpoint host or host:port; default is {id}.arvadosapi.com
1891 Host: sample.arvadosapi.com
1893 # Perform a proxy request when a local client requests an
1894 # object belonging to this remote.
1897 # Default "https". Can be set to "http" for testing.
1900 # Disable TLS verify. Can be set to true for testing.
1903 # When users present tokens issued by this remote cluster, and
1904 # their accounts are active on the remote cluster, activate
1905 # them on this cluster too.
1906 ActivateUsers: false
1909 # Workbench1 configs
1911 ActivationContactLink: mailto:info@arvados.org
1912 ArvadosDocsite: https://doc.arvados.org
1913 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1914 ShowUserAgreementInline: false
1916 # Set this configuration to true to avoid providing an easy way for users
1917 # to share data with unauthenticated users; this may be necessary on
1918 # installations where strict data access controls are needed.
1919 DisableSharingURLsUI: false
1921 # Below is a sample setting of user_profile_form_fields config parameter.
1922 # This configuration parameter should be set to either false (to disable) or
1923 # to a map as shown below.
1924 # Configure the map of input fields to be displayed in the profile page
1925 # using the attribute "key" for each of the input fields.
1926 # This sample shows configuration with one required and one optional form fields.
1927 # For each of these input fields:
1928 # You can specify "Type" as "text" or "select".
1929 # List the "Options" to be displayed for each of the "select" menu.
1930 # Set "Required" as "true" for any of these fields to make them required.
1931 # If any of the required fields are missing in the user's profile, the user will be
1932 # redirected to the profile page before they can access any Workbench features.
1933 UserProfileFormFields:
1936 FormFieldTitle: Best color
1937 FormFieldDescription: your favorite color
1946 # exampleTextValue: # key that will be set in properties
1948 # FormFieldTitle: ""
1949 # FormFieldDescription: ""
1952 # exampleOptionsValue:
1954 # FormFieldTitle: ""
1955 # FormFieldDescription: ""
1963 # Use "UserProfileFormMessage to configure the message you want
1964 # to display on the profile page.
1965 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1967 SiteName: Arvados Workbench
1969 # Workbench2 configs
1970 FileViewersConfigURL: ""
1972 # Idle time after which the user's session will be auto closed.
1973 # This feature is disabled when set to zero.
1976 # UUID of a collection. This collection should be shared with
1977 # all users. Workbench will look for a file "banner.html" in
1978 # this collection and display its contents (should be
1979 # HTML-formatted text) when users first log in to Workbench.
1982 # Workbench welcome screen, this is HTML text that will be
1983 # incorporated directly onto the page.
1985 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1986 <h2>Please log in.</h2>
1988 <p>If you have never used Arvados Workbench before, logging in
1989 for the first time will automatically create a new
1992 <i>Arvados Workbench uses your information only for
1993 identification, and does not retrieve any other personal
1996 # Workbench screen displayed to inactive users. This is HTML
1997 # text that will be incorporated directly onto the page.
1999 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
2000 <h3>Hi! You're logged in, but...</h3>
2001 <p>Your account is inactive.</p>
2002 <p>An administrator must activate your account before you can get
2005 # Connecting to Arvados shell VMs tends to be site-specific.
2006 # Put any special instructions here. This is HTML text that will
2007 # be incorporated directly onto the Workbench page.
2009 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
2010 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
2012 # Sample text if you are using a "switchyard" ssh proxy.
2013 # Replace "zzzzz" with your Cluster ID.
2015 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
2018 # ServerAliveInterval 60
2019 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
2022 # If you are using a switchyard ssh proxy, shell node hostnames
2023 # may require a special hostname suffix. In the sample ssh
2024 # configuration above, this would be ".zzzzz"
2025 # This is added to the hostname in the "command line" column
2026 # the Workbench "shell VMs" page.
2028 # If your shell nodes are directly accessible by users without a
2029 # proxy and have fully qualified host names, you should leave
2031 SSHHelpHostSuffix: ""
2033 # (Experimental) Restart services automatically when config file
2034 # changes are detected. Only supported by `arvados-server boot` in
2036 AutoReloadConfig: false