doc/api/methods/pipeline_templates.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "pipeline_templates"
   6
   7 ...
   8 {% comment %}
   9 Copyright (C) The Arvados Authors. All rights reserved.
  10
  11 SPDX-License-Identifier: CC-BY-SA-3.0
  12 {% endcomment %}
  13
  14 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/pipeline_templates@
  15
  16 Object type: @p5p6p@
  17
  18 Example UUID: @zzzzz-p5p6p-0123456789abcde@
  19
  20 h2. Resource
  21
  22 Deprecated.  A pipeline template is a collection of jobs that can be instantiated as a pipeline_instance.
  23
  24 Each PipelineTemplate has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  25
  26 table(table table-bordered table-condensed).
  27 |_. Attribute|_. Type|_. Description|_. Example|
  28 |name|string|||
  29 |components|hash|||
  30
  31 The pipeline template consists of "name" and "components".
  32
  33 table(table table-bordered table-condensed).
  34 |_. Attribute    |_. Type |_. Accepted values                           |_. Required|_. Description|
  35 |name            |string  |any                                          |yes        |The human-readable name of the pipeline template.|
  36 |components      |object  |JSON object containing job submission objects|yes        |The component jobs that make up the pipeline, with the component name as the key. |
  37
  38 h3. Components
  39
  40 The components field of the pipeline template is a JSON object which describes the individual steps that make up the pipeline.  Each component is an Arvados job submission.  "Parameters for job submissions are described on the job method page.":{{site.baseurl}}/api/methods/jobs.html#create  In addition, a component can have the following parameters:
  41
  42 table(table table-bordered table-condensed).
  43 |_. Attribute    |_. Type          |_. Accepted values |_. Required|_. Description|
  44 |output_name     |string or boolean|string or false    |no         |If a string is provided, use this name for the output collection of this component.  If the value is false, do not create a permanent output collection (an temporary intermediate collection will still be created).  If not provided, a default name will be assigned to the output.|
  45
  46 h3. Script parameters
  47
  48 When used in a pipeline, each parameter in the 'script_parameters' attribute of a component job can specify that the input parameter must be supplied by the user, or the input parameter should be linked to the output of another component.  To do this, the value of the parameter should be JSON object containing one of the following attributes:
  49
  50 table(table table-bordered table-condensed).
  51 |_. Attribute    |_. Type |_. Accepted values                               |_. Description|
  52 |default         |any     |any                                              |The default value for this parameter.|
  53 |required        |boolean |true or false                                    |Specifies whether the parameter is required to have a value or not.|
  54 |dataclass       |string  |One of 'Collection', 'File' [1], 'number', or 'text' |Data type of this parameter.|
  55 |search_for      |string  |any string                                       |Substring to use as a default search string when choosing inputs.|
  56 |output_of       |string  |the name of another component in the pipeline    |Specifies that the value of this parameter should be set to the 'output' attribute of the job that corresponds to the specified component.|
  57 |title           |string  |any string                                       |User friendly title to display when choosing parameter values|
  58 |description     |string  |any string                                       |Extended text description for describing expected/valid values for the script parameter|
  59 |link_name       |string  |any string                                       |User friendly name to display for the parameter value instead of the actual parameter value|
  60
  61 The 'output_of' parameter is especially important, as this is how components are actually linked together to form a pipeline.  Component jobs that depend on the output of other components do not run until the parent job completes and has produced output.  If the parent job fails, the entire pipeline fails.
  62
  63 fn1. The 'File' type refers to a specific file within a Keep collection in the form 'collection_hash/filename', for example '887cd41e9c613463eab2f0d885c6dd96+83/bob.txt'.
  64
  65 The 'search_for' parameter is meaningful only when input dataclass of type Collection or File is used. If a value is provided, this will be preloaded into the input data chooser dialog in Workbench. For example, if your input dataclass is a File and you are interested in a certain filename extention, you can preconfigure it in this attribute.
  66
  67 h3. Examples
  68
  69 This is a pipeline named "Filter MD5 hash values" with two components, "do_hash" and "filter".  The "input" script parameter of the "do_hash" component is required to be filled in by the user, and the expected data type is "Collection".  This also specifies that the "input" script parameter of the "filter" component is the output of "do_hash", so "filter" will not run until "do_hash" completes successfully.  When the pipeline runs, past jobs that meet the criteria described above may be substituted for either or both components to avoid redundant computation.
  70
  71 <notextile><pre>
  72 {
  73   "name": "Filter MD5 hash values",
  74   "components": {
  75     "do_hash": {
  76       "script": "hash.py",
  77       "repository": "<b>you</b>/<b>you</b>",
  78       "script_version": "master",
  79       "script_parameters": {
  80         "input": {
  81           "required": true,
  82           "dataclass": "Collection",
  83           "search_for": ".fastq.gz",
  84           "title":"Please select a fastq file"
  85         }
  86       },
  87     },
  88     "filter": {
  89       "script": "0-filter.py",
  90       "repository": "<b>you</b>/<b>you</b>",
  91       "script_version": "master",
  92       "script_parameters": {
  93         "input": {
  94           "output_of": "do_hash"
  95         }
  96       },
  97     }
  98   }
  99 }
 100 </pre></notextile>
 101
 102 This pipeline consists of three components.  The components "thing1" and "thing2" both depend on "cat_in_the_hat".  Once the "cat_in_the_hat" job is complete, both "thing1" and "thing2" can run in parallel, because they do not depend on each other.
 103
 104 <notextile><pre>
 105 {
 106   "name": "Wreck the house",
 107   "components": {
 108     "cat_in_the_hat": {
 109       "script": "cat.py",
 110       "repository": "<b>you</b>/<b>you</b>",
 111       "script_version": "master",
 112       "script_parameters": { }
 113     },
 114     "thing1": {
 115       "script": "thing1.py",
 116       "repository": "<b>you</b>/<b>you</b>",
 117       "script_version": "master",
 118       "script_parameters": {
 119         "input": {
 120           "output_of": "cat_in_the_hat"
 121         }
 122       },
 123     },
 124     "thing2": {
 125       "script": "thing2.py",
 126       "repository": "<b>you</b>/<b>you</b>",
 127       "script_version": "master",
 128       "script_parameters": {
 129         "input": {
 130           "output_of": "cat_in_the_hat"
 131         }
 132       },
 133     },
 134   }
 135 }
 136 </pre></notextile>
 137
 138 This pipeline consists of three components.  The component "cleanup" depends on "thing1" and "thing2".  Both "thing1" and "thing2" are started immediately and can run in parallel, because they do not depend on each other, but "cleanup" cannot begin until both "thing1" and "thing2" have completed.
 139
 140 <notextile><pre>
 141 {
 142   "name": "Clean the house",
 143   "components": {
 144     "thing1": {
 145       "script": "thing1.py",
 146       "repository": "<b>you</b>/<b>you</b>",
 147       "script_version": "master",
 148       "script_parameters": { }
 149     },
 150     "thing2": {
 151       "script": "thing2.py",
 152       "repository": "<b>you</b>/<b>you</b>",
 153       "script_version": "master",
 154       "script_parameters": { }
 155     },
 156     "cleanup": {
 157       "script": "cleanup.py",
 158       "repository": "<b>you</b>/<b>you</b>",
 159       "script_version": "master",
 160       "script_parameters": {
 161         "mess1": {
 162           "output_of": "thing1"
 163         },
 164         "mess2": {
 165           "output_of": "thing2"
 166         }
 167       }
 168     }
 169   }
 170 }
 171 </pre></notextile>
 172
 173 h2. Methods
 174
 175 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
 176
 177 Required arguments are displayed in %{background:#ccffcc}green%.
 178
 179 h3. create
 180
 181 Create a new PipelineTemplate.
 182
 183 Arguments:
 184
 185 table(table table-bordered table-condensed).
 186 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 187 |pipeline_template|object||query||
 188
 189 h3. delete
 190
 191 Delete an existing PipelineTemplate.
 192
 193 Arguments:
 194
 195 table(table table-bordered table-condensed).
 196 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 197 {background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
 198
 199 h3. get
 200
 201 Gets a PipelineTemplate's metadata by UUID.
 202
 203 Arguments:
 204
 205 table(table table-bordered table-condensed).
 206 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 207 {background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
 208
 209 h3. list
 210
 211 List pipeline_templates.
 212
 213 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
 214
 215 h3. update
 216
 217 Update attributes of an existing PipelineTemplate.
 218
 219 Arguments:
 220
 221 table(table table-bordered table-condensed).
 222 |_. Argument |_. Type |_. Description |_. Location |_. Example |
 223 {background:#ccffcc}.|uuid|string|The UUID of the PipelineTemplate in question.|path||
 224 |pipeline_template|object||query||