X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/9d2cf97c13005304f0a9031fd5d88ac89906bb33..b9fd7e3f374248a61159e4750a84e38d1c48d5dd:/lib/config/config.default.yml diff --git a/lib/config/config.default.yml b/lib/config/config.default.yml index 6389fceb78..59dabbb26d 100644 --- a/lib/config/config.default.yml +++ b/lib/config/config.default.yml @@ -275,6 +275,12 @@ Clusters: # in the directory where your API server is running. AnonymousUserToken: "" + # If a new user has an alternate email address (local@domain) + # with the domain given here, its local part becomes the new + # user's default username. Otherwise, the user's primary email + # address is used. + PreferDomainForUsername: "" + AuditLogs: # Time to keep audit logs, in seconds. (An audit log is a row added # to the "logs" table in the PostgreSQL database each time an @@ -446,6 +452,24 @@ Clusters: # > 0s = auto-create a new version when older than the specified number of seconds. PreserveVersionIfIdle: -1s + # If non-empty, allow project and collection names to contain + # the "/" character (slash/stroke/solidus), and replace "/" with + # the given string in the filesystem hierarchy presented by + # WebDAV. Example values are "%2f" and "{slash}". Names that + # contain the substitution string itself may result in confusing + # behavior, so a value like "_" is not recommended. + # + # If the default empty value is used, the server will reject + # requests to create or rename a collection when the new name + # contains "/". + # + # If the value "/" is used, project and collection names + # containing "/" will be allowed, but they will not be + # accessible via WebDAV. + # + # Use of this feature is not recommended, if it can be avoided. + ForwardSlashNameSubstitution: "" + # Managed collection properties. At creation time, if the client didn't # provide the listed keys, they will be automatically populated following # one of the following behaviors: @@ -493,12 +517,33 @@ Clusters: Login: # These settings are provided by your OAuth2 provider (eg # Google) used to perform upstream authentication. - ProviderAppSecret: "" ProviderAppID: "" + ProviderAppSecret: "" + + # (Experimental) Authenticate with Google, bypassing the + # SSO-provider gateway service. Use the Google Cloud console to + # enable the People API (APIs and Services > Enable APIs and + # services > Google People API > Enable), generate a Client ID + # and secret (APIs and Services > Credentials > Create + # credentials > OAuth client ID > Web application) and add your + # controller's /login URL (e.g., + # "https://zzzzz.example.com/login") as an authorized redirect + # URL. + # + # Incompatible with ForceLegacyAPI14. ProviderAppID must be + # blank. + GoogleClientID: "" + GoogleClientSecret: "" + + # Allow users to log in to existing accounts using any verified + # email address listed by their Google account. If true, the + # Google People API must be enabled in order for Google login to + # work. If false, only the primary email address will be used. + GoogleAlternateEmailAddresses: true # The cluster ID to delegate the user database. When set, # logins on this cluster will be redirected to the login cluster - # (login cluster must appear in RemoteHosts with Proxy: true) + # (login cluster must appear in RemoteClusters with Proxy: true) LoginCluster: "" # How long a cached token belonging to a remote cluster will @@ -578,7 +623,7 @@ Clusters: # (experimental) cloud dispatcher for executing containers on # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n" # and ends with "\n-----END RSA PRIVATE KEY-----\n". - DispatchPrivateKey: none + DispatchPrivateKey: "" # Maximum time to wait for workers to come up before abandoning # stale locks from a previous dispatch process. @@ -610,7 +655,7 @@ Clusters: # has been reached or crunch_log_seconds_between_events has elapsed since # the last flush. LogBytesPerEvent: 4096 - LogSecondsBetweenEvents: 1 + LogSecondsBetweenEvents: 5s # The sample period for throttling logs. LogThrottlePeriod: 60s @@ -761,6 +806,16 @@ Clusters: # Worker VM image ID. ImageID: "" + # An executable file (located on the dispatcher host) to be + # copied to cloud instances at runtime and used as the + # container runner/supervisor. The default value is the + # dispatcher program itself. + # + # Use the empty string to disable this step: nothing will be + # copied, and cloud instances are assumed to have a suitable + # version of crunch-run installed. + DeployRunnerBinary: "/proc/self/exe" + # Tags to add on all resources (VMs, NICs, disks) created by # the container dispatcher. (Arvados's own tags -- # InstanceType, IdleBehavior, and InstanceSecret -- will also @@ -855,7 +910,6 @@ Clusters: SAMPLE: true Driver: s3 DriverParameters: - # for s3 driver -- see # https://doc.arvados.org/install/configure-s3-object-storage.html IAMRole: aaaaa @@ -869,6 +923,15 @@ Clusters: ConnectTimeout: 1m ReadTimeout: 10m RaceWindow: 24h + + # For S3 driver, potentially unsafe tuning parameter, + # intentionally excluded from main documentation. + # + # Enable deletion (garbage collection) even when the + # configured BlobTrashLifetime is zero. WARNING: eventual + # consistency may result in race conditions that can cause + # data loss. Do not enable this unless you understand and + # accept the risk. UnsafeDelete: false # for azure driver -- see @@ -887,6 +950,21 @@ Clusters: # for local directory driver -- see # https://doc.arvados.org/install/configure-fs-storage.html Root: /var/lib/arvados/keep-data + + # For local directory driver, potentially confusing tuning + # parameter, intentionally excluded from main documentation. + # + # When true, read and write operations (for whole 64MiB + # blocks) on an individual volume will queued and issued + # serially. When false, read and write operations will be + # issued concurrently. + # + # May possibly improve throughput if you have physical spinning disks + # and experience contention when there are multiple requests + # to the same volume. + # + # Otherwise, when using SSDs, RAID, or a shared network filesystem, you + # should leave this alone. Serialize: false Mail: @@ -1060,8 +1138,7 @@ Clusters: # Workbench welcome screen, this is HTML text that will be # incorporated directly onto the page. WelcomePageHTML: | -
- +

Please log in.

The "Log in" button below will show you a sign-in @@ -1075,7 +1152,26 @@ Clusters: Arvados Workbench uses your name and email address only for identification, and does not retrieve any other personal information. -

- # Use experimental controller code (see https://dev.arvados.org/issues/14287) - EnableBetaController14287: false + # Workbench screen displayed to inactive users. This is HTML + # text that will be incorporated directly onto the page. + InactivePageHTML: | + +

Hi! You're logged in, but...

+

Your account is inactive.

+

An administrator must activate your account before you can get + any further.

+ + # Connecting to Arvados shell VMs tends to be site-specific. + # Put any special instructions here. This is HTML text that will + # be incorporated directly onto the Workbench page. + SSHHelpPageHTML: | + Accessing an Arvados VM with SSH (generic instructions). + Site configurations vary. Contact your local cluster administrator if you have difficulty accessing an Arvados shell node. + + # Bypass new (Arvados 1.5) API implementations, and hand off + # requests directly to Rails instead. This can provide a temporary + # workaround for clients that are incompatible with the new API + # implementation. Note that it also disables some new federation + # features and will be removed in a future release. + ForceLegacyAPI14: false