Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.3 / _api / airflow / contrib / operators / azure_container_instances_operator / index.html
blob: 2abce166d2c464d2e3db44a7b6f14078665c280a [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>airflow.contrib.operators.azure_container_instances_operator &mdash; Airflow Documentation</title>
<script type="text/javascript" src="../../../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></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/language_data.js"></script>
<script type="text/javascript" src="../../../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../../search.html" />
<link rel="next" title="airflow.contrib.operators.azure_cosmos_operator" href="../azure_cosmos_operator/index.html" />
<link rel="prev" title="airflow.contrib.operators.awsbatch_operator" href="../awsbatch_operator/index.html" />
<script>
document.addEventListener('DOMContentLoaded', function() {
var el = document.getElementById('changelog');
if (el !== null ) {
// [AIRFLOW-...]
el.innerHTML = el.innerHTML.replace(
/\[(AIRFLOW-[\d]+)\]/g,
`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
);
// (#...)
el.innerHTML = el.innerHTML.replace(
/\(#([\d]+)\)/g,
`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
);
};
})
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<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"> Airflow
</a>
<div class="version">
1.10.3
</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../howto/index.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../cli.html">Command Line Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../api.html">Experimental Rest API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../kubernetes.html">Kubernetes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../macros.html">Macros reference</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">API Reference</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#operators">Operators</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="../../../../index.html#baseoperator">BaseOperator</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../../../index.html#basesensoroperator">BaseSensorOperator</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#operators-packages">Operators packages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="../../../operators/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.operators</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.sensors</span></code></a></li>
<li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.sensors</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#core-and-community-package">Core and community package</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../../index.html">Airflow</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><a href="../../../../index.html">API Reference</a> &raquo;</li>
<li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators</span></code></a> &raquo;</li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators.azure_container_instances_operator</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../../_sources/_api/airflow/contrib/operators/azure_container_instances_operator/index.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-airflow.contrib.operators.azure_container_instances_operator">
<span id="airflow-contrib-operators-azure-container-instances-operator"></span><h1><a class="reference internal" href="#module-airflow.contrib.operators.azure_container_instances_operator" title="airflow.contrib.operators.azure_container_instances_operator"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators.azure_container_instances_operator</span></code></a><a class="headerlink" href="#module-airflow.contrib.operators.azure_container_instances_operator" title="Permalink to this headline"></a></h1>
<div class="section" id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline"></a></h2>
<dl class="data">
<dt id="airflow.contrib.operators.azure_container_instances_operator.Volume">
<code class="descclassname">airflow.contrib.operators.azure_container_instances_operator.</code><code class="descname">Volume</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#Volume"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.Volume" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.operators.azure_container_instances_operator.DEFAULT_ENVIRONMENT_VARIABLES">
<code class="descclassname">airflow.contrib.operators.azure_container_instances_operator.</code><code class="descname">DEFAULT_ENVIRONMENT_VARIABLES</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#DEFAULT_ENVIRONMENT_VARIABLES"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.DEFAULT_ENVIRONMENT_VARIABLES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.operators.azure_container_instances_operator.DEFAULT_VOLUMES">
<code class="descclassname">airflow.contrib.operators.azure_container_instances_operator.</code><code class="descname">DEFAULT_VOLUMES</code><em class="property"> = []</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#DEFAULT_VOLUMES"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.DEFAULT_VOLUMES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.operators.azure_container_instances_operator.DEFAULT_MEMORY_IN_GB">
<code class="descclassname">airflow.contrib.operators.azure_container_instances_operator.</code><code class="descname">DEFAULT_MEMORY_IN_GB</code><em class="property"> = 2.0</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#DEFAULT_MEMORY_IN_GB"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.DEFAULT_MEMORY_IN_GB" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.operators.azure_container_instances_operator.DEFAULT_CPU">
<code class="descclassname">airflow.contrib.operators.azure_container_instances_operator.</code><code class="descname">DEFAULT_CPU</code><em class="property"> = 1.0</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#DEFAULT_CPU"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.DEFAULT_CPU" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator">
<em class="property">class </em><code class="descclassname">airflow.contrib.operators.azure_container_instances_operator.</code><code class="descname">AzureContainerInstancesOperator</code><span class="sig-paren">(</span><em>ci_conn_id</em>, <em>registry_conn_id</em>, <em>resource_group</em>, <em>name</em>, <em>image</em>, <em>region</em>, <em>environment_variables=None</em>, <em>volumes=None</em>, <em>memory_in_gb=None</em>, <em>cpu=None</em>, <em>command=None</em>, <em>remove_on_error=True</em>, <em>fail_if_exists=True</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#AzureContainerInstancesOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator" title="Permalink to this definition"></a></dt>
<dd><p>Bases:<a class="reference internal" href="../../../models/index.html#airflow.models.BaseOperator" title="airflow.models.BaseOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.BaseOperator</span></code></a></p>
<p>Start a container on Azure Container Instances</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ci_conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – connection id of a service principal which will be used
to start the container instance</p></li>
<li><p><strong>registry_conn_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – connection id of a user which can login to a
private docker registry. If None, we assume a public registry</p></li>
<li><p><strong>resource_group</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – name of the resource group wherein this container
instance should be started</p></li>
<li><p><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – name of this container instance. Please note this name has
to be unique in order to run containers in parallel.</p></li>
<li><p><strong>image</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the docker image to be used</p></li>
<li><p><strong>region</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the region wherein this container instance should be started</p></li>
<li><p><strong>environment_variables</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – key,value pairs containing environment
variables which will be passed to the running container</p></li>
<li><p><strong>volumes</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a><em>[</em><em>&lt;conn_id</em><em>, </em><em>account_name</em><em>, </em><em>share_name</em><em>, </em><em>mount_path</em><em>, </em><em>read_only&gt;</em><em>]</em>) – list of volumes to be mounted to the container.
Currently only Azure Fileshares are supported.</p></li>
<li><p><strong>memory_in_gb</strong> (<em>double</em>) – the amount of memory to allocate to this container</p></li>
<li><p><strong>cpu</strong> (<em>double</em>) – the number of cpus to allocate to this container</p></li>
<li><p><strong>command</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – the command to run inside the container</p></li>
</ul>
</dd>
<dt class="field-even">Example</dt>
<dd class="field-even"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span> <span class="n">a</span> <span class="o">=</span> <span class="n">AzureContainerInstancesOperator</span><span class="p">(</span>
<span class="go"> &#39;azure_service_principal&#39;,</span>
<span class="go"> &#39;azure_registry_user&#39;,</span>
<span class="go"> &#39;my-resource-group&#39;,</span>
<span class="go"> &#39;my-container-name-{{ ds }}&#39;,</span>
<span class="go"> &#39;myprivateregistry.azurecr.io/my_container:latest&#39;,</span>
<span class="go"> &#39;westeurope&#39;,</span>
<span class="go"> {&#39;EXECUTION_DATE&#39;: &#39;{{ ds }}&#39;},</span>
<span class="go"> [(&#39;azure_wasb_conn_id&#39;,</span>
<span class="go"> &#39;my_storage_container&#39;,</span>
<span class="go"> &#39;my_fileshare&#39;,</span>
<span class="go"> &#39;/input-data&#39;,</span>
<span class="go"> True),],</span>
<span class="go"> memory_in_gb=14.0,</span>
<span class="go"> cpu=4.0,</span>
<span class="go"> command=&#39;python /app/myfile.py&#39;,</span>
<span class="go"> task_id=&#39;start_container&#39;</span>
<span class="go"> )</span>
</pre></div>
</div>
<dl class="attribute">
<dt id="airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator.template_fields">
<code class="descname">template_fields</code><em class="property"> = ['name', 'environment_variables']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#AzureContainerInstancesOperator.template_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator.template_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator.execute">
<code class="descname">execute</code><span class="sig-paren">(</span><em>self</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#AzureContainerInstancesOperator.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator.execute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator._monitor_logging">
<code class="descname">_monitor_logging</code><span class="sig-paren">(</span><em>self</em>, <em>ci_hook</em>, <em>resource_group</em>, <em>name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#AzureContainerInstancesOperator._monitor_logging"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator._monitor_logging" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator._log_last">
<code class="descname">_log_last</code><span class="sig-paren">(</span><em>self</em>, <em>logs</em>, <em>last_line_logged</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/azure_container_instances_operator.html#AzureContainerInstancesOperator._log_last"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.azure_container_instances_operator.AzureContainerInstancesOperator._log_last" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../azure_cosmos_operator/index.html" class="btn btn-neutral float-right" title="airflow.contrib.operators.azure_cosmos_operator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../awsbatch_operator/index.html" class="btn btn-neutral float-left" title="airflow.contrib.operators.awsbatch_operator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>