Skip to content

Commit

Permalink
Website publish
Browse files Browse the repository at this point in the history
  • Loading branch information
@arcalot-bot
arcalot-bot committed May 28, 2024
1 parent e952ffe commit 7e8a9ce
Show file tree
Hide file tree
Showing 12 changed files with 2,098 additions and 58 deletions.
67 changes: 64 additions & 3 deletions arcaflow/workflows/expressions/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../../../arcalot.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.21">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">



<title>Expressions - Arcalot</title>



<link rel="stylesheet" href="../../../assets/stylesheets/main.66ac8b77.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.6543a935.min.css">


<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -1735,6 +1735,15 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#binding-constants" class="md-nav__link">
<span class="md-ellipsis">
Binding Constants
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -2329,6 +2338,11 @@ <h2 id="functions">Functions</h2>
<td>string</td>
<td>Returns the contents of a file as a UTF-8 character string, given a file path string. Relative file paths are resolved from the Arcaflow process working directory. Shell environment variables are not expanded.</td>
</tr>
<tr>
<td><code>bindConstants(list[any], any)</code></td>
<td>list[object]</td>
<td>Returns a list of objects each containing two properties: an <code>item</code> property which contains the corresponding item from the list in the first parameter; and, a <code>constant</code> property which contains the value of the second input parameter. The output list items will have a generated schema name as described in <a href="../schemas/#generated-combined-schema-names">Generated Schema Names</a>. For usage see <a href="./#binding-constants">this example</a>.</td>
</tr>
</tbody>
</table>
<p>A function is used in an expression by referencing its name followed by a comma-separated list of zero or more argument
Expand Down Expand Up @@ -2635,6 +2649,53 @@ <h3 id="passing-between-steps">Passing between steps</h3>
<span class="w"> </span><span class="nt">some</span><span class="p">:</span>
<span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="kt">!expr</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">$.steps.step_a.outputs.success.some_value</span>
</code></pre></div>
<h3 id="binding-constants">Binding Constants</h3>
<div class="highlight"><span class="filename">input.yaml</span><pre><span></span><code><span class="nt">repeated_inputs</span><span class="p">:</span><span class="w"> </span>
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">mogo</span>
<span class="nt">varying_inputs</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">cpu_load</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">cpu_load</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">20</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">cpu_load</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">40</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">cpu_load</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">60</span>
</code></pre></div>
<div class="highlight"><span class="filename">workflow.yaml</span><pre><span></span><code><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v0.2.0</span>
<span class="nt">input</span><span class="p">:</span>
<span class="w"> </span><span class="nt">root</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RootObject</span>
<span class="w"> </span><span class="nt">objects</span><span class="p">:</span>
<span class="w"> </span><span class="nt">RootObject</span><span class="p">:</span>
<span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RootObject</span>
<span class="w"> </span><span class="nt">properties</span><span class="p">:</span>
<span class="w"> </span><span class="nt">repeated_inputs</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ref</span>
<span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RepeatedValues</span>
<span class="w"> </span><span class="nt">varying_inputs</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">list</span>
<span class="w"> </span><span class="nt">items</span><span class="p">:</span>
<span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SubRootObject</span>
<span class="w"> </span><span class="nt">type_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ref</span>
<span class="w"> </span><span class="nt">RepeatedValues</span><span class="p">:</span>
<span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">RepeatedValues</span>
<span class="w"> </span><span class="nt">properties</span><span class="p">:</span>
<span class="w"> </span><span class="nt">hostname</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">string</span>
<span class="w"> </span><span class="nt">SubRootObject</span><span class="p">:</span>
<span class="w"> </span><span class="nt">id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SubRootObject</span>
<span class="w"> </span><span class="nt">properties</span><span class="p">:</span>
<span class="w"> </span><span class="nt">cpu_load</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type</span><span class="p">:</span>
<span class="w"> </span><span class="nt">type_id</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">integer</span><span class="w"> </span>

<span class="nt">steps</span><span class="p">:</span>
<span class="w"> </span><span class="nt">example</span><span class="p">:</span>
<span class="w"> </span><span class="nt">plugin</span><span class="p">:</span>
<span class="w"> </span><span class="nt">deployment_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">image</span><span class="w"> </span>
<span class="w"> </span><span class="nt">src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">quay.io/some/container/image</span>
<span class="w"> </span><span class="nt">input</span><span class="p">:</span><span class="w"> </span><span class="kt">!expr</span><span class="w"> </span><span class="s">&#39;bindConstants($.input.varying_inputs,</span><span class="nv"> </span><span class="s">$.input.repeated_inputs)&#39;</span>
</code></pre></div>
<p>In this case, we do not need to know the schema name of the type output generated by <code>bindConstants()</code>. If you need to reference the schema of the list items returned by <code>bindConstants()</code>, see <a href="../schemas/#generated-combined-schema-names">Generated Schema Name</a>.</p>



Expand Down Expand Up @@ -2699,7 +2760,7 @@ <h3 id="passing-between-steps">Passing between steps</h3>
<script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.indexes", "toc.integrate", "search.suggest", "search.highlight", "search.share", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../../assets/javascripts/bundle.a7c05c9e.min.js"></script>
<script src="../../../assets/javascripts/bundle.081f42fc.min.js"></script>


</body>
Expand Down
Loading

0 comments on commit 7e8a9ce

Please sign in to comment.