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: 0
230 # Maximum number of 64MiB memory buffers per Keepstore server process, or
231 # 0 for no limit. When this limit is reached, up to
232 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
233 # buffers (like GET and PUT) will wait for buffer space to be released.
234 # Any HTTP requests beyond MaxConcurrentRequests will receive an
235 # immediate 503 response.
237 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
238 # * 1.1) fits comfortably in memory. On a host dedicated to running
239 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
240 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
241 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
242 MaxKeepBlobBuffers: 128
244 # API methods to disable. Disabled methods are not listed in the
245 # discovery document, and respond 404 to all requests.
246 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
249 # Interval (seconds) between asynchronous permission view updates. Any
250 # permission-updating API called with the 'async' parameter schedules a an
251 # update on the permission view in the future, if not already scheduled.
252 AsyncPermissionsUpdateInterval: 20s
254 # Maximum number of concurrent outgoing requests to make while
255 # serving a single incoming multi-cluster (federated) request.
256 MaxRequestAmplification: 4
258 # Maximum wall clock time to spend handling an incoming request.
261 # Websocket will send a periodic empty event after 'SendTimeout'
262 # if there is no other activity to maintain the connection /
263 # detect dropped connections.
266 WebsocketClientEventQueue: 64
267 WebsocketServerEventQueue: 4
269 # Timeout on requests to internal Keep services.
270 KeepServiceRequestTimeout: 15s
272 # Vocabulary file path, local to the node running the controller.
273 # This JSON file should contain the description of what's allowed
274 # as object's metadata. Its format is described at:
275 # https://doc.arvados.org/admin/metadata-vocabulary.html
278 # If true, a project must have a non-empty description field in
279 # order to be frozen.
280 FreezeProjectRequiresDescription: false
282 # Project properties that must have non-empty values in order to
283 # freeze a project. Example: "property_name": {}
284 FreezeProjectRequiresProperties:
287 # If true, only an admin user can un-freeze a project. If false,
288 # any user with "manage" permission can un-freeze.
289 UnfreezeProjectRequiresAdmin: false
292 # Config parameters to automatically setup new users. If enabled,
293 # this users will be able to self-activate. Enable this if you want
294 # to run an open instance where anyone can create an account and use
295 # the system without requiring manual approval.
297 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
298 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
299 AutoSetupNewUsers: false
300 AutoSetupNewUsersWithVmUUID: ""
301 AutoSetupNewUsersWithRepository: false
302 AutoSetupUsernameBlacklist:
311 # When NewUsersAreActive is set to true, new users will be active
312 # immediately. This skips the "self-activate" step which enforces
313 # user agreements. Should only be enabled for development.
314 NewUsersAreActive: false
316 # Newly activated users (whether set up by an admin or via
317 # AutoSetupNewUsers) immediately become visible to other active
320 # On a multi-tenant cluster, where the intent is for users to be
321 # invisible to one another unless they have been added to the
322 # same group(s) via Workbench admin interface, change this to
324 ActivatedUsersAreVisibleToOthers: true
326 # The e-mail address of the user you would like to become marked as an admin
327 # user on their first login.
328 AutoAdminUserWithEmail: ""
330 # If AutoAdminFirstUser is set to true, the first user to log in when no
331 # other admin users exist will automatically become an admin user.
332 AutoAdminFirstUser: false
334 # Email address to notify whenever a user creates a profile for the
336 UserProfileNotificationAddress: ""
337 AdminNotifierEmailFrom: arvados@example.com
338 EmailSubjectPrefix: "[ARVADOS] "
339 UserNotifierEmailFrom: arvados@example.com
340 UserNotifierEmailBcc: {}
341 NewUserNotificationRecipients: {}
342 NewInactiveUserNotificationRecipients: {}
344 # Set AnonymousUserToken to enable anonymous user access. Populate this
345 # field with a random string at least 50 characters long.
346 AnonymousUserToken: ""
348 # If a new user has an alternate email address (local@domain)
349 # with the domain given here, its local part becomes the new
350 # user's default username. Otherwise, the user's primary email
352 PreferDomainForUsername: ""
355 <% if not @user.full_name.empty? -%>
356 <%= @user.full_name %>,
361 Your Arvados account has been set up. You can log in at
363 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
366 Your Arvados administrator.
368 # If RoleGroupsVisibleToAll is true, all role groups are visible
369 # to all active users.
371 # If false, users must be granted permission to role groups in
372 # order to see them. This is more appropriate for a multi-tenant
374 RoleGroupsVisibleToAll: true
376 # If CanCreateRoleGroups is true, regular (non-admin) users can
377 # create new role groups.
379 # If false, only admins can create new role groups.
380 CanCreateRoleGroups: true
382 # During each period, a log entry with event_type="activity"
383 # will be recorded for each user who is active during that
384 # period. The object_uuid attribute will indicate the user's
387 # Multiple log entries for the same user may be generated during
388 # a period if there are multiple controller processes or a
389 # controller process is restarted.
391 # Use 0 to disable activity logging.
392 ActivityLoggingPeriod: 24h
395 # Time to keep audit logs, in seconds. (An audit log is a row added
396 # to the "logs" table in the PostgreSQL database each time an
397 # Arvados object is created, modified, or deleted.)
399 # Currently, websocket event notifications rely on audit logs, so
400 # this should not be set lower than 300 (5 minutes).
403 # Maximum number of log rows to delete in a single SQL transaction.
405 # If MaxDeleteBatch is 0, log entries will never be
406 # deleted by Arvados. Cleanup can be done by an external process
407 # without affecting any Arvados system processes, as long as very
408 # recent (<5 minutes old) logs are not deleted.
410 # 100000 is a reasonable batch size for most sites.
413 # Attributes to suppress in events and audit logs. Notably,
414 # specifying {"manifest_text": {}} here typically makes the database
415 # smaller and faster.
417 # Warning: Using any non-empty value here can have undesirable side
418 # effects for any client or component that relies on event logs.
419 # Use at your own risk.
420 UnloggedAttributes: {}
424 # Logging threshold: panic, fatal, error, warn, info, debug, or
428 # Logging format: json or text
431 # Maximum characters of (JSON-encoded) query parameters to include
432 # in each request log entry. When params exceed this size, they will
433 # be JSON-encoded, truncated to this size, and logged as
435 MaxRequestLogParamsSize: 2000
439 # Enable access controls for data stored in Keep. This should
440 # always be set to true on a production cluster.
443 # BlobSigningKey is a string of alphanumeric characters used to
444 # generate permission signatures for Keep locators. It must be
445 # identical to the permission key given to Keep. IMPORTANT: This
446 # is a site secret. It should be at least 50 characters.
448 # Modifying BlobSigningKey will invalidate all existing
449 # signatures, which can cause programs to fail (e.g., arv-put,
450 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
451 # when no such processes are running.
454 # Enable garbage collection of unreferenced blobs in Keep.
457 # Time to leave unreferenced blobs in "trashed" state before
458 # deleting them, or 0 to skip the "trashed" state entirely and
459 # delete unreferenced blobs.
461 # If you use any Amazon S3 buckets as storage volumes, this
462 # must be at least 24h to avoid occasional data loss.
463 BlobTrashLifetime: 336h
465 # How often to check for (and delete) trashed blocks whose
466 # BlobTrashLifetime has expired.
467 BlobTrashCheckInterval: 24h
469 # Maximum number of concurrent "trash blob" and "delete trashed
470 # blob" operations conducted by a single keepstore process. Each
471 # of these can be set to 0 to disable the respective operation.
473 # If BlobTrashLifetime is zero, "trash" and "delete trash"
474 # happen at once, so only the lower of these two values is used.
475 BlobTrashConcurrency: 4
476 BlobDeleteConcurrency: 4
478 # Maximum number of concurrent "create additional replica of
479 # existing blob" operations conducted by a single keepstore
481 BlobReplicateConcurrency: 4
483 # Default replication level for collections. This is used when a
484 # collection's replication_desired attribute is nil.
485 DefaultReplication: 2
487 # BlobSigningTTL determines the minimum lifetime of transient
488 # data, i.e., blocks that are not referenced by
489 # collections. Unreferenced blocks exist for two reasons:
491 # 1) A data block must be written to a disk/cloud backend device
492 # before a collection can be created/updated with a reference to
495 # 2) Deleting or updating a collection can remove the last
496 # remaining reference to a data block.
498 # If BlobSigningTTL is too short, long-running
499 # processes/containers will fail when they take too long (a)
500 # between writing blocks and writing collections that reference
501 # them, or (b) between reading collections and reading the
504 # If BlobSigningTTL is too long, data will still be stored long
505 # after the referring collections are deleted, and you will
506 # needlessly fill up disks or waste money on cloud storage.
508 # Modifying BlobSigningTTL invalidates existing signatures; see
509 # BlobSigningKey note above.
511 # The default is 2 weeks.
514 # When running keep-balance, this is the destination filename for
515 # the list of lost block hashes if there are any, one per line.
516 # Updated automically during each successful run.
517 BlobMissingReport: ""
519 # keep-balance operates periodically, i.e.: do a
520 # scan/balance operation, sleep, repeat.
522 # BalancePeriod determines the interval between start times of
523 # successive scan/balance operations. If a scan/balance operation
524 # takes longer than BalancePeriod, the next one will follow it
527 # If SIGUSR1 is received during an idle period between operations,
528 # the next operation will start immediately.
531 # Limits the number of collections retrieved by keep-balance per
532 # API transaction. If this is zero, page size is
533 # determined by the API server's own page size limits (see
534 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
535 BalanceCollectionBatch: 0
537 # The size of keep-balance's internal queue of
538 # collections. Higher values use more memory and improve throughput
539 # by allowing keep-balance to fetch the next page of collections
540 # while the current page is still being processed. If this is zero
541 # or omitted, pages are processed serially.
542 BalanceCollectionBuffers: 1000
544 # Maximum time for a rebalancing run. This ensures keep-balance
545 # eventually gives up and retries if, for example, a network
546 # error causes a hung connection that is never closed by the
547 # OS. It should be long enough that it doesn't interrupt a
548 # long-running balancing operation.
551 # Maximum number of replication_confirmed /
552 # storage_classes_confirmed updates to write to the database
553 # after a rebalancing run. When many updates are needed, this
554 # spreads them over a few runs rather than applying them all at
556 BalanceUpdateLimit: 100000
558 # Default lifetime for ephemeral collections: 2 weeks. This must not
559 # be less than BlobSigningTTL.
560 DefaultTrashLifetime: 336h
562 # Interval (seconds) between trash sweeps. During a trash sweep,
563 # collections are marked as trash if their trash_at time has
564 # arrived, and deleted if their delete_at time has arrived.
565 TrashSweepInterval: 60s
567 # If true, enable collection versioning.
568 # When a collection's preserve_version field is true or the current version
569 # is older than the amount of seconds defined on PreserveVersionIfIdle,
570 # a snapshot of the collection's previous state is created and linked to
571 # the current collection.
572 CollectionVersioning: true
574 # 0s = auto-create a new version on every update.
575 # -1s = never auto-create new versions.
576 # > 0s = auto-create a new version when older than the specified number of seconds.
577 PreserveVersionIfIdle: 10s
579 # If non-empty, allow project and collection names to contain
580 # the "/" character (slash/stroke/solidus), and replace "/" with
581 # the given string in the filesystem hierarchy presented by
582 # WebDAV. Example values are "%2f" and "{slash}". Names that
583 # contain the substitution string itself may result in confusing
584 # behavior, so a value like "_" is not recommended.
586 # If the default empty value is used, the server will reject
587 # requests to create or rename a collection when the new name
590 # If the value "/" is used, project and collection names
591 # containing "/" will be allowed, but they will not be
592 # accessible via WebDAV.
594 # Use of this feature is not recommended, if it can be avoided.
595 ForwardSlashNameSubstitution: ""
597 # Include "folder objects" in S3 ListObjects responses.
598 S3FolderObjects: true
600 # Managed collection properties. At creation time, if the client didn't
601 # provide the listed keys, they will be automatically populated following
602 # one of the following behaviors:
604 # * UUID of the user who owns the containing project.
605 # responsible_person_uuid: {Function: original_owner, Protected: true}
607 # * Default concrete value.
608 # foo_bar: {Value: baz, Protected: false}
610 # If Protected is true, only an admin user can modify its value.
612 SAMPLE: {Function: original_owner, Protected: true}
614 # In "trust all content" mode, Workbench will redirect download
615 # requests to WebDAV preview link, even in the cases when
616 # WebDAV would have to expose XSS vulnerabilities in order to
617 # handle the redirect (see discussion on Services.WebDAV).
619 # This setting has no effect in the recommended configuration, where the
620 # WebDAV service is configured to have a separate domain for every
621 # collection and XSS protection is provided by browsers' same-origin
624 # The default setting (false) is appropriate for a multi-user site.
625 TrustAllContent: false
627 # Cache parameters for WebDAV content serving:
629 # Time to cache manifests, permission checks, and sessions.
632 # Block cache entries. Each block consumes up to 64 MiB RAM.
635 # Approximate memory limit (in bytes) for session cache.
637 # Note this applies to the in-memory representation of
638 # projects and collections -- metadata, block locators,
639 # filenames, etc. -- excluding cached file content, which is
640 # limited by MaxBlockEntries.
641 MaxCollectionBytes: 100000000
643 # Persistent sessions.
646 # Selectively set permissions for regular users and admins to
647 # download or upload data files using the upload/download
648 # features for Workbench, WebDAV and S3 API support.
657 # Selectively set permissions for regular users and admins to be
658 # able to download or upload blocks using arv-put and
659 # arv-get from outside the cluster.
668 # Post upload / download events to the API server logs table, so
669 # that they can be included in the arv-user-activity report.
670 # You can disable this if you find that it is creating excess
671 # load on the API server and you don't need it.
672 WebDAVLogEvents: true
675 # One of the following mechanisms (Google, PAM, LDAP, or
676 # LoginCluster) should be enabled; see
677 # https://doc.arvados.org/install/setup-login.html
680 # Authenticate with Google.
683 # Use the Google Cloud console to enable the People API (APIs
684 # and Services > Enable APIs and services > Google People API
685 # > Enable), generate a Client ID and secret (APIs and
686 # Services > Credentials > Create credentials > OAuth client
687 # ID > Web application) and add your controller's /login URL
688 # (e.g., "https://zzzzz.example.com/login") as an authorized
693 # Allow users to log in to existing accounts using any verified
694 # email address listed by their Google account. If true, the
695 # Google People API must be enabled in order for Google login to
696 # work. If false, only the primary email address will be used.
697 AlternateEmailAddresses: true
699 # Send additional parameters with authentication requests. See
700 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
701 # for a list of supported parameters.
702 AuthenticationRequestParameters:
703 # Show the "choose which Google account" page, even if the
704 # client is currently logged in to exactly one Google
706 prompt: select_account
711 # Authenticate with an OpenID Connect provider.
714 # Issuer URL, e.g., "https://login.example.com".
716 # This must be exactly equal to the URL returned by the issuer
717 # itself in its config response ("isser" key). If the
718 # configured value is "https://example" and the provider
719 # returns "https://example:443" or "https://example/" then
720 # login will fail, even though those URLs are equivalent
724 # Your client ID and client secret (supplied by the provider).
728 # OpenID claim field containing the user's email
729 # address. Normally "email"; see
730 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
733 # OpenID claim field containing the email verification
734 # flag. Normally "email_verified". To accept every returned
735 # email address without checking a "verified" field at all,
736 # use the empty string "".
737 EmailVerifiedClaim: "email_verified"
739 # OpenID claim field containing the user's preferred
740 # username. If empty, use the mailbox part of the user's email
744 # Send additional parameters with authentication requests,
745 # like {display: page, prompt: consent}. See
746 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
747 # and refer to your provider's documentation for supported
749 AuthenticationRequestParameters:
752 # Accept an OIDC access token as an API token if the OIDC
753 # provider's UserInfo endpoint accepts it.
755 # AcceptAccessTokenScope should also be used when enabling
757 AcceptAccessToken: false
759 # Before accepting an OIDC access token as an API token, first
760 # check that it is a JWT whose "scope" value includes this
761 # value. Example: "https://zzzzz.example.com/" (your Arvados
764 # If this value is empty and AcceptAccessToken is true, all
765 # access tokens will be accepted regardless of scope,
766 # including non-JWT tokens. This is not recommended.
767 AcceptAccessTokenScope: ""
770 # Use PAM to authenticate users.
773 # PAM service name. PAM will apply the policy in the
774 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
775 # there is none, the default "other" config.
778 # Domain name (e.g., "example.com") to use to construct the
779 # user's email address if PAM authentication returns a
780 # username with no "@". If empty, use the PAM username as the
781 # user's email address, whether or not it contains "@".
783 # Note that the email address is used as the primary key for
784 # user records when logging in. Therefore, if you change
785 # PAMDefaultEmailDomain after the initial installation, you
786 # should also update existing user records to reflect the new
787 # domain. Otherwise, next time those users log in, they will
788 # be given new accounts instead of accessing their existing
790 DefaultEmailDomain: ""
793 # Use an LDAP service to authenticate users.
796 # Server URL, like "ldap://ldapserver.example.com:389" or
797 # "ldaps://ldapserver.example.com:636".
798 URL: "ldap://ldap:389"
800 # Use StartTLS upon connecting to the server.
803 # Skip TLS certificate name verification.
806 # Mininum TLS version to negotiate when connecting to server
807 # (ldaps://... or StartTLS). It may be necessary to set this
808 # to "1.1" for compatibility with older LDAP servers. If
809 # blank, use the recommended minimum version (1.2).
812 # Strip the @domain part if a user supplies an email-style
813 # username with this domain. If "*", strip any user-provided
814 # domain. If "", never strip the domain part. Example:
818 # If, after applying StripDomain, the username contains no "@"
819 # character, append this domain to form an email-style
820 # username. Example: "example.com"
823 # The LDAP attribute to filter on when looking up a username
824 # (after applying StripDomain and AppendDomain).
827 # Bind with this username (DN or UPN) and password when
828 # looking up the user record.
830 # Example user: "cn=admin,dc=example,dc=com"
832 SearchBindPassword: ""
834 # Directory base for username lookup. Example:
835 # "ou=Users,dc=example,dc=com"
838 # Additional filters to apply when looking up users' LDAP
839 # entries. This can be used to restrict access to a subset of
840 # LDAP users, or to disambiguate users from other directory
841 # entries that have the SearchAttribute present.
843 # Special characters in assertion values must be escaped (see
846 # Example: "(objectClass=person)"
849 # LDAP attribute to use as the user's email address.
851 # Important: This must not be an attribute whose value can be
852 # edited in the directory by the users themselves. Otherwise,
853 # users can take over other users' Arvados accounts trivially
854 # (email address is the primary key for Arvados accounts.)
857 # LDAP attribute to use as the preferred Arvados username. If
858 # no value is found (or this config is empty) the username
859 # originally supplied by the user will be used.
860 UsernameAttribute: uid
863 # Authenticate users listed here in the config file. This
864 # feature is intended to be used in test environments, and
865 # should not be used in production.
869 Email: alice@example.com
872 # The cluster ID to delegate the user database. When set,
873 # logins on this cluster will be redirected to the login cluster
874 # (login cluster must appear in RemoteClusters with Proxy: true)
877 # How long a cached token belonging to a remote cluster will
878 # remain valid before it needs to be revalidated.
879 RemoteTokenRefresh: 5m
881 # How long a client token created from a login flow will be valid without
882 # asking the user to re-login. Example values: 60m, 8h.
883 # Default value zero means tokens don't have expiration.
886 # If true (default) tokens issued through login are allowed to create
888 # If false, tokens issued through login are not allowed to
889 # viewing/creating other tokens. New tokens can only be created
890 # by going through login again.
891 IssueTrustedTokens: true
893 # Origins (scheme://host[:port]) of clients trusted to receive
894 # new tokens via login process. The ExternalURLs of the local
895 # Workbench1 and Workbench2 are trusted implicitly and do not
896 # need to be listed here. If this is a LoginCluster, you
897 # probably want to include the other Workbench instances in the
898 # federation in this list.
903 # "https://workbench.other-cluster.example": {}
904 # "https://workbench2.other-cluster.example": {}
908 # Treat any origin whose host part is "localhost" or a private
909 # IP address (e.g., http://10.0.0.123:3000/) as if it were
910 # listed in TrustedClients.
912 # Intended only for test/development use. Not appropriate for
914 TrustPrivateNetworks: false
917 # Path to git or gitolite-shell executable. Each authenticated
918 # request will execute this program with the single argument "http-backend"
919 GitCommand: /usr/bin/git
921 # Path to Gitolite's home directory. If a non-empty path is given,
922 # the CGI environment will be set up to support the use of
923 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
924 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
925 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
928 # Git repositories must be readable by api server, or you won't be
929 # able to submit crunch jobs. To pass the test suites, put a clone
930 # of the arvados tree in {git_repositories_dir}/arvados.git or
931 # {git_repositories_dir}/arvados/.git
932 Repositories: /var/lib/arvados/git/repositories
935 # Use "file:///var/lib/acme/live/example.com/cert" and
936 # ".../privkey" to load externally managed certificates.
940 # Accept invalid certificates when connecting to servers. Never
941 # use this in production.
945 # Obtain certificates automatically for ExternalURL domains
946 # using an ACME server and http-01 validation.
948 # To use Let's Encrypt, specify "LE". To use the Let's
949 # Encrypt staging environment, specify "LE-staging". To use a
950 # different ACME server, specify the full directory URL
953 # Note: this feature is not yet implemented in released
954 # versions, only in the alpha/prerelease arvados-server-easy
957 # Implies agreement with the server's terms of service.
961 # List of supported Docker Registry image formats that compute nodes
962 # are able to use. `arv keep docker` will error out if a user tries
963 # to store an image with an unsupported format. Use an empty array
964 # to skip the compatibility check (and display a warning message to
967 # Example for sites running docker < 1.10: {"v1": {}}
968 # Example for sites running docker >= 1.10: {"v2": {}}
969 # Example for disabling check: {}
970 SupportedDockerImageFormats:
974 # Include details about job reuse decisions in the server log. This
975 # causes additional database queries to run, so it should not be
976 # enabled unless you expect to examine the resulting logs for
977 # troubleshooting purposes.
978 LogReuseDecisions: false
980 # Default value for keep_cache_ram of a container's
981 # runtime_constraints. Note: this gets added to the RAM request
982 # used to allocate a VM or submit an HPC job.
984 # If this is zero, container requests that don't specify RAM or
985 # disk cache size will use a disk cache, sized to the
986 # container's RAM requirement (but with minimum 2 GiB and
988 DefaultKeepCacheRAM: 0
990 # Number of times a container can be unlocked before being
991 # automatically cancelled.
992 MaxDispatchAttempts: 5
994 # Default value for container_count_max for container requests. This is the
995 # number of times Arvados will create a new container to satisfy a container
996 # request. If a container is cancelled it will retry a new container if
997 # container_count < container_count_max on any container requests associated
998 # with the cancelled container.
1001 # The maximum number of compute nodes that can be in use simultaneously
1002 # If this limit is reduced, any existing nodes with slot number >= new limit
1003 # will not be counted against the new limit. In other words, the new limit
1004 # won't be strictly enforced until those nodes with higher slot numbers
1008 # Schedule all child containers on preemptible instances (e.g. AWS
1009 # Spot Instances) even if not requested by the submitter.
1011 # If false, containers are scheduled on preemptible instances
1012 # only when requested by the submitter.
1014 # This flag is ignored if no preemptible instance types are
1015 # configured, and has no effect on top-level containers.
1016 AlwaysUsePreemptibleInstances: false
1018 # Automatically add a preemptible variant for every
1019 # non-preemptible entry in InstanceTypes below. The maximum bid
1020 # price for the preemptible variant will be the non-preemptible
1021 # price multiplied by PreemptiblePriceFactor. If 0, preemptible
1022 # variants are not added automatically.
1024 # A price factor of 1.0 is a reasonable starting point.
1025 PreemptiblePriceFactor: 0
1027 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
1028 # cloud dispatcher for executing containers on worker VMs.
1029 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
1030 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
1031 DispatchPrivateKey: ""
1033 # Maximum time to wait for workers to come up before abandoning
1034 # stale locks from a previous dispatch process.
1035 StaleLockTimeout: 1m
1037 # The crunch-run command used to start a container on a worker node.
1039 # When dispatching to cloud VMs, this is used only if
1040 # DeployRunnerBinary in the CloudVMs section is set to the empty
1042 CrunchRunCommand: "crunch-run"
1044 # Extra arguments to add to crunch-run invocation
1045 # Example: ["--cgroup-parent-subsystem=memory"]
1046 CrunchRunArgumentsList: []
1048 # Extra RAM to reserve on the node, in addition to
1049 # the amount specified in the container's RuntimeConstraints
1050 ReserveExtraRAM: 550MiB
1052 # Minimum time between two attempts to run the same container
1055 # Container runtime: "docker" (default) or "singularity"
1056 RuntimeEngine: docker
1058 # When running a container, run a dedicated keepstore process,
1059 # using the specified number of 64 MiB memory buffers per
1060 # allocated CPU core (VCPUs in the container's runtime
1061 # constraints). The dedicated keepstore handles I/O for
1062 # collections mounted in the container, as well as saving
1065 # A zero value disables this feature.
1067 # In order for this feature to be activated, no volume may use
1068 # AccessViaHosts, and no writable volume may have Replication
1069 # lower than Collections.DefaultReplication. If these
1070 # requirements are not satisfied, the feature is disabled
1071 # automatically regardless of the value given here.
1073 # When an HPC dispatcher is in use (see SLURM and LSF sections),
1074 # this feature depends on the operator to ensure an up-to-date
1075 # cluster configuration file (/etc/arvados/config.yml) is
1076 # available on all compute nodes. If it is missing or not
1077 # readable by the crunch-run user, the feature will be disabled
1078 # automatically. To read it from a different location, add a
1079 # "-config=/path/to/config.yml" argument to
1080 # CrunchRunArgumentsList above.
1082 # When the cloud dispatcher is in use (see CloudVMs section) and
1083 # this configuration is enabled, the entire cluster
1084 # configuration file, including the system root token, is copied
1085 # to the worker node and held in memory for the duration of the
1087 LocalKeepBlobBuffersPerVCPU: 1
1089 # When running a dedicated keepstore process for a container
1090 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
1091 # messages to keepstore.txt in the container's log collection.
1093 # These log messages can reveal some volume configuration
1094 # details, error messages from the cloud storage provider, etc.,
1095 # which are not otherwise visible to users.
1098 # * "none" -- no keepstore.txt file
1099 # * "all" -- all logs, including request and response lines
1100 # * "errors" -- all logs except "response" logs with 2xx
1101 # response codes and "request" logs
1102 LocalKeepLogsToContainerLog: none
1105 # Periodically (see SweepInterval) Arvados will check for
1106 # containers that have been finished for at least this long,
1107 # and delete their stdout, stderr, arv-mount, crunch-run, and
1108 # crunchstat logs from the logs table.
1111 # How often to delete cached log entries for finished
1112 # containers (see MaxAge).
1115 # These two settings control how frequently log events are flushed to the
1116 # database. Log lines are buffered until either crunch_log_bytes_per_event
1117 # has been reached or crunch_log_seconds_between_events has elapsed since
1119 LogBytesPerEvent: 4096
1120 LogSecondsBetweenEvents: 5s
1122 # The sample period for throttling logs.
1123 LogThrottlePeriod: 60s
1125 # Maximum number of bytes that job can log over crunch_log_throttle_period
1126 # before being silenced until the end of the period.
1127 LogThrottleBytes: 65536
1129 # Maximum number of lines that job can log over crunch_log_throttle_period
1130 # before being silenced until the end of the period.
1131 LogThrottleLines: 1024
1133 # Maximum bytes that may be logged by a single job. Log bytes that are
1134 # silenced by throttling are not counted against this total.
1135 LimitLogBytesPerJob: 67108864
1137 LogPartialLineThrottlePeriod: 5s
1139 # Container logs are written to Keep and saved in a
1140 # collection, which is updated periodically while the
1141 # container runs. This value sets the interval between
1142 # collection updates.
1143 LogUpdatePeriod: 30m
1145 # The log collection is also updated when the specified amount of
1146 # log data (given in bytes) is produced in less than one update
1148 LogUpdateSize: 32MiB
1151 # An admin user can use "arvados-client shell" to start an
1152 # interactive shell (with any user ID) in any running
1156 # Any user can use "arvados-client shell" to start an
1157 # interactive shell (with any user ID) in any running
1158 # container that they started, provided it isn't also
1159 # associated with a different user's container request.
1161 # Interactive sessions make it easy to alter the container's
1162 # runtime environment in ways that aren't recorded or
1163 # reproducible. Consider the implications for automatic
1164 # container reuse before enabling and using this feature. In
1165 # particular, note that starting an interactive session does
1166 # not disqualify a container from being reused by a different
1167 # user/workflow in the future.
1172 SbatchArgumentsList: []
1173 SbatchEnvironmentVariables:
1176 # Path to dns server configuration directory
1177 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1178 # files or touch restart.txt (see below).
1179 DNSServerConfDir: ""
1181 # Template file for the dns server host snippets. See
1182 # unbound.template in this directory for an example. If false, do
1183 # not write any config files.
1184 DNSServerConfTemplate: ""
1186 # String to write to {dns_server_conf_dir}/restart.txt (with a
1187 # trailing newline) after updating local data. If false, do not
1188 # open or write the restart.txt file.
1189 DNSServerReloadCommand: ""
1191 # Command to run after each DNS update. Template variables will be
1192 # substituted; see the "unbound" example below. If false, do not run
1194 DNSServerUpdateCommand: ""
1196 ComputeNodeDomain: ""
1197 ComputeNodeNameservers:
1201 # Hostname to assign to a compute node when it sends a "ping" and the
1202 # hostname in its Node record is nil.
1203 # During bootstrapping, the "ping" script is expected to notice the
1204 # hostname given in the ping response, and update its unix hostname
1206 # If false, leave the hostname alone (this is appropriate if your compute
1207 # nodes' hostnames are already assigned by some other mechanism).
1209 # One way or another, the hostnames of your node records should agree
1210 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1212 # Example for compute0000, compute0001, ....:
1213 # assign_node_hostname: compute%<slot_number>04d
1214 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1215 AssignNodeHostname: "compute%<slot_number>d"
1218 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1220 # Template variables starting with % will be substituted as follows:
1223 # %C number of VCPUs
1226 # %G number of GPU devices (runtime_constraints.cuda.device_count)
1228 # Use %% to express a literal %. The %%J in the default will be changed
1229 # to %J, which is interpreted by bsub itself.
1231 # Note that the default arguments cause LSF to write two files
1232 # in /tmp on the compute node each time an Arvados container
1233 # runs. Ensure you have something in place to delete old files
1234 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1235 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]"]
1237 # Arguments that will be appended to the bsub command line
1238 # when submitting Arvados containers as LSF jobs with
1239 # runtime_constraints.cuda.device_count > 0
1240 BsubCUDAArguments: ["-gpu", "num=%G"]
1242 # Use sudo to switch to this user account when submitting LSF
1245 # This account must exist on the hosts where LSF jobs run
1246 # ("execution hosts"), as well as on the host where the
1247 # Arvados LSF dispatcher runs ("submission host").
1248 BsubSudoUser: "crunch"
1251 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1253 # Note: this only enables read-only access, creating new
1254 # legacy jobs and pipelines is not supported.
1256 # 'auto' -- (default) enable the Jobs API only if it has been used before
1257 # (i.e., there are job records in the database)
1258 # 'true' -- enable the Jobs API despite lack of existing records.
1259 # 'false' -- disable the Jobs API despite presence of existing records.
1262 # Git repositories must be readable by api server, or you won't be
1263 # able to submit crunch jobs. To pass the test suites, put a clone
1264 # of the arvados tree in {git_repositories_dir}/arvados.git or
1265 # {git_repositories_dir}/arvados/.git
1266 GitInternalDir: /var/lib/arvados/internal.git
1269 # Enable the cloud scheduler.
1272 # Name/number of port where workers' SSH services listen.
1275 # Interval between queue polls.
1278 # Shell command to execute on each worker to determine whether
1279 # the worker is booted and ready to run containers. It should
1280 # exit zero if the worker is ready.
1281 BootProbeCommand: "systemctl is-system-running"
1283 # Minimum interval between consecutive probes to a single
1287 # Maximum probes per second, across all workers in a pool.
1288 MaxProbesPerSecond: 10
1290 # Time before repeating SIGTERM when killing a container.
1293 # Time to give up on a process (most likely arv-mount) that
1294 # still holds a container lockfile after its main supervisor
1295 # process has exited, and declare the instance broken.
1296 TimeoutStaleRunLock: 5s
1298 # Time to give up on SIGTERM and write off the worker.
1301 # Maximum create/destroy-instance operations per second (0 =
1303 MaxCloudOpsPerSecond: 10
1305 # Maximum concurrent instance creation operations (0 = unlimited).
1307 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1308 # requests that can be in flight at any one time, whereas
1309 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1310 # that can be started per second.
1312 # Because the API for instance creation on Azure is synchronous, it is
1313 # recommended to increase MaxConcurrentInstanceCreateOps when running
1314 # on Azure. When using managed images, a value of 20 would be
1315 # appropriate. When using Azure Shared Image Galeries, it could be set
1316 # higher. For more information, see
1317 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1319 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1320 # providers too, if desired.
1321 MaxConcurrentInstanceCreateOps: 1
1323 # Interval between cloud provider syncs/updates ("list all
1327 # Time to leave an idle worker running (in case new containers
1328 # appear in the queue that it can run) before shutting it
1332 # Time to wait for a new worker to boot (i.e., pass
1333 # BootProbeCommand) before giving up and shutting it down.
1336 # Maximum time a worker can stay alive with no successful
1337 # probes before being automatically shut down.
1340 # Time after shutting down a worker to retry the
1341 # shutdown/destroy operation.
1342 TimeoutShutdown: 10s
1344 # Worker VM image ID.
1345 # (aws) AMI identifier
1346 # (azure) managed disks: the name of the managed disk image
1347 # (azure) shared image gallery: the name of the image definition. Also
1348 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1349 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1350 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1353 # An executable file (located on the dispatcher host) to be
1354 # copied to cloud instances at runtime and used as the
1355 # container runner/supervisor. The default value is the
1356 # dispatcher program itself.
1358 # Use the empty string to disable this step: nothing will be
1359 # copied, and cloud instances are assumed to have a suitable
1360 # version of crunch-run installed; see CrunchRunCommand above.
1361 DeployRunnerBinary: "/proc/self/exe"
1363 # Tags to add on all resources (VMs, NICs, disks) created by
1364 # the container dispatcher. (Arvados's own tags --
1365 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1370 # Prefix for predefined tags used by Arvados (InstanceSetID,
1371 # InstanceType, InstanceSecret, IdleBehavior). With the
1372 # default value "Arvados", tags are "ArvadosInstanceSetID",
1373 # "ArvadosInstanceSecret", etc.
1375 # This should only be changed while no cloud resources are in
1376 # use and the cloud dispatcher is not running. Otherwise,
1377 # VMs/resources that were added using the old tag prefix will
1378 # need to be detected and cleaned up manually.
1379 TagKeyPrefix: Arvados
1381 # Cloud driver: "azure" (Microsoft Azure), "ec2" (Amazon AWS),
1382 # or "loopback" (run containers on dispatch host for testing
1386 # Cloud-specific driver parameters.
1389 # (ec2) Credentials. Omit or leave blank if using IAM role.
1393 # (ec2) Instance configuration.
1399 AdminUsername: debian
1400 # (ec2) name of the IAMInstanceProfile for instances started by
1401 # the cloud dispatcher. Leave blank when not needed.
1402 IAMInstanceProfile: ""
1404 # (azure) Credentials.
1410 # (azure) Instance configuration.
1411 CloudEnvironment: AzurePublicCloud
1414 # (azure) The resource group where the VM and virtual NIC will be
1418 # (azure) The resource group of the Network to use for the virtual
1419 # NIC (if different from ResourceGroup)
1420 NetworkResourceGroup: ""
1424 # (azure) managed disks: The resource group where the managed disk
1425 # image can be found (if different from ResourceGroup).
1426 ImageResourceGroup: ""
1428 # (azure) shared image gallery: the name of the gallery
1429 SharedImageGalleryName: ""
1430 # (azure) shared image gallery: the version of the image definition
1431 SharedImageGalleryImageVersion: ""
1433 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1437 # (azure) How long to wait before deleting VHD and NIC
1438 # objects that are no longer being used.
1439 DeleteDanglingResourcesAfter: 20s
1441 # Account (that already exists in the VM image) that will be
1442 # set up with an ssh authorized key to allow the compute
1443 # dispatcher to connect.
1444 AdminUsername: arvados
1448 # Use the instance type name as the key (in place of "SAMPLE" in
1449 # this sample entry).
1451 # Cloud provider's instance type. Defaults to the configured type name.
1455 IncludedScratch: 16GB
1459 # Include this section if the node type includes GPU (CUDA) support
1461 DriverVersion: "11.0"
1462 HardwareCapability: "9.0"
1467 # If you use multiple storage classes, specify them here, using
1468 # the storage class name as the key (in place of "SAMPLE" in
1469 # this sample entry).
1471 # Further info/examples:
1472 # https://doc.arvados.org/admin/storage-classes.html
1475 # Priority determines the order volumes should be searched
1476 # when reading data, in cases where a keepstore server has
1477 # access to multiple volumes with different storage classes.
1480 # Default determines which storage class(es) should be used
1481 # when a user/client writes data or saves a new collection
1482 # without specifying storage classes.
1484 # If any StorageClasses are configured, at least one of them
1485 # must have Default: true.
1490 # AccessViaHosts specifies which keepstore processes can read
1491 # and write data on the volume.
1493 # For a local filesystem, AccessViaHosts has one entry,
1494 # indicating which server the filesystem is located on.
1496 # For a network-attached backend accessible by all keepstore
1497 # servers, like a cloud storage bucket or an NFS mount,
1498 # AccessViaHosts can be empty/omitted.
1500 # Further info/examples:
1501 # https://doc.arvados.org/install/configure-fs-storage.html
1502 # https://doc.arvados.org/install/configure-s3-object-storage.html
1503 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1507 "http://host1.example:25107": {}
1511 # If you have configured storage classes (see StorageClasses
1512 # section above), add an entry here for each storage class
1513 # satisfied by this volume.
1517 # for s3 driver -- see
1518 # https://doc.arvados.org/install/configure-s3-object-storage.html
1521 SecretAccessKey: aaaaa
1525 LocationConstraint: false
1532 # Use aws-s3-go (v2) instead of goamz
1533 UseAWSS3v2Driver: true
1535 # For S3 driver, potentially unsafe tuning parameter,
1536 # intentionally excluded from main documentation.
1538 # Enable deletion (garbage collection) even when the
1539 # configured BlobTrashLifetime is zero. WARNING: eventual
1540 # consistency may result in race conditions that can cause
1541 # data loss. Do not enable this unless you understand and
1545 # for azure driver -- see
1546 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1547 StorageAccountName: aaaaa
1548 StorageAccountKey: aaaaa
1549 StorageBaseURL: core.windows.net
1550 ContainerName: aaaaa
1552 ListBlobsRetryDelay: 10s
1553 ListBlobsMaxAttempts: 10
1555 WriteRaceInterval: 15s
1556 WriteRacePollTime: 1s
1558 # for local directory driver -- see
1559 # https://doc.arvados.org/install/configure-fs-storage.html
1560 Root: /var/lib/arvados/keep-data
1562 # For local directory driver, potentially confusing tuning
1563 # parameter, intentionally excluded from main documentation.
1565 # When true, read and write operations (for whole 64MiB
1566 # blocks) on an individual volume will queued and issued
1567 # serially. When false, read and write operations will be
1568 # issued concurrently.
1570 # May possibly improve throughput if you have physical spinning disks
1571 # and experience contention when there are multiple requests
1572 # to the same volume.
1574 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1575 # should leave this alone.
1581 SendUserSetupNotificationEmail: true
1583 # Bug/issue report notification to and from addresses
1584 IssueReporterEmailFrom: "arvados@example.com"
1585 IssueReporterEmailTo: "arvados@example.com"
1586 SupportEmailAddress: "arvados@example.com"
1588 # Generic issue email from
1589 EmailFrom: "arvados@example.com"
1596 ActivateUsers: false
1598 # API endpoint host or host:port; default is {id}.arvadosapi.com
1599 Host: sample.arvadosapi.com
1601 # Perform a proxy request when a local client requests an
1602 # object belonging to this remote.
1605 # Default "https". Can be set to "http" for testing.
1608 # Disable TLS verify. Can be set to true for testing.
1611 # When users present tokens issued by this remote cluster, and
1612 # their accounts are active on the remote cluster, activate
1613 # them on this cluster too.
1614 ActivateUsers: false
1617 # Workbench1 configs
1619 ActivationContactLink: mailto:info@arvados.org
1620 ArvadosDocsite: https://doc.arvados.org
1621 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1622 ShowUserAgreementInline: false
1625 # Set this configuration to true to avoid providing an easy way for users
1626 # to share data with unauthenticated users; this may be necessary on
1627 # installations where strict data access controls are needed.
1628 DisableSharingURLsUI: false
1630 # Scratch directory used by the remote repository browsing
1631 # feature. If it doesn't exist, it (and any missing parents) will be
1632 # created using mkdir_p.
1633 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1635 # Below is a sample setting of user_profile_form_fields config parameter.
1636 # This configuration parameter should be set to either false (to disable) or
1637 # to a map as shown below.
1638 # Configure the map of input fields to be displayed in the profile page
1639 # using the attribute "key" for each of the input fields.
1640 # This sample shows configuration with one required and one optional form fields.
1641 # For each of these input fields:
1642 # You can specify "Type" as "text" or "select".
1643 # List the "Options" to be displayed for each of the "select" menu.
1644 # Set "Required" as "true" for any of these fields to make them required.
1645 # If any of the required fields are missing in the user's profile, the user will be
1646 # redirected to the profile page before they can access any Workbench features.
1647 UserProfileFormFields:
1650 FormFieldTitle: Best color
1651 FormFieldDescription: your favorite color
1660 # exampleTextValue: # key that will be set in properties
1662 # FormFieldTitle: ""
1663 # FormFieldDescription: ""
1666 # exampleOptionsValue:
1668 # FormFieldTitle: ""
1669 # FormFieldDescription: ""
1677 # Use "UserProfileFormMessage to configure the message you want
1678 # to display on the profile page.
1679 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1681 # Mimetypes of applications for which the view icon
1682 # would be enabled in a collection's show page.
1683 # It is sufficient to list only applications here.
1684 # No need to list text and image types.
1685 ApplicationMimetypesWithViewIcon:
1703 # The maximum number of bytes to load in the log viewer
1704 LogViewerMaxBytes: 1M
1706 # When anonymous_user_token is configured, show public projects page
1707 EnablePublicProjectsPage: true
1709 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1710 EnableGettingStartedPopup: false
1712 # Ask Arvados API server to compress its response payloads.
1713 APIResponseCompression: true
1715 # Timeouts for API requests.
1716 APIClientConnectTimeout: 2m
1717 APIClientReceiveTimeout: 5m
1719 # Maximum number of historic log records of a running job to fetch
1720 # and display in the Log tab, while subscribing to web sockets.
1721 RunningJobLogRecordsToFetch: 2000
1723 # In systems with many shared projects, loading of dashboard and topnav
1724 # can be slow due to collections indexing; use the following parameters
1725 # to suppress these properties
1726 ShowRecentCollectionsOnDashboard: true
1727 ShowUserNotifications: true
1729 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1730 # a link to the multi-site search page on a "home" Workbench site.
1733 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1736 # Should workbench allow management of local git repositories? Set to false if
1737 # the jobs api is disabled and there are no local git repositories.
1740 SiteName: Arvados Workbench
1741 ProfilingEnabled: false
1743 # This is related to obsolete Google OpenID 1.0 login
1744 # but some workbench stuff still expects it to be set.
1745 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1747 # Workbench2 configs
1748 FileViewersConfigURL: ""
1750 # Idle time after which the user's session will be auto closed.
1751 # This feature is disabled when set to zero.
1754 # URL to a file that is a fragment of text or HTML which should
1755 # be rendered in Workbench as a banner.
1758 # Workbench welcome screen, this is HTML text that will be
1759 # incorporated directly onto the page.
1761 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1762 <h2>Please log in.</h2>
1764 <p>If you have never used Arvados Workbench before, logging in
1765 for the first time will automatically create a new
1768 <i>Arvados Workbench uses your information only for
1769 identification, and does not retrieve any other personal
1772 # Workbench screen displayed to inactive users. This is HTML
1773 # text that will be incorporated directly onto the page.
1775 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1776 <h3>Hi! You're logged in, but...</h3>
1777 <p>Your account is inactive.</p>
1778 <p>An administrator must activate your account before you can get
1781 # Connecting to Arvados shell VMs tends to be site-specific.
1782 # Put any special instructions here. This is HTML text that will
1783 # be incorporated directly onto the Workbench page.
1785 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1786 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1788 # Sample text if you are using a "switchyard" ssh proxy.
1789 # Replace "zzzzz" with your Cluster ID.
1791 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1794 # ServerAliveInterval 60
1795 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1798 # If you are using a switchyard ssh proxy, shell node hostnames
1799 # may require a special hostname suffix. In the sample ssh
1800 # configuration above, this would be ".zzzzz"
1801 # This is added to the hostname in the "command line" column
1802 # the Workbench "shell VMs" page.
1804 # If your shell nodes are directly accessible by users without a
1805 # proxy and have fully qualified host names, you should leave
1807 SSHHelpHostSuffix: ""
1809 # (Experimental) Restart services automatically when config file
1810 # changes are detected. Only supported by `arvados-server boot` in
1812 AutoReloadConfig: false