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 # In each of the service sections below, the keys under
26 # InternalURLs are the endpoints where the service should be
27 # listening, and reachable from other hosts in the
31 # "http://host1.example:12345": {}
32 # "http://host2.example:12345": {}
35 InternalURLs: {SAMPLE: {}}
38 InternalURLs: {SAMPLE: {}}
41 InternalURLs: {SAMPLE: {}}
44 InternalURLs: {SAMPLE: {}}
47 InternalURLs: {SAMPLE: {}}
50 InternalURLs: {SAMPLE: {}}
53 InternalURLs: {SAMPLE: {}}
56 InternalURLs: {SAMPLE: {}}
59 InternalURLs: {SAMPLE: {}}
62 InternalURLs: {SAMPLE: {}}
63 # Base URL for Workbench inline preview. If blank, use
64 # WebDAVDownload instead, and disable inline preview.
65 # If both are empty, downloading collections from workbench
68 # It is important to properly configure the download service
69 # to migitate cross-site-scripting (XSS) attacks. A HTML page
70 # can be stored in collection. If an attacker causes a victim
71 # to visit that page through Workbench, it will be rendered by
72 # the browser. If all collections are served at the same
73 # domain, the browser will consider collections as coming from
74 # the same origin and having access to the same browsing data,
75 # enabling malicious Javascript on that page to access Arvados
76 # on behalf of the victim.
78 # This is mitigating by having separate domains for each
79 # collection, or limiting preview to circumstances where the
80 # collection is not accessed with the user's regular
83 # Serve preview links using uuid or pdh in subdomain
84 # (requires wildcard DNS and TLS certificate)
85 # https://*.collections.uuid_prefix.arvadosapi.com
87 # Serve preview links using uuid or pdh in main domain
88 # (requires wildcard DNS and TLS certificate)
89 # https://*--collections.uuid_prefix.arvadosapi.com
91 # Serve preview links by setting uuid or pdh in the path.
92 # This configuration only allows previews of public data or
93 # collection-sharing links, because these use the anonymous
94 # user token or the token is already embedded in the URL.
95 # Other data must be handled as downloads via WebDAVDownload:
96 # https://collections.uuid_prefix.arvadosapi.com
101 InternalURLs: {SAMPLE: {}}
102 # Base URL for download links. If blank, serve links to WebDAV
103 # with disposition=attachment query param. Unlike preview links,
104 # browsers do not render attachments, so there is no risk of XSS.
106 # If WebDAVDownload is blank, and WebDAV uses a
107 # single-origin form, then Workbench will show an error page
109 # Serve download links by setting uuid or pdh in the path:
110 # https://download.uuid_prefix.arvadosapi.com
117 # Rendezvous is normally empty/omitted. When changing the
118 # URL of a Keepstore service, Rendezvous should be set to
119 # the old URL (with trailing slash omitted) to preserve
120 # rendezvous ordering.
124 InternalURLs: {SAMPLE: {}}
127 InternalURLs: {SAMPLE: {}}
128 # ShellInABox service endpoint URL for a given VM. If empty, do not
129 # offer web shell logins.
131 # E.g., using a path-based proxy server to forward connections to shell hosts:
132 # https://webshell.uuid_prefix.arvadosapi.com
134 # E.g., using a name-based proxy server to forward connections to shell hosts:
135 # https://*.webshell.uuid_prefix.arvadosapi.com
138 InternalURLs: {SAMPLE: {}}
141 InternalURLs: {SAMPLE: {}}
144 InternalURLs: {SAMPLE: {}}
148 # max concurrent connections per arvados server daemon
151 # All parameters here are passed to the PG client library in a connection string;
152 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
160 # Limits for how long a client token created by regular users can be valid,
161 # and also is used as a default expiration policy when no expiration date is
163 # Default value zero means token expirations don't get clamped and no
164 # default expiration is set.
167 # Maximum size (in bytes) allowed for a single API request. This
168 # limit is published in the discovery document for use by clients.
169 # Note: You must separately configure the upstream web server or
170 # proxy to actually enforce the desired maximum request size on the
172 MaxRequestSize: 134217728
174 # Limit the number of bytes read from the database during an index
175 # request (by retrieving and returning fewer rows than would
176 # normally be returned in a single response).
177 # Note 1: This setting never reduces the number of returned rows to
178 # zero, no matter how big the first data row is.
179 # Note 2: Currently, this is only checked against a specific set of
180 # columns that tend to get large (collections.manifest_text,
181 # containers.mounts, workflows.definition). Other fields (e.g.,
182 # "properties" hashes) are not counted against this limit.
183 MaxIndexDatabaseRead: 134217728
185 # Maximum number of items to return when responding to a APIs that
186 # can return partial result sets using limit and offset parameters
187 # (e.g., *.index, groups.contents). If a request specifies a "limit"
188 # parameter higher than this value, this value is used instead.
189 MaxItemsPerResponse: 1000
191 # Maximum number of concurrent requests to accept in a single
192 # service process, or 0 for no limit.
193 MaxConcurrentRequests: 0
195 # Maximum number of 64MiB memory buffers per Keepstore server process, or
196 # 0 for no limit. When this limit is reached, up to
197 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
198 # buffers (like GET and PUT) will wait for buffer space to be released.
199 # Any HTTP requests beyond MaxConcurrentRequests will receive an
200 # immediate 503 response.
202 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
203 # * 1.1) fits comfortably in memory. On a host dedicated to running
204 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
205 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
206 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
207 MaxKeepBlobBuffers: 128
209 # API methods to disable. Disabled methods are not listed in the
210 # discovery document, and respond 404 to all requests.
211 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
214 # Interval (seconds) between asynchronous permission view updates. Any
215 # permission-updating API called with the 'async' parameter schedules a an
216 # update on the permission view in the future, if not already scheduled.
217 AsyncPermissionsUpdateInterval: 20s
219 # Maximum number of concurrent outgoing requests to make while
220 # serving a single incoming multi-cluster (federated) request.
221 MaxRequestAmplification: 4
223 # Maximum wall clock time to spend handling an incoming request.
226 # Websocket will send a periodic empty event after 'SendTimeout'
227 # if there is no other activity to maintain the connection /
228 # detect dropped connections.
231 WebsocketClientEventQueue: 64
232 WebsocketServerEventQueue: 4
234 # Timeout on requests to internal Keep services.
235 KeepServiceRequestTimeout: 15s
238 # Config parameters to automatically setup new users. If enabled,
239 # this users will be able to self-activate. Enable this if you want
240 # to run an open instance where anyone can create an account and use
241 # the system without requiring manual approval.
243 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
244 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
245 AutoSetupNewUsers: false
246 AutoSetupNewUsersWithVmUUID: ""
247 AutoSetupNewUsersWithRepository: false
248 AutoSetupUsernameBlacklist:
257 # When NewUsersAreActive is set to true, new users will be active
258 # immediately. This skips the "self-activate" step which enforces
259 # user agreements. Should only be enabled for development.
260 NewUsersAreActive: false
262 # Newly activated users (whether set up by an admin or via
263 # AutoSetupNewUsers) immediately become visible to other active
266 # On a multi-tenant cluster, where the intent is for users to be
267 # invisible to one another unless they have been added to the
268 # same group(s) via Workbench admin interface, change this to
270 ActivatedUsersAreVisibleToOthers: true
272 # The e-mail address of the user you would like to become marked as an admin
273 # user on their first login.
274 AutoAdminUserWithEmail: ""
276 # If AutoAdminFirstUser is set to true, the first user to log in when no
277 # other admin users exist will automatically become an admin user.
278 AutoAdminFirstUser: false
280 # Email address to notify whenever a user creates a profile for the
282 UserProfileNotificationAddress: ""
283 AdminNotifierEmailFrom: arvados@example.com
284 EmailSubjectPrefix: "[ARVADOS] "
285 UserNotifierEmailFrom: arvados@example.com
286 UserNotifierEmailBcc: {}
287 NewUserNotificationRecipients: {}
288 NewInactiveUserNotificationRecipients: {}
290 # Set AnonymousUserToken to enable anonymous user access. Populate this
291 # field with a long random string. Then run "bundle exec
292 # ./script/get_anonymous_user_token.rb" in the directory where your API
293 # server is running to record the token in the database.
294 AnonymousUserToken: ""
296 # If a new user has an alternate email address (local@domain)
297 # with the domain given here, its local part becomes the new
298 # user's default username. Otherwise, the user's primary email
300 PreferDomainForUsername: ""
303 <% if not @user.full_name.empty? -%>
304 <%= @user.full_name %>,
309 Your Arvados account has been set up. You can log in at
311 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
314 Your Arvados administrator.
317 # Time to keep audit logs, in seconds. (An audit log is a row added
318 # to the "logs" table in the PostgreSQL database each time an
319 # Arvados object is created, modified, or deleted.)
321 # Currently, websocket event notifications rely on audit logs, so
322 # this should not be set lower than 300 (5 minutes).
325 # Maximum number of log rows to delete in a single SQL transaction.
327 # If MaxDeleteBatch is 0, log entries will never be
328 # deleted by Arvados. Cleanup can be done by an external process
329 # without affecting any Arvados system processes, as long as very
330 # recent (<5 minutes old) logs are not deleted.
332 # 100000 is a reasonable batch size for most sites.
335 # Attributes to suppress in events and audit logs. Notably,
336 # specifying {"manifest_text": {}} here typically makes the database
337 # smaller and faster.
339 # Warning: Using any non-empty value here can have undesirable side
340 # effects for any client or component that relies on event logs.
341 # Use at your own risk.
342 UnloggedAttributes: {}
346 # Logging threshold: panic, fatal, error, warn, info, debug, or
350 # Logging format: json or text
353 # Maximum characters of (JSON-encoded) query parameters to include
354 # in each request log entry. When params exceed this size, they will
355 # be JSON-encoded, truncated to this size, and logged as
357 MaxRequestLogParamsSize: 2000
361 # Enable access controls for data stored in Keep. This should
362 # always be set to true on a production cluster.
365 # BlobSigningKey is a string of alphanumeric characters used to
366 # generate permission signatures for Keep locators. It must be
367 # identical to the permission key given to Keep. IMPORTANT: This
368 # is a site secret. It should be at least 50 characters.
370 # Modifying BlobSigningKey will invalidate all existing
371 # signatures, which can cause programs to fail (e.g., arv-put,
372 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
373 # when no such processes are running.
376 # Enable garbage collection of unreferenced blobs in Keep.
379 # Time to leave unreferenced blobs in "trashed" state before
380 # deleting them, or 0 to skip the "trashed" state entirely and
381 # delete unreferenced blobs.
383 # If you use any Amazon S3 buckets as storage volumes, this
384 # must be at least 24h to avoid occasional data loss.
385 BlobTrashLifetime: 336h
387 # How often to check for (and delete) trashed blocks whose
388 # BlobTrashLifetime has expired.
389 BlobTrashCheckInterval: 24h
391 # Maximum number of concurrent "trash blob" and "delete trashed
392 # blob" operations conducted by a single keepstore process. Each
393 # of these can be set to 0 to disable the respective operation.
395 # If BlobTrashLifetime is zero, "trash" and "delete trash"
396 # happen at once, so only the lower of these two values is used.
397 BlobTrashConcurrency: 4
398 BlobDeleteConcurrency: 4
400 # Maximum number of concurrent "create additional replica of
401 # existing blob" operations conducted by a single keepstore
403 BlobReplicateConcurrency: 4
405 # Default replication level for collections. This is used when a
406 # collection's replication_desired attribute is nil.
407 DefaultReplication: 2
409 # BlobSigningTTL determines the minimum lifetime of transient
410 # data, i.e., blocks that are not referenced by
411 # collections. Unreferenced blocks exist for two reasons:
413 # 1) A data block must be written to a disk/cloud backend device
414 # before a collection can be created/updated with a reference to
417 # 2) Deleting or updating a collection can remove the last
418 # remaining reference to a data block.
420 # If BlobSigningTTL is too short, long-running
421 # processes/containers will fail when they take too long (a)
422 # between writing blocks and writing collections that reference
423 # them, or (b) between reading collections and reading the
426 # If BlobSigningTTL is too long, data will still be stored long
427 # after the referring collections are deleted, and you will
428 # needlessly fill up disks or waste money on cloud storage.
430 # Modifying BlobSigningTTL invalidates existing signatures; see
431 # BlobSigningKey note above.
433 # The default is 2 weeks.
436 # When running keep-balance, this is the destination filename for
437 # the list of lost block hashes if there are any, one per line.
438 # Updated automically during each successful run.
439 BlobMissingReport: ""
441 # keep-balance operates periodically, i.e.: do a
442 # scan/balance operation, sleep, repeat.
444 # BalancePeriod determines the interval between start times of
445 # successive scan/balance operations. If a scan/balance operation
446 # takes longer than BalancePeriod, the next one will follow it
449 # If SIGUSR1 is received during an idle period between operations,
450 # the next operation will start immediately.
453 # Limits the number of collections retrieved by keep-balance per
454 # API transaction. If this is zero, page size is
455 # determined by the API server's own page size limits (see
456 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
457 BalanceCollectionBatch: 0
459 # The size of keep-balance's internal queue of
460 # collections. Higher values use more memory and improve throughput
461 # by allowing keep-balance to fetch the next page of collections
462 # while the current page is still being processed. If this is zero
463 # or omitted, pages are processed serially.
464 BalanceCollectionBuffers: 1000
466 # Maximum time for a rebalancing run. This ensures keep-balance
467 # eventually gives up and retries if, for example, a network
468 # error causes a hung connection that is never closed by the
469 # OS. It should be long enough that it doesn't interrupt a
470 # long-running balancing operation.
473 # Maximum number of replication_confirmed /
474 # storage_classes_confirmed updates to write to the database
475 # after a rebalancing run. When many updates are needed, this
476 # spreads them over a few runs rather than applying them all at
478 BalanceUpdateLimit: 100000
480 # Default lifetime for ephemeral collections: 2 weeks. This must not
481 # be less than BlobSigningTTL.
482 DefaultTrashLifetime: 336h
484 # Interval (seconds) between trash sweeps. During a trash sweep,
485 # collections are marked as trash if their trash_at time has
486 # arrived, and deleted if their delete_at time has arrived.
487 TrashSweepInterval: 60s
489 # If true, enable collection versioning.
490 # When a collection's preserve_version field is true or the current version
491 # is older than the amount of seconds defined on PreserveVersionIfIdle,
492 # a snapshot of the collection's previous state is created and linked to
493 # the current collection.
494 CollectionVersioning: false
496 # 0s = auto-create a new version on every update.
497 # -1s = never auto-create new versions.
498 # > 0s = auto-create a new version when older than the specified number of seconds.
499 PreserveVersionIfIdle: -1s
501 # If non-empty, allow project and collection names to contain
502 # the "/" character (slash/stroke/solidus), and replace "/" with
503 # the given string in the filesystem hierarchy presented by
504 # WebDAV. Example values are "%2f" and "{slash}". Names that
505 # contain the substitution string itself may result in confusing
506 # behavior, so a value like "_" is not recommended.
508 # If the default empty value is used, the server will reject
509 # requests to create or rename a collection when the new name
512 # If the value "/" is used, project and collection names
513 # containing "/" will be allowed, but they will not be
514 # accessible via WebDAV.
516 # Use of this feature is not recommended, if it can be avoided.
517 ForwardSlashNameSubstitution: ""
519 # Include "folder objects" in S3 ListObjects responses.
520 S3FolderObjects: true
522 # Managed collection properties. At creation time, if the client didn't
523 # provide the listed keys, they will be automatically populated following
524 # one of the following behaviors:
526 # * UUID of the user who owns the containing project.
527 # responsible_person_uuid: {Function: original_owner, Protected: true}
529 # * Default concrete value.
530 # foo_bar: {Value: baz, Protected: false}
532 # If Protected is true, only an admin user can modify its value.
534 SAMPLE: {Function: original_owner, Protected: true}
536 # In "trust all content" mode, Workbench will redirect download
537 # requests to WebDAV preview link, even in the cases when
538 # WebDAV would have to expose XSS vulnerabilities in order to
539 # handle the redirect (see discussion on Services.WebDAV).
541 # This setting has no effect in the recommended configuration, where the
542 # WebDAV service is configured to have a separate domain for every
543 # collection and XSS protection is provided by browsers' same-origin
546 # The default setting (false) is appropriate for a multi-user site.
547 TrustAllContent: false
549 # Cache parameters for WebDAV content serving:
551 # Time to cache manifests, permission checks, and sessions.
554 # Time to cache collection state.
557 # Block cache entries. Each block consumes up to 64 MiB RAM.
560 # Collection cache entries.
561 MaxCollectionEntries: 1000
563 # Approximate memory limit (in bytes) for collection cache.
564 MaxCollectionBytes: 100000000
566 # UUID cache entries.
569 # Persistent sessions.
572 # Selectively set permissions for regular users and admins to
573 # download or upload data files using the upload/download
574 # features for Workbench, WebDAV and S3 API support.
583 # Selectively set permissions for regular users and admins to be
584 # able to download or upload blocks using arv-put and
585 # arv-get from outside the cluster.
594 # Post upload / download events to the API server logs table, so
595 # that they can be included in the arv-user-activity report.
596 # You can disable this if you find that it is creating excess
597 # load on the API server and you don't need it.
598 WebDAVLogEvents: true
601 # One of the following mechanisms (Google, PAM, LDAP, or
602 # LoginCluster) should be enabled; see
603 # https://doc.arvados.org/install/setup-login.html
606 # Authenticate with Google.
609 # Use the Google Cloud console to enable the People API (APIs
610 # and Services > Enable APIs and services > Google People API
611 # > Enable), generate a Client ID and secret (APIs and
612 # Services > Credentials > Create credentials > OAuth client
613 # ID > Web application) and add your controller's /login URL
614 # (e.g., "https://zzzzz.example.com/login") as an authorized
619 # Allow users to log in to existing accounts using any verified
620 # email address listed by their Google account. If true, the
621 # Google People API must be enabled in order for Google login to
622 # work. If false, only the primary email address will be used.
623 AlternateEmailAddresses: true
625 # Send additional parameters with authentication requests. See
626 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
627 # for a list of supported parameters.
628 AuthenticationRequestParameters:
629 # Show the "choose which Google account" page, even if the
630 # client is currently logged in to exactly one Google
632 prompt: select_account
637 # Authenticate with an OpenID Connect provider.
640 # Issuer URL, e.g., "https://login.example.com".
642 # This must be exactly equal to the URL returned by the issuer
643 # itself in its config response ("isser" key). If the
644 # configured value is "https://example" and the provider
645 # returns "https://example:443" or "https://example/" then
646 # login will fail, even though those URLs are equivalent
650 # Your client ID and client secret (supplied by the provider).
654 # OpenID claim field containing the user's email
655 # address. Normally "email"; see
656 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
659 # OpenID claim field containing the email verification
660 # flag. Normally "email_verified". To accept every returned
661 # email address without checking a "verified" field at all,
662 # use the empty string "".
663 EmailVerifiedClaim: "email_verified"
665 # OpenID claim field containing the user's preferred
666 # username. If empty, use the mailbox part of the user's email
670 # Send additional parameters with authentication requests,
671 # like {display: page, prompt: consent}. See
672 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
673 # and refer to your provider's documentation for supported
675 AuthenticationRequestParameters:
678 # Accept an OIDC access token as an API token if the OIDC
679 # provider's UserInfo endpoint accepts it.
681 # AcceptAccessTokenScope should also be used when enabling
683 AcceptAccessToken: false
685 # Before accepting an OIDC access token as an API token, first
686 # check that it is a JWT whose "scope" value includes this
687 # value. Example: "https://zzzzz.example.com/" (your Arvados
690 # If this value is empty and AcceptAccessToken is true, all
691 # access tokens will be accepted regardless of scope,
692 # including non-JWT tokens. This is not recommended.
693 AcceptAccessTokenScope: ""
696 # Use PAM to authenticate users.
699 # PAM service name. PAM will apply the policy in the
700 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
701 # there is none, the default "other" config.
704 # Domain name (e.g., "example.com") to use to construct the
705 # user's email address if PAM authentication returns a
706 # username with no "@". If empty, use the PAM username as the
707 # user's email address, whether or not it contains "@".
709 # Note that the email address is used as the primary key for
710 # user records when logging in. Therefore, if you change
711 # PAMDefaultEmailDomain after the initial installation, you
712 # should also update existing user records to reflect the new
713 # domain. Otherwise, next time those users log in, they will
714 # be given new accounts instead of accessing their existing
716 DefaultEmailDomain: ""
719 # Use an LDAP service to authenticate users.
722 # Server URL, like "ldap://ldapserver.example.com:389" or
723 # "ldaps://ldapserver.example.com:636".
724 URL: "ldap://ldap:389"
726 # Use StartTLS upon connecting to the server.
729 # Skip TLS certificate name verification.
732 # Strip the @domain part if a user supplies an email-style
733 # username with this domain. If "*", strip any user-provided
734 # domain. If "", never strip the domain part. Example:
738 # If, after applying StripDomain, the username contains no "@"
739 # character, append this domain to form an email-style
740 # username. Example: "example.com"
743 # The LDAP attribute to filter on when looking up a username
744 # (after applying StripDomain and AppendDomain).
747 # Bind with this username (DN or UPN) and password when
748 # looking up the user record.
750 # Example user: "cn=admin,dc=example,dc=com"
752 SearchBindPassword: ""
754 # Directory base for username lookup. Example:
755 # "ou=Users,dc=example,dc=com"
758 # Additional filters to apply when looking up users' LDAP
759 # entries. This can be used to restrict access to a subset of
760 # LDAP users, or to disambiguate users from other directory
761 # entries that have the SearchAttribute present.
763 # Special characters in assertion values must be escaped (see
766 # Example: "(objectClass=person)"
769 # LDAP attribute to use as the user's email address.
771 # Important: This must not be an attribute whose value can be
772 # edited in the directory by the users themselves. Otherwise,
773 # users can take over other users' Arvados accounts trivially
774 # (email address is the primary key for Arvados accounts.)
777 # LDAP attribute to use as the preferred Arvados username. If
778 # no value is found (or this config is empty) the username
779 # originally supplied by the user will be used.
780 UsernameAttribute: uid
783 # Authenticate users listed here in the config file. This
784 # feature is intended to be used in test environments, and
785 # should not be used in production.
789 Email: alice@example.com
792 # The cluster ID to delegate the user database. When set,
793 # logins on this cluster will be redirected to the login cluster
794 # (login cluster must appear in RemoteClusters with Proxy: true)
797 # How long a cached token belonging to a remote cluster will
798 # remain valid before it needs to be revalidated.
799 RemoteTokenRefresh: 5m
801 # How long a client token created from a login flow will be valid without
802 # asking the user to re-login. Example values: 60m, 8h.
803 # Default value zero means tokens don't have expiration.
806 # If true (default) tokens issued through login are allowed to create
808 # If false, tokens issued through login are not allowed to
809 # viewing/creating other tokens. New tokens can only be created
810 # by going through login again.
811 IssueTrustedTokens: true
813 # When the token is returned to a client, the token itself may
814 # be restricted from viewing/creating other tokens based on whether
815 # the client is "trusted" or not. The local Workbench1 and
816 # Workbench2 are trusted by default, but if this is a
817 # LoginCluster, you probably want to include the other Workbench
818 # instances in the federation in this list.
821 "https://workbench.federate1.example": {}
822 "https://workbench.federate2.example": {}
825 # Path to git or gitolite-shell executable. Each authenticated
826 # request will execute this program with the single argument "http-backend"
827 GitCommand: /usr/bin/git
829 # Path to Gitolite's home directory. If a non-empty path is given,
830 # the CGI environment will be set up to support the use of
831 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
832 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
833 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
836 # Git repositories must be readable by api server, or you won't be
837 # able to submit crunch jobs. To pass the test suites, put a clone
838 # of the arvados tree in {git_repositories_dir}/arvados.git or
839 # {git_repositories_dir}/arvados/.git
840 Repositories: /var/lib/arvados/git/repositories
848 # List of supported Docker Registry image formats that compute nodes
849 # are able to use. `arv keep docker` will error out if a user tries
850 # to store an image with an unsupported format. Use an empty array
851 # to skip the compatibility check (and display a warning message to
854 # Example for sites running docker < 1.10: {"v1": {}}
855 # Example for sites running docker >= 1.10: {"v2": {}}
856 # Example for disabling check: {}
857 SupportedDockerImageFormats:
861 # Include details about job reuse decisions in the server log. This
862 # causes additional database queries to run, so it should not be
863 # enabled unless you expect to examine the resulting logs for
864 # troubleshooting purposes.
865 LogReuseDecisions: false
867 # Default value for keep_cache_ram of a container's runtime_constraints.
868 DefaultKeepCacheRAM: 268435456
870 # Number of times a container can be unlocked before being
871 # automatically cancelled.
872 MaxDispatchAttempts: 5
874 # Default value for container_count_max for container requests. This is the
875 # number of times Arvados will create a new container to satisfy a container
876 # request. If a container is cancelled it will retry a new container if
877 # container_count < container_count_max on any container requests associated
878 # with the cancelled container.
881 # The maximum number of compute nodes that can be in use simultaneously
882 # If this limit is reduced, any existing nodes with slot number >= new limit
883 # will not be counted against the new limit. In other words, the new limit
884 # won't be strictly enforced until those nodes with higher slot numbers
888 # Preemptible instance support (e.g. AWS Spot Instances)
889 # When true, child containers will get created with the preemptible
890 # scheduling parameter parameter set.
891 UsePreemptibleInstances: false
893 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
894 # cloud dispatcher for executing containers on worker VMs.
895 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
896 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
897 DispatchPrivateKey: ""
899 # Maximum time to wait for workers to come up before abandoning
900 # stale locks from a previous dispatch process.
903 # The crunch-run command used to start a container on a worker node.
905 # When dispatching to cloud VMs, this is used only if
906 # DeployRunnerBinary in the CloudVMs section is set to the empty
908 CrunchRunCommand: "crunch-run"
910 # Extra arguments to add to crunch-run invocation
911 # Example: ["--cgroup-parent-subsystem=memory"]
912 CrunchRunArgumentsList: []
914 # Extra RAM to reserve on the node, in addition to
915 # the amount specified in the container's RuntimeConstraints
916 ReserveExtraRAM: 256MiB
918 # Minimum time between two attempts to run the same container
921 # Container runtime: "docker" (default) or "singularity"
922 RuntimeEngine: docker
924 # When running a container, run a dedicated keepstore process,
925 # using the specified number of 64 MiB memory buffers per
926 # allocated CPU core (VCPUs in the container's runtime
927 # constraints). The dedicated keepstore handles I/O for
928 # collections mounted in the container, as well as saving
931 # A zero value disables this feature.
933 # In order for this feature to be activated, no volume may use
934 # AccessViaHosts, and each volume must have Replication higher
935 # than Collections.DefaultReplication. If these requirements are
936 # not satisfied, the feature is disabled automatically
937 # regardless of the value given here.
939 # Note that when this configuration is enabled, the entire
940 # cluster configuration file, including the system root token,
941 # is copied to the worker node and held in memory for the
942 # duration of the container.
943 LocalKeepBlobBuffersPerVCPU: 1
945 # When running a dedicated keepstore process for a container
946 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
947 # messages to keepstore.txt in the container's log collection.
949 # These log messages can reveal some volume configuration
950 # details, error messages from the cloud storage provider, etc.,
951 # which are not otherwise visible to users.
954 # * "none" -- no keepstore.txt file
955 # * "all" -- all logs, including request and response lines
956 # * "errors" -- all logs except "response" logs with 2xx
957 # response codes and "request" logs
958 LocalKeepLogsToContainerLog: none
961 # When you run the db:delete_old_container_logs task, it will find
962 # containers that have been finished for at least this many seconds,
963 # and delete their stdout, stderr, arv-mount, crunch-run, and
964 # crunchstat logs from the logs table.
967 # These two settings control how frequently log events are flushed to the
968 # database. Log lines are buffered until either crunch_log_bytes_per_event
969 # has been reached or crunch_log_seconds_between_events has elapsed since
971 LogBytesPerEvent: 4096
972 LogSecondsBetweenEvents: 5s
974 # The sample period for throttling logs.
975 LogThrottlePeriod: 60s
977 # Maximum number of bytes that job can log over crunch_log_throttle_period
978 # before being silenced until the end of the period.
979 LogThrottleBytes: 65536
981 # Maximum number of lines that job can log over crunch_log_throttle_period
982 # before being silenced until the end of the period.
983 LogThrottleLines: 1024
985 # Maximum bytes that may be logged by a single job. Log bytes that are
986 # silenced by throttling are not counted against this total.
987 LimitLogBytesPerJob: 67108864
989 LogPartialLineThrottlePeriod: 5s
991 # Container logs are written to Keep and saved in a
992 # collection, which is updated periodically while the
993 # container runs. This value sets the interval between
994 # collection updates.
997 # The log collection is also updated when the specified amount of
998 # log data (given in bytes) is produced in less than one update
1000 LogUpdateSize: 32MiB
1003 # An admin user can use "arvados-client shell" to start an
1004 # interactive shell (with any user ID) in any running
1008 # Any user can use "arvados-client shell" to start an
1009 # interactive shell (with any user ID) in any running
1010 # container that they started, provided it isn't also
1011 # associated with a different user's container request.
1013 # Interactive sessions make it easy to alter the container's
1014 # runtime environment in ways that aren't recorded or
1015 # reproducible. Consider the implications for automatic
1016 # container reuse before enabling and using this feature. In
1017 # particular, note that starting an interactive session does
1018 # not disqualify a container from being reused by a different
1019 # user/workflow in the future.
1024 SbatchArgumentsList: []
1025 SbatchEnvironmentVariables:
1028 # Path to dns server configuration directory
1029 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1030 # files or touch restart.txt (see below).
1031 DNSServerConfDir: ""
1033 # Template file for the dns server host snippets. See
1034 # unbound.template in this directory for an example. If false, do
1035 # not write any config files.
1036 DNSServerConfTemplate: ""
1038 # String to write to {dns_server_conf_dir}/restart.txt (with a
1039 # trailing newline) after updating local data. If false, do not
1040 # open or write the restart.txt file.
1041 DNSServerReloadCommand: ""
1043 # Command to run after each DNS update. Template variables will be
1044 # substituted; see the "unbound" example below. If false, do not run
1046 DNSServerUpdateCommand: ""
1048 ComputeNodeDomain: ""
1049 ComputeNodeNameservers:
1053 # Hostname to assign to a compute node when it sends a "ping" and the
1054 # hostname in its Node record is nil.
1055 # During bootstrapping, the "ping" script is expected to notice the
1056 # hostname given in the ping response, and update its unix hostname
1058 # If false, leave the hostname alone (this is appropriate if your compute
1059 # nodes' hostnames are already assigned by some other mechanism).
1061 # One way or another, the hostnames of your node records should agree
1062 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1064 # Example for compute0000, compute0001, ....:
1065 # assign_node_hostname: compute%<slot_number>04d
1066 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1067 AssignNodeHostname: "compute%<slot_number>d"
1070 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1072 # Template variables starting with % will be substituted as follows:
1075 # %C number of VCPUs
1079 # Use %% to express a literal %. The %%J in the default will be changed
1080 # to %J, which is interpreted by bsub itself.
1082 # Note that the default arguments cause LSF to write two files
1083 # in /tmp on the compute node each time an Arvados container
1084 # runs. Ensure you have something in place to delete old files
1085 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1086 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]"]
1088 # Use sudo to switch to this user account when submitting LSF
1091 # This account must exist on the hosts where LSF jobs run
1092 # ("execution hosts"), as well as on the host where the
1093 # Arvados LSF dispatcher runs ("submission host").
1094 BsubSudoUser: "crunch"
1097 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1099 # Note: this only enables read-only access, creating new
1100 # legacy jobs and pipelines is not supported.
1102 # 'auto' -- (default) enable the Jobs API only if it has been used before
1103 # (i.e., there are job records in the database)
1104 # 'true' -- enable the Jobs API despite lack of existing records.
1105 # 'false' -- disable the Jobs API despite presence of existing records.
1108 # Git repositories must be readable by api server, or you won't be
1109 # able to submit crunch jobs. To pass the test suites, put a clone
1110 # of the arvados tree in {git_repositories_dir}/arvados.git or
1111 # {git_repositories_dir}/arvados/.git
1112 GitInternalDir: /var/lib/arvados/internal.git
1115 # Enable the cloud scheduler.
1118 # Name/number of port where workers' SSH services listen.
1121 # Interval between queue polls.
1124 # Shell command to execute on each worker to determine whether
1125 # the worker is booted and ready to run containers. It should
1126 # exit zero if the worker is ready.
1127 BootProbeCommand: "systemctl is-system-running"
1129 # Minimum interval between consecutive probes to a single
1133 # Maximum probes per second, across all workers in a pool.
1134 MaxProbesPerSecond: 10
1136 # Time before repeating SIGTERM when killing a container.
1139 # Time to give up on a process (most likely arv-mount) that
1140 # still holds a container lockfile after its main supervisor
1141 # process has exited, and declare the instance broken.
1142 TimeoutStaleRunLock: 5s
1144 # Time to give up on SIGTERM and write off the worker.
1147 # Maximum create/destroy-instance operations per second (0 =
1149 MaxCloudOpsPerSecond: 10
1151 # Maximum concurrent instance creation operations (0 = unlimited).
1153 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1154 # requests that can be in flight at any one time, whereas
1155 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1156 # that can be started per second.
1158 # Because the API for instance creation on Azure is synchronous, it is
1159 # recommended to increase MaxConcurrentInstanceCreateOps when running
1160 # on Azure. When using managed images, a value of 20 would be
1161 # appropriate. When using Azure Shared Image Galeries, it could be set
1162 # higher. For more information, see
1163 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1165 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1166 # providers too, if desired.
1167 MaxConcurrentInstanceCreateOps: 1
1169 # Interval between cloud provider syncs/updates ("list all
1173 # Time to leave an idle worker running (in case new containers
1174 # appear in the queue that it can run) before shutting it
1178 # Time to wait for a new worker to boot (i.e., pass
1179 # BootProbeCommand) before giving up and shutting it down.
1182 # Maximum time a worker can stay alive with no successful
1183 # probes before being automatically shut down.
1186 # Time after shutting down a worker to retry the
1187 # shutdown/destroy operation.
1188 TimeoutShutdown: 10s
1190 # Worker VM image ID.
1191 # (aws) AMI identifier
1192 # (azure) managed disks: the name of the managed disk image
1193 # (azure) shared image gallery: the name of the image definition. Also
1194 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1195 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1196 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1199 # An executable file (located on the dispatcher host) to be
1200 # copied to cloud instances at runtime and used as the
1201 # container runner/supervisor. The default value is the
1202 # dispatcher program itself.
1204 # Use the empty string to disable this step: nothing will be
1205 # copied, and cloud instances are assumed to have a suitable
1206 # version of crunch-run installed; see CrunchRunCommand above.
1207 DeployRunnerBinary: "/proc/self/exe"
1209 # Tags to add on all resources (VMs, NICs, disks) created by
1210 # the container dispatcher. (Arvados's own tags --
1211 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1216 # Prefix for predefined tags used by Arvados (InstanceSetID,
1217 # InstanceType, InstanceSecret, IdleBehavior). With the
1218 # default value "Arvados", tags are "ArvadosInstanceSetID",
1219 # "ArvadosInstanceSecret", etc.
1221 # This should only be changed while no cloud resources are in
1222 # use and the cloud dispatcher is not running. Otherwise,
1223 # VMs/resources that were added using the old tag prefix will
1224 # need to be detected and cleaned up manually.
1225 TagKeyPrefix: Arvados
1227 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1230 # Cloud-specific driver parameters.
1233 # (ec2) Credentials. Omit or leave blank if using IAM role.
1237 # (ec2) Instance configuration.
1243 AdminUsername: debian
1245 # (azure) Credentials.
1251 # (azure) Instance configuration.
1252 CloudEnvironment: AzurePublicCloud
1255 # (azure) The resource group where the VM and virtual NIC will be
1259 # (azure) The resource group of the Network to use for the virtual
1260 # NIC (if different from ResourceGroup)
1261 NetworkResourceGroup: ""
1265 # (azure) managed disks: The resource group where the managed disk
1266 # image can be found (if different from ResourceGroup).
1267 ImageResourceGroup: ""
1269 # (azure) shared image gallery: the name of the gallery
1270 SharedImageGalleryName: ""
1271 # (azure) shared image gallery: the version of the image definition
1272 SharedImageGalleryImageVersion: ""
1274 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1278 # (azure) How long to wait before deleting VHD and NIC
1279 # objects that are no longer being used.
1280 DeleteDanglingResourcesAfter: 20s
1282 # Account (that already exists in the VM image) that will be
1283 # set up with an ssh authorized key to allow the compute
1284 # dispatcher to connect.
1285 AdminUsername: arvados
1289 # Use the instance type name as the key (in place of "SAMPLE" in
1290 # this sample entry).
1292 # Cloud provider's instance type. Defaults to the configured type name.
1296 IncludedScratch: 16GB
1303 # If you use multiple storage classes, specify them here, using
1304 # the storage class name as the key (in place of "SAMPLE" in
1305 # this sample entry).
1307 # Further info/examples:
1308 # https://doc.arvados.org/admin/storage-classes.html
1311 # Priority determines the order volumes should be searched
1312 # when reading data, in cases where a keepstore server has
1313 # access to multiple volumes with different storage classes.
1316 # Default determines which storage class(es) should be used
1317 # when a user/client writes data or saves a new collection
1318 # without specifying storage classes.
1320 # If any StorageClasses are configured, at least one of them
1321 # must have Default: true.
1326 # AccessViaHosts specifies which keepstore processes can read
1327 # and write data on the volume.
1329 # For a local filesystem, AccessViaHosts has one entry,
1330 # indicating which server the filesystem is located on.
1332 # For a network-attached backend accessible by all keepstore
1333 # servers, like a cloud storage bucket or an NFS mount,
1334 # AccessViaHosts can be empty/omitted.
1336 # Further info/examples:
1337 # https://doc.arvados.org/install/configure-fs-storage.html
1338 # https://doc.arvados.org/install/configure-s3-object-storage.html
1339 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1343 "http://host1.example:25107": {}
1347 # If you have configured storage classes (see StorageClasses
1348 # section above), add an entry here for each storage class
1349 # satisfied by this volume.
1353 # for s3 driver -- see
1354 # https://doc.arvados.org/install/configure-s3-object-storage.html
1357 SecretAccessKey: aaaaa
1361 LocationConstraint: false
1368 # Use aws-s3-go (v2) instead of goamz
1369 UseAWSS3v2Driver: false
1371 # For S3 driver, potentially unsafe tuning parameter,
1372 # intentionally excluded from main documentation.
1374 # Enable deletion (garbage collection) even when the
1375 # configured BlobTrashLifetime is zero. WARNING: eventual
1376 # consistency may result in race conditions that can cause
1377 # data loss. Do not enable this unless you understand and
1381 # for azure driver -- see
1382 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1383 StorageAccountName: aaaaa
1384 StorageAccountKey: aaaaa
1385 StorageBaseURL: core.windows.net
1386 ContainerName: aaaaa
1388 ListBlobsRetryDelay: 10s
1389 ListBlobsMaxAttempts: 10
1391 WriteRaceInterval: 15s
1392 WriteRacePollTime: 1s
1394 # for local directory driver -- see
1395 # https://doc.arvados.org/install/configure-fs-storage.html
1396 Root: /var/lib/arvados/keep-data
1398 # For local directory driver, potentially confusing tuning
1399 # parameter, intentionally excluded from main documentation.
1401 # When true, read and write operations (for whole 64MiB
1402 # blocks) on an individual volume will queued and issued
1403 # serially. When false, read and write operations will be
1404 # issued concurrently.
1406 # May possibly improve throughput if you have physical spinning disks
1407 # and experience contention when there are multiple requests
1408 # to the same volume.
1410 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1411 # should leave this alone.
1417 SendUserSetupNotificationEmail: true
1419 # Bug/issue report notification to and from addresses
1420 IssueReporterEmailFrom: "arvados@example.com"
1421 IssueReporterEmailTo: "arvados@example.com"
1422 SupportEmailAddress: "arvados@example.com"
1424 # Generic issue email from
1425 EmailFrom: "arvados@example.com"
1432 ActivateUsers: false
1434 # API endpoint host or host:port; default is {id}.arvadosapi.com
1435 Host: sample.arvadosapi.com
1437 # Perform a proxy request when a local client requests an
1438 # object belonging to this remote.
1441 # Default "https". Can be set to "http" for testing.
1444 # Disable TLS verify. Can be set to true for testing.
1447 # When users present tokens issued by this remote cluster, and
1448 # their accounts are active on the remote cluster, activate
1449 # them on this cluster too.
1450 ActivateUsers: false
1453 # Workbench1 configs
1455 ActivationContactLink: mailto:info@arvados.org
1456 ArvadosDocsite: https://doc.arvados.org
1457 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1458 ShowUserAgreementInline: false
1461 # Scratch directory used by the remote repository browsing
1462 # feature. If it doesn't exist, it (and any missing parents) will be
1463 # created using mkdir_p.
1464 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1466 # Below is a sample setting of user_profile_form_fields config parameter.
1467 # This configuration parameter should be set to either false (to disable) or
1468 # to a map as shown below.
1469 # Configure the map of input fields to be displayed in the profile page
1470 # using the attribute "key" for each of the input fields.
1471 # This sample shows configuration with one required and one optional form fields.
1472 # For each of these input fields:
1473 # You can specify "Type" as "text" or "select".
1474 # List the "Options" to be displayed for each of the "select" menu.
1475 # Set "Required" as "true" for any of these fields to make them required.
1476 # If any of the required fields are missing in the user's profile, the user will be
1477 # redirected to the profile page before they can access any Workbench features.
1478 UserProfileFormFields:
1481 FormFieldTitle: Best color
1482 FormFieldDescription: your favorite color
1491 # exampleTextValue: # key that will be set in properties
1493 # FormFieldTitle: ""
1494 # FormFieldDescription: ""
1497 # exampleOptionsValue:
1499 # FormFieldTitle: ""
1500 # FormFieldDescription: ""
1508 # Use "UserProfileFormMessage to configure the message you want
1509 # to display on the profile page.
1510 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1512 # Mimetypes of applications for which the view icon
1513 # would be enabled in a collection's show page.
1514 # It is sufficient to list only applications here.
1515 # No need to list text and image types.
1516 ApplicationMimetypesWithViewIcon:
1534 # The maximum number of bytes to load in the log viewer
1535 LogViewerMaxBytes: 1M
1537 # When anonymous_user_token is configured, show public projects page
1538 EnablePublicProjectsPage: true
1540 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1541 EnableGettingStartedPopup: false
1543 # Ask Arvados API server to compress its response payloads.
1544 APIResponseCompression: true
1546 # Timeouts for API requests.
1547 APIClientConnectTimeout: 2m
1548 APIClientReceiveTimeout: 5m
1550 # Maximum number of historic log records of a running job to fetch
1551 # and display in the Log tab, while subscribing to web sockets.
1552 RunningJobLogRecordsToFetch: 2000
1554 # In systems with many shared projects, loading of dashboard and topnav
1555 # can be slow due to collections indexing; use the following parameters
1556 # to suppress these properties
1557 ShowRecentCollectionsOnDashboard: true
1558 ShowUserNotifications: true
1560 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1561 # a link to the multi-site search page on a "home" Workbench site.
1564 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1567 # Should workbench allow management of local git repositories? Set to false if
1568 # the jobs api is disabled and there are no local git repositories.
1571 SiteName: Arvados Workbench
1572 ProfilingEnabled: false
1574 # This is related to obsolete Google OpenID 1.0 login
1575 # but some workbench stuff still expects it to be set.
1576 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1578 # Workbench2 configs
1580 FileViewersConfigURL: ""
1582 # Idle time after which the user's session will be auto closed.
1583 # This feature is disabled when set to zero.
1586 # Workbench welcome screen, this is HTML text that will be
1587 # incorporated directly onto the page.
1589 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1590 <h2>Please log in.</h2>
1592 <p>If you have never used Arvados Workbench before, logging in
1593 for the first time will automatically create a new
1596 <i>Arvados Workbench uses your information only for
1597 identification, and does not retrieve any other personal
1600 # Workbench screen displayed to inactive users. This is HTML
1601 # text that will be incorporated directly onto the page.
1603 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1604 <h3>Hi! You're logged in, but...</h3>
1605 <p>Your account is inactive.</p>
1606 <p>An administrator must activate your account before you can get
1609 # Connecting to Arvados shell VMs tends to be site-specific.
1610 # Put any special instructions here. This is HTML text that will
1611 # be incorporated directly onto the Workbench page.
1613 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1614 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1616 # Sample text if you are using a "switchyard" ssh proxy.
1617 # Replace "zzzzz" with your Cluster ID.
1619 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1622 # ServerAliveInterval 60
1623 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1626 # If you are using a switchyard ssh proxy, shell node hostnames
1627 # may require a special hostname suffix. In the sample ssh
1628 # configuration above, this would be ".zzzzz"
1629 # This is added to the hostname in the "command line" column
1630 # the Workbench "shell VMs" page.
1632 # If your shell nodes are directly accessible by users without a
1633 # proxy and have fully qualified host names, you should leave
1635 SSHHelpHostSuffix: ""
1637 # (Experimental) Restart services automatically when config file
1638 # changes are detected. Only supported by `arvados-server boot` in
1640 AutoReloadConfig: false