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
23 # Token to be included in all healthcheck requests. Disabled by default.
24 # Server expects request header of the format "Authorization: Bearer xxx"
29 # In each of the service sections below, the keys under
30 # InternalURLs are the endpoints where the service should be
31 # listening, and reachable from other hosts in the cluster.
34 "http://host1.example:12345": {}
35 "http://host2.example:12345":
36 # Rendezvous is normally empty/omitted. When changing the
37 # URL of a Keepstore service, Rendezvous should be set to
38 # the old URL (with trailing slash omitted) to preserve
39 # rendezvous ordering.
74 # Base URL for Workbench inline preview. If blank, use
75 # WebDAVDownload instead, and disable inline preview.
76 # If both are empty, downloading collections from workbench
79 # It is important to properly configure the download service
80 # to migitate cross-site-scripting (XSS) attacks. A HTML page
81 # can be stored in collection. If an attacker causes a victim
82 # to visit that page through Workbench, it will be rendered by
83 # the browser. If all collections are served at the same
84 # domain, the browser will consider collections as coming from
85 # the same origin and having access to the same browsing data,
86 # enabling malicious Javascript on that page to access Arvados
87 # on behalf of the victim.
89 # This is mitigating by having separate domains for each
90 # collection, or limiting preview to circumstances where the
91 # collection is not accessed with the user's regular
94 # Serve preview links using uuid or pdh in subdomain
95 # (requires wildcard DNS and TLS certificate)
96 # https://*.collections.uuid_prefix.arvadosapi.com
98 # Serve preview links using uuid or pdh in main domain
99 # (requires wildcard DNS and TLS certificate)
100 # https://*--collections.uuid_prefix.arvadosapi.com
102 # Serve preview links by setting uuid or pdh in the path.
103 # This configuration only allows previews of public data or
104 # collection-sharing links, because these use the anonymous
105 # user token or the token is already embedded in the URL.
106 # Other data must be handled as downloads via WebDAVDownload:
107 # https://collections.uuid_prefix.arvadosapi.com
113 # Base URL for download links. If blank, serve links to WebDAV
114 # with disposition=attachment query param. Unlike preview links,
115 # browsers do not render attachments, so there is no risk of XSS.
117 # If WebDAVDownload is blank, and WebDAV uses a
118 # single-origin form, then Workbench will show an error page
120 # Serve download links by setting uuid or pdh in the path:
121 # https://download.uuid_prefix.arvadosapi.com
133 # ShellInABox service endpoint URL for a given VM. If empty, do not
134 # offer web shell logins.
136 # E.g., using a path-based proxy server to forward connections to shell hosts:
137 # https://webshell.uuid_prefix.arvadosapi.com
139 # E.g., using a name-based proxy server to forward connections to shell hosts:
140 # https://*.webshell.uuid_prefix.arvadosapi.com
156 # max concurrent connections per arvados server daemon
159 # All parameters here are passed to the PG client library in a connection string;
160 # see https://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-PARAMKEYWORDS
168 # Maximum size (in bytes) allowed for a single API request. This
169 # limit is published in the discovery document for use by clients.
170 # Note: You must separately configure the upstream web server or
171 # proxy to actually enforce the desired maximum request size on the
173 MaxRequestSize: 134217728
175 # Limit the number of bytes read from the database during an index
176 # request (by retrieving and returning fewer rows than would
177 # normally be returned in a single response).
178 # Note 1: This setting never reduces the number of returned rows to
179 # zero, no matter how big the first data row is.
180 # Note 2: Currently, this is only checked against a specific set of
181 # columns that tend to get large (collections.manifest_text,
182 # containers.mounts, workflows.definition). Other fields (e.g.,
183 # "properties" hashes) are not counted against this limit.
184 MaxIndexDatabaseRead: 134217728
186 # Maximum number of items to return when responding to a APIs that
187 # can return partial result sets using limit and offset parameters
188 # (e.g., *.index, groups.contents). If a request specifies a "limit"
189 # parameter higher than this value, this value is used instead.
190 MaxItemsPerResponse: 1000
192 # Maximum number of concurrent requests to accept in a single
193 # service process, or 0 for no limit. Currently supported only
195 MaxConcurrentRequests: 0
197 # Maximum number of 64MiB memory buffers per keepstore server
198 # process, or 0 for no limit.
199 MaxKeepBlobBuffers: 128
201 # API methods to disable. Disabled methods are not listed in the
202 # discovery document, and respond 404 to all requests.
203 # Example: {"jobs.create":{}, "pipeline_instances.create": {}}
206 # Interval (seconds) between asynchronous permission view updates. Any
207 # permission-updating API called with the 'async' parameter schedules a an
208 # update on the permission view in the future, if not already scheduled.
209 AsyncPermissionsUpdateInterval: 20s
211 # Maximum number of concurrent outgoing requests to make while
212 # serving a single incoming multi-cluster (federated) request.
213 MaxRequestAmplification: 4
215 # RailsSessionSecretToken is a string of alphanumeric characters
216 # used by Rails to sign session tokens. IMPORTANT: This is a
217 # site secret. It should be at least 50 characters.
218 RailsSessionSecretToken: ""
220 # Maximum wall clock time to spend handling an incoming request.
223 # Websocket will send a periodic empty event after 'SendTimeout'
224 # if there is no other activity to maintain the connection /
225 # detect dropped connections.
228 WebsocketClientEventQueue: 64
229 WebsocketServerEventQueue: 4
231 # Timeout on requests to internal Keep services.
232 KeepServiceRequestTimeout: 15s
235 # Config parameters to automatically setup new users. If enabled,
236 # this users will be able to self-activate. Enable this if you want
237 # to run an open instance where anyone can create an account and use
238 # the system without requiring manual approval.
240 # The params AutoSetupNewUsersWith* are meaningful only when AutoSetupNewUsers is turned on.
241 # AutoSetupUsernameBlacklist is a list of usernames to be blacklisted for auto setup.
242 AutoSetupNewUsers: false
243 AutoSetupNewUsersWithVmUUID: ""
244 AutoSetupNewUsersWithRepository: false
245 AutoSetupUsernameBlacklist:
254 # When NewUsersAreActive is set to true, new users will be active
255 # immediately. This skips the "self-activate" step which enforces
256 # user agreements. Should only be enabled for development.
257 NewUsersAreActive: false
259 # The e-mail address of the user you would like to become marked as an admin
260 # user on their first login.
261 # In the default configuration, authentication happens through the Arvados SSO
262 # server, which uses OAuth2 against Google's servers, so in that case this
263 # should be an address associated with a Google account.
264 AutoAdminUserWithEmail: ""
266 # If AutoAdminFirstUser is set to true, the first user to log in when no
267 # other admin users exist will automatically become an admin user.
268 AutoAdminFirstUser: false
270 # Email address to notify whenever a user creates a profile for the
272 UserProfileNotificationAddress: ""
273 AdminNotifierEmailFrom: arvados@example.com
274 EmailSubjectPrefix: "[ARVADOS] "
275 UserNotifierEmailFrom: arvados@example.com
276 NewUserNotificationRecipients: {}
277 NewInactiveUserNotificationRecipients: {}
279 # Set AnonymousUserToken to enable anonymous user access. You can get
280 # the token by running "bundle exec ./script/get_anonymous_user_token.rb"
281 # in the directory where your API server is running.
282 AnonymousUserToken: ""
284 # If a new user has an alternate email address (local@domain)
285 # with the domain given here, its local part becomes the new
286 # user's default username. Otherwise, the user's primary email
288 PreferDomainForUsername: ""
291 # Time to keep audit logs, in seconds. (An audit log is a row added
292 # to the "logs" table in the PostgreSQL database each time an
293 # Arvados object is created, modified, or deleted.)
295 # Currently, websocket event notifications rely on audit logs, so
296 # this should not be set lower than 300 (5 minutes).
299 # Maximum number of log rows to delete in a single SQL transaction.
301 # If MaxDeleteBatch is 0, log entries will never be
302 # deleted by Arvados. Cleanup can be done by an external process
303 # without affecting any Arvados system processes, as long as very
304 # recent (<5 minutes old) logs are not deleted.
306 # 100000 is a reasonable batch size for most sites.
309 # Attributes to suppress in events and audit logs. Notably,
310 # specifying {"manifest_text": {}} here typically makes the database
311 # smaller and faster.
313 # Warning: Using any non-empty value here can have undesirable side
314 # effects for any client or component that relies on event logs.
315 # Use at your own risk.
316 UnloggedAttributes: {}
320 # Logging threshold: panic, fatal, error, warn, info, debug, or
324 # Logging format: json or text
327 # Maximum characters of (JSON-encoded) query parameters to include
328 # in each request log entry. When params exceed this size, they will
329 # be JSON-encoded, truncated to this size, and logged as
331 MaxRequestLogParamsSize: 2000
335 # Enable access controls for data stored in Keep. This should
336 # always be set to true on a production cluster.
339 # BlobSigningKey is a string of alphanumeric characters used to
340 # generate permission signatures for Keep locators. It must be
341 # identical to the permission key given to Keep. IMPORTANT: This
342 # is a site secret. It should be at least 50 characters.
344 # Modifying BlobSigningKey will invalidate all existing
345 # signatures, which can cause programs to fail (e.g., arv-put,
346 # arv-get, and Crunch jobs). To avoid errors, rotate keys only
347 # when no such processes are running.
350 # Enable garbage collection of unreferenced blobs in Keep.
353 # Time to leave unreferenced blobs in "trashed" state before
354 # deleting them, or 0 to skip the "trashed" state entirely and
355 # delete unreferenced blobs.
357 # If you use any Amazon S3 buckets as storage volumes, this
358 # must be at least 24h to avoid occasional data loss.
359 BlobTrashLifetime: 336h
361 # How often to check for (and delete) trashed blocks whose
362 # BlobTrashLifetime has expired.
363 BlobTrashCheckInterval: 24h
365 # Maximum number of concurrent "trash blob" and "delete trashed
366 # blob" operations conducted by a single keepstore process. Each
367 # of these can be set to 0 to disable the respective operation.
369 # If BlobTrashLifetime is zero, "trash" and "delete trash"
370 # happen at once, so only the lower of these two values is used.
371 BlobTrashConcurrency: 4
372 BlobDeleteConcurrency: 4
374 # Maximum number of concurrent "create additional replica of
375 # existing blob" operations conducted by a single keepstore
377 BlobReplicateConcurrency: 4
379 # Default replication level for collections. This is used when a
380 # collection's replication_desired attribute is nil.
381 DefaultReplication: 2
383 # BlobSigningTTL determines the minimum lifetime of transient
384 # data, i.e., blocks that are not referenced by
385 # collections. Unreferenced blocks exist for two reasons:
387 # 1) A data block must be written to a disk/cloud backend device
388 # before a collection can be created/updated with a reference to
391 # 2) Deleting or updating a collection can remove the last
392 # remaining reference to a data block.
394 # If BlobSigningTTL is too short, long-running
395 # processes/containers will fail when they take too long (a)
396 # between writing blocks and writing collections that reference
397 # them, or (b) between reading collections and reading the
400 # If BlobSigningTTL is too long, data will still be stored long
401 # after the referring collections are deleted, and you will
402 # needlessly fill up disks or waste money on cloud storage.
404 # Modifying BlobSigningTTL invalidates existing signatures; see
405 # BlobSigningKey note above.
407 # The default is 2 weeks.
410 # When running keep-balance, this is the destination filename for
411 # the list of lost block hashes if there are any, one per line.
412 # Updated automically during each successful run.
413 BlobMissingReport: ""
415 # keep-balance operates periodically, i.e.: do a
416 # scan/balance operation, sleep, repeat.
418 # BalancePeriod determines the interval between start times of
419 # successive scan/balance operations. If a scan/balance operation
420 # takes longer than RunPeriod, the next one will follow it
423 # If SIGUSR1 is received during an idle period between operations,
424 # the next operation will start immediately.
427 # Limits the number of collections retrieved by keep-balance per
428 # API transaction. If this is zero, page size is
429 # determined by the API server's own page size limits (see
430 # API.MaxItemsPerResponse and API.MaxIndexDatabaseRead).
431 BalanceCollectionBatch: 0
433 # The size of keep-balance's internal queue of
434 # collections. Higher values use more memory and improve throughput
435 # by allowing keep-balance to fetch the next page of collections
436 # while the current page is still being processed. If this is zero
437 # or omitted, pages are processed serially.
438 BalanceCollectionBuffers: 1000
440 # Default lifetime for ephemeral collections: 2 weeks. This must not
441 # be less than BlobSigningTTL.
442 DefaultTrashLifetime: 336h
444 # Interval (seconds) between trash sweeps. During a trash sweep,
445 # collections are marked as trash if their trash_at time has
446 # arrived, and deleted if their delete_at time has arrived.
447 TrashSweepInterval: 60s
449 # If true, enable collection versioning.
450 # When a collection's preserve_version field is true or the current version
451 # is older than the amount of seconds defined on PreserveVersionIfIdle,
452 # a snapshot of the collection's previous state is created and linked to
453 # the current collection.
454 CollectionVersioning: false
456 # 0s = auto-create a new version on every update.
457 # -1s = never auto-create new versions.
458 # > 0s = auto-create a new version when older than the specified number of seconds.
459 PreserveVersionIfIdle: -1s
461 # Managed collection properties. At creation time, if the client didn't
462 # provide the listed keys, they will be automatically populated following
463 # one of the following behaviors:
465 # * UUID of the user who owns the containing project.
466 # responsible_person_uuid: {Function: original_owner, Protected: true}
468 # * Default concrete value.
469 # foo_bar: {Value: baz, Protected: false}
471 # If Protected is true, only an admin user can modify its value.
473 SAMPLE: {Function: original_owner, Protected: true}
475 # In "trust all content" mode, Workbench will redirect download
476 # requests to WebDAV preview link, even in the cases when
477 # WebDAV would have to expose XSS vulnerabilities in order to
478 # handle the redirect (see discussion on Services.WebDAV).
480 # This setting has no effect in the recommended configuration,
481 # where the WebDAV is configured to have a separate domain for
482 # every collection; in this case XSS protection is provided by
483 # browsers' same-origin policy.
485 # The default setting (false) is appropriate for a multi-user site.
486 TrustAllContent: false
488 # Cache parameters for WebDAV content serving:
489 # * TTL: Maximum time to cache manifests and permission checks.
490 # * UUIDTTL: Maximum time to cache collection state.
491 # * MaxBlockEntries: Maximum number of block cache entries.
492 # * MaxCollectionEntries: Maximum number of collection cache entries.
493 # * MaxCollectionBytes: Approximate memory limit for collection cache.
494 # * MaxPermissionEntries: Maximum number of permission cache entries.
495 # * MaxUUIDEntries: Maximum number of UUID cache entries.
500 MaxCollectionEntries: 1000
501 MaxCollectionBytes: 100000000
502 MaxPermissionEntries: 1000
506 # These settings are provided by your OAuth2 provider (eg
507 # Google) used to perform upstream authentication.
509 ProviderAppSecret: ""
511 # (Experimental) Authenticate with Google, bypassing the
512 # SSO-provider gateway service. Use the Google Cloud console to
513 # enable the People API (APIs and Services > Enable APIs and
514 # services > Google People API > Enable), generate a Client ID
515 # and secret (APIs and Services > Credentials > Create
516 # credentials > OAuth client ID > Web application) and add your
517 # controller's /login URL (e.g.,
518 # "https://zzzzz.example.com/login") as an authorized redirect
521 # Incompatible with ForceLegacyAPI14. ProviderAppID must be
524 GoogleClientSecret: ""
526 # Allow users to log in to existing accounts using any verified
527 # email address listed by their Google account. If true, the
528 # Google People API must be enabled in order for Google login to
529 # work. If false, only the primary email address will be used.
530 GoogleAlternateEmailAddresses: true
532 # The cluster ID to delegate the user database. When set,
533 # logins on this cluster will be redirected to the login cluster
534 # (login cluster must appear in RemoteClusters with Proxy: true)
537 # How long a cached token belonging to a remote cluster will
538 # remain valid before it needs to be revalidated.
539 RemoteTokenRefresh: 5m
542 # Path to git or gitolite-shell executable. Each authenticated
543 # request will execute this program with the single argument "http-backend"
544 GitCommand: /usr/bin/git
546 # Path to Gitolite's home directory. If a non-empty path is given,
547 # the CGI environment will be set up to support the use of
548 # gitolite-shell as a GitCommand: for example, if GitoliteHome is
549 # "/gh", then the CGI environment will have GITOLITE_HTTP_HOME=/gh,
550 # PATH=$PATH:/gh/bin, and GL_BYPASS_ACCESS_CHECKS=1.
553 # Git repositories must be readable by api server, or you won't be
554 # able to submit crunch jobs. To pass the test suites, put a clone
555 # of the arvados tree in {git_repositories_dir}/arvados.git or
556 # {git_repositories_dir}/arvados/.git
557 Repositories: /var/lib/arvados/git/repositories
565 # List of supported Docker Registry image formats that compute nodes
566 # are able to use. ` + "`" + `arv keep docker` + "`" + ` will error out if a user tries
567 # to store an image with an unsupported format. Use an empty array
568 # to skip the compatibility check (and display a warning message to
571 # Example for sites running docker < 1.10: {"v1": {}}
572 # Example for sites running docker >= 1.10: {"v2": {}}
573 # Example for disabling check: {}
574 SupportedDockerImageFormats:
578 # Include details about job reuse decisions in the server log. This
579 # causes additional database queries to run, so it should not be
580 # enabled unless you expect to examine the resulting logs for
581 # troubleshooting purposes.
582 LogReuseDecisions: false
584 # Default value for keep_cache_ram of a container's runtime_constraints.
585 DefaultKeepCacheRAM: 268435456
587 # Number of times a container can be unlocked before being
588 # automatically cancelled.
589 MaxDispatchAttempts: 5
591 # Default value for container_count_max for container requests. This is the
592 # number of times Arvados will create a new container to satisfy a container
593 # request. If a container is cancelled it will retry a new container if
594 # container_count < container_count_max on any container requests associated
595 # with the cancelled container.
598 # The maximum number of compute nodes that can be in use simultaneously
599 # If this limit is reduced, any existing nodes with slot number >= new limit
600 # will not be counted against the new limit. In other words, the new limit
601 # won't be strictly enforced until those nodes with higher slot numbers
605 # Preemptible instance support (e.g. AWS Spot Instances)
606 # When true, child containers will get created with the preemptible
607 # scheduling parameter parameter set.
608 UsePreemptibleInstances: false
610 # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the
611 # (experimental) cloud dispatcher for executing containers on
612 # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n"
613 # and ends with "\n-----END RSA PRIVATE KEY-----\n".
614 DispatchPrivateKey: none
616 # Maximum time to wait for workers to come up before abandoning
617 # stale locks from a previous dispatch process.
620 # The crunch-run command to manage the container on a node
621 CrunchRunCommand: "crunch-run"
623 # Extra arguments to add to crunch-run invocation
624 # Example: ["--cgroup-parent-subsystem=memory"]
625 CrunchRunArgumentsList: []
627 # Extra RAM to reserve on the node, in addition to
628 # the amount specified in the container's RuntimeConstraints
629 ReserveExtraRAM: 256MiB
631 # Minimum time between two attempts to run the same container
635 # When you run the db:delete_old_container_logs task, it will find
636 # containers that have been finished for at least this many seconds,
637 # and delete their stdout, stderr, arv-mount, crunch-run, and
638 # crunchstat logs from the logs table.
641 # These two settings control how frequently log events are flushed to the
642 # database. Log lines are buffered until either crunch_log_bytes_per_event
643 # has been reached or crunch_log_seconds_between_events has elapsed since
645 LogBytesPerEvent: 4096
646 LogSecondsBetweenEvents: 1
648 # The sample period for throttling logs.
649 LogThrottlePeriod: 60s
651 # Maximum number of bytes that job can log over crunch_log_throttle_period
652 # before being silenced until the end of the period.
653 LogThrottleBytes: 65536
655 # Maximum number of lines that job can log over crunch_log_throttle_period
656 # before being silenced until the end of the period.
657 LogThrottleLines: 1024
659 # Maximum bytes that may be logged by a single job. Log bytes that are
660 # silenced by throttling are not counted against this total.
661 LimitLogBytesPerJob: 67108864
663 LogPartialLineThrottlePeriod: 5s
665 # Container logs are written to Keep and saved in a
666 # collection, which is updated periodically while the
667 # container runs. This value sets the interval between
668 # collection updates.
671 # The log collection is also updated when the specified amount of
672 # log data (given in bytes) is produced in less than one update
678 SbatchArgumentsList: []
679 SbatchEnvironmentVariables:
682 # Path to dns server configuration directory
683 # (e.g. /etc/unbound.d/conf.d). If false, do not write any config
684 # files or touch restart.txt (see below).
687 # Template file for the dns server host snippets. See
688 # unbound.template in this directory for an example. If false, do
689 # not write any config files.
690 DNSServerConfTemplate: ""
692 # String to write to {dns_server_conf_dir}/restart.txt (with a
693 # trailing newline) after updating local data. If false, do not
694 # open or write the restart.txt file.
695 DNSServerReloadCommand: ""
697 # Command to run after each DNS update. Template variables will be
698 # substituted; see the "unbound" example below. If false, do not run
700 DNSServerUpdateCommand: ""
702 ComputeNodeDomain: ""
703 ComputeNodeNameservers:
707 # Hostname to assign to a compute node when it sends a "ping" and the
708 # hostname in its Node record is nil.
709 # During bootstrapping, the "ping" script is expected to notice the
710 # hostname given in the ping response, and update its unix hostname
712 # If false, leave the hostname alone (this is appropriate if your compute
713 # nodes' hostnames are already assigned by some other mechanism).
715 # One way or another, the hostnames of your node records should agree
716 # with your DNS records and your /etc/slurm-llnl/slurm.conf files.
718 # Example for compute0000, compute0001, ....:
719 # assign_node_hostname: compute%<slot_number>04d
720 # (See http://ruby-doc.org/core-2.2.2/Kernel.html#method-i-format for more.)
721 AssignNodeHostname: "compute%<slot_number>d"
724 # Enable the legacy 'jobs' API (crunch v1). This value must be a string.
726 # Note: this only enables read-only access, creating new
727 # legacy jobs and pipelines is not supported.
729 # 'auto' -- (default) enable the Jobs API only if it has been used before
730 # (i.e., there are job records in the database)
731 # 'true' -- enable the Jobs API despite lack of existing records.
732 # 'false' -- disable the Jobs API despite presence of existing records.
735 # Git repositories must be readable by api server, or you won't be
736 # able to submit crunch jobs. To pass the test suites, put a clone
737 # of the arvados tree in {git_repositories_dir}/arvados.git or
738 # {git_repositories_dir}/arvados/.git
739 GitInternalDir: /var/lib/arvados/internal.git
742 # Enable the cloud scheduler (experimental).
745 # Name/number of port where workers' SSH services listen.
748 # Interval between queue polls.
751 # Shell command to execute on each worker to determine whether
752 # the worker is booted and ready to run containers. It should
753 # exit zero if the worker is ready.
754 BootProbeCommand: "docker ps -q"
756 # Minimum interval between consecutive probes to a single
760 # Maximum probes per second, across all workers in a pool.
761 MaxProbesPerSecond: 10
763 # Time before repeating SIGTERM when killing a container.
766 # Time to give up on SIGTERM and write off the worker.
769 # Maximum create/destroy-instance operations per second (0 =
771 MaxCloudOpsPerSecond: 0
773 # Interval between cloud provider syncs/updates ("list all
777 # Time to leave an idle worker running (in case new containers
778 # appear in the queue that it can run) before shutting it
782 # Time to wait for a new worker to boot (i.e., pass
783 # BootProbeCommand) before giving up and shutting it down.
786 # Maximum time a worker can stay alive with no successful
787 # probes before being automatically shut down.
790 # Time after shutting down a worker to retry the
791 # shutdown/destroy operation.
794 # Worker VM image ID.
797 # Tags to add on all resources (VMs, NICs, disks) created by
798 # the container dispatcher. (Arvados's own tags --
799 # InstanceType, IdleBehavior, and InstanceSecret -- will also
804 # Prefix for predefined tags used by Arvados (InstanceSetID,
805 # InstanceType, InstanceSecret, IdleBehavior). With the
806 # default value "Arvados", tags are "ArvadosInstanceSetID",
807 # "ArvadosInstanceSecret", etc.
809 # This should only be changed while no cloud resources are in
810 # use and the cloud dispatcher is not running. Otherwise,
811 # VMs/resources that were added using the old tag prefix will
812 # need to be detected and cleaned up manually.
813 TagKeyPrefix: Arvados
815 # Cloud driver: "azure" (Microsoft Azure) or "ec2" (Amazon AWS).
818 # Cloud-specific driver parameters.
825 # (ec2) Instance configuration.
831 AdminUsername: debian
833 # (azure) Credentials.
839 # (azure) Instance configuration.
840 CloudEnvironment: AzurePublicCloud
847 DeleteDanglingResourcesAfter: 20s
848 AdminUsername: arvados
852 # Use the instance type name as the key (in place of "SAMPLE" in
853 # this sample entry).
855 # Cloud provider's instance type. Defaults to the configured type name.
859 IncludedScratch: 16GB
866 # AccessViaHosts specifies which keepstore processes can read
867 # and write data on the volume.
869 # For a local filesystem, AccessViaHosts has one entry,
870 # indicating which server the filesystem is located on.
872 # For a network-attached backend accessible by all keepstore
873 # servers, like a cloud storage bucket or an NFS mount,
874 # AccessViaHosts can be empty/omitted.
876 # Further info/examples:
877 # https://doc.arvados.org/install/configure-fs-storage.html
878 # https://doc.arvados.org/install/configure-s3-object-storage.html
879 # https://doc.arvados.org/install/configure-azure-blob-storage.html
883 "http://host1.example:25107": {}
892 # for s3 driver -- see
893 # https://doc.arvados.org/install/configure-s3-object-storage.html
900 LocationConstraint: false
907 # for azure driver -- see
908 # https://doc.arvados.org/install/configure-azure-blob-storage.html
909 StorageAccountName: aaaaa
910 StorageAccountKey: aaaaa
911 StorageBaseURL: core.windows.net
914 ListBlobsRetryDelay: 10s
915 ListBlobsMaxAttempts: 10
917 WriteRaceInterval: 15s
918 WriteRacePollTime: 1s
920 # for local directory driver -- see
921 # https://doc.arvados.org/install/configure-fs-storage.html
922 Root: /var/lib/arvados/keep-data
928 SendUserSetupNotificationEmail: true
930 # Bug/issue report notification to and from addresses
931 IssueReporterEmailFrom: "arvados@example.com"
932 IssueReporterEmailTo: "arvados@example.com"
933 SupportEmailAddress: "arvados@example.com"
935 # Generic issue email from
936 EmailFrom: "arvados@example.com"
945 # API endpoint host or host:port; default is {id}.arvadosapi.com
946 Host: sample.arvadosapi.com
948 # Perform a proxy request when a local client requests an
949 # object belonging to this remote.
952 # Default "https". Can be set to "http" for testing.
955 # Disable TLS verify. Can be set to true for testing.
958 # When users present tokens issued by this remote cluster, and
959 # their accounts are active on the remote cluster, activate
960 # them on this cluster too.
966 ActivationContactLink: mailto:info@arvados.org
967 ArvadosDocsite: https://doc.arvados.org
968 ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public
969 ShowUserAgreementInline: false
972 # Scratch directory used by the remote repository browsing
973 # feature. If it doesn't exist, it (and any missing parents) will be
974 # created using mkdir_p.
975 RepositoryCache: /var/www/arvados-workbench/current/tmp/git
977 # Below is a sample setting of user_profile_form_fields config parameter.
978 # This configuration parameter should be set to either false (to disable) or
979 # to a map as shown below.
980 # Configure the map of input fields to be displayed in the profile page
981 # using the attribute "key" for each of the input fields.
982 # This sample shows configuration with one required and one optional form fields.
983 # For each of these input fields:
984 # You can specify "Type" as "text" or "select".
985 # List the "Options" to be displayed for each of the "select" menu.
986 # Set "Required" as "true" for any of these fields to make them required.
987 # If any of the required fields are missing in the user's profile, the user will be
988 # redirected to the profile page before they can access any Workbench features.
989 UserProfileFormFields:
992 FormFieldTitle: Best color
993 FormFieldDescription: your favorite color
1002 # exampleTextValue: # key that will be set in properties
1004 # FormFieldTitle: ""
1005 # FormFieldDescription: ""
1008 # exampleOptionsValue:
1010 # FormFieldTitle: ""
1011 # FormFieldDescription: ""
1019 # Use "UserProfileFormMessage to configure the message you want
1020 # to display on the profile page.
1021 UserProfileFormMessage: 'Welcome to Arvados. All <span style="color:red">required fields</span> must be completed before you can proceed.'
1023 # Mimetypes of applications for which the view icon
1024 # would be enabled in a collection's show page.
1025 # It is sufficient to list only applications here.
1026 # No need to list text and image types.
1027 ApplicationMimetypesWithViewIcon:
1045 # The maximum number of bytes to load in the log viewer
1046 LogViewerMaxBytes: 1M
1048 # When anonymous_user_token is configured, show public projects page
1049 EnablePublicProjectsPage: true
1051 # By default, disable the "Getting Started" popup which is specific to Arvados playground
1052 EnableGettingStartedPopup: false
1054 # Ask Arvados API server to compress its response payloads.
1055 APIResponseCompression: true
1057 # Timeouts for API requests.
1058 APIClientConnectTimeout: 2m
1059 APIClientReceiveTimeout: 5m
1061 # Maximum number of historic log records of a running job to fetch
1062 # and display in the Log tab, while subscribing to web sockets.
1063 RunningJobLogRecordsToFetch: 2000
1065 # In systems with many shared projects, loading of dashboard and topnav
1066 # cab be slow due to collections indexing; use the following parameters
1067 # to suppress these properties
1068 ShowRecentCollectionsOnDashboard: true
1069 ShowUserNotifications: true
1071 # Enable/disable "multi-site search" in top nav ("true"/"false"), or
1072 # a link to the multi-site search page on a "home" Workbench site.
1075 # https://workbench.qr1hi.arvadosapi.com/collections/multisite
1078 # Should workbench allow management of local git repositories? Set to false if
1079 # the jobs api is disabled and there are no local git repositories.
1082 SiteName: Arvados Workbench
1083 ProfilingEnabled: false
1085 # This is related to obsolete Google OpenID 1.0 login
1086 # but some workbench stuff still expects it to be set.
1087 DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id"
1089 # Workbench2 configs
1091 FileViewersConfigURL: ""
1093 # Workbench welcome screen, this is HTML text that will be
1094 # incorporated directly onto the page.
1096 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1097 <h2>Please log in.</h2>
1099 <p>The "Log in" button below will show you a sign-in
1100 page. After you log in, you will be redirected back to
1101 Arvados Workbench.</p>
1103 <p>If you have never used Arvados Workbench before, logging in
1104 for the first time will automatically create a new
1107 <i>Arvados Workbench uses your name and email address only for
1108 identification, and does not retrieve any other personal
1112 <img src="/arvados-logo-big.png" style="width: 20%; float: right; padding: 1em;" />
1113 <h3>Hi! You're logged in, but...</h3>
1114 <p>Your account is inactive.</p>
1115 <p>An administrator must activate your account before you can get
1118 # Bypass new (Arvados 1.5) API implementations, and hand off
1119 # requests directly to Rails instead. This can provide a temporary
1120 # workaround for clients that are incompatible with the new API
1121 # implementation. Note that it also disables some new federation
1122 # features and will be removed in a future release.
1123 ForceLegacyAPI14: false