Skip to content

Commit

Permalink
Improve google pipelines docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pditommaso committed Jun 27, 2019
1 parent 8fb1390 commit aed407e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/google.rst
Expand Up @@ -308,7 +308,7 @@ instances may be utilized using the ``machineType`` directive

Examples::

process custom_instance_using_cpus_and_memory {
process custom_resources_task {
cpus 8
memory '40 GB'

Expand All @@ -317,16 +317,16 @@ Examples::
"""
}

process predefined_instance_overrides_cpus_and_memory {
cpus 8
memory '40 GB'
process predefined_resources_task {
machineType 'n1-highmem-8'

"""
<Your script here>
"""
}

.. note:: This feature requires Nextflow 19.07.0 or later.

Pipeline execution
------------------

Expand Down
9 changes: 6 additions & 3 deletions docs/process.rst
Expand Up @@ -1559,19 +1559,22 @@ This can be defined in the ``nextflow.config`` file as shown below::
.. _process-machineType:

machineType
---------
-----------

The ``machineType`` can be used to specify a predefined Google Compute Platform `machine type <https://cloud.google.com/compute/docs/machine-types>`_
when running using the google-pipelines executor.
when running using the :ref:`Google Pipeline <google-pipelines>` executor.

This directive is optional and if specified overrides the cpus and memory directives::

process googlePipelinesPredefinedMachineType {
process foo {
machineType 'n1-highmem-8'

"""
<your script here>
"""
}

.. note:: This feature requires Nextflow 19.07.0 or later.

See also: `cpus`_ and `memory`_.

Expand Down

0 comments on commit aed407e

Please sign in to comment.