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 accept in a single
227 # service process, or 0 for no limit.
228 MaxConcurrentRequests: 64
230 # Fraction of MaxConcurrentRequests that can be "log create"
231 # messages at any given time. This is to prevent logging
232 # updates from crowding out more important requests.
233 LogCreateRequestFraction: 0.50
235 # Maximum number of 64MiB memory buffers per Keepstore server process, or
236 # 0 for no limit. When this limit is reached, up to
237 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
238 # buffers (like GET and PUT) will wait for buffer space to be released.
239 # Any HTTP requests beyond MaxConcurrentRequests will receive an
240 # immediate 503 response.
242 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
243 # * 1.1) fits comfortably in memory. On a host dedicated to running
244 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
245 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
246 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
247 MaxKeepBlobBuffers: 128
249 # API methods to disable. Disabled methods are not listed in the
250 # discovery document, and respond 404 to all requests.
251 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
254 # Interval (seconds) between asynchronous permission view updates. Any
255 # permission-updating API called with the 'async' parameter schedules a an
256 # update on the permission view in the future, if not already scheduled.
257 AsyncPermissionsUpdateInterval: 20s
259 # Maximum number of concurrent outgoing requests to make while
260 # serving a single incoming multi-cluster (federated) request.
261 MaxRequestAmplification: 4
263 # Maximum wall clock time to spend handling an incoming request.
266 # Websocket will send a periodic empty event after 'SendTimeout'
267 # if there is no other activity to maintain the connection /
268 # detect dropped connections.
271 WebsocketClientEventQueue: 64
272 WebsocketServerEventQueue: 4
274 # Timeout on requests to internal Keep services.
275 KeepServiceRequestTimeout: 15s
277 # Vocabulary file path, local to the node running the controller.
278 # This JSON file should contain the description of what's allowed
279 # as object's metadata. Its format is described at:
280 # https://doc.arvados.org/admin/metadata-vocabulary.html
283 # If true, a project must have a non-empty description field in
284 # order to be frozen.
285 FreezeProjectRequiresDescription: false
287 # Project properties that must have non-empty values in order to
288 # freeze a project. Example: "property_name": {}
289 FreezeProjectRequiresProperties:
292 # If true, only an admin user can un-freeze a project. If false,
293 # any user with "manage" permission can un-freeze.
294 UnfreezeProjectRequiresAdmin: false
296 # (Experimental) Use row-level locking on update API calls.
297 LockBeforeUpdate: false
300 # Config parameters to automatically setup new users. If enabled,
301 # this users will be able to self-activate. Enable this if you want
302 # to run an open instance where anyone can create an account and use
303 # the system without requiring manual approval.
305 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
306 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
307 AutoSetupNewUsers: false
308 AutoSetupNewUsersWithVmUUID: ""
309 AutoSetupNewUsersWithRepository: false
310 AutoSetupUsernameBlacklist:
319 # When NewUsersAreActive is set to true, new users will be active
320 # immediately. This skips the "self-activate" step which enforces
321 # user agreements. Should only be enabled for development.
322 NewUsersAreActive: false
324 # Newly activated users (whether set up by an admin or via
325 # AutoSetupNewUsers) immediately become visible to other active
328 # On a multi-tenant cluster, where the intent is for users to be
329 # invisible to one another unless they have been added to the
330 # same group(s) via Workbench admin interface, change this to
332 ActivatedUsersAreVisibleToOthers: true
334 # The e-mail address of the user you would like to become marked as an admin
335 # user on their first login.
336 AutoAdminUserWithEmail: ""
338 # If AutoAdminFirstUser is set to true, the first user to log in when no
339 # other admin users exist will automatically become an admin user.
340 AutoAdminFirstUser: false
342 # Email address to notify whenever a user creates a profile for the
344 UserProfileNotificationAddress: ""
345 AdminNotifierEmailFrom: arvados@example.com
346 EmailSubjectPrefix: "[ARVADOS] "
347 UserNotifierEmailFrom: arvados@example.com
348 UserNotifierEmailBcc: {}
349 NewUserNotificationRecipients: {}
350 NewInactiveUserNotificationRecipients: {}
352 # Set AnonymousUserToken to enable anonymous user access. Populate this
353 # field with a random string at least 50 characters long.
354 AnonymousUserToken: ""
356 # If a new user has an alternate email address (local@domain)
357 # with the domain given here, its local part becomes the new
358 # user's default username. Otherwise, the user's primary email
360 PreferDomainForUsername: ""
363 <% if not @user.full_name.empty? -%>
364 <%= @user.full_name %>,
369 Your Arvados account has been set up. You can log in at
371 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
374 Your Arvados administrator.
376 # If RoleGroupsVisibleToAll is true, all role groups are visible
377 # to all active users.
379 # If false, users must be granted permission to role groups in
380 # order to see them. This is more appropriate for a multi-tenant
382 RoleGroupsVisibleToAll: true
384 # If CanCreateRoleGroups is true, regular (non-admin) users can
385 # create new role groups.
387 # If false, only admins can create new role groups.
388 CanCreateRoleGroups: true
390 # During each period, a log entry with event_type="activity"
391 # will be recorded for each user who is active during that
392 # period. The object_uuid attribute will indicate the user's
395 # Multiple log entries for the same user may be generated during
396 # a period if there are multiple controller processes or a
397 # controller process is restarted.
399 # Use 0 to disable activity logging.
400 ActivityLoggingPeriod: 24h
403 # Time to keep audit logs, in seconds. (An audit log is a row added
404 # to the "logs" table in the PostgreSQL database each time an
405 # Arvados object is created, modified, or deleted.)
407 # Currently, websocket event notifications rely on audit logs, so
408 # this should not be set lower than 300 (5 minutes).
411 # Maximum number of log rows to delete in a single SQL transaction.
413 # If MaxDeleteBatch is 0, log entries will never be
414 # deleted by Arvados. Cleanup can be done by an external process
415 # without affecting any Arvados system processes, as long as very
416 # recent (<5 minutes old) logs are not deleted.
418 # 100000 is a reasonable batch size for most sites.
421 # Attributes to suppress in events and audit logs. Notably,
422 # specifying {"manifest_text": {}} here typically makes the database
423 # smaller and faster.
425 # Warning: Using any non-empty value here can have undesirable side
426 # effects for any client or component that relies on event logs.
427 # Use at your own risk.
428 UnloggedAttributes: {}
432 # Logging threshold: panic, fatal, error, warn, info, debug, or
436 # Logging format: json or text
439 # Maximum characters of (JSON-encoded) query parameters to include
440 # in each request log entry. When params exceed this size, they will
441 # be JSON-encoded, truncated to this size, and logged as
443 MaxRequestLogParamsSize: 2000
447 # Enable access controls for data stored in Keep. This should
448 # always be set to true on a production cluster.
451 # BlobSigningKey is a string of alphanumeric characters used to
452 # generate permission signatures for Keep locators. It must be
453 # identical to the permission key given to Keep. IMPORTANT: This
454 # is a site secret. It should be at least 50 characters.
456 # Modifying BlobSigningKey will invalidate all existing
457 # signatures, which can cause programs to fail (e.g., arv-put,
458 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
459 # when no such processes are running.
462 # Enable garbage collection of unreferenced blobs in Keep.
465 # Time to leave unreferenced blobs in "trashed" state before
466 # deleting them, or 0 to skip the "trashed" state entirely and
467 # delete unreferenced blobs.
469 # If you use any Amazon S3 buckets as storage volumes, this
470 # must be at least 24h to avoid occasional data loss.
471 BlobTrashLifetime: 336h
473 # How often to check for (and delete) trashed blocks whose
474 # BlobTrashLifetime has expired.
475 BlobTrashCheckInterval: 24h
477 # Maximum number of concurrent "trash blob" and "delete trashed
478 # blob" operations conducted by a single keepstore process. Each
479 # of these can be set to 0 to disable the respective operation.
481 # If BlobTrashLifetime is zero, "trash" and "delete trash"
482 # happen at once, so only the lower of these two values is used.
483 BlobTrashConcurrency: 4
484 BlobDeleteConcurrency: 4
486 # Maximum number of concurrent "create additional replica of
487 # existing blob" operations conducted by a single keepstore
489 BlobReplicateConcurrency: 4
491 # Default replication level for collections. This is used when a
492 # collection's replication_desired attribute is nil.
493 DefaultReplication: 2
495 # BlobSigningTTL determines the minimum lifetime of transient
496 # data, i.e., blocks that are not referenced by
497 # collections. Unreferenced blocks exist for two reasons:
499 # 1) A data block must be written to a disk/cloud backend device
500 # before a collection can be created/updated with a reference to
503 # 2) Deleting or updating a collection can remove the last
504 # remaining reference to a data block.
506 # If BlobSigningTTL is too short, long-running
507 # processes/containers will fail when they take too long (a)
508 # between writing blocks and writing collections that reference
509 # them, or (b) between reading collections and reading the
512 # If BlobSigningTTL is too long, data will still be stored long
513 # after the referring collections are deleted, and you will
514 # needlessly fill up disks or waste money on cloud storage.
516 # Modifying BlobSigningTTL invalidates existing signatures; see
517 # BlobSigningKey note above.
519 # The default is 2 weeks.
522 # When running keep-balance, this is the destination filename for
523 # the list of lost block hashes if there are any, one per line.
524 # Updated automically during each successful run.
525 BlobMissingReport: ""
527 # keep-balance operates periodically, i.e.: do a
528 # scan/balance operation, sleep, repeat.
530 # BalancePeriod determines the interval between start times of
531 # successive scan/balance operations. If a scan/balance operation
532 # takes longer than BalancePeriod, the next one will follow it
535 # If SIGUSR1 is received during an idle period between operations,
536 # the next operation will start immediately.
539 # Limits the number of collections retrieved by keep-balance per
540 # API transaction. If this is zero, page size is
541 # determined by the API server's own page size limits (see
542 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
543 BalanceCollectionBatch: 0
545 # The size of keep-balance's internal queue of
546 # collections. Higher values use more memory and improve throughput
547 # by allowing keep-balance to fetch the next page of collections
548 # while the current page is still being processed. If this is zero
549 # or omitted, pages are processed serially.
550 BalanceCollectionBuffers: 1000
552 # Maximum time for a rebalancing run. This ensures keep-balance
553 # eventually gives up and retries if, for example, a network
554 # error causes a hung connection that is never closed by the
555 # OS. It should be long enough that it doesn't interrupt a
556 # long-running balancing operation.
559 # Maximum number of replication_confirmed /
560 # storage_classes_confirmed updates to write to the database
561 # after a rebalancing run. When many updates are needed, this
562 # spreads them over a few runs rather than applying them all at
564 BalanceUpdateLimit: 100000
566 # Default lifetime for ephemeral collections: 2 weeks. This must not
567 # be less than BlobSigningTTL.
568 DefaultTrashLifetime: 336h
570 # Interval (seconds) between trash sweeps. During a trash sweep,
571 # collections are marked as trash if their trash_at time has
572 # arrived, and deleted if their delete_at time has arrived.
573 TrashSweepInterval: 60s
575 # If true, enable collection versioning.
576 # When a collection's preserve_version field is true or the current version
577 # is older than the amount of seconds defined on PreserveVersionIfIdle,
578 # a snapshot of the collection's previous state is created and linked to
579 # the current collection.
580 CollectionVersioning: true
582 # 0s = auto-create a new version on every update.
583 # -1s = never auto-create new versions.
584 # > 0s = auto-create a new version when older than the specified number of seconds.
585 PreserveVersionIfIdle: 10s
587 # If non-empty, allow project and collection names to contain
588 # the "/" character (slash/stroke/solidus), and replace "/" with
589 # the given string in the filesystem hierarchy presented by
590 # WebDAV. Example values are "%2f" and "{slash}". Names that
591 # contain the substitution string itself may result in confusing
592 # behavior, so a value like "_" is not recommended.
594 # If the default empty value is used, the server will reject
595 # requests to create or rename a collection when the new name
598 # If the value "/" is used, project and collection names
599 # containing "/" will be allowed, but they will not be
600 # accessible via WebDAV.
602 # Use of this feature is not recommended, if it can be avoided.
603 ForwardSlashNameSubstitution: ""
605 # Include "folder objects" in S3 ListObjects responses.
606 S3FolderObjects: true
608 # Managed collection properties. At creation time, if the client didn't
609 # provide the listed keys, they will be automatically populated following
610 # one of the following behaviors:
612 # * UUID of the user who owns the containing project.
613 # responsible_person_uuid: {Function: original_owner, Protected: true}
615 # * Default concrete value.
616 # foo_bar: {Value: baz, Protected: false}
618 # If Protected is true, only an admin user can modify its value.
620 SAMPLE: {Function: original_owner, Protected: true}
622 # In "trust all content" mode, Workbench will redirect download
623 # requests to WebDAV preview link, even in the cases when
624 # WebDAV would have to expose XSS vulnerabilities in order to
625 # handle the redirect (see discussion on Services.WebDAV).
627 # This setting has no effect in the recommended configuration, where the
628 # WebDAV service is configured to have a separate domain for every
629 # collection and XSS protection is provided by browsers' same-origin
632 # The default setting (false) is appropriate for a multi-user site.
633 TrustAllContent: false
635 # Cache parameters for WebDAV content serving:
637 # Time to cache manifests, permission checks, and sessions.
640 # Block cache entries. Each block consumes up to 64 MiB RAM.
643 # Approximate memory limit (in bytes) for session cache.
645 # Note this applies to the in-memory representation of
646 # projects and collections -- metadata, block locators,
647 # filenames, etc. -- excluding cached file content, which is
648 # limited by MaxBlockEntries.
649 MaxCollectionBytes: 100000000
651 # Persistent sessions.
654 # Selectively set permissions for regular users and admins to
655 # download or upload data files using the upload/download
656 # features for Workbench, WebDAV and S3 API support.
665 # Selectively set permissions for regular users and admins to be
666 # able to download or upload blocks using arv-put and
667 # arv-get from outside the cluster.
676 # Post upload / download events to the API server logs table, so
677 # that they can be included in the arv-user-activity report.
678 # You can disable this if you find that it is creating excess
679 # load on the API server and you don't need it.
680 WebDAVLogEvents: true
683 # One of the following mechanisms (Google, PAM, LDAP, or
684 # LoginCluster) should be enabled; see
685 # https://doc.arvados.org/install/setup-login.html
688 # Authenticate with Google.
691 # Use the Google Cloud console to enable the People API (APIs
692 # and Services > Enable APIs and services > Google People API
693 # > Enable), generate a Client ID and secret (APIs and
694 # Services > Credentials > Create credentials > OAuth client
695 # ID > Web application) and add your controller's /login URL
696 # (e.g., "https://zzzzz.example.com/login") as an authorized
701 # Allow users to log in to existing accounts using any verified
702 # email address listed by their Google account. If true, the
703 # Google People API must be enabled in order for Google login to
704 # work. If false, only the primary email address will be used.
705 AlternateEmailAddresses: true
707 # Send additional parameters with authentication requests. See
708 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
709 # for a list of supported parameters.
710 AuthenticationRequestParameters:
711 # Show the "choose which Google account" page, even if the
712 # client is currently logged in to exactly one Google
714 prompt: select_account
719 # Authenticate with an OpenID Connect provider.
722 # Issuer URL, e.g., "https://login.example.com".
724 # This must be exactly equal to the URL returned by the issuer
725 # itself in its config response ("isser" key). If the
726 # configured value is "https://example" and the provider
727 # returns "https://example:443" or "https://example/" then
728 # login will fail, even though those URLs are equivalent
732 # Your client ID and client secret (supplied by the provider).
736 # OpenID claim field containing the user's email
737 # address. Normally "email"; see
738 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
741 # OpenID claim field containing the email verification
742 # flag. Normally "email_verified". To accept every returned
743 # email address without checking a "verified" field at all,
744 # use the empty string "".
745 EmailVerifiedClaim: "email_verified"
747 # OpenID claim field containing the user's preferred
748 # username. If empty, use the mailbox part of the user's email
752 # Send additional parameters with authentication requests,
753 # like {display: page, prompt: consent}. See
754 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
755 # and refer to your provider's documentation for supported
757 AuthenticationRequestParameters:
760 # Accept an OIDC access token as an API token if the OIDC
761 # provider's UserInfo endpoint accepts it.
763 # AcceptAccessTokenScope should also be used when enabling
765 AcceptAccessToken: false
767 # Before accepting an OIDC access token as an API token, first
768 # check that it is a JWT whose "scope" value includes this
769 # value. Example: "https://zzzzz.example.com/" (your Arvados
772 # If this value is empty and AcceptAccessToken is true, all
773 # access tokens will be accepted regardless of scope,
774 # including non-JWT tokens. This is not recommended.
775 AcceptAccessTokenScope: ""
778 # Use PAM to authenticate users.
781 # PAM service name. PAM will apply the policy in the
782 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
783 # there is none, the default "other" config.
786 # Domain name (e.g., "example.com") to use to construct the
787 # user's email address if PAM authentication returns a
788 # username with no "@". If empty, use the PAM username as the
789 # user's email address, whether or not it contains "@".
791 # Note that the email address is used as the primary key for
792 # user records when logging in. Therefore, if you change
793 # PAMDefaultEmailDomain after the initial installation, you
794 # should also update existing user records to reflect the new
795 # domain. Otherwise, next time those users log in, they will
796 # be given new accounts instead of accessing their existing
798 DefaultEmailDomain: ""
801 # Use an LDAP service to authenticate users.
804 # Server URL, like "ldap://ldapserver.example.com:389" or
805 # "ldaps://ldapserver.example.com:636".
806 URL: "ldap://ldap:389"
808 # Use StartTLS upon connecting to the server.
811 # Skip TLS certificate name verification.
814 # Mininum TLS version to negotiate when connecting to server
815 # (ldaps://... or StartTLS). It may be necessary to set this
816 # to "1.1" for compatibility with older LDAP servers that fail
817 # with 'LDAP Result Code 200 "Network Error": TLS handshake
818 # failed (tls: server selected unsupported protocol version
821 # If blank, use the recommended minimum version (1.2).
824 # Strip the @domain part if a user supplies an email-style
825 # username with this domain. If "*", strip any user-provided
826 # domain. If "", never strip the domain part. Example:
830 # If, after applying StripDomain, the username contains no "@"
831 # character, append this domain to form an email-style
832 # username. Example: "example.com"
835 # The LDAP attribute to filter on when looking up a username
836 # (after applying StripDomain and AppendDomain).
839 # Bind with this username (DN or UPN) and password when
840 # looking up the user record.
842 # Example user: "cn=admin,dc=example,dc=com"
844 SearchBindPassword: ""
846 # Directory base for username lookup. Example:
847 # "ou=Users,dc=example,dc=com"
850 # Additional filters to apply when looking up users' LDAP
851 # entries. This can be used to restrict access to a subset of
852 # LDAP users, or to disambiguate users from other directory
853 # entries that have the SearchAttribute present.
855 # Special characters in assertion values must be escaped (see
858 # Example: "(objectClass=person)"
861 # LDAP attribute to use as the user's email address.
863 # Important: This must not be an attribute whose value can be
864 # edited in the directory by the users themselves. Otherwise,
865 # users can take over other users' Arvados accounts trivially
866 # (email address is the primary key for Arvados accounts.)
869 # LDAP attribute to use as the preferred Arvados username. If
870 # no value is found (or this config is empty) the username
871 # originally supplied by the user will be used.
872 UsernameAttribute: uid
875 # Authenticate users listed here in the config file. This
876 # feature is intended to be used in test environments, and
877 # should not be used in production.
881 Email: alice@example.com
884 # The cluster ID to delegate the user database. When set,
885 # logins on this cluster will be redirected to the login cluster
886 # (login cluster must appear in RemoteClusters with Proxy: true)
889 # How long a cached token belonging to a remote cluster will
890 # remain valid before it needs to be revalidated.
891 RemoteTokenRefresh: 5m
893 # How long a client token created from a login flow will be valid without
894 # asking the user to re-login. Example values: 60m, 8h.
895 # Default value zero means tokens don't have expiration.
898 # If true (default) tokens issued through login are allowed to create
900 # If false, tokens issued through login are not allowed to
901 # viewing/creating other tokens. New tokens can only be created
902 # by going through login again.
903 IssueTrustedTokens: true
905 # Origins (scheme://host[:port]) of clients trusted to receive
906 # new tokens via login process. The ExternalURLs of the local
907 # Workbench1 and Workbench2 are trusted implicitly and do not
908 # need to be listed here. If this is a LoginCluster, you
909 # probably want to include the other Workbench instances in the
910 # federation in this list.
915 # "https://workbench.other-cluster.example": {}
916 # "https://workbench2.other-cluster.example": {}
920 # Treat any origin whose host part is "localhost" or a private
921 # IP address (e.g., http://10.0.0.123:3000/) as if it were
922 # listed in TrustedClients.
924 # Intended only for test/development use. Not appropriate for
926 TrustPrivateNetworks: false
929 # Path to git or gitolite-shell executable. Each authenticated
930 # request will execute this program with the single argument "http-backend"
931 GitCommand: /usr/bin/git
933 # Path to Gitolite's home directory. If a non-empty path is given,
934 # the CGI environment will be set up to support the use of
935 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
936 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
937 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
940 # Git repositories must be readable by api server, or you won't be
941 # able to submit crunch jobs. To pass the test suites, put a clone
942 # of the arvados tree in {git_repositories_dir}/arvados.git or
943 # {git_repositories_dir}/arvados/.git
944 Repositories: /var/lib/arvados/git/repositories
947 # Use "file:///var/lib/acme/live/example.com/cert" and
948 # ".../privkey" to load externally managed certificates.
952 # Accept invalid certificates when connecting to servers. Never
953 # use this in production.
957 # Obtain certificates automatically for ExternalURL domains
958 # using an ACME server and http-01 validation.
960 # To use Let's Encrypt, specify "LE". To use the Let's
961 # Encrypt staging environment, specify "LE-staging". To use a
962 # different ACME server, specify the full directory URL
965 # Note: this feature is not yet implemented in released
966 # versions, only in the alpha/prerelease arvados-server-easy
969 # Implies agreement with the server's terms of service.
973 # List of supported Docker Registry image formats that compute nodes
974 # are able to use. `arv keep docker` will error out if a user tries
975 # to store an image with an unsupported format. Use an empty array
976 # to skip the compatibility check (and display a warning message to
979 # Example for sites running docker < 1.10: {"v1": {}}
980 # Example for sites running docker >= 1.10: {"v2": {}}
981 # Example for disabling check: {}
982 SupportedDockerImageFormats:
986 # Include details about job reuse decisions in the server log. This
987 # causes additional database queries to run, so it should not be
988 # enabled unless you expect to examine the resulting logs for
989 # troubleshooting purposes.
990 LogReuseDecisions: false
992 # Default value for keep_cache_ram of a container's
993 # runtime_constraints. Note: this gets added to the RAM request
994 # used to allocate a VM or submit an HPC job.
996 # If this is zero, container requests that don't specify RAM or
997 # disk cache size will use a disk cache, sized to the
998 # container's RAM requirement (but with minimum 2 GiB and
1001 # Note: If you change this value, containers that used the previous
1002 # default value will only be reused by container requests that
1003 # explicitly specify the previous value in their keep_cache_ram
1004 # runtime constraint.
1005 DefaultKeepCacheRAM: 0
1007 # Number of times a container can be unlocked before being
1008 # automatically cancelled.
1009 MaxDispatchAttempts: 5
1011 # Default value for container_count_max for container requests. This is the
1012 # number of times Arvados will create a new container to satisfy a container
1013 # request. If a container is cancelled it will retry a new container if
1014 # container_count < container_count_max on any container requests associated
1015 # with the cancelled container.
1018 # Schedule all child containers on preemptible instances (e.g. AWS
1019 # Spot Instances) even if not requested by the submitter.
1021 # If false, containers are scheduled on preemptible instances
1022 # only when requested by the submitter.
1024 # This flag is ignored if no preemptible instance types are
1025 # configured, and has no effect on top-level containers.
1026 AlwaysUsePreemptibleInstances: false
1028 # Automatically add a preemptible variant for every
1029 # non-preemptible entry in InstanceTypes below. The maximum bid
1030 # price for the preemptible variant will be the non-preemptible
1031 # price multiplied by PreemptiblePriceFactor. If 0, preemptible
1032 # variants are not added automatically.
1034 # A price factor of 1.0 is a reasonable starting point.
1035 PreemptiblePriceFactor: 0
1037 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
1038 # cloud dispatcher for executing containers on worker VMs.
1039 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
1040 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
1041 DispatchPrivateKey: ""
1043 # Maximum time to wait for workers to come up before abandoning
1044 # stale locks from a previous dispatch process.
1045 StaleLockTimeout: 1m
1047 # The crunch-run command used to start a container on a worker node.
1049 # When dispatching to cloud VMs, this is used only if
1050 # DeployRunnerBinary in the CloudVMs section is set to the empty
1052 CrunchRunCommand: "crunch-run"
1054 # Extra arguments to add to crunch-run invocation
1055 # Example: ["--cgroup-parent-subsystem=memory"]
1056 CrunchRunArgumentsList: []
1058 # Extra RAM to reserve on the node, in addition to
1059 # the amount specified in the container's RuntimeConstraints
1060 ReserveExtraRAM: 550MiB
1062 # Minimum time between two attempts to run the same container
1065 # Container runtime: "docker" (default) or "singularity"
1066 RuntimeEngine: docker
1068 # When running a container, run a dedicated keepstore process,
1069 # using the specified number of 64 MiB memory buffers per
1070 # allocated CPU core (VCPUs in the container's runtime
1071 # constraints). The dedicated keepstore handles I/O for
1072 # collections mounted in the container, as well as saving
1075 # A zero value disables this feature.
1077 # In order for this feature to be activated, no volume may use
1078 # AccessViaHosts, and no writable volume may have Replication
1079 # lower than Collections.DefaultReplication. If these
1080 # requirements are not satisfied, the feature is disabled
1081 # automatically regardless of the value given here.
1083 # When an HPC dispatcher is in use (see SLURM and LSF sections),
1084 # this feature depends on the operator to ensure an up-to-date
1085 # cluster configuration file (/etc/arvados/config.yml) is
1086 # available on all compute nodes. If it is missing or not
1087 # readable by the crunch-run user, the feature will be disabled
1088 # automatically. To read it from a different location, add a
1089 # "-config=/path/to/config.yml" argument to
1090 # CrunchRunArgumentsList above.
1092 # When the cloud dispatcher is in use (see CloudVMs section) and
1093 # this configuration is enabled, the entire cluster
1094 # configuration file, including the system root token, is copied
1095 # to the worker node and held in memory for the duration of the
1097 LocalKeepBlobBuffersPerVCPU: 1
1099 # When running a dedicated keepstore process for a container
1100 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
1101 # messages to keepstore.txt in the container's log collection.
1103 # These log messages can reveal some volume configuration
1104 # details, error messages from the cloud storage provider, etc.,
1105 # which are not otherwise visible to users.
1108 # * "none" -- no keepstore.txt file
1109 # * "all" -- all logs, including request and response lines
1110 # * "errors" -- all logs except "response" logs with 2xx
1111 # response codes and "request" logs
1112 LocalKeepLogsToContainerLog: none
1115 # Periodically (see SweepInterval) Arvados will check for
1116 # containers that have been finished for at least this long,
1117 # and delete their stdout, stderr, arv-mount, crunch-run, and
1118 # crunchstat logs from the logs table.
1121 # How often to delete cached log entries for finished
1122 # containers (see MaxAge).
1125 # These two settings control how frequently log events are flushed to the
1126 # database. Log lines are buffered until either crunch_log_bytes_per_event
1127 # has been reached or crunch_log_seconds_between_events has elapsed since
1129 LogBytesPerEvent: 4096
1130 LogSecondsBetweenEvents: 5s
1132 # The sample period for throttling logs.
1133 LogThrottlePeriod: 60s
1135 # Maximum number of bytes that job can log over crunch_log_throttle_period
1136 # before being silenced until the end of the period.
1137 LogThrottleBytes: 65536
1139 # Maximum number of lines that job can log over crunch_log_throttle_period
1140 # before being silenced until the end of the period.
1141 LogThrottleLines: 1024
1143 # Maximum bytes that may be logged by a single job. Log bytes that are
1144 # silenced by throttling are not counted against this total.
1145 LimitLogBytesPerJob: 67108864
1147 LogPartialLineThrottlePeriod: 5s
1149 # Container logs are written to Keep and saved in a
1150 # collection, which is updated periodically while the
1151 # container runs. This value sets the interval between
1152 # collection updates.
1153 LogUpdatePeriod: 30m
1155 # The log collection is also updated when the specified amount of
1156 # log data (given in bytes) is produced in less than one update
1158 LogUpdateSize: 32MiB
1161 # An admin user can use "arvados-client shell" to start an
1162 # interactive shell (with any user ID) in any running
1166 # Any user can use "arvados-client shell" to start an
1167 # interactive shell (with any user ID) in any running
1168 # container that they started, provided it isn't also
1169 # associated with a different user's container request.
1171 # Interactive sessions make it easy to alter the container's
1172 # runtime environment in ways that aren't recorded or
1173 # reproducible. Consider the implications for automatic
1174 # container reuse before enabling and using this feature. In
1175 # particular, note that starting an interactive session does
1176 # not disqualify a container from being reused by a different
1177 # user/workflow in the future.
1182 SbatchArgumentsList: []
1183 SbatchEnvironmentVariables:
1186 # Path to dns server configuration directory
1187 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1188 # files or touch restart.txt (see below).
1189 DNSServerConfDir: ""
1191 # Template file for the dns server host snippets. See
1192 # unbound.template in this directory for an example. If false, do
1193 # not write any config files.
1194 DNSServerConfTemplate: ""
1196 # String to write to {dns_server_conf_dir}/restart.txt (with a
1197 # trailing newline) after updating local data. If false, do not
1198 # open or write the restart.txt file.
1199 DNSServerReloadCommand: ""
1201 # Command to run after each DNS update. Template variables will be
1202 # substituted; see the "unbound" example below. If false, do not run
1204 DNSServerUpdateCommand: ""
1206 ComputeNodeDomain: ""
1207 ComputeNodeNameservers:
1211 # Hostname to assign to a compute node when it sends a "ping" and the
1212 # hostname in its Node record is nil.
1213 # During bootstrapping, the "ping" script is expected to notice the
1214 # hostname given in the ping response, and update its unix hostname
1216 # If false, leave the hostname alone (this is appropriate if your compute
1217 # nodes' hostnames are already assigned by some other mechanism).
1219 # One way or another, the hostnames of your node records should agree
1220 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1222 # Example for compute0000, compute0001, ....:
1223 # assign_node_hostname: compute%<slot_number>04d
1224 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1225 AssignNodeHostname: "compute%<slot_number>d"
1228 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1230 # Template variables starting with % will be substituted as follows:
1233 # %C number of VCPUs
1236 # %G number of GPU devices (runtime_constraints.cuda.device_count)
1238 # Use %% to express a literal %. The %%J in the default will be changed
1239 # to %J, which is interpreted by bsub itself.
1241 # Note that the default arguments cause LSF to write two files
1242 # in /tmp on the compute node each time an Arvados container
1243 # runs. Ensure you have something in place to delete old files
1244 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1245 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]"]
1247 # Arguments that will be appended to the bsub command line
1248 # when submitting Arvados containers as LSF jobs with
1249 # runtime_constraints.cuda.device_count > 0
1250 BsubCUDAArguments: ["-gpu", "num=%G"]
1252 # Use sudo to switch to this user account when submitting LSF
1255 # This account must exist on the hosts where LSF jobs run
1256 # ("execution hosts"), as well as on the host where the
1257 # Arvados LSF dispatcher runs ("submission host").
1258 BsubSudoUser: "crunch"
1261 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1263 # Note: this only enables read-only access, creating new
1264 # legacy jobs and pipelines is not supported.
1266 # 'auto' -- (default) enable the Jobs API only if it has been used before
1267 # (i.e., there are job records in the database)
1268 # 'true' -- enable the Jobs API despite lack of existing records.
1269 # 'false' -- disable the Jobs API despite presence of existing records.
1272 # Git repositories must be readable by api server, or you won't be
1273 # able to submit crunch jobs. To pass the test suites, put a clone
1274 # of the arvados tree in {git_repositories_dir}/arvados.git or
1275 # {git_repositories_dir}/arvados/.git
1276 GitInternalDir: /var/lib/arvados/internal.git
1279 # Enable the cloud scheduler.
1282 # Name/number of port where workers' SSH services listen.
1285 # Interval between queue polls.
1288 # Shell command to execute on each worker to determine whether
1289 # the worker is booted and ready to run containers. It should
1290 # exit zero if the worker is ready.
1291 BootProbeCommand: "systemctl is-system-running"
1293 # Minimum interval between consecutive probes to a single
1297 # Maximum probes per second, across all workers in a pool.
1298 MaxProbesPerSecond: 10
1300 # Time before repeating SIGTERM when killing a container.
1303 # Time to give up on a process (most likely arv-mount) that
1304 # still holds a container lockfile after its main supervisor
1305 # process has exited, and declare the instance broken.
1306 TimeoutStaleRunLock: 5s
1308 # Time to give up on SIGTERM and write off the worker.
1311 # Maximum create/destroy-instance operations per second (0 =
1313 MaxCloudOpsPerSecond: 10
1315 # Maximum concurrent instance creation operations (0 = unlimited).
1317 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1318 # requests that can be in flight at any one time, whereas
1319 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1320 # that can be started per second.
1322 # Because the API for instance creation on Azure is synchronous, it is
1323 # recommended to increase MaxConcurrentInstanceCreateOps when running
1324 # on Azure. When using managed images, a value of 20 would be
1325 # appropriate. When using Azure Shared Image Galeries, it could be set
1326 # higher. For more information, see
1327 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1329 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1330 # providers too, if desired.
1331 MaxConcurrentInstanceCreateOps: 1
1333 # The maximum number of instances to run at a time, or 0 for
1336 # If more instances than this are already running and busy
1337 # when the dispatcher starts up, the running containers will
1338 # be allowed to finish before the excess instances are shut
1342 # Maximum fraction of CloudVMs.MaxInstances allowed to run
1343 # "supervisor" containers at any given time. A supervisor is a
1344 # container whose purpose is mainly to submit and manage other
1345 # containers, such as arvados-cwl-runner workflow runner.
1347 # If there is a hard limit on the amount of concurrent
1348 # containers that the cluster can run, it is important to
1349 # avoid crowding out the containers doing useful work with
1350 # containers who just create more work.
1352 # For example, with the default MaxInstances of 64, it will
1353 # schedule at most floor(64*0.30) = 19 concurrent workflows,
1354 # ensuring 45 slots are available for work.
1355 SupervisorFraction: 0.30
1357 # Interval between cloud provider syncs/updates ("list all
1361 # Time to leave an idle worker running (in case new containers
1362 # appear in the queue that it can run) before shutting it
1366 # Time to wait for a new worker to boot (i.e., pass
1367 # BootProbeCommand) before giving up and shutting it down.
1370 # Maximum time a worker can stay alive with no successful
1371 # probes before being automatically shut down.
1374 # Time after shutting down a worker to retry the
1375 # shutdown/destroy operation.
1376 TimeoutShutdown: 10s
1378 # Worker VM image ID.
1379 # (aws) AMI identifier
1380 # (azure) managed disks: the name of the managed disk image
1381 # (azure) shared image gallery: the name of the image definition. Also
1382 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1383 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1384 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1387 # An executable file (located on the dispatcher host) to be
1388 # copied to cloud instances at runtime and used as the
1389 # container runner/supervisor. The default value is the
1390 # dispatcher program itself.
1392 # Use the empty string to disable this step: nothing will be
1393 # copied, and cloud instances are assumed to have a suitable
1394 # version of crunch-run installed; see CrunchRunCommand above.
1395 DeployRunnerBinary: "/proc/self/exe"
1397 # Tags to add on all resources (VMs, NICs, disks) created by
1398 # the container dispatcher. (Arvados's own tags --
1399 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1404 # Prefix for predefined tags used by Arvados (InstanceSetID,
1405 # InstanceType, InstanceSecret, IdleBehavior). With the
1406 # default value "Arvados", tags are "ArvadosInstanceSetID",
1407 # "ArvadosInstanceSecret", etc.
1409 # This should only be changed while no cloud resources are in
1410 # use and the cloud dispatcher is not running. Otherwise,
1411 # VMs/resources that were added using the old tag prefix will
1412 # need to be detected and cleaned up manually.
1413 TagKeyPrefix: Arvados
1415 # Cloud driver: "azure" (Microsoft Azure), "ec2" (Amazon AWS),
1416 # or "loopback" (run containers on dispatch host for testing
1420 # Cloud-specific driver parameters.
1423 # (ec2) Credentials. Omit or leave blank if using IAM role.
1427 # (ec2) Instance configuration.
1433 AdminUsername: debian
1434 # (ec2) name of the IAMInstanceProfile for instances started by
1435 # the cloud dispatcher. Leave blank when not needed.
1436 IAMInstanceProfile: ""
1438 # (ec2) how often to look up spot instance pricing data
1439 # (only while running spot instances) for the purpose of
1440 # calculating container cost estimates. A value of 0
1441 # disables spot price lookups entirely.
1442 SpotPriceUpdateInterval: 24h
1444 # (ec2) per-GiB-month cost of EBS volumes. Matches
1445 # EBSVolumeType. Used to account for AddedScratch when
1446 # calculating container cost estimates. Note that
1447 # https://aws.amazon.com/ebs/pricing/ defines GB to mean
1448 # GiB, so an advertised price $0.10/GB indicates a real
1449 # price of $0.10/GiB and can be entered here as 0.10.
1452 # (azure) Credentials.
1458 # (azure) Instance configuration.
1459 CloudEnvironment: AzurePublicCloud
1462 # (azure) The resource group where the VM and virtual NIC will be
1466 # (azure) The resource group of the Network to use for the virtual
1467 # NIC (if different from ResourceGroup)
1468 NetworkResourceGroup: ""
1472 # (azure) managed disks: The resource group where the managed disk
1473 # image can be found (if different from ResourceGroup).
1474 ImageResourceGroup: ""
1476 # (azure) shared image gallery: the name of the gallery
1477 SharedImageGalleryName: ""
1478 # (azure) shared image gallery: the version of the image definition
1479 SharedImageGalleryImageVersion: ""
1481 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1485 # (azure) How long to wait before deleting VHD and NIC
1486 # objects that are no longer being used.
1487 DeleteDanglingResourcesAfter: 20s
1489 # Account (that already exists in the VM image) that will be
1490 # set up with an ssh authorized key to allow the compute
1491 # dispatcher to connect.
1492 AdminUsername: arvados
1496 # Use the instance type name as the key (in place of "SAMPLE" in
1497 # this sample entry).
1499 # Cloud provider's instance type. Defaults to the configured type name.
1503 IncludedScratch: 16GB
1505 # Hourly price ($), used to select node types for containers,
1506 # and to calculate estimated container costs. For spot
1507 # instances on EC2, this is also used as the maximum price
1508 # when launching spot instances, while the estimated container
1509 # cost is computed based on the current spot price according
1510 # to AWS. On Azure, and on-demand instances on EC2, the price
1511 # given here is used to compute container cost estimates.
1514 # Include this section if the node type includes GPU (CUDA) support
1516 DriverVersion: "11.0"
1517 HardwareCapability: "9.0"
1522 # If you use multiple storage classes, specify them here, using
1523 # the storage class name as the key (in place of "SAMPLE" in
1524 # this sample entry).
1526 # Further info/examples:
1527 # https://doc.arvados.org/admin/storage-classes.html
1530 # Priority determines the order volumes should be searched
1531 # when reading data, in cases where a keepstore server has
1532 # access to multiple volumes with different storage classes.
1535 # Default determines which storage class(es) should be used
1536 # when a user/client writes data or saves a new collection
1537 # without specifying storage classes.
1539 # If any StorageClasses are configured, at least one of them
1540 # must have Default: true.
1545 # AccessViaHosts specifies which keepstore processes can read
1546 # and write data on the volume.
1548 # For a local filesystem, AccessViaHosts has one entry,
1549 # indicating which server the filesystem is located on.
1551 # For a network-attached backend accessible by all keepstore
1552 # servers, like a cloud storage bucket or an NFS mount,
1553 # AccessViaHosts can be empty/omitted.
1555 # Further info/examples:
1556 # https://doc.arvados.org/install/configure-fs-storage.html
1557 # https://doc.arvados.org/install/configure-s3-object-storage.html
1558 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1562 "http://host1.example:25107": {}
1566 # If you have configured storage classes (see StorageClasses
1567 # section above), add an entry here for each storage class
1568 # satisfied by this volume.
1572 # for s3 driver -- see
1573 # https://doc.arvados.org/install/configure-s3-object-storage.html
1576 SecretAccessKey: aaaaa
1580 LocationConstraint: false
1587 # Use aws-s3-go (v2) instead of goamz
1588 UseAWSS3v2Driver: true
1590 # For S3 driver, potentially unsafe tuning parameter,
1591 # intentionally excluded from main documentation.
1593 # Enable deletion (garbage collection) even when the
1594 # configured BlobTrashLifetime is zero. WARNING: eventual
1595 # consistency may result in race conditions that can cause
1596 # data loss. Do not enable this unless you understand and
1600 # for azure driver -- see
1601 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1602 StorageAccountName: aaaaa
1603 StorageAccountKey: aaaaa
1604 StorageBaseURL: core.windows.net
1605 ContainerName: aaaaa
1607 ListBlobsRetryDelay: 10s
1608 ListBlobsMaxAttempts: 10
1610 WriteRaceInterval: 15s
1611 WriteRacePollTime: 1s
1613 # for local directory driver -- see
1614 # https://doc.arvados.org/install/configure-fs-storage.html
1615 Root: /var/lib/arvados/keep-data
1617 # For local directory driver, potentially confusing tuning
1618 # parameter, intentionally excluded from main documentation.
1620 # When true, read and write operations (for whole 64MiB
1621 # blocks) on an individual volume will queued and issued
1622 # serially. When false, read and write operations will be
1623 # issued concurrently.
1625 # May possibly improve throughput if you have physical spinning disks
1626 # and experience contention when there are multiple requests
1627 # to the same volume.
1629 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1630 # should leave this alone.
1636 SendUserSetupNotificationEmail: true
1638 # Bug/issue report notification to and from addresses
1639 IssueReporterEmailFrom: "arvados@example.com"
1640 IssueReporterEmailTo: "arvados@example.com"
1641 SupportEmailAddress: "arvados@example.com"
1643 # Generic issue email from
1644 EmailFrom: "arvados@example.com"
1651 ActivateUsers: false
1653 # API endpoint host or host:port; default is {id}.arvadosapi.com
1654 Host: sample.arvadosapi.com
1656 # Perform a proxy request when a local client requests an
1657 # object belonging to this remote.
1660 # Default "https". Can be set to "http" for testing.
1663 # Disable TLS verify. Can be set to true for testing.
1666 # When users present tokens issued by this remote cluster, and
1667 # their accounts are active on the remote cluster, activate
1668 # them on this cluster too.
1669 ActivateUsers: false
1672 # Workbench1 configs
1674 ActivationContactLink: mailto:info@arvados.org
1675 ArvadosDocsite: https://doc.arvados.org
1676 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1677 ShowUserAgreementInline: false
1680 # Set this configuration to true to avoid providing an easy way for users
1681 # to share data with unauthenticated users; this may be necessary on
1682 # installations where strict data access controls are needed.
1683 DisableSharingURLsUI: false
1685 # Scratch directory used by the remote repository browsing
1686 # feature. If it doesn't exist, it (and any missing parents) will be
1687 # created using mkdir_p.
1688 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1690 # Below is a sample setting of user_profile_form_fields config parameter.
1691 # This configuration parameter should be set to either false (to disable) or
1692 # to a map as shown below.
1693 # Configure the map of input fields to be displayed in the profile page
1694 # using the attribute "key" for each of the input fields.
1695 # This sample shows configuration with one required and one optional form fields.
1696 # For each of these input fields:
1697 # You can specify "Type" as "text" or "select".
1698 # List the "Options" to be displayed for each of the "select" menu.
1699 # Set "Required" as "true" for any of these fields to make them required.
1700 # If any of the required fields are missing in the user's profile, the user will be
1701 # redirected to the profile page before they can access any Workbench features.
1702 UserProfileFormFields:
1705 FormFieldTitle: Best color
1706 FormFieldDescription: your favorite color
1715 # exampleTextValue: # key that will be set in properties
1717 # FormFieldTitle: ""
1718 # FormFieldDescription: ""
1721 # exampleOptionsValue:
1723 # FormFieldTitle: ""
1724 # FormFieldDescription: ""
1732 # Use "UserProfileFormMessage to configure the message you want
1733 # to display on the profile page.
1734 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1736 # Mimetypes of applications for which the view icon
1737 # would be enabled in a collection's show page.
1738 # It is sufficient to list only applications here.
1739 # No need to list text and image types.
1740 ApplicationMimetypesWithViewIcon:
1758 # The maximum number of bytes to load in the log viewer
1759 LogViewerMaxBytes: 1M
1761 # When anonymous_user_token is configured, show public projects page
1762 EnablePublicProjectsPage: true
1764 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1765 EnableGettingStartedPopup: false
1767 # Ask Arvados API server to compress its response payloads.
1768 APIResponseCompression: true
1770 # Timeouts for API requests.
1771 APIClientConnectTimeout: 2m
1772 APIClientReceiveTimeout: 5m
1774 # Maximum number of historic log records of a running job to fetch
1775 # and display in the Log tab, while subscribing to web sockets.
1776 RunningJobLogRecordsToFetch: 2000
1778 # In systems with many shared projects, loading of dashboard and topnav
1779 # can be slow due to collections indexing; use the following parameters
1780 # to suppress these properties
1781 ShowRecentCollectionsOnDashboard: true
1782 ShowUserNotifications: true
1784 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1785 # a link to the multi-site search page on a "home" Workbench site.
1788 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1791 # Should workbench allow management of local git repositories? Set to false if
1792 # the jobs api is disabled and there are no local git repositories.
1795 SiteName: Arvados Workbench
1796 ProfilingEnabled: false
1798 # This is related to obsolete Google OpenID 1.0 login
1799 # but some workbench stuff still expects it to be set.
1800 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1802 # Workbench2 configs
1803 FileViewersConfigURL: ""
1805 # Idle time after which the user's session will be auto closed.
1806 # This feature is disabled when set to zero.
1809 # UUID of a collection. This collection should be shared with
1810 # all users. Workbench will look for a file "banner.html" in
1811 # this collection and display its contents (should be
1812 # HTML-formatted text) when users first log in to Workbench.
1815 # Workbench welcome screen, this is HTML text that will be
1816 # incorporated directly onto the page.
1818 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1819 <h2>Please log in.</h2>
1821 <p>If you have never used Arvados Workbench before, logging in
1822 for the first time will automatically create a new
1825 <i>Arvados Workbench uses your information only for
1826 identification, and does not retrieve any other personal
1829 # Workbench screen displayed to inactive users. This is HTML
1830 # text that will be incorporated directly onto the page.
1832 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1833 <h3>Hi! You're logged in, but...</h3>
1834 <p>Your account is inactive.</p>
1835 <p>An administrator must activate your account before you can get
1838 # Connecting to Arvados shell VMs tends to be site-specific.
1839 # Put any special instructions here. This is HTML text that will
1840 # be incorporated directly onto the Workbench page.
1842 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1843 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1845 # Sample text if you are using a "switchyard" ssh proxy.
1846 # Replace "zzzzz" with your Cluster ID.
1848 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1851 # ServerAliveInterval 60
1852 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1855 # If you are using a switchyard ssh proxy, shell node hostnames
1856 # may require a special hostname suffix. In the sample ssh
1857 # configuration above, this would be ".zzzzz"
1858 # This is added to the hostname in the "command line" column
1859 # the Workbench "shell VMs" page.
1861 # If your shell nodes are directly accessible by users without a
1862 # proxy and have fully qualified host names, you should leave
1864 SSHHelpHostSuffix: ""
1866 # (Experimental) Restart services automatically when config file
1867 # changes are detected. Only supported by `arvados-server boot` in
1869 AutoReloadConfig: false