Skip to main content

google

The google scope controls the interactions with Google Cloud, including Google Cloud Batch and Google Cloud Storage.

google.enableRequesterPaysBuckets​

Use the given Google Cloud project ID as the billing project for storage access (default: false). Required when accessing data from requester pays buckets.

google.httpConnectTimeout​
Added in version 23.10

The HTTP connection timeout for Cloud Storage API requests (default: '60s').

google.httpReadTimeout​
Added in version 23.10

The HTTP read timeout for Cloud Storage API requests (default: '60s').

google.location​

The Google Cloud location where jobs are executed (default: us-central1).

google.project​

The Google Cloud project ID to use for pipeline execution.

google.batch.allowedLocations​

The set of allowed locations for VMs to be provisioned (default: no restriction).

google.batch.autoRetryExitCodes​
Added in version 24.10

The list of exit codes that should be automatically retried by Google Batch when google.batch.maxSpotAttempts is greater than 0 (default: [50001]). See Google Batch documentation for the complete list of retryable exit codes.

google.batch.bootDiskImage​
Added in version 24.10

The image URI of the virtual machine boot disk, e.g batch-debian (default: none). See Google documentation for details.

google.batch.bootDiskSize​

The size of the virtual machine boot disk, e.g 50.GB (default: none).

google.batch.cpuPlatform​

The minimum CPU Platform, e.g. 'Intel Skylake' (default: none).

google.batch.gcsfuseOptions​
Added in version 25.04

List of custom mount options for gcsfuse (default: ['-o rw', '-implicit-dirs']).

google.batch.installOpsAgent​

Enables Ops Agent installation on Google Batch instances for enhanced monitoring and logging (default: false). See the Google Batch documentation for details.

note

The Ops Agent requires a compatible boot disk image. For Google Batch, use Batch-debian images (e.g., batch-debian) with google.batch.bootDiskImage. The default Container-Optimized OS (batch-cos) is not compatible with the Ops Agent.

google.batch.logsPath​
Added in version 26.04

The Google Cloud Storage path where job logs should be stored, e.g. gs://my-logs-bucket/logs. When specified, Google Batch will write job logs to this location instead of Cloud Logging. The bucket must be accessible and writable by the service account.

google.batch.maxSpotAttempts​
Added in version 24.10

The default value was changed from 5 to 0.

Max number of execution attempts of a job interrupted by a Compute Engine Spot reclaim event (default: 0). See alsogoogle.batch.autoRetryExitCodes

google.batch.network​

The URL of an existing network resource to which the VM will be attached.

You can specify the network as a full or partial URL. For example, the following are all valid URLs:

  • https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}
  • projects/{project}/global/networks/{network}
  • global/networks/{network}
google.batch.networkTags​

The network tags to be applied to the instances created by Google Batch jobs (e.g., ['allow-ssh', 'allow-http']). Network tags are ignored when using instance templates.

google.batch.serviceAccountEmail​

The Google service account email to use for the pipeline execution. If not specified, the default Compute Engine service account for the project will be used.

The service account must have the IAM roles listed in the Google Cloud Batch documentation for Nextflow. Without these roles, Cloud Batch jobs stay in the SCHEDULED state and never run.

This service account will only be used for tasks submitted by Nextflow, not for Nextflow itself. See Credentials for more information on Google Cloud credentials.

google.batch.spot​

Enable the use of spot virtual machines (default: false).

google.batch.subnetwork​

The URL of an existing subnetwork resource in the network to which the VM will be attached.

You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:

  • https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork}
  • projects/{project}/regions/{region}/subnetworks/{subnetwork}
  • regions/{region}/subnetworks/{subnetwork}
google.batch.usePrivateAddress​

Do not provision public IP addresses for VMs, such that they only have an internal IP address (default: false). When this option is enabled, jobs can only load Docker images from Google Container Registry, and cannot use external services other than Google APIs.

google.storage.retryPolicy.maxAttempts​
Added in version 24.10

Max attempts when retrying failed API requests to Cloud Storage (default: 10).

google.storage.retryPolicy.maxDelay​
Added in version 24.10

Max delay when retrying failed API requests to Cloud Storage (default: '90s').

google.storage.retryPolicy.multiplier​
Added in version 24.10

Delay multiplier when retrying failed API requests to Cloud Storage (default: 2.0).

On this Page