X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/ec1bcd246ad1097a502d02a9f0239d7bbed6d958..247006e2b7e3e3e1860b093d2a8d23d4536255d3:/lib/config/generated_config.go diff --git a/lib/config/generated_config.go b/lib/config/generated_config.go index f4df11a6b2..602f30e1da 100644 --- a/lib/config/generated_config.go +++ b/lib/config/generated_config.go @@ -25,6 +25,16 @@ Clusters: ManagementToken: "" Services: + + # In each of the service sections below, the keys under + # InternalURLs are the endpoints where the service should be + # listening, and reachable from other hosts in the cluster. + SAMPLE: + InternalURLs: + "http://example.host:12345": {} + SAMPLE: {} + ExternalURL: "-" + RailsAPI: InternalURLs: {} ExternalURL: "-" @@ -41,32 +51,92 @@ Clusters: InternalURLs: {} ExternalURL: "" GitSSH: + InternalURLs: {} ExternalURL: "" DispatchCloud: InternalURLs: {} ExternalURL: "-" SSO: + InternalURLs: {} ExternalURL: "" Keepproxy: InternalURLs: {} ExternalURL: "" WebDAV: InternalURLs: {} + # Base URL for Workbench inline preview. If blank, use + # WebDAVDownload instead, and disable inline preview. + # If both are empty, downloading collections from workbench + # will be impossible. + # + # It is important to properly configure the download service + # to migitate cross-site-scripting (XSS) attacks. A HTML page + # can be stored in collection. If an attacker causes a victim + # to visit that page through Workbench, it will be rendered by + # the browser. If all collections are served at the same + # domain, the browser will consider collections as coming from + # the same origin and having access to the same browsing data, + # enabling malicious Javascript on that page to access Arvados + # on behalf of the victim. + # + # This is mitigating by having separate domains for each + # collection, or limiting preview to circumstances where the + # collection is not accessed with the user's regular + # full-access token. + # + # Serve preview links using uuid or pdh in subdomain + # (requires wildcard DNS and TLS certificate) + # https://*.collections.uuid_prefix.arvadosapi.com + # + # Serve preview links using uuid or pdh in main domain + # (requires wildcard DNS and TLS certificate) + # https://*--collections.uuid_prefix.arvadosapi.com + # + # Serve preview links by setting uuid or pdh in the path. + # This configuration only allows previews of public data or + # collection-sharing links, because these use the anonymous + # user token or the token is already embedded in the URL. + # Other data must be handled as downloads via WebDAVDownload: + # https://collections.uuid_prefix.arvadosapi.com + # ExternalURL: "" + WebDAVDownload: InternalURLs: {} + # Base URL for download links. If blank, serve links to WebDAV + # with disposition=attachment query param. Unlike preview links, + # browsers do not render attachments, so there is no risk of XSS. + # + # If WebDAVDownload is blank, and WebDAV uses a + # single-origin form, then Workbench will show an error page + # + # Serve download links by setting uuid or pdh in the path: + # https://download.uuid_prefix.arvadosapi.com + # ExternalURL: "" + Keepstore: InternalURLs: {} ExternalURL: "-" Composer: + InternalURLs: {} ExternalURL: "" WebShell: + InternalURLs: {} + # ShellInABox service endpoint URL for a given VM. If empty, do not + # offer web shell logins. + # + # E.g., using a path-based proxy server to forward connections to shell hosts: + # https://webshell.uuid_prefix.arvadosapi.com + # + # E.g., using a name-based proxy server to forward connections to shell hosts: + # https://*.webshell.uuid_prefix.arvadosapi.com ExternalURL: "" Workbench1: InternalURLs: {} ExternalURL: "" Workbench2: + InternalURLs: {} ExternalURL: "" Nodemanager: InternalURLs: {} @@ -86,6 +156,7 @@ Clusters: user: "" password: "" dbname: "" + SAMPLE: "" API: # Maximum size (in bytes) allowed for a single API request. This # limit is published in the discovery document for use by clients. @@ -113,13 +184,13 @@ Clusters: # API methods to disable. Disabled methods are not listed in the # discovery document, and respond 404 to all requests. - # Example: ["jobs.create", "pipeline_instances.create"] - DisabledAPIs: [] + # Example: {"jobs.create":{}, "pipeline_instances.create": {}} + DisabledAPIs: {} # Interval (seconds) between asynchronous permission view updates. Any # permission-updating API called with the 'async' parameter schedules a an # update on the permission view in the future, if not already scheduled. - AsyncPermissionsUpdateInterval: 20 + AsyncPermissionsUpdateInterval: 20s # Maximum number of concurrent outgoing requests to make while # serving a single incoming multi-cluster (federated) request. @@ -133,6 +204,14 @@ Clusters: # Maximum wall clock time to spend handling an incoming request. RequestTimeout: 5m + # Websocket will send a periodic empty event after 'SendTimeout' + # if there is no other activity to maintain the connection / + # detect dropped connections. + SendTimeout: 60s + + WebsocketClientEventQueue: 64 + WebsocketServerEventQueue: 4 + Users: # Config parameters to automatically setup new users. If enabled, # this users will be able to self-activate. Enable this if you want @@ -144,7 +223,14 @@ Clusters: AutoSetupNewUsers: false AutoSetupNewUsersWithVmUUID: "" AutoSetupNewUsersWithRepository: false - AutoSetupUsernameBlacklist: [arvados, git, gitolite, gitolite-admin, root, syslog] + AutoSetupUsernameBlacklist: + arvados: {} + git: {} + gitolite: {} + gitolite-admin: {} + root: {} + syslog: {} + SAMPLE: {} # When new_users_are_active is set to true, new users will be active # immediately. This skips the "self-activate" step which enforces @@ -168,8 +254,13 @@ Clusters: AdminNotifierEmailFrom: arvados@example.com EmailSubjectPrefix: "[ARVADOS] " UserNotifierEmailFrom: arvados@example.com - NewUserNotificationRecipients: [] - NewInactiveUserNotificationRecipients: [] + NewUserNotificationRecipients: {} + NewInactiveUserNotificationRecipients: {} + + # Set anonymous_user_token to enable anonymous user access. You can get + # the token by running "bundle exec ./script/get_anonymous_user_token.rb" + # in the directory where your API server is running. + AnonymousUserToken: "" AuditLogs: # Time to keep audit logs, in seconds. (An audit log is a row added @@ -191,13 +282,13 @@ Clusters: MaxDeleteBatch: 0 # Attributes to suppress in events and audit logs. Notably, - # specifying ["manifest_text"] here typically makes the database + # specifying {"manifest_text": {}} here typically makes the database # smaller and faster. # # Warning: Using any non-empty value here can have undesirable side # effects for any client or component that relies on event logs. # Use at your own risk. - UnloggedAttributes: [] + UnloggedAttributes: {} SystemLogs: @@ -226,7 +317,7 @@ Clusters: # one another! BlobSigning: true - # blob_signing_key is a string of alphanumeric characters used to + # BlobSigningKey is a string of alphanumeric characters used to # generate permission signatures for Keep locators. It must be # identical to the permission key given to Keep. IMPORTANT: This is # a site secret. It should be at least 50 characters. @@ -266,7 +357,7 @@ Clusters: # Interval (seconds) between trash sweeps. During a trash sweep, # collections are marked as trash if their trash_at time has # arrived, and deleted if their delete_at time has arrived. - TrashSweepInterval: 60 + TrashSweepInterval: 60s # If true, enable collection versioning. # When a collection's preserve_version field is true or the current version @@ -275,23 +366,37 @@ Clusters: # the current collection. CollectionVersioning: false - # 0 = auto-create a new version on every update. - # -1 = never auto-create new versions. - # > 0 = auto-create a new version when older than the specified number of seconds. - PreserveVersionIfIdle: -1 + # 0s = auto-create a new version on every update. + # -1s = never auto-create new versions. + # > 0s = auto-create a new version when older than the specified number of seconds. + PreserveVersionIfIdle: -1s - # Default collection properties. At creation time, if the client didn't + # 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: # # * UUID of the user who owns the containing project. - # responsible_person_uuid: {function: original_owner, protected: true} + # responsible_person_uuid: {Function: original_owner, Protected: true} # # * Default concrete value. - # foo_bar: {value: baz, protected: false} + # foo_bar: {Value: baz, Protected: false} # - # If protected is true, only an admin user can modify its value. - DefaultProperties: {} + # If Protected is true, only an admin user can modify its value. + ManagedProperties: + SAMPLE: {Function: original_owner, Protected: true} + + # In "trust all content" mode, Workbench will redirect download + # requests to WebDAV preview link, even in the cases when + # WebDAV would have to expose XSS vulnerabilities in order to + # handle the redirect (see discussion on Services.WebDAV). + # + # This setting has no effect in the recommended configuration, + # where the WebDAV is configured to have a separate domain for + # every collection; in this case XSS protection is provided by + # browsers' same-origin policy. + # + # The default setting (false) is appropriate for a multi-user site. + TrustAllContent: false Login: # These settings are provided by your OAuth2 provider (e.g., @@ -318,10 +423,12 @@ Clusters: # to skip the compatibility check (and display a warning message to # that effect). # - # Example for sites running docker < 1.10: ["v1"] - # Example for sites running docker >= 1.10: ["v2"] - # Example for disabling check: [] - SupportedDockerImageFormats: ["v2"] + # Example for sites running docker < 1.10: {"v1": {}} + # Example for sites running docker >= 1.10: {"v2": {}} + # Example for disabling check: {} + SupportedDockerImageFormats: + "v2": {} + SAMPLE: {} # Include details about job reuse decisions in the server log. This # causes additional database queries to run, so it should not be @@ -355,12 +462,6 @@ Clusters: # scheduling parameter parameter set. UsePreemptibleInstances: false - # Include details about job reuse decisions in the server log. This - # causes additional database queries to run, so it should not be - # enabled unless you expect to examine the resulting logs for - # troubleshooting purposes. - LogReuseDecisions: false - # PEM encoded SSH key (RSA, DSA, or ECDSA) used by the # (experimental) cloud dispatcher for executing containers on # worker VMs. Begins with "-----BEGIN RSA PRIVATE KEY-----\n" @@ -371,6 +472,20 @@ Clusters: # stale locks from a previous dispatch process. StaleLockTimeout: 1m + # The crunch-run command to manage the container on a node + CrunchRunCommand: "crunch-run" + + # Extra arguments to add to crunch-run invocation + # Example: ["--cgroup-parent-subsystem=memory"] + CrunchRunArgumentsList: [] + + # Extra RAM to reserve on the node, in addition to + # the amount specified in the container's RuntimeConstraints + ReserveExtraRAM: 256MiB + + # Minimum time between two attempts to run the same container + MinRetryPeriod: 0s + Logging: # When you run the db:delete_old_container_logs task, it will find # containers that have been finished for at least this many seconds, @@ -385,8 +500,8 @@ Clusters: LogBytesPerEvent: 4096 LogSecondsBetweenEvents: 1 - # The sample period for throttling logs, in seconds. - LogThrottlePeriod: 60 + # The sample period for throttling logs. + LogThrottlePeriod: 60s # Maximum number of bytes that job can log over crunch_log_throttle_period # before being silenced until the end of the period. @@ -400,20 +515,24 @@ Clusters: # silenced by throttling are not counted against this total. LimitLogBytesPerJob: 67108864 - LogPartialLineThrottlePeriod: 5 + LogPartialLineThrottlePeriod: 5s - # Container logs are written to Keep and saved in a collection, - # which is updated periodically while the container runs. This - # value sets the interval (given in seconds) between collection - # updates. - LogUpdatePeriod: 1800 + # Container logs are written to Keep and saved in a + # collection, which is updated periodically while the + # container runs. This value sets the interval between + # collection updates. + LogUpdatePeriod: 30m # The log collection is also updated when the specified amount of # log data (given in bytes) is produced in less than one update # period. - LogUpdateSize: 33554432 + LogUpdateSize: 32MiB SLURM: + PrioritySpread: 0 + SbatchArgumentsList: [] + SbatchEnvironmentVariables: + SAMPLE: "" Managed: # Path to dns server configuration directory # (e.g. /etc/unbound.d/conf.d). If false, do not write any config @@ -437,7 +556,8 @@ Clusters: ComputeNodeDomain: "" ComputeNodeNameservers: - - 192.168.1.1 + "192.168.1.1": {} + SAMPLE: {} # Hostname to assign to a compute node when it sends a "ping" and the # hostname in its Node record is nil. @@ -506,7 +626,7 @@ Clusters: # Shell command to execute on each worker to determine whether # the worker is booted and ready to run containers. It should # exit zero if the worker is ready. - BootProbeCommand: "docker ps" + BootProbeCommand: "docker ps -q" # Minimum interval between consecutive probes to a single # worker. @@ -547,7 +667,7 @@ Clusters: TimeoutShutdown: 10s # Worker VM image ID. - ImageID: ami-01234567890abcdef + ImageID: "" # Tags to add on all resources (VMs, NICs, disks) created by # the container dispatcher. (Arvados's own tags -- @@ -579,7 +699,7 @@ Clusters: # (ec2) Instance configuration. SecurityGroupIDs: - - "" + "SAMPLE": {} SubnetID: "" Region: "" EBSVolumeType: gp2 @@ -619,11 +739,15 @@ Clusters: Mail: MailchimpAPIKey: "" MailchimpListID: "" - SendUserSetupNotificationEmail: "" - IssueReporterEmailFrom: "" - IssueReporterEmailTo: "" - SupportEmailAddress: "" - EmailFrom: "" + SendUserSetupNotificationEmail: true + + # Bug/issue report notification to and from addresses + IssueReporterEmailFrom: "arvados@example.com" + IssueReporterEmailTo: "arvados@example.com" + SupportEmailAddress: "arvados@example.com" + + # Generic issue email from + EmailFrom: "arvados@example.com" RemoteClusters: "*": Host: "" @@ -632,9 +756,154 @@ Clusters: Insecure: false ActivateUsers: false SAMPLE: + # API endpoint host or host:port; default is {id}.arvadosapi.com Host: sample.arvadosapi.com + + # Perform a proxy request when a local client requests an + # object belonging to this remote. Proxy: false + + # Default "https". Can be set to "http" for testing. Scheme: https + + # Disable TLS verify. Can be set to true for testing. Insecure: false + + # When users present tokens issued by this remote cluster, and + # their accounts are active on the remote cluster, activate + # them on this cluster too. ActivateUsers: false + + Workbench: + # Workbench1 configs + Theme: default + ActivationContactLink: mailto:info@arvados.org + ArvadosDocsite: https://doc.arvados.org + ArvadosPublicDataDocURL: https://playground.arvados.org/projects/public + ShowUserAgreementInline: false + SecretKeyBase: "" + + # Scratch directory used by the remote repository browsing + # feature. If it doesn't exist, it (and any missing parents) will be + # created using mkdir_p. + RepositoryCache: /var/www/arvados-workbench/current/tmp/git + + # Below is a sample setting of user_profile_form_fields config parameter. + # This configuration parameter should be set to either false (to disable) or + # to a map as shown below. + # Configure the map of input fields to be displayed in the profile page + # using the attribute "key" for each of the input fields. + # This sample shows configuration with one required and one optional form fields. + # For each of these input fields: + # You can specify "Type" as "text" or "select". + # List the "Options" to be displayed for each of the "select" menu. + # Set "Required" as "true" for any of these fields to make them required. + # If any of the required fields are missing in the user's profile, the user will be + # redirected to the profile page before they can access any Workbench features. + UserProfileFormFields: + SAMPLE: + Type: select + FormFieldTitle: Best color + FormFieldDescription: your favorite color + Required: false + Position: 1 + Options: + red: {} + blue: {} + green: {} + SAMPLE: {} + + # exampleTextValue: # key that will be set in properties + # Type: text # + # FormFieldTitle: "" + # FormFieldDescription: "" + # Required: true + # Position: 1 + # exampleOptionsValue: + # Type: select + # FormFieldTitle: "" + # FormFieldDescription: "" + # Required: true + # Position: 1 + # Options: + # red: {} + # blue: {} + # yellow: {} + + # Use "UserProfileFormMessage to configure the message you want + # to display on the profile page. + UserProfileFormMessage: 'Welcome to Arvados. All required fields must be completed before you can proceed.' + + # Mimetypes of applications for which the view icon + # would be enabled in a collection's show page. + # It is sufficient to list only applications here. + # No need to list text and image types. + ApplicationMimetypesWithViewIcon: + cwl: {} + fasta: {} + go: {} + javascript: {} + json: {} + pdf: {} + python: {} + x-python: {} + r: {} + rtf: {} + sam: {} + x-sh: {} + vnd.realvnc.bed: {} + xml: {} + xsl: {} + SAMPLE: {} + + # The maximum number of bytes to load in the log viewer + LogViewerMaxBytes: 1M + + # When anonymous_user_token is configured, show public projects page + EnablePublicProjectsPage: true + + # By default, disable the "Getting Started" popup which is specific to Arvados playground + EnableGettingStartedPopup: false + + # Ask Arvados API server to compress its response payloads. + APIResponseCompression: true + + # Timeouts for API requests. + APIClientConnectTimeout: 2m + APIClientReceiveTimeout: 5m + + # Maximum number of historic log records of a running job to fetch + # and display in the Log tab, while subscribing to web sockets. + RunningJobLogRecordsToFetch: 2000 + + # In systems with many shared projects, loading of dashboard and topnav + # cab be slow due to collections indexing; use the following parameters + # to suppress these properties + ShowRecentCollectionsOnDashboard: true + ShowUserNotifications: true + + # Enable/disable "multi-site search" in top nav ("true"/"false"), or + # a link to the multi-site search page on a "home" Workbench site. + # + # Example: + # https://workbench.qr1hi.arvadosapi.com/collections/multisite + MultiSiteSearch: "" + + # Should workbench allow management of local git repositories? Set to false if + # the jobs api is disabled and there are no local git repositories. + Repositories: true + + SiteName: Arvados Workbench + ProfilingEnabled: false + + # This is related to obsolete Google OpenID 1.0 login + # but some workbench stuff still expects it to be set. + DefaultOpenIdPrefix: "https://www.google.com/accounts/o8/id" + + # Workbench2 configs + VocabularyURL: "" + FileViewersConfigURL: "" + + # Use experimental controller code (see https://dev.arvados.org/issues/14287) + EnableBetaController14287: false `)