1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
7 var DefaultYAML = []byte(`# Copyright (C) The Arvados Authors. All rights reserved.
9 # SPDX-License-Identifier: AGPL-3.0
11 # Do not use this file for site configuration. Create
12 # /etc/arvados/config.yml instead.
14 # The order of precedence (highest to lowest):
15 # 1. Legacy component-specific config files (deprecated)
16 # 2. /etc/arvados/config.yml
17 # 3. config.default.yml
21 # Token used internally by Arvados components to authenticate to
22 # one another. Use a string of at least 50 random alphanumerics.
25 # Token to be included in all healthcheck requests. Disabled by default.
26 # Server expects request header of the format "Authorization: Bearer xxx"
31 # In each of the service sections below, the keys under
32 # InternalURLs are the endpoints where the service should be
33 # listening, and reachable from other hosts in the
37 # "http://host1.example:12345": {}
38 # "http://host2.example:12345": {}
41 InternalURLs: {SAMPLE: {}}
44 InternalURLs: {SAMPLE: {}}
47 InternalURLs: {SAMPLE: {}}
50 InternalURLs: {SAMPLE: {}}
53 InternalURLs: {SAMPLE: {}}
56 InternalURLs: {SAMPLE: {}}
59 InternalURLs: {SAMPLE: {}}
62 InternalURLs: {SAMPLE: {}}
65 InternalURLs: {SAMPLE: {}}
68 InternalURLs: {SAMPLE: {}}
69 # Base URL for Workbench inline preview. If blank, use
70 # WebDAVDownload instead, and disable inline preview.
71 # If both are empty, downloading collections from workbench
74 # It is important to properly configure the download service
75 # to migitate cross-site-scripting (XSS) attacks. A HTML page
76 # can be stored in collection. If an attacker causes a victim
77 # to visit that page through Workbench, it will be rendered by
78 # the browser. If all collections are served at the same
79 # domain, the browser will consider collections as coming from
80 # the same origin and having access to the same browsing data,
81 # enabling malicious Javascript on that page to access Arvados
82 # on behalf of the victim.
84 # This is mitigating by having separate domains for each
85 # collection, or limiting preview to circumstances where the
86 # collection is not accessed with the user's regular
89 # Serve preview links using uuid or pdh in subdomain
90 # (requires wildcard DNS and TLS certificate)
91 # https://*.collections.uuid_prefix.arvadosapi.com
93 # Serve preview links using uuid or pdh in main domain
94 # (requires wildcard DNS and TLS certificate)
95 # https://*--collections.uuid_prefix.arvadosapi.com
97 # Serve preview links by setting uuid or pdh in the path.
98 # This configuration only allows previews of public data or
99 # collection-sharing links, because these use the anonymous
100 # user token or the token is already embedded in the URL.
101 # Other data must be handled as downloads via WebDAVDownload:
102 # https://collections.uuid_prefix.arvadosapi.com
107 InternalURLs: {SAMPLE: {}}
108 # Base URL for download links. If blank, serve links to WebDAV
109 # with disposition=attachment query param. Unlike preview links,
110 # browsers do not render attachments, so there is no risk of XSS.
112 # If WebDAVDownload is blank, and WebDAV uses a
113 # single-origin form, then Workbench will show an error page
115 # Serve download links by setting uuid or pdh in the path:
116 # https://download.uuid_prefix.arvadosapi.com
123 # Rendezvous is normally empty/omitted. When changing the
124 # URL of a Keepstore service, Rendezvous should be set to
125 # the old URL (with trailing slash omitted) to preserve
126 # rendezvous ordering.
130 InternalURLs: {SAMPLE: {}}
133 InternalURLs: {SAMPLE: {}}
134 # ShellInABox service endpoint URL for a given VM. If empty, do not
135 # offer web shell logins.
137 # E.g., using a path-based proxy server to forward connections to shell hosts:
138 # https://webshell.uuid_prefix.arvadosapi.com
140 # E.g., using a name-based proxy server to forward connections to shell hosts:
141 # https://*.webshell.uuid_prefix.arvadosapi.com
144 InternalURLs: {SAMPLE: {}}
147 InternalURLs: {SAMPLE: {}}
150 InternalURLs: {SAMPLE: {}}
154 # max concurrent connections per arvados server daemon
157 # All parameters here are passed to the PG client library in a connection string;
158 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
166 # Limits for how long a client token created by regular users can be valid,
167 # and also is used as a default expiration policy when no expiration date is
169 # Default value zero means token expirations don't get clamped and no
170 # default expiration is set.
173 # Maximum size (in bytes) allowed for a single API request. This
174 # limit is published in the discovery document for use by clients.
175 # Note: You must separately configure the upstream web server or
176 # proxy to actually enforce the desired maximum request size on the
178 MaxRequestSize: 134217728
180 # Limit the number of bytes read from the database during an index
181 # request (by retrieving and returning fewer rows than would
182 # normally be returned in a single response).
183 # Note 1: This setting never reduces the number of returned rows to
184 # zero, no matter how big the first data row is.
185 # Note 2: Currently, this is only checked against a specific set of
186 # columns that tend to get large (collections.manifest_text,
187 # containers.mounts, workflows.definition). Other fields (e.g.,
188 # "properties" hashes) are not counted against this limit.
189 MaxIndexDatabaseRead: 134217728
191 # Maximum number of items to return when responding to a APIs that
192 # can return partial result sets using limit and offset parameters
193 # (e.g., *.index, groups.contents). If a request specifies a "limit"
194 # parameter higher than this value, this value is used instead.
195 MaxItemsPerResponse: 1000
197 # Maximum number of concurrent requests to accept in a single
198 # service process, or 0 for no limit.
199 MaxConcurrentRequests: 0
201 # Maximum number of 64MiB memory buffers per Keepstore server process, or
202 # 0 for no limit. When this limit is reached, up to
203 # (MaxConcurrentRequests - MaxKeepBlobBuffers) HTTP requests requiring
204 # buffers (like GET and PUT) will wait for buffer space to be released.
205 # Any HTTP requests beyond MaxConcurrentRequests will receive an
206 # immediate 503 response.
208 # MaxKeepBlobBuffers should be set such that (MaxKeepBlobBuffers * 64MiB
209 # * 1.1) fits comfortably in memory. On a host dedicated to running
210 # Keepstore, divide total memory by 88MiB to suggest a suitable value.
211 # For example, if grep MemTotal /proc/meminfo reports MemTotal: 7125440
212 # kB, compute 7125440 / (88 * 1024)=79 and set MaxKeepBlobBuffers: 79
213 MaxKeepBlobBuffers: 128
215 # API methods to disable. Disabled methods are not listed in the
216 # discovery document, and respond 404 to all requests.
217 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
220 # Interval (seconds) between asynchronous permission view updates. Any
221 # permission-updating API called with the 'async' parameter schedules a an
222 # update on the permission view in the future, if not already scheduled.
223 AsyncPermissionsUpdateInterval: 20s
225 # Maximum number of concurrent outgoing requests to make while
226 # serving a single incoming multi-cluster (federated) request.
227 MaxRequestAmplification: 4
229 # Maximum wall clock time to spend handling an incoming request.
232 # Websocket will send a periodic empty event after 'SendTimeout'
233 # if there is no other activity to maintain the connection /
234 # detect dropped connections.
237 WebsocketClientEventQueue: 64
238 WebsocketServerEventQueue: 4
240 # Timeout on requests to internal Keep services.
241 KeepServiceRequestTimeout: 15s
243 # Vocabulary file path, local to the node running the controller.
244 # This JSON file should contain the description of what's allowed
245 # as object's metadata. Its format is described at:
246 # https://doc.arvados.org/admin/metadata-vocabulary.html
250 # Config parameters to automatically setup new users. If enabled,
251 # this users will be able to self-activate. Enable this if you want
252 # to run an open instance where anyone can create an account and use
253 # the system without requiring manual approval.
255 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
256 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
257 AutoSetupNewUsers: false
258 AutoSetupNewUsersWithVmUUID: ""
259 AutoSetupNewUsersWithRepository: false
260 AutoSetupUsernameBlacklist:
269 # When NewUsersAreActive is set to true, new users will be active
270 # immediately. This skips the "self-activate" step which enforces
271 # user agreements. Should only be enabled for development.
272 NewUsersAreActive: false
274 # The e-mail address of the user you would like to become marked as an admin
275 # user on their first login.
276 AutoAdminUserWithEmail: ""
278 # If AutoAdminFirstUser is set to true, the first user to log in when no
279 # other admin users exist will automatically become an admin user.
280 AutoAdminFirstUser: false
282 # Email address to notify whenever a user creates a profile for the
284 UserProfileNotificationAddress: ""
285 AdminNotifierEmailFrom: arvados@example.com
286 EmailSubjectPrefix: "[ARVADOS] "
287 UserNotifierEmailFrom: arvados@example.com
288 UserNotifierEmailBcc: {}
289 NewUserNotificationRecipients: {}
290 NewInactiveUserNotificationRecipients: {}
292 # Set AnonymousUserToken to enable anonymous user access. Populate this
293 # field with a long random string. Then run "bundle exec
294 # ./script/get_anonymous_user_token.rb" in the directory where your API
295 # server is running to record the token in the database.
296 AnonymousUserToken: ""
298 # If a new user has an alternate email address (local@domain)
299 # with the domain given here, its local part becomes the new
300 # user's default username. Otherwise, the user's primary email
302 PreferDomainForUsername: ""
305 <% if not @user.full_name.empty? -%>
306 <%= @user.full_name %>,
311 Your Arvados account has been set up. You can log in at
313 <%= Rails.configuration.Services.Workbench1.ExternalURL %>
316 Your Arvados administrator.
319 # Time to keep audit logs, in seconds. (An audit log is a row added
320 # to the "logs" table in the PostgreSQL database each time an
321 # Arvados object is created, modified, or deleted.)
323 # Currently, websocket event notifications rely on audit logs, so
324 # this should not be set lower than 300 (5 minutes).
327 # Maximum number of log rows to delete in a single SQL transaction.
329 # If MaxDeleteBatch is 0, log entries will never be
330 # deleted by Arvados. Cleanup can be done by an external process
331 # without affecting any Arvados system processes, as long as very
332 # recent (<5 minutes old) logs are not deleted.
334 # 100000 is a reasonable batch size for most sites.
337 # Attributes to suppress in events and audit logs. Notably,
338 # specifying {"manifest_text": {}} here typically makes the database
339 # smaller and faster.
341 # Warning: Using any non-empty value here can have undesirable side
342 # effects for any client or component that relies on event logs.
343 # Use at your own risk.
344 UnloggedAttributes: {}
348 # Logging threshold: panic, fatal, error, warn, info, debug, or
352 # Logging format: json or text
355 # Maximum characters of (JSON-encoded) query parameters to include
356 # in each request log entry. When params exceed this size, they will
357 # be JSON-encoded, truncated to this size, and logged as
359 MaxRequestLogParamsSize: 2000
363 # Enable access controls for data stored in Keep. This should
364 # always be set to true on a production cluster.
367 # BlobSigningKey is a string of alphanumeric characters used to
368 # generate permission signatures for Keep locators. It must be
369 # identical to the permission key given to Keep. IMPORTANT: This
370 # is a site secret. It should be at least 50 characters.
372 # Modifying BlobSigningKey will invalidate all existing
373 # signatures, which can cause programs to fail (e.g., arv-put,
374 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
375 # when no such processes are running.
378 # Enable garbage collection of unreferenced blobs in Keep.
381 # Time to leave unreferenced blobs in "trashed" state before
382 # deleting them, or 0 to skip the "trashed" state entirely and
383 # delete unreferenced blobs.
385 # If you use any Amazon S3 buckets as storage volumes, this
386 # must be at least 24h to avoid occasional data loss.
387 BlobTrashLifetime: 336h
389 # How often to check for (and delete) trashed blocks whose
390 # BlobTrashLifetime has expired.
391 BlobTrashCheckInterval: 24h
393 # Maximum number of concurrent "trash blob" and "delete trashed
394 # blob" operations conducted by a single keepstore process. Each
395 # of these can be set to 0 to disable the respective operation.
397 # If BlobTrashLifetime is zero, "trash" and "delete trash"
398 # happen at once, so only the lower of these two values is used.
399 BlobTrashConcurrency: 4
400 BlobDeleteConcurrency: 4
402 # Maximum number of concurrent "create additional replica of
403 # existing blob" operations conducted by a single keepstore
405 BlobReplicateConcurrency: 4
407 # Default replication level for collections. This is used when a
408 # collection's replication_desired attribute is nil.
409 DefaultReplication: 2
411 # BlobSigningTTL determines the minimum lifetime of transient
412 # data, i.e., blocks that are not referenced by
413 # collections. Unreferenced blocks exist for two reasons:
415 # 1) A data block must be written to a disk/cloud backend device
416 # before a collection can be created/updated with a reference to
419 # 2) Deleting or updating a collection can remove the last
420 # remaining reference to a data block.
422 # If BlobSigningTTL is too short, long-running
423 # processes/containers will fail when they take too long (a)
424 # between writing blocks and writing collections that reference
425 # them, or (b) between reading collections and reading the
428 # If BlobSigningTTL is too long, data will still be stored long
429 # after the referring collections are deleted, and you will
430 # needlessly fill up disks or waste money on cloud storage.
432 # Modifying BlobSigningTTL invalidates existing signatures; see
433 # BlobSigningKey note above.
435 # The default is 2 weeks.
438 # When running keep-balance, this is the destination filename for
439 # the list of lost block hashes if there are any, one per line.
440 # Updated automically during each successful run.
441 BlobMissingReport: ""
443 # keep-balance operates periodically, i.e.: do a
444 # scan/balance operation, sleep, repeat.
446 # BalancePeriod determines the interval between start times of
447 # successive scan/balance operations. If a scan/balance operation
448 # takes longer than BalancePeriod, the next one will follow it
451 # If SIGUSR1 is received during an idle period between operations,
452 # the next operation will start immediately.
455 # Limits the number of collections retrieved by keep-balance per
456 # API transaction. If this is zero, page size is
457 # determined by the API server's own page size limits (see
458 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
459 BalanceCollectionBatch: 0
461 # The size of keep-balance's internal queue of
462 # collections. Higher values use more memory and improve throughput
463 # by allowing keep-balance to fetch the next page of collections
464 # while the current page is still being processed. If this is zero
465 # or omitted, pages are processed serially.
466 BalanceCollectionBuffers: 1000
468 # Maximum time for a rebalancing run. This ensures keep-balance
469 # eventually gives up and retries if, for example, a network
470 # error causes a hung connection that is never closed by the
471 # OS. It should be long enough that it doesn't interrupt a
472 # long-running balancing operation.
475 # Maximum number of replication_confirmed /
476 # storage_classes_confirmed updates to write to the database
477 # after a rebalancing run. When many updates are needed, this
478 # spreads them over a few runs rather than applying them all at
480 BalanceUpdateLimit: 100000
482 # Default lifetime for ephemeral collections: 2 weeks. This must not
483 # be less than BlobSigningTTL.
484 DefaultTrashLifetime: 336h
486 # Interval (seconds) between trash sweeps. During a trash sweep,
487 # collections are marked as trash if their trash_at time has
488 # arrived, and deleted if their delete_at time has arrived.
489 TrashSweepInterval: 60s
491 # If true, enable collection versioning.
492 # When a collection's preserve_version field is true or the current version
493 # is older than the amount of seconds defined on PreserveVersionIfIdle,
494 # a snapshot of the collection's previous state is created and linked to
495 # the current collection.
496 CollectionVersioning: false
498 # 0s = auto-create a new version on every update.
499 # -1s = never auto-create new versions.
500 # > 0s = auto-create a new version when older than the specified number of seconds.
501 PreserveVersionIfIdle: -1s
503 # If non-empty, allow project and collection names to contain
504 # the "/" character (slash/stroke/solidus), and replace "/" with
505 # the given string in the filesystem hierarchy presented by
506 # WebDAV. Example values are "%2f" and "{slash}". Names that
507 # contain the substitution string itself may result in confusing
508 # behavior, so a value like "_" is not recommended.
510 # If the default empty value is used, the server will reject
511 # requests to create or rename a collection when the new name
514 # If the value "/" is used, project and collection names
515 # containing "/" will be allowed, but they will not be
516 # accessible via WebDAV.
518 # Use of this feature is not recommended, if it can be avoided.
519 ForwardSlashNameSubstitution: ""
521 # Include "folder objects" in S3 ListObjects responses.
522 S3FolderObjects: true
524 # Managed collection properties. At creation time, if the client didn't
525 # provide the listed keys, they will be automatically populated following
526 # one of the following behaviors:
528 # * UUID of the user who owns the containing project.
529 # responsible_person_uuid: {Function: original_owner, Protected: true}
531 # * Default concrete value.
532 # foo_bar: {Value: baz, Protected: false}
534 # If Protected is true, only an admin user can modify its value.
536 SAMPLE: {Function: original_owner, Protected: true}
538 # In "trust all content" mode, Workbench will redirect download
539 # requests to WebDAV preview link, even in the cases when
540 # WebDAV would have to expose XSS vulnerabilities in order to
541 # handle the redirect (see discussion on Services.WebDAV).
543 # This setting has no effect in the recommended configuration, where the
544 # WebDAV service is configured to have a separate domain for every
545 # collection and XSS protection is provided by browsers' same-origin
548 # The default setting (false) is appropriate for a multi-user site.
549 TrustAllContent: false
551 # Cache parameters for WebDAV content serving:
553 # Time to cache manifests, permission checks, and sessions.
556 # Time to cache collection state.
559 # Block cache entries. Each block consumes up to 64 MiB RAM.
562 # Collection cache entries.
563 MaxCollectionEntries: 1000
565 # Approximate memory limit (in bytes) for collection cache.
566 MaxCollectionBytes: 100000000
568 # UUID cache entries.
571 # Persistent sessions.
574 # Selectively set permissions for regular users and admins to
575 # download or upload data files using the upload/download
576 # features for Workbench, WebDAV and S3 API support.
585 # Selectively set permissions for regular users and admins to be
586 # able to download or upload blocks using arv-put and
587 # arv-get from outside the cluster.
596 # Post upload / download events to the API server logs table, so
597 # that they can be included in the arv-user-activity report.
598 # You can disable this if you find that it is creating excess
599 # load on the API server and you don't need it.
600 WebDAVLogEvents: true
603 # One of the following mechanisms (Google, PAM, LDAP, or
604 # LoginCluster) should be enabled; see
605 # https://doc.arvados.org/install/setup-login.html
608 # Authenticate with Google.
611 # Use the Google Cloud console to enable the People API (APIs
612 # and Services > Enable APIs and services > Google People API
613 # > Enable), generate a Client ID and secret (APIs and
614 # Services > Credentials > Create credentials > OAuth client
615 # ID > Web application) and add your controller's /login URL
616 # (e.g., "https://zzzzz.example.com/login") as an authorized
621 # Allow users to log in to existing accounts using any verified
622 # email address listed by their Google account. If true, the
623 # Google People API must be enabled in order for Google login to
624 # work. If false, only the primary email address will be used.
625 AlternateEmailAddresses: true
627 # Send additional parameters with authentication requests. See
628 # https://developers.google.com/identity/protocols/oauth2/openid-connect#authenticationuriparameters
629 # for a list of supported parameters.
630 AuthenticationRequestParameters:
631 # Show the "choose which Google account" page, even if the
632 # client is currently logged in to exactly one Google
634 prompt: select_account
639 # Authenticate with an OpenID Connect provider.
642 # Issuer URL, e.g., "https://login.example.com".
644 # This must be exactly equal to the URL returned by the issuer
645 # itself in its config response ("isser" key). If the
646 # configured value is "https://example" and the provider
647 # returns "https://example:443" or "https://example/" then
648 # login will fail, even though those URLs are equivalent
652 # Your client ID and client secret (supplied by the provider).
656 # OpenID claim field containing the user's email
657 # address. Normally "email"; see
658 # https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
661 # OpenID claim field containing the email verification
662 # flag. Normally "email_verified". To accept every returned
663 # email address without checking a "verified" field at all,
664 # use the empty string "".
665 EmailVerifiedClaim: "email_verified"
667 # OpenID claim field containing the user's preferred
668 # username. If empty, use the mailbox part of the user's email
672 # Send additional parameters with authentication requests,
673 # like {display: page, prompt: consent}. See
674 # https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
675 # and refer to your provider's documentation for supported
677 AuthenticationRequestParameters:
680 # Accept an OIDC access token as an API token if the OIDC
681 # provider's UserInfo endpoint accepts it.
683 # AcceptAccessTokenScope should also be used when enabling
685 AcceptAccessToken: false
687 # Before accepting an OIDC access token as an API token, first
688 # check that it is a JWT whose "scope" value includes this
689 # value. Example: "https://zzzzz.example.com/" (your Arvados
692 # If this value is empty and AcceptAccessToken is true, all
693 # access tokens will be accepted regardless of scope,
694 # including non-JWT tokens. This is not recommended.
695 AcceptAccessTokenScope: ""
698 # Use PAM to authenticate users.
701 # PAM service name. PAM will apply the policy in the
702 # corresponding config file (e.g., /etc/pam.d/arvados) or, if
703 # there is none, the default "other" config.
706 # Domain name (e.g., "example.com") to use to construct the
707 # user's email address if PAM authentication returns a
708 # username with no "@". If empty, use the PAM username as the
709 # user's email address, whether or not it contains "@".
711 # Note that the email address is used as the primary key for
712 # user records when logging in. Therefore, if you change
713 # PAMDefaultEmailDomain after the initial installation, you
714 # should also update existing user records to reflect the new
715 # domain. Otherwise, next time those users log in, they will
716 # be given new accounts instead of accessing their existing
718 DefaultEmailDomain: ""
721 # Use an LDAP service to authenticate users.
724 # Server URL, like "ldap://ldapserver.example.com:389" or
725 # "ldaps://ldapserver.example.com:636".
726 URL: "ldap://ldap:389"
728 # Use StartTLS upon connecting to the server.
731 # Skip TLS certificate name verification.
734 # Strip the @domain part if a user supplies an email-style
735 # username with this domain. If "*", strip any user-provided
736 # domain. If "", never strip the domain part. Example:
740 # If, after applying StripDomain, the username contains no "@"
741 # character, append this domain to form an email-style
742 # username. Example: "example.com"
745 # The LDAP attribute to filter on when looking up a username
746 # (after applying StripDomain and AppendDomain).
749 # Bind with this username (DN or UPN) and password when
750 # looking up the user record.
752 # Example user: "cn=admin,dc=example,dc=com"
754 SearchBindPassword: ""
756 # Directory base for username lookup. Example:
757 # "ou=Users,dc=example,dc=com"
760 # Additional filters to apply when looking up users' LDAP
761 # entries. This can be used to restrict access to a subset of
762 # LDAP users, or to disambiguate users from other directory
763 # entries that have the SearchAttribute present.
765 # Special characters in assertion values must be escaped (see
768 # Example: "(objectClass=person)"
771 # LDAP attribute to use as the user's email address.
773 # Important: This must not be an attribute whose value can be
774 # edited in the directory by the users themselves. Otherwise,
775 # users can take over other users' Arvados accounts trivially
776 # (email address is the primary key for Arvados accounts.)
779 # LDAP attribute to use as the preferred Arvados username. If
780 # no value is found (or this config is empty) the username
781 # originally supplied by the user will be used.
782 UsernameAttribute: uid
785 # Authenticate users listed here in the config file. This
786 # feature is intended to be used in test environments, and
787 # should not be used in production.
791 Email: alice@example.com
794 # The cluster ID to delegate the user database. When set,
795 # logins on this cluster will be redirected to the login cluster
796 # (login cluster must appear in RemoteClusters with Proxy: true)
799 # How long a cached token belonging to a remote cluster will
800 # remain valid before it needs to be revalidated.
801 RemoteTokenRefresh: 5m
803 # How long a client token created from a login flow will be valid without
804 # asking the user to re-login. Example values: 60m, 8h.
805 # Default value zero means tokens don't have expiration.
808 # If true (default) tokens issued through login are allowed to create
810 # If false, tokens issued through login are not allowed to
811 # viewing/creating other tokens. New tokens can only be created
812 # by going through login again.
813 IssueTrustedTokens: true
815 # When the token is returned to a client, the token itself may
816 # be restricted from viewing/creating other tokens based on whether
817 # the client is "trusted" or not. The local Workbench1 and
818 # Workbench2 are trusted by default, but if this is a
819 # LoginCluster, you probably want to include the other Workbench
820 # instances in the federation in this list.
823 "https://workbench.federate1.example": {}
824 "https://workbench.federate2.example": {}
827 # Path to git or gitolite-shell executable. Each authenticated
828 # request will execute this program with the single argument "http-backend"
829 GitCommand: /usr/bin/git
831 # Path to Gitolite's home directory. If a non-empty path is given,
832 # the CGI environment will be set up to support the use of
833 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
834 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
835 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
838 # Git repositories must be readable by api server, or you won't be
839 # able to submit crunch jobs. To pass the test suites, put a clone
840 # of the arvados tree in {git_repositories_dir}/arvados.git or
841 # {git_repositories_dir}/arvados/.git
842 Repositories: /var/lib/arvados/git/repositories
850 # List of supported Docker Registry image formats that compute nodes
851 # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
852 # to store an image with an unsupported format. Use an empty array
853 # to skip the compatibility check (and display a warning message to
856 # Example for sites running docker < 1.10: {"v1": {}}
857 # Example for sites running docker >= 1.10: {"v2": {}}
858 # Example for disabling check: {}
859 SupportedDockerImageFormats:
863 # Include details about job reuse decisions in the server log. This
864 # causes additional database queries to run, so it should not be
865 # enabled unless you expect to examine the resulting logs for
866 # troubleshooting purposes.
867 LogReuseDecisions: false
869 # Default value for keep_cache_ram of a container's runtime_constraints.
870 DefaultKeepCacheRAM: 268435456
872 # Number of times a container can be unlocked before being
873 # automatically cancelled.
874 MaxDispatchAttempts: 5
876 # Default value for container_count_max for container requests. This is the
877 # number of times Arvados will create a new container to satisfy a container
878 # request. If a container is cancelled it will retry a new container if
879 # container_count < container_count_max on any container requests associated
880 # with the cancelled container.
883 # The maximum number of compute nodes that can be in use simultaneously
884 # If this limit is reduced, any existing nodes with slot number >= new limit
885 # will not be counted against the new limit. In other words, the new limit
886 # won't be strictly enforced until those nodes with higher slot numbers
890 # Preemptible instance support (e.g. AWS Spot Instances)
891 # When true, child containers will get created with the preemptible
892 # scheduling parameter parameter set.
893 UsePreemptibleInstances: false
895 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
896 # cloud dispatcher for executing containers on worker VMs.
897 # Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
898 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
899 DispatchPrivateKey: ""
901 # Maximum time to wait for workers to come up before abandoning
902 # stale locks from a previous dispatch process.
905 # The crunch-run command used to start a container on a worker node.
907 # When dispatching to cloud VMs, this is used only if
908 # DeployRunnerBinary in the CloudVMs section is set to the empty
910 CrunchRunCommand: "crunch-run"
912 # Extra arguments to add to crunch-run invocation
913 # Example: ["--cgroup-parent-subsystem=memory"]
914 CrunchRunArgumentsList: []
916 # Extra RAM to reserve on the node, in addition to
917 # the amount specified in the container's RuntimeConstraints
918 ReserveExtraRAM: 256MiB
920 # Minimum time between two attempts to run the same container
923 # Container runtime: "docker" (default) or "singularity"
924 RuntimeEngine: docker
926 # When running a container, run a dedicated keepstore process,
927 # using the specified number of 64 MiB memory buffers per
928 # allocated CPU core (VCPUs in the container's runtime
929 # constraints). The dedicated keepstore handles I/O for
930 # collections mounted in the container, as well as saving
933 # A zero value disables this feature.
935 # In order for this feature to be activated, no volume may use
936 # AccessViaHosts, and each volume must have Replication higher
937 # than Collections.DefaultReplication. If these requirements are
938 # not satisfied, the feature is disabled automatically
939 # regardless of the value given here.
941 # Note that when this configuration is enabled, the entire
942 # cluster configuration file, including the system root token,
943 # is copied to the worker node and held in memory for the
944 # duration of the container.
945 LocalKeepBlobBuffersPerVCPU: 1
947 # When running a dedicated keepstore process for a container
948 # (see LocalKeepBlobBuffersPerVCPU), write keepstore log
949 # messages to keepstore.txt in the container's log collection.
951 # These log messages can reveal some volume configuration
952 # details, error messages from the cloud storage provider, etc.,
953 # which are not otherwise visible to users.
956 # * "none" -- no keepstore.txt file
957 # * "all" -- all logs, including request and response lines
958 # * "errors" -- all logs except "response" logs with 2xx
959 # response codes and "request" logs
960 LocalKeepLogsToContainerLog: none
963 # When you run the db:delete_old_container_logs task, it will find
964 # containers that have been finished for at least this many seconds,
965 # and delete their stdout, stderr, arv-mount, crunch-run, and
966 # crunchstat logs from the logs table.
969 # These two settings control how frequently log events are flushed to the
970 # database. Log lines are buffered until either crunch_log_bytes_per_event
971 # has been reached or crunch_log_seconds_between_events has elapsed since
973 LogBytesPerEvent: 4096
974 LogSecondsBetweenEvents: 5s
976 # The sample period for throttling logs.
977 LogThrottlePeriod: 60s
979 # Maximum number of bytes that job can log over crunch_log_throttle_period
980 # before being silenced until the end of the period.
981 LogThrottleBytes: 65536
983 # Maximum number of lines that job can log over crunch_log_throttle_period
984 # before being silenced until the end of the period.
985 LogThrottleLines: 1024
987 # Maximum bytes that may be logged by a single job. Log bytes that are
988 # silenced by throttling are not counted against this total.
989 LimitLogBytesPerJob: 67108864
991 LogPartialLineThrottlePeriod: 5s
993 # Container logs are written to Keep and saved in a
994 # collection, which is updated periodically while the
995 # container runs. This value sets the interval between
996 # collection updates.
999 # The log collection is also updated when the specified amount of
1000 # log data (given in bytes) is produced in less than one update
1002 LogUpdateSize: 32MiB
1005 # An admin user can use "arvados-client shell" to start an
1006 # interactive shell (with any user ID) in any running
1010 # Any user can use "arvados-client shell" to start an
1011 # interactive shell (with any user ID) in any running
1012 # container that they started, provided it isn't also
1013 # associated with a different user's container request.
1015 # Interactive sessions make it easy to alter the container's
1016 # runtime environment in ways that aren't recorded or
1017 # reproducible. Consider the implications for automatic
1018 # container reuse before enabling and using this feature. In
1019 # particular, note that starting an interactive session does
1020 # not disqualify a container from being reused by a different
1021 # user/workflow in the future.
1026 SbatchArgumentsList: []
1027 SbatchEnvironmentVariables:
1030 # Path to dns server configuration directory
1031 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
1032 # files or touch restart.txt (see below).
1033 DNSServerConfDir: ""
1035 # Template file for the dns server host snippets. See
1036 # unbound.template in this directory for an example. If false, do
1037 # not write any config files.
1038 DNSServerConfTemplate: ""
1040 # String to write to {dns_server_conf_dir}/restart.txt (with a
1041 # trailing newline) after updating local data. If false, do not
1042 # open or write the restart.txt file.
1043 DNSServerReloadCommand: ""
1045 # Command to run after each DNS update. Template variables will be
1046 # substituted; see the "unbound" example below. If false, do not run
1048 DNSServerUpdateCommand: ""
1050 ComputeNodeDomain: ""
1051 ComputeNodeNameservers:
1055 # Hostname to assign to a compute node when it sends a "ping" and the
1056 # hostname in its Node record is nil.
1057 # During bootstrapping, the "ping" script is expected to notice the
1058 # hostname given in the ping response, and update its unix hostname
1060 # If false, leave the hostname alone (this is appropriate if your compute
1061 # nodes' hostnames are already assigned by some other mechanism).
1063 # One way or another, the hostnames of your node records should agree
1064 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
1066 # Example for compute0000, compute0001, ....:
1067 # assign_node_hostname: compute%<slot_number>04d
1068 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
1069 AssignNodeHostname: "compute%<slot_number>d"
1072 # Arguments to bsub when submitting Arvados containers as LSF jobs.
1074 # Template variables starting with % will be substituted as follows:
1077 # %C number of VCPUs
1081 # Use %% to express a literal %. The %%J in the default will be changed
1082 # to %J, which is interpreted by bsub itself.
1084 # Note that the default arguments cause LSF to write two files
1085 # in /tmp on the compute node each time an Arvados container
1086 # runs. Ensure you have something in place to delete old files
1087 # from /tmp, or adjust the "-o" and "-e" arguments accordingly.
1088 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]"]
1090 # Use sudo to switch to this user account when submitting LSF
1093 # This account must exist on the hosts where LSF jobs run
1094 # ("execution hosts"), as well as on the host where the
1095 # Arvados LSF dispatcher runs ("submission host").
1096 BsubSudoUser: "crunch"
1099 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
1101 # Note: this only enables read-only access, creating new
1102 # legacy jobs and pipelines is not supported.
1104 # 'auto' -- (default) enable the Jobs API only if it has been used before
1105 # (i.e., there are job records in the database)
1106 # 'true' -- enable the Jobs API despite lack of existing records.
1107 # 'false' -- disable the Jobs API despite presence of existing records.
1110 # Git repositories must be readable by api server, or you won't be
1111 # able to submit crunch jobs. To pass the test suites, put a clone
1112 # of the arvados tree in {git_repositories_dir}/arvados.git or
1113 # {git_repositories_dir}/arvados/.git
1114 GitInternalDir: /var/lib/arvados/internal.git
1117 # Enable the cloud scheduler.
1120 # Name/number of port where workers' SSH services listen.
1123 # Interval between queue polls.
1126 # Shell command to execute on each worker to determine whether
1127 # the worker is booted and ready to run containers. It should
1128 # exit zero if the worker is ready.
1129 BootProbeCommand: "systemctl is-system-running"
1131 # Minimum interval between consecutive probes to a single
1135 # Maximum probes per second, across all workers in a pool.
1136 MaxProbesPerSecond: 10
1138 # Time before repeating SIGTERM when killing a container.
1141 # Time to give up on a process (most likely arv-mount) that
1142 # still holds a container lockfile after its main supervisor
1143 # process has exited, and declare the instance broken.
1144 TimeoutStaleRunLock: 5s
1146 # Time to give up on SIGTERM and write off the worker.
1149 # Maximum create/destroy-instance operations per second (0 =
1151 MaxCloudOpsPerSecond: 10
1153 # Maximum concurrent instance creation operations (0 = unlimited).
1155 # MaxConcurrentInstanceCreateOps limits the number of instance creation
1156 # requests that can be in flight at any one time, whereas
1157 # MaxCloudOpsPerSecond limits the number of create/destroy operations
1158 # that can be started per second.
1160 # Because the API for instance creation on Azure is synchronous, it is
1161 # recommended to increase MaxConcurrentInstanceCreateOps when running
1162 # on Azure. When using managed images, a value of 20 would be
1163 # appropriate. When using Azure Shared Image Galeries, it could be set
1164 # higher. For more information, see
1165 # https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image
1167 # MaxConcurrentInstanceCreateOps can be increased for other cloud
1168 # providers too, if desired.
1169 MaxConcurrentInstanceCreateOps: 1
1171 # Interval between cloud provider syncs/updates ("list all
1175 # Time to leave an idle worker running (in case new containers
1176 # appear in the queue that it can run) before shutting it
1180 # Time to wait for a new worker to boot (i.e., pass
1181 # BootProbeCommand) before giving up and shutting it down.
1184 # Maximum time a worker can stay alive with no successful
1185 # probes before being automatically shut down.
1188 # Time after shutting down a worker to retry the
1189 # shutdown/destroy operation.
1190 TimeoutShutdown: 10s
1192 # Worker VM image ID.
1193 # (aws) AMI identifier
1194 # (azure) managed disks: the name of the managed disk image
1195 # (azure) shared image gallery: the name of the image definition. Also
1196 # see the SharedImageGalleryName and SharedImageGalleryImageVersion fields.
1197 # (azure) unmanaged disks (deprecated): the complete URI of the VHD, e.g.
1198 # https://xxxxx.blob.core.windows.net/system/Microsoft.Compute/Images/images/xxxxx.vhd
1201 # An executable file (located on the dispatcher host) to be
1202 # copied to cloud instances at runtime and used as the
1203 # container runner/supervisor. The default value is the
1204 # dispatcher program itself.
1206 # Use the empty string to disable this step: nothing will be
1207 # copied, and cloud instances are assumed to have a suitable
1208 # version of crunch-run installed; see CrunchRunCommand above.
1209 DeployRunnerBinary: "/proc/self/exe"
1211 # Tags to add on all resources (VMs, NICs, disks) created by
1212 # the container dispatcher. (Arvados's own tags --
1213 # InstanceType, IdleBehavior, and InstanceSecret -- will also
1218 # Prefix for predefined tags used by Arvados (InstanceSetID,
1219 # InstanceType, InstanceSecret, IdleBehavior). With the
1220 # default value "Arvados", tags are "ArvadosInstanceSetID",
1221 # "ArvadosInstanceSecret", etc.
1223 # This should only be changed while no cloud resources are in
1224 # use and the cloud dispatcher is not running. Otherwise,
1225 # VMs/resources that were added using the old tag prefix will
1226 # need to be detected and cleaned up manually.
1227 TagKeyPrefix: Arvados
1229 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
1232 # Cloud-specific driver parameters.
1235 # (ec2) Credentials. Omit or leave blank if using IAM role.
1239 # (ec2) Instance configuration.
1245 AdminUsername: debian
1247 # (azure) Credentials.
1253 # (azure) Instance configuration.
1254 CloudEnvironment: AzurePublicCloud
1257 # (azure) The resource group where the VM and virtual NIC will be
1261 # (azure) The resource group of the Network to use for the virtual
1262 # NIC (if different from ResourceGroup)
1263 NetworkResourceGroup: ""
1267 # (azure) managed disks: The resource group where the managed disk
1268 # image can be found (if different from ResourceGroup).
1269 ImageResourceGroup: ""
1271 # (azure) shared image gallery: the name of the gallery
1272 SharedImageGalleryName: ""
1273 # (azure) shared image gallery: the version of the image definition
1274 SharedImageGalleryImageVersion: ""
1276 # (azure) unmanaged disks (deprecated): Where to store the VM VHD blobs
1280 # (azure) How long to wait before deleting VHD and NIC
1281 # objects that are no longer being used.
1282 DeleteDanglingResourcesAfter: 20s
1284 # Account (that already exists in the VM image) that will be
1285 # set up with an ssh authorized key to allow the compute
1286 # dispatcher to connect.
1287 AdminUsername: arvados
1291 # Use the instance type name as the key (in place of "SAMPLE" in
1292 # this sample entry).
1294 # Cloud provider's instance type. Defaults to the configured type name.
1298 IncludedScratch: 16GB
1305 # If you use multiple storage classes, specify them here, using
1306 # the storage class name as the key (in place of "SAMPLE" in
1307 # this sample entry).
1309 # Further info/examples:
1310 # https://doc.arvados.org/admin/storage-classes.html
1313 # Priority determines the order volumes should be searched
1314 # when reading data, in cases where a keepstore server has
1315 # access to multiple volumes with different storage classes.
1318 # Default determines which storage class(es) should be used
1319 # when a user/client writes data or saves a new collection
1320 # without specifying storage classes.
1322 # If any StorageClasses are configured, at least one of them
1323 # must have Default: true.
1328 # AccessViaHosts specifies which keepstore processes can read
1329 # and write data on the volume.
1331 # For a local filesystem, AccessViaHosts has one entry,
1332 # indicating which server the filesystem is located on.
1334 # For a network-attached backend accessible by all keepstore
1335 # servers, like a cloud storage bucket or an NFS mount,
1336 # AccessViaHosts can be empty/omitted.
1338 # Further info/examples:
1339 # https://doc.arvados.org/install/configure-fs-storage.html
1340 # https://doc.arvados.org/install/configure-s3-object-storage.html
1341 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1345 "http://host1.example:25107": {}
1349 # If you have configured storage classes (see StorageClasses
1350 # section above), add an entry here for each storage class
1351 # satisfied by this volume.
1355 # for s3 driver -- see
1356 # https://doc.arvados.org/install/configure-s3-object-storage.html
1359 SecretAccessKey: aaaaa
1363 LocationConstraint: false
1370 # Use aws-s3-go (v2) instead of goamz
1371 UseAWSS3v2Driver: false
1373 # For S3 driver, potentially unsafe tuning parameter,
1374 # intentionally excluded from main documentation.
1376 # Enable deletion (garbage collection) even when the
1377 # configured BlobTrashLifetime is zero. WARNING: eventual
1378 # consistency may result in race conditions that can cause
1379 # data loss. Do not enable this unless you understand and
1383 # for azure driver -- see
1384 # https://doc.arvados.org/install/configure-azure-blob-storage.html
1385 StorageAccountName: aaaaa
1386 StorageAccountKey: aaaaa
1387 StorageBaseURL: core.windows.net
1388 ContainerName: aaaaa
1390 ListBlobsRetryDelay: 10s
1391 ListBlobsMaxAttempts: 10
1393 WriteRaceInterval: 15s
1394 WriteRacePollTime: 1s
1396 # for local directory driver -- see
1397 # https://doc.arvados.org/install/configure-fs-storage.html
1398 Root: /var/lib/arvados/keep-data
1400 # For local directory driver, potentially confusing tuning
1401 # parameter, intentionally excluded from main documentation.
1403 # When true, read and write operations (for whole 64MiB
1404 # blocks) on an individual volume will queued and issued
1405 # serially. When false, read and write operations will be
1406 # issued concurrently.
1408 # May possibly improve throughput if you have physical spinning disks
1409 # and experience contention when there are multiple requests
1410 # to the same volume.
1412 # Otherwise, when using SSDs, RAID, or a shared network filesystem, you
1413 # should leave this alone.
1419 SendUserSetupNotificationEmail: true
1421 # Bug/issue report notification to and from addresses
1422 IssueReporterEmailFrom: "arvados@example.com"
1423 IssueReporterEmailTo: "arvados@example.com"
1424 SupportEmailAddress: "arvados@example.com"
1426 # Generic issue email from
1427 EmailFrom: "arvados@example.com"
1434 ActivateUsers: false
1436 # API endpoint host or host:port; default is {id}.arvadosapi.com
1437 Host: sample.arvadosapi.com
1439 # Perform a proxy request when a local client requests an
1440 # object belonging to this remote.
1443 # Default "https". Can be set to "http" for testing.
1446 # Disable TLS verify. Can be set to true for testing.
1449 # When users present tokens issued by this remote cluster, and
1450 # their accounts are active on the remote cluster, activate
1451 # them on this cluster too.
1452 ActivateUsers: false
1455 # Workbench1 configs
1457 ActivationContactLink: mailto:info@arvados.org
1458 ArvadosDocsite: https://doc.arvados.org
1459 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
1460 ShowUserAgreementInline: false
1463 # Scratch directory used by the remote repository browsing
1464 # feature. If it doesn't exist, it (and any missing parents) will be
1465 # created using mkdir_p.
1466 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
1468 # Below is a sample setting of user_profile_form_fields config parameter.
1469 # This configuration parameter should be set to either false (to disable) or
1470 # to a map as shown below.
1471 # Configure the map of input fields to be displayed in the profile page
1472 # using the attribute "key" for each of the input fields.
1473 # This sample shows configuration with one required and one optional form fields.
1474 # For each of these input fields:
1475 # You can specify "Type" as "text" or "select".
1476 # List the "Options" to be displayed for each of the "select" menu.
1477 # Set "Required" as "true" for any of these fields to make them required.
1478 # If any of the required fields are missing in the user's profile, the user will be
1479 # redirected to the profile page before they can access any Workbench features.
1480 UserProfileFormFields:
1483 FormFieldTitle: Best color
1484 FormFieldDescription: your favorite color
1493 # exampleTextValue: # key that will be set in properties
1495 # FormFieldTitle: ""
1496 # FormFieldDescription: ""
1499 # exampleOptionsValue:
1501 # FormFieldTitle: ""
1502 # FormFieldDescription: ""
1510 # Use "UserProfileFormMessage to configure the message you want
1511 # to display on the profile page.
1512 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1514 # Mimetypes of applications for which the view icon
1515 # would be enabled in a collection's show page.
1516 # It is sufficient to list only applications here.
1517 # No need to list text and image types.
1518 ApplicationMimetypesWithViewIcon:
1536 # The maximum number of bytes to load in the log viewer
1537 LogViewerMaxBytes: 1M
1539 # When anonymous_user_token is configured, show public projects page
1540 EnablePublicProjectsPage: true
1542 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1543 EnableGettingStartedPopup: false
1545 # Ask Arvados API server to compress its response payloads.
1546 APIResponseCompression: true
1548 # Timeouts for API requests.
1549 APIClientConnectTimeout: 2m
1550 APIClientReceiveTimeout: 5m
1552 # Maximum number of historic log records of a running job to fetch
1553 # and display in the Log tab, while subscribing to web sockets.
1554 RunningJobLogRecordsToFetch: 2000
1556 # In systems with many shared projects, loading of dashboard and topnav
1557 # can be slow due to collections indexing; use the following parameters
1558 # to suppress these properties
1559 ShowRecentCollectionsOnDashboard: true
1560 ShowUserNotifications: true
1562 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1563 # a link to the multi-site search page on a "home" Workbench site.
1566 # https://workbench.zzzzz.arvadosapi.com/collections/multisite
1569 # Should workbench allow management of local git repositories? Set to false if
1570 # the jobs api is disabled and there are no local git repositories.
1573 SiteName: Arvados Workbench
1574 ProfilingEnabled: false
1576 # This is related to obsolete Google OpenID 1.0 login
1577 # but some workbench stuff still expects it to be set.
1578 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1580 # Workbench2 configs
1581 FileViewersConfigURL: ""
1583 # Idle time after which the user's session will be auto closed.
1584 # This feature is disabled when set to zero.
1587 # Workbench welcome screen, this is HTML text that will be
1588 # incorporated directly onto the page.
1590 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1591 <h2>Please log in.</h2>
1593 <p>If you have never used Arvados Workbench before, logging in
1594 for the first time will automatically create a new
1597 <i>Arvados Workbench uses your information only for
1598 identification, and does not retrieve any other personal
1601 # Workbench screen displayed to inactive users. This is HTML
1602 # text that will be incorporated directly onto the page.
1604 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1605 <h3>Hi! You're logged in, but...</h3>
1606 <p>Your account is inactive.</p>
1607 <p>An administrator must activate your account before you can get
1610 # Connecting to Arvados shell VMs tends to be site-specific.
1611 # Put any special instructions here. This is HTML text that will
1612 # be incorporated directly onto the Workbench page.
1614 <a href="https://doc.arvados.org/user/getting_started/ssh-access-unix.html">Accessing an Arvados VM with SSH</a> (generic instructions).
1615 Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node.
1617 # Sample text if you are using a "switchyard" ssh proxy.
1618 # Replace "zzzzz" with your Cluster ID.
1620 # <p>Add a section like this to your SSH configuration file ( <i>~/.ssh/config</i>):</p>
1623 # ServerAliveInterval 60
1624 # ProxyCommand ssh -p2222 turnout@switchyard.zzzzz.arvadosapi.com -x -a $SSH_PROXY_FLAGS %h
1627 # If you are using a switchyard ssh proxy, shell node hostnames
1628 # may require a special hostname suffix. In the sample ssh
1629 # configuration above, this would be ".zzzzz"
1630 # This is added to the hostname in the "command line" column
1631 # the Workbench "shell VMs" page.
1633 # If your shell nodes are directly accessible by users without a
1634 # proxy and have fully qualified host names, you should leave
1636 SSHHelpHostSuffix: ""
1638 # (Experimental) Restart services automatically when config file
1639 # changes are detected. Only supported by ` + "`" + `arvados-server boot` + "`" + ` in
1641 AutoReloadConfig: false