blob: a9d0d938daf1ae7c46d32019b7bea9e6995f4476 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>aria.orchestrator.workflows.executor &mdash; ARIA TOSCA 0.1.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="ARIA TOSCA 0.1.1 documentation" href="index.html"/>
<link rel="next" title="aria.parser" href="aria.parser.html"/>
<link rel="prev" title="aria.orchestrator.workflows.builtin" href="aria.orchestrator.workflows.builtin.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> ARIA TOSCA
</a>
<div class="version">
0.1.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="cli.html">CLI</a></li>
<li class="toctree-l1"><a class="reference internal" href="rest.html">REST</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="aria.html"><code class="docutils literal"><span class="pre">aria</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.cli.html"><code class="docutils literal"><span class="pre">aria.cli</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.modeling.html"><code class="docutils literal"><span class="pre">aria.modeling</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.modeling.models.html"><code class="docutils literal"><span class="pre">aria.modeling.models</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.html"><code class="docutils literal"><span class="pre">aria.orchestrator</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.context.html"><code class="docutils literal"><span class="pre">aria.orchestrator.context</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ctx_proxy.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ctx_proxy</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ssh.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ssh</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.api.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.api</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.builtin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.builtin</span></code></a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.base"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor.base</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.celery"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor.celery</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.dry"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor.dry</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.process"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor.process</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.thread"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor.thread</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="aria.parser.html"><code class="docutils literal"><span class="pre">aria.parser</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.parser.consumption.html"><code class="docutils literal"><span class="pre">aria.parser.consumption</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.parser.loading.html"><code class="docutils literal"><span class="pre">aria.parser.loading</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.parser.modeling.html"><code class="docutils literal"><span class="pre">aria.parser.modeling</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.parser.presentation.html"><code class="docutils literal"><span class="pre">aria.parser.presentation</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.parser.reading.html"><code class="docutils literal"><span class="pre">aria.parser.reading</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.parser.validation.html"><code class="docutils literal"><span class="pre">aria.parser.validation</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.storage.html"><code class="docutils literal"><span class="pre">aria.storage</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria.utils.html"><code class="docutils literal"><span class="pre">aria.utils</span></code></a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.modeling.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.modeling</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.presentation.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.presentation</span></code></a></li>
<li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_nfv_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_nfv_v1_0</span></code></a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">ARIA TOSCA</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/aria.orchestrator.workflows.executor.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-aria.orchestrator.workflows.executor">
<span id="aria-orchestrator-workflows-executor"></span><h1><a class="reference internal" href="#module-aria.orchestrator.workflows.executor" title="aria.orchestrator.workflows.executor"><code class="xref py py-mod docutils literal"><span class="pre">aria.orchestrator.workflows.executor</span></code></a><a class="headerlink" href="#module-aria.orchestrator.workflows.executor" title="Permalink to this headline"></a></h1>
<p>Task executors.</p>
<div class="section" id="module-aria.orchestrator.workflows.executor.base">
<span id="aria-orchestrator-workflows-executor-base"></span><h2><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.base" title="aria.orchestrator.workflows.executor.base"><code class="xref py py-mod docutils literal"><span class="pre">aria.orchestrator.workflows.executor.base</span></code></a><a class="headerlink" href="#module-aria.orchestrator.workflows.executor.base" title="Permalink to this headline"></a></h2>
<p>Base class for task executors.</p>
<dl class="class">
<dt id="aria.orchestrator.workflows.executor.base.BaseExecutor">
<em class="property">class </em><code class="descclassname">aria.orchestrator.workflows.executor.base.</code><code class="descname">BaseExecutor</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.base.BaseExecutor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="aria.html#aria.logger.LoggerMixin" title="aria.logger.LoggerMixin"><code class="xref py py-class docutils literal"><span class="pre">aria.logger.LoggerMixin</span></code></a></p>
<p>Base class for task executors.</p>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.base.BaseExecutor.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.base.BaseExecutor.close" title="Permalink to this definition"></a></dt>
<dd><p>Closes the executor.</p>
</dd></dl>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.base.BaseExecutor.execute">
<code class="descname">execute</code><span class="sig-paren">(</span><em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.base.BaseExecutor.execute" title="Permalink to this definition"></a></dt>
<dd><p>Executes a task.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>task</strong> – task to execute</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.base.BaseExecutor.terminate">
<code class="descname">terminate</code><span class="sig-paren">(</span><em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.base.BaseExecutor.terminate" title="Permalink to this definition"></a></dt>
<dd><p>Terminate the executing task
:return:</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="aria.orchestrator.workflows.executor.base.StubTaskExecutor">
<em class="property">class </em><code class="descclassname">aria.orchestrator.workflows.executor.base.</code><code class="descname">StubTaskExecutor</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.base.StubTaskExecutor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#aria.orchestrator.workflows.executor.base.BaseExecutor" title="aria.orchestrator.workflows.executor.base.BaseExecutor"><code class="xref py py-class docutils literal"><span class="pre">aria.orchestrator.workflows.executor.base.BaseExecutor</span></code></a></p>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.base.StubTaskExecutor.execute">
<code class="descname">execute</code><span class="sig-paren">(</span><em>ctx</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.base.StubTaskExecutor.execute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-aria.orchestrator.workflows.executor.celery">
<span id="aria-orchestrator-workflows-executor-celery"></span><h2><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.celery" title="aria.orchestrator.workflows.executor.celery"><code class="xref py py-mod docutils literal"><span class="pre">aria.orchestrator.workflows.executor.celery</span></code></a><a class="headerlink" href="#module-aria.orchestrator.workflows.executor.celery" title="Permalink to this headline"></a></h2>
<p>Celery task executor.</p>
<dl class="class">
<dt id="aria.orchestrator.workflows.executor.celery.CeleryExecutor">
<em class="property">class </em><code class="descclassname">aria.orchestrator.workflows.executor.celery.</code><code class="descname">CeleryExecutor</code><span class="sig-paren">(</span><em>app</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.celery.CeleryExecutor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#aria.orchestrator.workflows.executor.base.BaseExecutor" title="aria.orchestrator.workflows.executor.base.BaseExecutor"><code class="xref py py-class docutils literal"><span class="pre">aria.orchestrator.workflows.executor.base.BaseExecutor</span></code></a></p>
<p>Celery task executor.</p>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.celery.CeleryExecutor.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.celery.CeleryExecutor.close" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-aria.orchestrator.workflows.executor.dry">
<span id="aria-orchestrator-workflows-executor-dry"></span><h2><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.dry" title="aria.orchestrator.workflows.executor.dry"><code class="xref py py-mod docutils literal"><span class="pre">aria.orchestrator.workflows.executor.dry</span></code></a><a class="headerlink" href="#module-aria.orchestrator.workflows.executor.dry" title="Permalink to this headline"></a></h2>
<p>Dry task executor.</p>
<dl class="class">
<dt id="aria.orchestrator.workflows.executor.dry.DryExecutor">
<em class="property">class </em><code class="descclassname">aria.orchestrator.workflows.executor.dry.</code><code class="descname">DryExecutor</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.dry.DryExecutor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#aria.orchestrator.workflows.executor.base.BaseExecutor" title="aria.orchestrator.workflows.executor.base.BaseExecutor"><code class="xref py py-class docutils literal"><span class="pre">aria.orchestrator.workflows.executor.base.BaseExecutor</span></code></a></p>
<p>Dry task executor: prints task information without causing any side effects.</p>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.dry.DryExecutor.execute">
<code class="descname">execute</code><span class="sig-paren">(</span><em>ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.dry.DryExecutor.execute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-aria.orchestrator.workflows.executor.process">
<span id="aria-orchestrator-workflows-executor-process"></span><h2><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.process" title="aria.orchestrator.workflows.executor.process"><code class="xref py py-mod docutils literal"><span class="pre">aria.orchestrator.workflows.executor.process</span></code></a><a class="headerlink" href="#module-aria.orchestrator.workflows.executor.process" title="Permalink to this headline"></a></h2>
<p>Sub-process task executor.</p>
<dl class="class">
<dt id="aria.orchestrator.workflows.executor.process.ProcessExecutor">
<em class="property">class </em><code class="descclassname">aria.orchestrator.workflows.executor.process.</code><code class="descname">ProcessExecutor</code><span class="sig-paren">(</span><em>plugin_manager=None</em>, <em>python_path=None</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.process.ProcessExecutor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#aria.orchestrator.workflows.executor.base.BaseExecutor" title="aria.orchestrator.workflows.executor.base.BaseExecutor"><code class="xref py py-class docutils literal"><span class="pre">aria.orchestrator.workflows.executor.base.BaseExecutor</span></code></a></p>
<p>Sub-process task executor.</p>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.process.ProcessExecutor.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.process.ProcessExecutor.close" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.process.ProcessExecutor.terminate">
<code class="descname">terminate</code><span class="sig-paren">(</span><em>task_id</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.process.ProcessExecutor.terminate" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-aria.orchestrator.workflows.executor.thread">
<span id="aria-orchestrator-workflows-executor-thread"></span><h2><a class="reference internal" href="#module-aria.orchestrator.workflows.executor.thread" title="aria.orchestrator.workflows.executor.thread"><code class="xref py py-mod docutils literal"><span class="pre">aria.orchestrator.workflows.executor.thread</span></code></a><a class="headerlink" href="#module-aria.orchestrator.workflows.executor.thread" title="Permalink to this headline"></a></h2>
<p>Thread task executor.</p>
<dl class="class">
<dt id="aria.orchestrator.workflows.executor.thread.ThreadExecutor">
<em class="property">class </em><code class="descclassname">aria.orchestrator.workflows.executor.thread.</code><code class="descname">ThreadExecutor</code><span class="sig-paren">(</span><em>pool_size=1</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.thread.ThreadExecutor" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#aria.orchestrator.workflows.executor.base.BaseExecutor" title="aria.orchestrator.workflows.executor.base.BaseExecutor"><code class="xref py py-class docutils literal"><span class="pre">aria.orchestrator.workflows.executor.base.BaseExecutor</span></code></a></p>
<p>Thread task executor.</p>
<p>It’s easier writing tests using this executor rather than the full-blown sub-process executor.</p>
<p>Note: This executor is incapable of running plugin operations.</p>
<dl class="method">
<dt id="aria.orchestrator.workflows.executor.thread.ThreadExecutor.close">
<code class="descname">close</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#aria.orchestrator.workflows.executor.thread.ThreadExecutor.close" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="aria.parser.html" class="btn btn-neutral float-right" title="aria.parser" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="aria.orchestrator.workflows.builtin.html" class="btn btn-neutral" title="aria.orchestrator.workflows.builtin" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2016-2017, Apache Software Foundation.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1.1',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>