3601 lines
250 KiB
HTML
3601 lines
250 KiB
HTML
|
||
|
||
<!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>pylorax.api package — Lorax 29.14 documentation</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<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="prev" title="pylorax package" href="pylorax.html" />
|
||
|
||
|
||
<script src="_static/js/modernizr.min.js"></script>
|
||
|
||
</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"> Lorax
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div class="version">
|
||
29.14
|
||
</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="intro.html">Introduction to Lorax</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="intro.html#before-lorax">Before Lorax</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="lorax.html">Lorax</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="livemedia-creator.html">livemedia-creator</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="lorax-composer.html">lorax-composer</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="composer-cli.html">composer-cli</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="product-images.html">Product and Updates Images</a></li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">src</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="composer.html">composer package</a></li>
|
||
<li class="toctree-l2 current"><a class="reference internal" href="pylorax.html">pylorax package</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="pylorax.html#subpackages">Subpackages</a><ul class="current">
|
||
<li class="toctree-l4 current"><a class="current reference internal" href="#">pylorax.api package</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#submodules">Submodules</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.base">pylorax.base module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.buildstamp">pylorax.buildstamp module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.cmdline">pylorax.cmdline module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.creator">pylorax.creator module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.decorators">pylorax.decorators module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.discinfo">pylorax.discinfo module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.dnfhelper">pylorax.dnfhelper module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.executils">pylorax.executils module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.imgutils">pylorax.imgutils module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.installer">pylorax.installer module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.ltmpl">pylorax.ltmpl module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.monitor">pylorax.monitor module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.mount">pylorax.mount module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.output">pylorax.output module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.sysutils">pylorax.sysutils module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.treebuilder">pylorax.treebuilder module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax.treeinfo">pylorax.treeinfo module</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="pylorax.html#module-pylorax">Module contents</a></li>
|
||
</ul>
|
||
</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">Lorax</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> »</li>
|
||
|
||
<li><a href="modules.html">src</a> »</li>
|
||
|
||
<li><a href="pylorax.html">pylorax package</a> »</li>
|
||
|
||
<li>pylorax.api package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="_sources/pylorax.api.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="pylorax-api-package">
|
||
<h1>pylorax.api package<a class="headerlink" href="#pylorax-api-package" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.checkparams">
|
||
<span id="pylorax-api-checkparams-module"></span><h2>pylorax.api.checkparams module<a class="headerlink" href="#module-pylorax.api.checkparams" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.checkparams.checkparams">
|
||
<code class="descclassname">pylorax.api.checkparams.</code><code class="descname">checkparams</code><span class="sig-paren">(</span><em>tuples</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/checkparams.html#checkparams"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.checkparams.checkparams" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.cmdline">
|
||
<span id="pylorax-api-cmdline-module"></span><h2>pylorax.api.cmdline module<a class="headerlink" href="#module-pylorax.api.cmdline" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.cmdline.lorax_composer_parser">
|
||
<code class="descclassname">pylorax.api.cmdline.</code><code class="descname">lorax_composer_parser</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/cmdline.html#lorax_composer_parser"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.cmdline.lorax_composer_parser" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the ArgumentParser for lorax-composer</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.compose">
|
||
<span id="pylorax-api-compose-module"></span><h2>pylorax.api.compose module<a class="headerlink" href="#module-pylorax.api.compose" title="Permalink to this headline">¶</a></h2>
|
||
<p>Setup for composing an image</p>
|
||
<div class="section" id="adding-new-output-types">
|
||
<h3>Adding New Output Types<a class="headerlink" href="#adding-new-output-types" title="Permalink to this headline">¶</a></h3>
|
||
<p>The new output type must add a kickstart template to ./share/composer/ where the
|
||
name of the kickstart (without the trailing .ks) matches the entry in compose_args.</p>
|
||
<p>The kickstart should not have any url or repo entries, these will be added at build
|
||
time. The %packages section should be the last thing, and while it can contain mandatory
|
||
packages required by the output type, it should not have the trailing %end because the
|
||
package NEVRAs will be appended to it at build time.</p>
|
||
<p>compose_args should have a name matching the kickstart, and it should set the novirt_install
|
||
parameters needed to generate the desired output. Other types should be set to False.</p>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.add_customizations">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">add_customizations</code><span class="sig-paren">(</span><em>f</em>, <em>recipe</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#add_customizations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.add_customizations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add customizations to the kickstart file</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"><ul class="first simple">
|
||
<li><strong>f</strong> (<em>open file object</em>) – kickstart file object</li>
|
||
<li><strong>recipe</strong> (<em>Recipe object</em>) – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">RuntimeError if there was a problem writing to the kickstart</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.compose_args">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">compose_args</code><span class="sig-paren">(</span><em>compose_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#compose_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.compose_args" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the settings to pass to novirt_install for the compose type</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>compose_type</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 type of compose to create, from <cite>compose_types()</cite></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This will return a dict of options that match the ArgumentParser options for livemedia-creator.
|
||
These are the ones the define the type of output, it’s filename, etc.
|
||
Other options will be filled in by <cite>make_compose()</cite></p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.compose_types">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">compose_types</code><span class="sig-paren">(</span><em>share_dir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#compose_types"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.compose_types" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a list of the supported output types</p>
|
||
<p>The output types come from the kickstart names in /usr/share/lorax/composer/*ks</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.move_compose_results">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">move_compose_results</code><span class="sig-paren">(</span><em>cfg</em>, <em>results_dir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#move_compose_results"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.move_compose_results" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Move the final image to the results_dir and cleanup the unneeded compose files</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"><ul class="first last simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Build configuration</li>
|
||
<li><strong>results_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Directory to put the results into</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.repo_to_ks">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">repo_to_ks</code><span class="sig-paren">(</span><em>r</em>, <em>url='url'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#repo_to_ks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.repo_to_ks" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a kickstart line with the correct args.
|
||
:param r: DNF repository information
|
||
:type r: dnf.Repo
|
||
:param url: “url” or “baseurl” to use for the baseurl parameter
|
||
:type url: str
|
||
:returns: kickstart command arguments for url/repo command
|
||
:rtype: str</p>
|
||
<p>Set url to “baseurl” if it is a repo, leave it as “url” for the installation url.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.start_build">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">start_build</code><span class="sig-paren">(</span><em>cfg</em>, <em>dnflock</em>, <em>gitlock</em>, <em>branch</em>, <em>recipe_name</em>, <em>compose_type</em>, <em>test_mode=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#start_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.start_build" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Start the build</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration object</li>
|
||
<li><strong>dnflock</strong> (<em>YumLock</em>) – Lock and YumBase for depsolving</li>
|
||
<li><strong>recipe</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 recipe to build</li>
|
||
<li><strong>compose_type</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 type of output to create from the recipe</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Unique ID for the build that can be used to track its status</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.test_templates">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">test_templates</code><span class="sig-paren">(</span><em>dbo</em>, <em>share_dir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#test_templates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.test_templates" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Try depsolving each of the the templates and report any errors</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>dbo</strong> (<em>dnf.Base</em>) – dnf base object</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of template types and errors</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">List of errors</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Return a list of templates and errors encountered or an empty list</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.write_ks_group">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">write_ks_group</code><span class="sig-paren">(</span><em>f</em>, <em>group</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_group"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_group" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Write kickstart group entry</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"><ul class="first last simple">
|
||
<li><strong>f</strong> (<em>open file object</em>) – kickstart file object</li>
|
||
<li><strong>group</strong> – A blueprint group dictionary</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>gid is optional</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.compose.write_ks_user">
|
||
<code class="descclassname">pylorax.api.compose.</code><code class="descname">write_ks_user</code><span class="sig-paren">(</span><em>f</em>, <em>user</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/compose.html#write_ks_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.compose.write_ks_user" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Write kickstart user and sshkey entry</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"><ul class="first last simple">
|
||
<li><strong>f</strong> (<em>open file object</em>) – kickstart file object</li>
|
||
<li><strong>user</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A blueprint user dictionary</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If the entry contains a ssh key, use sshkey to write it
|
||
All of the user fields are optional, except name, write out a kickstart user entry
|
||
with whatever options are relevant.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.config">
|
||
<span id="pylorax-api-config-module"></span><h2>pylorax.api.config module<a class="headerlink" href="#module-pylorax.api.config" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="pylorax.api.config.ComposerConfig">
|
||
<em class="property">class </em><code class="descclassname">pylorax.api.config.</code><code class="descname">ComposerConfig</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#ComposerConfig"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.config.ComposerConfig" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">configparser.SafeConfigParser</span></code></p>
|
||
<dl class="method">
|
||
<dt id="pylorax.api.config.ComposerConfig.get_default">
|
||
<code class="descname">get_default</code><span class="sig-paren">(</span><em>section</em>, <em>option</em>, <em>default</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#ComposerConfig.get_default"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.config.ComposerConfig.get_default" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.config.configure">
|
||
<code class="descclassname">pylorax.api.config.</code><code class="descname">configure</code><span class="sig-paren">(</span><em>conf_file='/etc/lorax/composer.conf'</em>, <em>root_dir='/'</em>, <em>test_config=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#configure"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.config.configure" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>lorax-composer configuration</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"><ul class="first last simple">
|
||
<li><strong>conf_file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Path to the config file overriding the default settings</li>
|
||
<li><strong>root_dir</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Directory to prepend to paths, defaults to /</li>
|
||
<li><strong>test_config</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Set to True to skip reading conf_file</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.config.make_dnf_dirs">
|
||
<code class="descclassname">pylorax.api.config.</code><code class="descname">make_dnf_dirs</code><span class="sig-paren">(</span><em>conf</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#make_dnf_dirs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.config.make_dnf_dirs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Make any missing dnf directories</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>conf</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – The configuration to use</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.config.make_queue_dirs">
|
||
<code class="descclassname">pylorax.api.config.</code><code class="descname">make_queue_dirs</code><span class="sig-paren">(</span><em>conf</em>, <em>gid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/config.html#make_queue_dirs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.config.make_queue_dirs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Make any missing queue directories</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"><ul class="first simple">
|
||
<li><strong>conf</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – The configuration to use</li>
|
||
<li><strong>gid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Group ID that has access to the queue directories</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">list of errors</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of str</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.crossdomain">
|
||
<span id="pylorax-api-crossdomain-module"></span><h2>pylorax.api.crossdomain module<a class="headerlink" href="#module-pylorax.api.crossdomain" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.crossdomain.crossdomain">
|
||
<code class="descclassname">pylorax.api.crossdomain.</code><code class="descname">crossdomain</code><span class="sig-paren">(</span><em>origin</em>, <em>methods=None</em>, <em>headers=None</em>, <em>max_age=21600</em>, <em>attach_to_all=True</em>, <em>automatic_options=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/crossdomain.html#crossdomain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.crossdomain.crossdomain" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.dnfbase">
|
||
<span id="pylorax-api-dnfbase-module"></span><h2>pylorax.api.dnfbase module<a class="headerlink" href="#module-pylorax.api.dnfbase" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.dnfbase.get_base_object">
|
||
<code class="descclassname">pylorax.api.dnfbase.</code><code class="descname">get_base_object</code><span class="sig-paren">(</span><em>conf</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/dnfbase.html#get_base_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.dnfbase.get_base_object" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get the DNF object with settings from the config file</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>conf</strong> (<em>ComposerParser</em>) – configuration object</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A DNF Base object</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dnf.Base</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.errors">
|
||
<span id="pylorax-api-errors-module"></span><h2>pylorax.api.errors module<a class="headerlink" href="#module-pylorax.api.errors" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.projects">
|
||
<span id="pylorax-api-projects-module"></span><h2>pylorax.api.projects module<a class="headerlink" href="#module-pylorax.api.projects" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="exception">
|
||
<dt id="pylorax.api.projects.ProjectsError">
|
||
<em class="property">exception </em><code class="descclassname">pylorax.api.projects.</code><code class="descname">ProjectsError</code><a class="reference internal" href="_modules/pylorax/api/projects.html#ProjectsError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.ProjectsError" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.api_changelog">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">api_changelog</code><span class="sig-paren">(</span><em>changelog</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#api_changelog"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.api_changelog" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Convert the changelog to a string</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>changelog</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><em>tuple</em></a>) – A list of time, author, string tuples.</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The most recent changelog text or “”</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This returns only the most recent changelog entry.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.api_time">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">api_time</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#api_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.api_time" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Convert time since epoch to a string</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>t</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Seconds since epoch</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Time string</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.delete_repo_source">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">delete_repo_source</code><span class="sig-paren">(</span><em>source_glob</em>, <em>source_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#delete_repo_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.delete_repo_source" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete a source from a repo file</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>source_glob</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – A glob of the repo sources to search</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body">ProjectsError if there was a problem</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>A repo file may have multiple sources in it, delete only the selected source.
|
||
If it is the last one in the file, delete the file.</p>
|
||
<p>WARNING: This will delete ANY source, the caller needs to ensure that a system
|
||
source_name isn’t passed to it.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.dep_evra">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">dep_evra</code><span class="sig-paren">(</span><em>dep</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dep_evra"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.dep_evra" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the epoch:version-release.arch for the dep</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>dep</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – dependency dict</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">epoch:version-release.arch</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.dep_nevra">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">dep_nevra</code><span class="sig-paren">(</span><em>dep</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dep_nevra"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.dep_nevra" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the name-epoch:version-release.arch</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.dnf_repo_to_file_repo">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">dnf_repo_to_file_repo</code><span class="sig-paren">(</span><em>repo</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#dnf_repo_to_file_repo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.dnf_repo_to_file_repo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a string representation of a DNF Repo object suitable for writing to a .repo file</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>repo</strong> (<em>dnf.RepoDict</em>) – DNF Repository</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A string</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The DNF Repo.dump() function does not produce a string that can be used as a dnf .repo file,
|
||
it ouputs baseurl and gpgkey as python lists which DNF cannot read. So do this manually with
|
||
only the attributes we care about.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.estimate_size">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">estimate_size</code><span class="sig-paren">(</span><em>packages</em>, <em>block_size=6144</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#estimate_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.estimate_size" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Estimate the installed size of a package list</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"><ul class="first simple">
|
||
<li><strong>packages</strong> (<em>list of hawkey.Package objects</em>) – The packages to be installed</li>
|
||
<li><strong>block_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – The block size to use for rounding up file sizes.</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The estimated size of installed packages</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)">int</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Estimating actual requirements is difficult without the actual file sizes, which
|
||
dnf doesn’t provide access to. So use the file count and block size to estimate
|
||
a minimum size for each package.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.get_repo_sources">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">get_repo_sources</code><span class="sig-paren">(</span><em>source_glob</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#get_repo_sources"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.get_repo_sources" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a list of sources from a directory of yum repositories</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>source_glob</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – A glob to use to match the source files, including full path</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of the source ids in all of the matching files</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of str</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.get_source_ids">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">get_source_ids</code><span class="sig-paren">(</span><em>source_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#get_source_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.get_source_ids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a list of the source ids in a file</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>source_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Full path and filename of the source (yum repo) file</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of source id strings</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of str</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.modules_info">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">modules_info</code><span class="sig-paren">(</span><em>dbo</em>, <em>module_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#modules_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.modules_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return details about a module, including dependencies</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"><ul class="first simple">
|
||
<li><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</li>
|
||
<li><strong>module_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Names of the modules to get info about</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">List of dicts with module details and dependencies.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of dicts</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.modules_list">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">modules_list</code><span class="sig-paren">(</span><em>dbo</em>, <em>module_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#modules_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.modules_list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a list of modules</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"><ul class="first simple">
|
||
<li><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</li>
|
||
<li><strong>offset</strong> – Number of modules to skip</li>
|
||
<li><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Maximum number of modules to return</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">List of module information and total count</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">tuple of a list of dicts and an Int</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Modules don’t exist in RHEL7 so this only returns projects
|
||
and sets the type to “rpm”</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.pkg_to_dep">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">pkg_to_dep</code><span class="sig-paren">(</span><em>pkg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_dep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_dep" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Extract the info from a hawkey.Package object</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>pkg</strong> (<em>hawkey.Package</em>) – A hawkey.Package object</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dict with name, epoch, version, release, arch</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.pkg_to_project">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">pkg_to_project</code><span class="sig-paren">(</span><em>pkg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_project"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_project" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Extract the details from a hawkey.Package object</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>pkgs</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dict with the name, summary, description, and url.</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>upstream_vcs is hard-coded to UPSTREAM_VCS</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.pkg_to_project_info">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">pkg_to_project_info</code><span class="sig-paren">(</span><em>pkg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#pkg_to_project_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.pkg_to_project_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Extract the details from a hawkey.Package object</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>pkg</strong> (<em>hawkey.Package</em>) – hawkey.Package object with package details</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dict with the project details, as well as epoch, release, arch, build_time, changelog, …</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>metadata entries are hard-coded to {}</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.proj_to_module">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">proj_to_module</code><span class="sig-paren">(</span><em>proj</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#proj_to_module"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.proj_to_module" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Extract the name from a project_info dict</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>pkg</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – dict with package details</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dict with name, and group_type</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>group_type is hard-coded to “rpm”</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.projects_depsolve">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">projects_depsolve</code><span class="sig-paren">(</span><em>dbo</em>, <em>projects</em>, <em>groups</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_depsolve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.projects_depsolve" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the dependencies for a list of projects</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"><ul class="first simple">
|
||
<li><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</li>
|
||
<li><strong>projects</strong> (<em>List of Strings</em>) – The projects to find the dependencies for</li>
|
||
<li><strong>groups</strong> (<em>List of str</em>) – The groups to include in dependency solving</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">NEVRA’s of the project and its dependencies</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">list of dicts</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ProjectsError if there was a problem installing something</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.projects_depsolve_with_size">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">projects_depsolve_with_size</code><span class="sig-paren">(</span><em>dbo</em>, <em>projects</em>, <em>groups</em>, <em>with_core=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_depsolve_with_size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.projects_depsolve_with_size" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the dependencies and installed size for a list of projects</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"><ul class="first simple">
|
||
<li><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</li>
|
||
<li><strong>project_names</strong> (<em>List of Strings</em>) – The projects to find the dependencies for</li>
|
||
<li><strong>groups</strong> (<em>List of str</em>) – The groups to include in dependency solving</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">installed size and a list of NEVRA’s of the project and its dependencies</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">tuple of (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)">int</a>, list of dicts)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">ProjectsError if there was a problem installing something</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.projects_info">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">projects_info</code><span class="sig-paren">(</span><em>dbo</em>, <em>project_names</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.projects_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return details about specific projects</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"><ul class="first simple">
|
||
<li><strong>dbo</strong> (<em>dnf.Base</em>) – dnf base object</li>
|
||
<li><strong>project_names</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – List of names of projects to get info about</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">List of project info dicts with pkg_to_project as well as epoch, version, release, etc.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of dicts</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If project_names is None it will return the full list of available packages</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.projects_list">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">projects_list</code><span class="sig-paren">(</span><em>dbo</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#projects_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.projects_list" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a list of projects</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>dbo</strong> (<em>dnf.Base</em>) – dnf base object</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of project info dicts with name, summary, description, homepage, upstream_vcs</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of dicts</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.repo_to_source">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">repo_to_source</code><span class="sig-paren">(</span><em>repo</em>, <em>system_source</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#repo_to_source"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.repo_to_source" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a Weldr Source dict created from the DNF Repository</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>dnf.RepoDict</em>) – DNF Repository</li>
|
||
<li><strong>system_source</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – True if this source is an immutable system source</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A dict with Weldr Source fields filled in</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"check_gpg"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"check_ssl"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"gpgkey_url"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="s2">"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"fedora"</span><span class="p">,</span>
|
||
<span class="s2">"proxy"</span><span class="p">:</span> <span class="s2">"http://proxy.brianlane.com:8123"</span><span class="p">,</span>
|
||
<span class="s2">"system"</span><span class="p">:</span> <span class="n">true</span>
|
||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"yum-metalink"</span><span class="p">,</span>
|
||
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.projects.source_to_repo">
|
||
<code class="descclassname">pylorax.api.projects.</code><code class="descname">source_to_repo</code><span class="sig-paren">(</span><em>source</em>, <em>dnf_conf</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/projects.html#source_to_repo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.projects.source_to_repo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a dnf Repo object created from a source dict</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>source</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A Weldr source dict</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dnf Repo object</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dnf.Repo</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"check_gpg"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
||
<span class="s2">"check_ssl"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
||
<span class="s2">"gpgkey_urls"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="s2">"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"fedora"</span><span class="p">,</span>
|
||
<span class="s2">"proxy"</span><span class="p">:</span> <span class="s2">"http://proxy.brianlane.com:8123"</span><span class="p">,</span>
|
||
<span class="s2">"system"</span><span class="p">:</span> <span class="kc">True</span>
|
||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"yum-metalink"</span><span class="p">,</span>
|
||
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.queue">
|
||
<span id="pylorax-api-queue-module"></span><h2>pylorax.api.queue module<a class="headerlink" href="#module-pylorax.api.queue" title="Permalink to this headline">¶</a></h2>
|
||
<p>Functions to monitor compose queue and run anaconda</p>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.build_status">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">build_status</code><span class="sig-paren">(</span><em>cfg</em>, <em>status_filter=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#build_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.build_status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the details of finished or failed builds</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>status_filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – What builds to return. None == all, “FINISHED”, or “FAILED”</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A list of the build details (from compose_details)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of dicts</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This returns a list of build details for each of the matching builds on the
|
||
system. It does not return the status of builds that have not been finished.
|
||
Use queue_status() for those.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.compose_detail">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">compose_detail</code><span class="sig-paren">(</span><em>results_dir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#compose_detail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.compose_detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return details about the build.</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>results_dir</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 directory containing the metadata and results for the build</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A dictionary with details about the compose</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">IOError if it cannot read the directory, STATUS, or blueprint file.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The following details are included in the dict:</p>
|
||
<ul class="simple">
|
||
<li>id - The uuid of the comoposition</li>
|
||
<li>queue_status - The final status of the composition (FINISHED or FAILED)</li>
|
||
<li>compose_type - The type of output generated (tar, iso, etc.)</li>
|
||
<li>blueprint - Blueprint name</li>
|
||
<li>version - Blueprint version</li>
|
||
<li>image_size - Size of the image, if finished. 0 otherwise.</li>
|
||
</ul>
|
||
<p>Various timestamps are also included in the dict. These are all Unix UTC timestamps.
|
||
It is possible for these timestamps to not always exist, in which case they will be
|
||
None in Python (or null in JSON). The following timestamps are included:</p>
|
||
<ul class="simple">
|
||
<li>job_created - When the user submitted the compose</li>
|
||
<li>job_started - Anaconda started running</li>
|
||
<li>job_finished - Job entered FINISHED or FAILED state</li>
|
||
</ul>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.get_compose_type">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">get_compose_type</code><span class="sig-paren">(</span><em>results_dir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#get_compose_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.get_compose_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the type of composition.</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>results_dir</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 directory containing the metadata and results for the build</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The type of compose (eg. ‘tar’)</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">RuntimeError if no kickstart template can be found.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.get_image_name">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">get_image_name</code><span class="sig-paren">(</span><em>uuid_dir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#get_image_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.get_image_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the filename and full path of the build’s image file</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>uuid</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 UUID of the build</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The image filename and full path</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">tuple of strings</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">RuntimeError if there was a problem (eg. invalid uuid, missing config file)</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.make_compose">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">make_compose</code><span class="sig-paren">(</span><em>cfg</em>, <em>results_dir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#make_compose"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.make_compose" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Run anaconda with the final-kickstart.ks from results_dir</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</li>
|
||
<li><strong>results_dir</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 directory containing the metadata and results for the build</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Nothing</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">May raise various exceptions</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This takes the final-kickstart.ks, and the settings in config.toml and runs Anaconda
|
||
in no-virt mode (directly on the host operating system). Exceptions should be caught
|
||
at the higer level.</p>
|
||
<p>If there is a failure, the build artifacts will be cleaned up, and any logs will be
|
||
moved into logs/anaconda/ and their ownership will be set to the user from the cfg
|
||
object.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.monitor">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">monitor</code><span class="sig-paren">(</span><em>cfg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#monitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.monitor" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Monitor the queue for new compose requests</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>cfg</strong> (<a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><em>DataHolder</em></a>) – Configuration settings</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Does not return</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The queue has 2 subdirectories, new and run. When a compose is ready to be run
|
||
a symlink to the uniquely named results directory should be placed in ./queue/new/</p>
|
||
<p>When the it is ready to be run (it is checked every 30 seconds or after a previous
|
||
compose is finished) the symlink will be moved into ./queue/run/ and a STATUS file
|
||
will be created in the results directory.</p>
|
||
<p>STATUS can contain one of: RUNNING, FINISHED, FAILED</p>
|
||
<p>If the system is restarted while a compose is running it will move any old symlinks
|
||
from ./queue/run/ to ./queue/new/ and rerun them.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.queue_status">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">queue_status</code><span class="sig-paren">(</span><em>cfg</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#queue_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.queue_status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return details about what is in the queue.</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>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of the new composes, and a list of the running composes</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This returns a dict with 2 lists. “new” is the list of uuids that are waiting to be built,
|
||
and “run” has the uuids that are being built (currently limited to 1 at a time).</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.start_queue_monitor">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">start_queue_monitor</code><span class="sig-paren">(</span><em>cfg</em>, <em>uid</em>, <em>gid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#start_queue_monitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.start_queue_monitor" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Start the queue monitor as a mp process</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – User ID that owns the queue</li>
|
||
<li><strong>gid</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Group ID that owns the queue</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.uuid_cancel">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">uuid_cancel</code><span class="sig-paren">(</span><em>cfg</em>, <em>uuid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.uuid_cancel" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Cancel a build and delete its results</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uuid</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 UUID of the build</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if it was canceled and deleted</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Only call this if the build status is WAITING or RUNNING</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.uuid_delete">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">uuid_delete</code><span class="sig-paren">(</span><em>cfg</em>, <em>uuid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.uuid_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete all of the results from a compose</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uuid</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 UUID of the build</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if it was deleted</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">This will raise an error if the delete failed</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.uuid_image">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">uuid_image</code><span class="sig-paren">(</span><em>cfg</em>, <em>uuid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.uuid_image" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the filename and full path of the build’s image file</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uuid</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 UUID of the build</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The image filename and full path</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">tuple of strings</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">RuntimeError if there was a problem (eg. invalid uuid, missing config file)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.uuid_info">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">uuid_info</code><span class="sig-paren">(</span><em>cfg</em>, <em>uuid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.uuid_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return information about the composition</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uuid</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 UUID of the build</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">dictionary of information about the composition or None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">RuntimeError if there was a problem</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This will return a dict with the following fields populated:</p>
|
||
<ul class="simple">
|
||
<li>id - The uuid of the comoposition</li>
|
||
<li>config - containing the configuration settings used to run Anaconda</li>
|
||
<li>blueprint - The depsolved blueprint used to generate the kickstart</li>
|
||
<li>commit - The (local) git commit hash for the blueprint used</li>
|
||
<li>deps - The NEVRA of all of the dependencies used in the composition</li>
|
||
<li>compose_type - The type of output generated (tar, iso, etc.)</li>
|
||
<li>queue_status - The final status of the composition (FINISHED or FAILED)</li>
|
||
</ul>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.uuid_log">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">uuid_log</code><span class="sig-paren">(</span><em>cfg</em>, <em>uuid</em>, <em>size=1024</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_log"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.uuid_log" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return <cite>size</cite> kbytes from the end of the anaconda.log</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uuid</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 UUID of the build</li>
|
||
<li><strong>size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Number of kbytes to read. Default is 1024</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Up to <cite>size</cite> kbytes from the end of the log</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">RuntimeError if there was a problem (eg. no log file available)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This function tries to return lines from the end of the log, it will
|
||
attempt to start on a line boundry, and may return less than <cite>size</cite> kbytes.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.uuid_status">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">uuid_status</code><span class="sig-paren">(</span><em>cfg</em>, <em>uuid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.uuid_status" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the details of a specific UUID compose</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uuid</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 UUID of the build</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Details about the build</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a> or None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Returns the same dict as <cite>compose_details()</cite></p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.queue.uuid_tar">
|
||
<code class="descclassname">pylorax.api.queue.</code><code class="descname">uuid_tar</code><span class="sig-paren">(</span><em>cfg</em>, <em>uuid</em>, <em>metadata=False</em>, <em>image=False</em>, <em>logs=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/queue.html#uuid_tar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.queue.uuid_tar" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a tar of the build data</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"><ul class="first simple">
|
||
<li><strong>cfg</strong> (<a class="reference internal" href="#pylorax.api.config.ComposerConfig" title="pylorax.api.config.ComposerConfig"><em>ComposerConfig</em></a>) – Configuration settings</li>
|
||
<li><strong>uuid</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 UUID of the build</li>
|
||
<li><strong>metadata</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Set to true to include all the metadata needed to reproduce the build</li>
|
||
<li><strong>image</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Set to true to include the output image</li>
|
||
<li><strong>logs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Set to true to include the logs from the build</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A stream of bytes from tar</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">A generator</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">RuntimeError if there was a problem (eg. missing config file)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This yields an uncompressed tar’s data to the caller. It includes
|
||
the selected data to the caller by returning the Popen stdout from the tar process.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.recipes">
|
||
<span id="pylorax-api-recipes-module"></span><h2>pylorax.api.recipes module<a class="headerlink" href="#module-pylorax.api.recipes" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="pylorax.api.recipes.CommitDetails">
|
||
<em class="property">class </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">CommitDetails</code><span class="sig-paren">(</span><em>commit</em>, <em>timestamp</em>, <em>message</em>, <em>revision=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#CommitDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.CommitDetails" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="pylorax.html#pylorax.base.DataHolder" title="pylorax.base.DataHolder"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylorax.base.DataHolder</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="pylorax.api.recipes.CommitTimeValError">
|
||
<em class="property">exception </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">CommitTimeValError</code><a class="reference internal" href="_modules/pylorax/api/recipes.html#CommitTimeValError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.CommitTimeValError" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pylorax.api.recipes.Recipe">
|
||
<em class="property">class </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">Recipe</code><span class="sig-paren">(</span><em>name</em>, <em>description</em>, <em>version</em>, <em>modules</em>, <em>packages</em>, <em>groups</em>, <em>customizations=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
|
||
<p>A Recipe of package and modules</p>
|
||
<p>This is a subclass of dict that enforces the constructor arguments
|
||
and adds a .filename property to return the recipe’s filename,
|
||
and a .toml() function to return the recipe as a TOML string.</p>
|
||
<dl class="method">
|
||
<dt id="pylorax.api.recipes.Recipe.bump_version">
|
||
<code class="descname">bump_version</code><span class="sig-paren">(</span><em>old_version=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.bump_version"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.bump_version" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>semver recipe version number bump</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>old_version</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – An optional old version number</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The new version number or None</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">ValueError</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If neither have a version, 0.0.1 is returned
|
||
If there is no old version the new version is checked and returned
|
||
If there is no new version, but there is a old one, bump its patch level
|
||
If the old and new versions are the same, bump the patch level
|
||
If they are different, check and return the new version</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.recipes.Recipe.filename">
|
||
<code class="descname">filename</code><a class="headerlink" href="#pylorax.api.recipes.Recipe.filename" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the Recipe’s filename</p>
|
||
<p>Replaces spaces in the name with ‘-‘ and appends .toml</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pylorax.api.recipes.Recipe.freeze">
|
||
<code class="descname">freeze</code><span class="sig-paren">(</span><em>deps</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.freeze"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.freeze" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a new Recipe with full module and package NEVRA</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>deps</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>) – A list of dependency NEVRA to use to fill in the modules and packages</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A new Recipe object</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.recipes.Recipe.group_names">
|
||
<code class="descname">group_names</code><a class="headerlink" href="#pylorax.api.recipes.Recipe.group_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the names of the groups. Groups do not have versions.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.recipes.Recipe.module_names">
|
||
<code class="descname">module_names</code><a class="headerlink" href="#pylorax.api.recipes.Recipe.module_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the names of the modules</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.recipes.Recipe.module_nver">
|
||
<code class="descname">module_nver</code><a class="headerlink" href="#pylorax.api.recipes.Recipe.module_nver" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the names and version globs of the modules</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.recipes.Recipe.package_names">
|
||
<code class="descname">package_names</code><a class="headerlink" href="#pylorax.api.recipes.Recipe.package_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the names of the packages</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.recipes.Recipe.package_nver">
|
||
<code class="descname">package_nver</code><a class="headerlink" href="#pylorax.api.recipes.Recipe.package_nver" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the names and version globs of the packages</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pylorax.api.recipes.Recipe.toml">
|
||
<code class="descname">toml</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#Recipe.toml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.Recipe.toml" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the Recipe in TOML format</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="pylorax.api.recipes.RecipeError">
|
||
<em class="property">exception </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">RecipeError</code><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeError" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="exception">
|
||
<dt id="pylorax.api.recipes.RecipeFileError">
|
||
<em class="property">exception </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">RecipeFileError</code><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeFileError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeFileError" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pylorax.api.recipes.RecipeGroup">
|
||
<em class="property">class </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">RecipeGroup</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeGroup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeGroup" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pylorax.api.recipes.RecipeModule">
|
||
<em class="property">class </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">RecipeModule</code><span class="sig-paren">(</span><em>name</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipeModule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.RecipeModule" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pylorax.api.recipes.RecipePackage">
|
||
<em class="property">class </em><code class="descclassname">pylorax.api.recipes.</code><code class="descname">RecipePackage</code><span class="sig-paren">(</span><em>name</em>, <em>version</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#RecipePackage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.RecipePackage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pylorax.api.recipes.RecipeModule" title="pylorax.api.recipes.RecipeModule"><code class="xref py py-class docutils literal notranslate"><span class="pre">pylorax.api.recipes.RecipeModule</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.commit_recipe">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">commit_recipe</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Commit a recipe to a branch</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – Recipe to commit</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">OId of the new commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.commit_recipe_directory">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">commit_recipe_directory</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>directory</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe_directory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe_directory" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Commit all *.toml files from a directory, if they aren’t already in git.</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>directory</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 directory of *.toml recipes to commit</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit or RecipeFileError</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Files with Toml or RecipeFileErrors will be skipped, and the remainder will
|
||
be tried.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.commit_recipe_file">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">commit_recipe_file</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#commit_recipe_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.commit_recipe_file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Commit a recipe file to a branch</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Path to the recipe file to commit</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">OId of the new commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit or RecipeFileError</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.delete_file">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">delete_file</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#delete_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.delete_file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete a file from a branch.</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – filename to delete</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">OId of the new commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.delete_recipe">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">delete_recipe</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#delete_recipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.delete_recipe" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete a recipe from a branch.</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe_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>) – Recipe name to delete</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">OId of the new commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.diff_items">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">diff_items</code><span class="sig-paren">(</span><em>title</em>, <em>old_items</em>, <em>new_items</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#diff_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.diff_items" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the differences between two lists of dicts.</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"><ul class="first simple">
|
||
<li><strong>title</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Title of the entry</li>
|
||
<li><strong>old_items</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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em>)</em>) – List of item dicts with “name” field</li>
|
||
<li><strong>new_items</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><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em>)</em>) – List of item dicts with “name” field</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">List of diff dicts with old/new entries</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a>)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.find_commit_tag">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">find_commit_tag</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>commit_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_commit_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.find_commit_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Find the tag that matches the commit_id</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – filename to revert</li>
|
||
<li><strong>commit_id</strong> (<em>Git.OId</em>) – The commit id to check</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The tag or None if there isn’t one</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a> or None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>There should be only 1 tag pointing to a commit, but there may not
|
||
be a tag at all.</p>
|
||
<p>The tag will look like: ‘refs/tags/<branch>/<filename>/r<revision>’</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.find_name">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">find_name</code><span class="sig-paren">(</span><em>name</em>, <em>lst</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#find_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.find_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Find the dict matching the name in a list and return it.</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"><ul class="first simple">
|
||
<li><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 to search for</li>
|
||
<li><strong>lst</strong> – List of dict’s with “name” field</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">First dict with matching name, or None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a> or None</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.get_commit_details">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">get_commit_details</code><span class="sig-paren">(</span><em>commit</em>, <em>revision=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#get_commit_details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.get_commit_details" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the details about a specific commit.</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"><ul class="first simple">
|
||
<li><strong>commit</strong> (<em>Git.Commit</em>) – The commit to get details from</li>
|
||
<li><strong>revision</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Optional commit revision</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Details about the commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#pylorax.api.recipes.CommitDetails" title="pylorax.api.recipes.CommitDetails">CommitDetails</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">CommitTimeValError or Ggit exceptions</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.get_revision_from_tag">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">get_revision_from_tag</code><span class="sig-paren">(</span><em>tag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#get_revision_from_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.get_revision_from_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the revision number from a tag</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>tag</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 tag to exract the revision from</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The integer revision or None</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)">int</a> or None</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>The revision is the part after the r in ‘branch/filename/rXXX’</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.gfile">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">gfile</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#gfile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.gfile" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Convert a string path to GFile for use with Git</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.head_commit">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">head_commit</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#head_commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.head_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get the branch’s HEAD Commit Object</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Branch’s head commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.Commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.is_commit_tag">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">is_commit_tag</code><span class="sig-paren">(</span><em>repo</em>, <em>commit_id</em>, <em>tag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#is_commit_tag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.is_commit_tag" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Check to see if a tag points to a specific commit.</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>commit_id</strong> (<em>Git.OId</em>) – The commit id to check</li>
|
||
<li><strong>tag</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 tag to check</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if the tag points to the commit, False otherwise</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.is_parent_diff">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">is_parent_diff</code><span class="sig-paren">(</span><em>repo</em>, <em>filename</em>, <em>tree</em>, <em>parent</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#is_parent_diff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.is_parent_diff" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Check to see if the commit is different from its parents</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – filename to revert</li>
|
||
<li><strong>tree</strong> (<em>Git.Tree</em>) – The commit’s tree</li>
|
||
<li><strong>parent</strong> (<em>Git.Commit</em>) – The commit’s parent commit</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Retuns:</th><td class="field-body"><p class="first">True if filename in the commit is different from its parents</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.list_branch_files">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">list_branch_files</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_branch_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.list_branch_files" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a sorted list of the files on the branch HEAD</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A sorted list of the filenames</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a>)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.list_commit_files">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">list_commit_files</code><span class="sig-paren">(</span><em>repo</em>, <em>commit</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_commit_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.list_commit_files" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a sorted list of the files on a commit</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>commit</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 commit hash to list</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A sorted list of the filenames</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a>)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.list_commits">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">list_commits</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>limit=0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#list_commits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.list_commits" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>List the commit history of a file on a branch.</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – filename to revert</li>
|
||
<li><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – Number of commits to return (0=all)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A list of commit details</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>(<a class="reference internal" href="#pylorax.api.recipes.CommitDetails" title="pylorax.api.recipes.CommitDetails">CommitDetails</a>)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.open_or_create_repo">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">open_or_create_repo</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#open_or_create_repo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.open_or_create_repo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Open an existing repo, or create a new one</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>path</strong> (<em>string</em>) – path to recipe directory</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A repository object</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Git.Repository</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">Can raise errors from Ggit</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>A bare git repo will be created in the git directory of the specified path.
|
||
If a repo already exists it will be opened and returned instead of
|
||
creating a new one.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.prepare_commit">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">prepare_commit</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>builder</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#prepare_commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.prepare_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Prepare for a commit</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>builder</strong> (<a class="reference internal" href="pylorax.html#pylorax.treebuilder.TreeBuilder" title="pylorax.treebuilder.TreeBuilder"><em>TreeBuilder</em></a>) – instance of TreeBuilder</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">(Tree, Sig, Ref)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)">tuple</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.read_commit">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">read_commit</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>commit=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.read_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the contents of a file on a specific branch or commit.</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – filename to read</li>
|
||
<li><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Optional commit hash</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The commit id, and the contents of the commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)">tuple</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a>)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If no commit is passed the master:filename is returned, otherwise it will be
|
||
commit:filename</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.read_commit_spec">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">read_commit_spec</code><span class="sig-paren">(</span><em>repo</em>, <em>spec</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_commit_spec"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.read_commit_spec" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the raw content of the blob specified by the spec</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>spec</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Git revparse spec</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Contents of the commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>eg. To read the README file from master the spec is “master:README”</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.read_recipe_and_id">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">read_recipe_and_id</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em>, <em>commit=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_recipe_and_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.read_recipe_and_id" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read a recipe commit and its id from git</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe_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>) – Recipe name to read</li>
|
||
<li><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Optional commit hash</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The commit id, and a Recipe object</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)">tuple</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a>, <a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a>)</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If no commit is passed the master:filename is returned, otherwise it will be
|
||
commit:filename</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.read_recipe_commit">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">read_recipe_commit</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em>, <em>commit=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#read_recipe_commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.read_recipe_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read a recipe commit from git and return a Recipe object</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe_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>) – Recipe name to read</li>
|
||
<li><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Optional commit hash</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A Recipe object</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If no commit is passed the master:filename is returned, otherwise it will be
|
||
commit:filename</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.recipe_diff">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">recipe_diff</code><span class="sig-paren">(</span><em>old_recipe</em>, <em>new_recipe</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_diff"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_diff" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Diff two versions of a recipe</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"><ul class="first simple">
|
||
<li><strong>old_recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The old version of the recipe</li>
|
||
<li><strong>new_recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The new version of the recipe</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A list of diff dict entries with old/new</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a>)</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.recipe_filename">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">recipe_filename</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_filename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_filename" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the toml filename for a recipe</p>
|
||
<p>Replaces spaces with ‘-‘ and appends ‘.toml’</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.recipe_from_dict">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">recipe_from_dict</code><span class="sig-paren">(</span><em>recipe_dict</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a Recipe object from a plain dict.</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>recipe_dict</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A plain dict of the recipe</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Recipe object</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">RecipeError</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.recipe_from_file">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">recipe_from_file</code><span class="sig-paren">(</span><em>recipe_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a recipe file as a Recipe object</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>recipe_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Path to the recipe fila</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Recipe object</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.recipe_from_toml">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">recipe_from_toml</code><span class="sig-paren">(</span><em>recipe_str</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#recipe_from_toml"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.recipe_from_toml" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a Recipe object from a toml string.</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>recipe_str</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 Recipe TOML string</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A Recipe object</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a></td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body">TomlError</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.revert_file">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">revert_file</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>commit</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#revert_file"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.revert_file" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Revert the contents of a file to that of a previous commit</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – filename to revert</li>
|
||
<li><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Commit hash</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">OId of the new commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.revert_recipe">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">revert_recipe</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em>, <em>commit</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#revert_recipe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.revert_recipe" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Revert the contents of a recipe to that of a previous commit</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe_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>) – Recipe name to revert</li>
|
||
<li><strong>commit</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Commit hash</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">OId of the new commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.tag_file_commit">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">tag_file_commit</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#tag_file_commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.tag_file_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Tag a file’s most recent commit</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Filename to tag</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Tag id or None if it failed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>This uses git tags, of the form <cite>refs/tags/<branch>/<filename>/r<revision></cite>
|
||
Only the most recent recipe commit can be tagged to prevent out of order tagging.
|
||
Revisions start at 1 and increment for each new commit that is tagged.
|
||
If the commit has already been tagged it will return false.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.tag_recipe_commit">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">tag_recipe_commit</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#tag_recipe_commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.tag_recipe_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Tag a file’s most recent commit</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe_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>) – Recipe name to tag</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Tag id or None if it failed.</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Uses tag_file_commit()</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.recipes.write_commit">
|
||
<code class="descclassname">pylorax.api.recipes.</code><code class="descname">write_commit</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>filename</em>, <em>message</em>, <em>content</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/recipes.html#write_commit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.recipes.write_commit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Make a new commit to a repository’s branch</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – full path of the file to add</li>
|
||
<li><strong>message</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 commit message</li>
|
||
<li><strong>content</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 data to write</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">OId of the new commit</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Git.OId</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">Can raise errors from Ggit</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.regexes">
|
||
<span id="pylorax-api-regexes-module"></span><h2>pylorax.api.regexes module<a class="headerlink" href="#module-pylorax.api.regexes" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.server">
|
||
<span id="pylorax-api-server-module"></span><h2>pylorax.api.server module<a class="headerlink" href="#module-pylorax.api.server" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="pylorax.api.server.GitLock">
|
||
<em class="property">class </em><code class="descclassname">pylorax.api.server.</code><code class="descname">GitLock</code><span class="sig-paren">(</span><em>repo</em>, <em>lock</em>, <em>dir</em><span class="sig-paren">)</span><a class="headerlink" href="#pylorax.api.server.GitLock" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.server.GitLock.dir">
|
||
<code class="descname">dir</code><a class="headerlink" href="#pylorax.api.server.GitLock.dir" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 2</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.server.GitLock.lock">
|
||
<code class="descname">lock</code><a class="headerlink" href="#pylorax.api.server.GitLock.lock" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 1</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pylorax.api.server.GitLock.repo">
|
||
<code class="descname">repo</code><a class="headerlink" href="#pylorax.api.server.GitLock.repo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Alias for field number 0</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.timestamp">
|
||
<span id="pylorax-api-timestamp-module"></span><h2>pylorax.api.timestamp module<a class="headerlink" href="#module-pylorax.api.timestamp" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.timestamp.timestamp_dict">
|
||
<code class="descclassname">pylorax.api.timestamp.</code><code class="descname">timestamp_dict</code><span class="sig-paren">(</span><em>destdir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/timestamp.html#timestamp_dict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.timestamp.timestamp_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.timestamp.write_timestamp">
|
||
<code class="descclassname">pylorax.api.timestamp.</code><code class="descname">write_timestamp</code><span class="sig-paren">(</span><em>destdir</em>, <em>ty</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/timestamp.html#write_timestamp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.timestamp.write_timestamp" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.v0">
|
||
<span id="pylorax-api-v0-module"></span><h2>pylorax.api.v0 module<a class="headerlink" href="#module-pylorax.api.v0" title="Permalink to this headline">¶</a></h2>
|
||
<p>Setup v0 of the API server</p>
|
||
<p>v0_api() must be called to setup the API routes for Flask</p>
|
||
<div class="section" id="status-responses">
|
||
<h3>Status Responses<a class="headerlink" href="#status-responses" title="Permalink to this headline">¶</a></h3>
|
||
<p>Some requests only return a status/error response.</p>
|
||
<blockquote>
|
||
<div><p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
<p>Example response:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"status"</span><span class="p">:</span> <span class="n">true</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Error response:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"ggit-error: Failed to remove entry. File isn't in the tree - jboss.toml (-1)"</span><span class="p">]</span>
|
||
<span class="s2">"status"</span><span class="p">:</span> <span class="n">false</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-routes">
|
||
<h3>API Routes<a class="headerlink" href="#api-routes" title="Permalink to this headline">¶</a></h3>
|
||
<p>All of the blueprints routes support the optional <cite>branch</cite> argument. If it is not
|
||
used then the API will use the <cite>master</cite> branch for blueprints. If you want to create
|
||
a new branch use the <cite>new</cite> or <cite>workspace</cite> routes with ?branch=<branch-name> to
|
||
store the new blueprint on the new branch.</p>
|
||
<div class="section" id="api-v0-blueprints-list">
|
||
<h4><cite>/api/v0/blueprints/list</cite><a class="headerlink" href="#api-v0-blueprints-list" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>List the available blueprints:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
|
||
<span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="s2">"blueprints"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="s2">"atlas"</span><span class="p">,</span>
|
||
<span class="s2">"development"</span><span class="p">,</span>
|
||
<span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"http-server"</span><span class="p">,</span>
|
||
<span class="s2">"jboss"</span><span class="p">,</span>
|
||
<span class="s2">"kubernetes"</span> <span class="p">],</span>
|
||
<span class="s2">"total"</span><span class="p">:</span> <span class="mi">6</span> <span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-blueprints-info-blueprint-names">
|
||
<h4><cite>/api/v0/blueprints/info/<blueprint_names></cite><a class="headerlink" href="#api-v0-blueprints-info-blueprint-names" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the JSON representation of the blueprint. This includes 3 top level
|
||
objects. <cite>changes</cite> which lists whether or not the workspace is different from
|
||
the most recent commit. <cite>blueprints</cite> which lists the JSON representation of the
|
||
blueprint, and <cite>errors</cite> which will list any errors, like non-existant blueprints.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"changes"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"changed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"blueprints"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"An example GlusterFS server with samba"</span><span class="p">,</span>
|
||
<span class="s2">"modules"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.7.*"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs-cli"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.7.*"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"packages"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"2ping"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.2.1"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"samba"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"4.2.*"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Error example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"changes"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"ggit-error: the path 'missing.toml' does not exist in the given tree (-3)"</span><span class="p">]</span>
|
||
<span class="s2">"blueprints"</span><span class="p">:</span> <span class="p">[]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-blueprints-changes-blueprint-names-offset-0-limit-20">
|
||
<h4><cite>/api/v0/blueprints/changes/<blueprint_names>[?offset=0&limit=20]</cite><a class="headerlink" href="#api-v0-blueprints-changes-blueprint-names-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the commits to a blueprint. By default it returns the first 20 commits, this
|
||
can be changed by passing <cite>offset</cite> and/or <cite>limit</cite>. The response will include the
|
||
commit hash, summary, timestamp, and optionally the revision number. The commit
|
||
hash can be passed to <cite>/api/v0/blueprints/diff/</cite> to retrieve the exact changes.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"limit"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
|
||
<span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="s2">"blueprints"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"changes"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"commit"</span><span class="p">:</span> <span class="s2">"e083921a7ed1cf2eec91ad12b9ad1e70ef3470be"</span><span class="p">,</span>
|
||
<span class="s2">"message"</span><span class="p">:</span> <span class="s2">"blueprint glusterfs, version 0.0.6 saved."</span><span class="p">,</span>
|
||
<span class="s2">"revision"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
|
||
<span class="s2">"timestamp"</span><span class="p">:</span> <span class="s2">"2017-11-23T00:18:13Z"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"commit"</span><span class="p">:</span> <span class="s2">"cee5f4c20fc33ea4d54bfecf56f4ad41ad15f4f3"</span><span class="p">,</span>
|
||
<span class="s2">"message"</span><span class="p">:</span> <span class="s2">"blueprint glusterfs, version 0.0.5 saved."</span><span class="p">,</span>
|
||
<span class="s2">"revision"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
|
||
<span class="s2">"timestamp"</span><span class="p">:</span> <span class="s2">"2017-11-11T01:00:28Z"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"commit"</span><span class="p">:</span> <span class="s2">"29b492f26ed35d80800b536623bafc51e2f0eff2"</span><span class="p">,</span>
|
||
<span class="s2">"message"</span><span class="p">:</span> <span class="s2">"blueprint glusterfs, version 0.0.4 saved."</span><span class="p">,</span>
|
||
<span class="s2">"revision"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
|
||
<span class="s2">"timestamp"</span><span class="p">:</span> <span class="s2">"2017-11-11T00:28:30Z"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"commit"</span><span class="p">:</span> <span class="s2">"03374adbf080fe34f5c6c29f2e49cc2b86958bf2"</span><span class="p">,</span>
|
||
<span class="s2">"message"</span><span class="p">:</span> <span class="s2">"blueprint glusterfs, version 0.0.3 saved."</span><span class="p">,</span>
|
||
<span class="s2">"revision"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
|
||
<span class="s2">"timestamp"</span><span class="p">:</span> <span class="s2">"2017-11-10T23:15:52Z"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"commit"</span><span class="p">:</span> <span class="s2">"0e08ecbb708675bfabc82952599a1712a843779d"</span><span class="p">,</span>
|
||
<span class="s2">"message"</span><span class="p">:</span> <span class="s2">"blueprint glusterfs, version 0.0.2 saved."</span><span class="p">,</span>
|
||
<span class="s2">"revision"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
|
||
<span class="s2">"timestamp"</span><span class="p">:</span> <span class="s2">"2017-11-10T23:14:56Z"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"commit"</span><span class="p">:</span> <span class="s2">"3e11eb87a63d289662cba4b1804a0947a6843379"</span><span class="p">,</span>
|
||
<span class="s2">"message"</span><span class="p">:</span> <span class="s2">"blueprint glusterfs, version 0.0.1 saved."</span><span class="p">,</span>
|
||
<span class="s2">"revision"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
|
||
<span class="s2">"timestamp"</span><span class="p">:</span> <span class="s2">"2017-11-08T00:02:47Z"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"total"</span><span class="p">:</span> <span class="mi">6</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="post-api-v0-blueprints-new">
|
||
<h4>POST <cite>/api/v0/blueprints/new</cite><a class="headerlink" href="#post-api-v0-blueprints-new" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Create a new blueprint, or update an existing blueprint. This supports both JSON and TOML
|
||
for the blueprint format. The blueprint should be in the body of the request with the
|
||
<cite>Content-Type</cite> header set to either <cite>application/json</cite> or <cite>text/x-toml</cite>.</p>
|
||
<p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="delete-api-v0-blueprints-delete-blueprint-name">
|
||
<h4>DELETE <cite>/api/v0/blueprints/delete/<blueprint_name></cite><a class="headerlink" href="#delete-api-v0-blueprints-delete-blueprint-name" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Delete a blueprint. The blueprint is deleted from the branch, and will no longer
|
||
be listed by the <cite>list</cite> route. A blueprint can be undeleted using the <cite>undo</cite> route
|
||
to revert to a previous commit.</p>
|
||
<p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="post-api-v0-blueprints-workspace">
|
||
<h4>POST <cite>/api/v0/blueprints/workspace</cite><a class="headerlink" href="#post-api-v0-blueprints-workspace" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Write a blueprint to the temporary workspace. This works exactly the same as <cite>new</cite> except
|
||
that it does not create a commit. JSON and TOML bodies are supported.</p>
|
||
<p>The workspace is meant to be used as a temporary blueprint storage for clients.
|
||
It will be read by the <cite>info</cite> and <cite>diff</cite> routes if it is different from the
|
||
most recent commit.</p>
|
||
<p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="delete-api-v0-blueprints-workspace-blueprint-name">
|
||
<h4>DELETE <cite>/api/v0/blueprints/workspace/<blueprint_name></cite><a class="headerlink" href="#delete-api-v0-blueprints-workspace-blueprint-name" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Remove the temporary workspace copy of a blueprint. The <cite>info</cite> route will now
|
||
return the most recent commit of the blueprint. Any changes that were in the
|
||
workspace will be lost.</p>
|
||
<p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="post-api-v0-blueprints-undo-blueprint-name-commit">
|
||
<h4>POST <cite>/api/v0/blueprints/undo/<blueprint_name>/<commit></cite><a class="headerlink" href="#post-api-v0-blueprints-undo-blueprint-name-commit" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>This will revert the blueprint to a previous commit. The commit hash from the <cite>changes</cite>
|
||
route can be used in this request.</p>
|
||
<p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="post-api-v0-blueprints-tag-blueprint-name">
|
||
<h4>POST <cite>/api/v0/blueprints/tag/<blueprint_name></cite><a class="headerlink" href="#post-api-v0-blueprints-tag-blueprint-name" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Tag a blueprint as a new release. This uses git tags with a special format.
|
||
<cite>refs/tags/<branch>/<filename>/r<revision></cite>. Only the most recent blueprint commit
|
||
can be tagged. Revisions start at 1 and increment for each new tag
|
||
(per-blueprint). If the commit has already been tagged it will return false.</p>
|
||
<p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-blueprints-diff-blueprint-name-from-commit-to-commit">
|
||
<h4><cite>/api/v0/blueprints/diff/<blueprint_name>/<from_commit>/<to_commit></cite><a class="headerlink" href="#api-v0-blueprints-diff-blueprint-name-from-commit-to-commit" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the differences between two commits, or the workspace. The commit hash
|
||
from the <cite>changes</cite> response can be used here, or several special strings:</p>
|
||
<ul class="simple">
|
||
<li>NEWEST will select the newest git commit. This works for <cite>from_commit</cite> or <cite>to_commit</cite></li>
|
||
<li>WORKSPACE will select the workspace copy. This can only be used in <cite>to_commit</cite></li>
|
||
</ul>
|
||
<p>eg. <cite>/api/v0/blueprints/diff/glusterfs/NEWEST/WORKSPACE</cite> will return the differences
|
||
between the most recent git commit and the contents of the workspace.</p>
|
||
<p>Each entry in the response’s diff object contains the old blueprint value and the new one.
|
||
If old is null and new is set, then it was added.
|
||
If new is null and old is set, then it was removed.
|
||
If both are set, then it was changed.</p>
|
||
<p>The old/new entries will have the name of the blueprint field that was changed. This
|
||
can be one of: Name, Description, Version, Module, or Package.
|
||
The contents for these will be the old/new values for them.</p>
|
||
<p>In the example below the version was changed and the ping package was added.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"diff"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"new"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"Version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">},</span>
|
||
<span class="s2">"old"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"Version"</span><span class="p">:</span> <span class="s2">"0.0.5"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"new"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"Package"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.2.1"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">},</span>
|
||
<span class="s2">"old"</span><span class="p">:</span> <span class="n">null</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-blueprints-freeze-blueprint-names">
|
||
<h4><cite>/api/v0/blueprints/freeze/<blueprint_names></cite><a class="headerlink" href="#api-v0-blueprints-freeze-blueprint-names" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return a JSON representation of the blueprint with the package and module versions set
|
||
to the exact versions chosen by depsolving the blueprint.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"blueprints"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"An example GlusterFS server with samba"</span><span class="p">,</span>
|
||
<span class="s2">"modules"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.8.4-18.4.el7.x86_64"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs-cli"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.8.4-18.4.el7.x86_64"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"packages"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"2:3.2.1-2.el7.noarch"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"samba"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"4.6.2-8.el7.x86_64"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-blueprints-depsolve-blueprint-names">
|
||
<h4><cite>/api/v0/blueprints/depsolve/<blueprint_names></cite><a class="headerlink" href="#api-v0-blueprints-depsolve-blueprint-names" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Depsolve the blueprint using yum, return the blueprint used, and the NEVRAs of the packages
|
||
chosen to satisfy the blueprint’s requirements. The response will include a list of results,
|
||
with the full dependency list in <cite>dependencies</cite>, the NEVRAs for the blueprint’s direct modules
|
||
and packages in <cite>modules</cite>, and any error will be in <cite>errors</cite>.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"blueprints"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"dependencies"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"noarch"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"2ping"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"2.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.2.1"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"acl"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"12.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"2.2.51"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"audit-libs"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"3.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"2.7.6"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"avahi-libs"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"17.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.6.31"</span>
|
||
<span class="p">},</span>
|
||
<span class="o">...</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"modules"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"noarch"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"2ping"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"2.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.2.1"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"18.4.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.8.4"</span>
|
||
<span class="p">},</span>
|
||
<span class="o">...</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"An example GlusterFS server with samba"</span><span class="p">,</span>
|
||
<span class="s2">"modules"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.7.*"</span>
|
||
<span class="p">},</span>
|
||
<span class="o">...</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-projects-list-offset-0-limit-20">
|
||
<h4><cite>/api/v0/projects/list[?offset=0&limit=20]</cite><a class="headerlink" href="#api-v0-projects-list-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>List all of the available projects. By default this returns the first 20 items,
|
||
but this can be changed by setting the <cite>offset</cite> and <cite>limit</cite> arguments.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"limit"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
|
||
<span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="s2">"projects"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"0 A.D. (pronounced "</span><span class="n">zero</span> <span class="n">ey</span><span class="o">-</span><span class="n">dee</span><span class="s2">") is a ..."</span><span class="p">,</span>
|
||
<span class="s2">"homepage"</span><span class="p">:</span> <span class="s2">"http://play0ad.com"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"0ad"</span><span class="p">,</span>
|
||
<span class="s2">"summary"</span><span class="p">:</span> <span class="s2">"Cross-Platform RTS Game of Ancient Warfare"</span><span class="p">,</span>
|
||
<span class="s2">"upstream_vcs"</span><span class="p">:</span> <span class="s2">"UPSTREAM_VCS"</span>
|
||
<span class="p">},</span>
|
||
<span class="o">...</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"total"</span><span class="p">:</span> <span class="mi">21770</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-projects-info-project-names">
|
||
<h4><cite>/api/v0/projects/info/<project_names></cite><a class="headerlink" href="#api-v0-projects-info-project-names" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return information about the comma-separated list of projects. It includes the description
|
||
of the package along with the list of available builds.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"projects"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"builds"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"build_config_ref"</span><span class="p">:</span> <span class="s2">"BUILD_CONFIG_REF"</span><span class="p">,</span>
|
||
<span class="s2">"build_env_ref"</span><span class="p">:</span> <span class="s2">"BUILD_ENV_REF"</span><span class="p">,</span>
|
||
<span class="s2">"build_time"</span><span class="p">:</span> <span class="s2">"2017-03-01T08:39:23"</span><span class="p">,</span>
|
||
<span class="s2">"changelog"</span><span class="p">:</span> <span class="s2">"- restore incremental backups correctly, files ..."</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
|
||
<span class="s2">"metadata"</span><span class="p">:</span> <span class="p">{},</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"32.el7"</span><span class="p">,</span>
|
||
<span class="s2">"source"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"license"</span><span class="p">:</span> <span class="s2">"GPLv3+"</span><span class="p">,</span>
|
||
<span class="s2">"metadata"</span><span class="p">:</span> <span class="p">{},</span>
|
||
<span class="s2">"source_ref"</span><span class="p">:</span> <span class="s2">"SOURCE_REF"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.26"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"The GNU tar program saves many ..."</span><span class="p">,</span>
|
||
<span class="s2">"homepage"</span><span class="p">:</span> <span class="s2">"http://www.gnu.org/software/tar/"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"tar"</span><span class="p">,</span>
|
||
<span class="s2">"summary"</span><span class="p">:</span> <span class="s2">"A GNU file archiving program"</span><span class="p">,</span>
|
||
<span class="s2">"upstream_vcs"</span><span class="p">:</span> <span class="s2">"UPSTREAM_VCS"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-projects-depsolve-project-names">
|
||
<h4><cite>/api/v0/projects/depsolve/<project_names></cite><a class="headerlink" href="#api-v0-projects-depsolve-project-names" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Depsolve the comma-separated list of projects and return the list of NEVRAs needed
|
||
to satisfy the request.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"projects"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"noarch"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"basesystem"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"7.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"10.0"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bash"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"28.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"4.2.46"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"filesystem"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"21.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3.2"</span>
|
||
<span class="p">},</span>
|
||
<span class="o">...</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-projects-source-list">
|
||
<h4><cite>/api/v0/projects/source/list</cite><a class="headerlink" href="#api-v0-projects-source-list" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the list of repositories used for depsolving and installing packages.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"sources"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="s2">"fedora"</span><span class="p">,</span>
|
||
<span class="s2">"fedora-cisco-openh264"</span><span class="p">,</span>
|
||
<span class="s2">"fedora-updates-testing"</span><span class="p">,</span>
|
||
<span class="s2">"fedora-updates"</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-projects-source-info-source-names">
|
||
<h4><cite>/api/v0/projects/source/info/<source-names></cite><a class="headerlink" href="#api-v0-projects-source-info-source-names" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return information about the comma-separated list of source names. Or all of the
|
||
sources if ‘*’ is passed. Note that general globbing is not supported, only ‘*’.</p>
|
||
<p>immutable system sources will have the “system” field set to true. User added sources
|
||
will have it set to false. System sources cannot be changed or deleted.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"sources"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"fedora"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"check_gpg"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"check_ssl"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"gpgkey_urls"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="s2">"file:///etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-28-x86_64"</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"fedora"</span><span class="p">,</span>
|
||
<span class="s2">"proxy"</span><span class="p">:</span> <span class="s2">"http://proxy.brianlane.com:8123"</span><span class="p">,</span>
|
||
<span class="s2">"system"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"yum-metalink"</span><span class="p">,</span>
|
||
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://mirrors.fedoraproject.org/metalink?repo=fedora-28&arch=x86_64"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="post-api-v0-projects-source-new">
|
||
<h4>POST <cite>/api/v0/projects/source/new</cite><a class="headerlink" href="#post-api-v0-projects-source-new" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Add (or change) a source for use when depsolving blueprints and composing images.</p>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">proxy</span></code> and <code class="docutils literal notranslate"><span class="pre">gpgkey_urls</span></code> entries are optional. All of the others are required. The supported
|
||
types for the urls are:</p>
|
||
<ul class="simple">
|
||
<li><code class="docutils literal notranslate"><span class="pre">yum-baseurl</span></code> is a URL to a yum repository.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">yum-mirrorlist</span></code> is a URL for a mirrorlist.</li>
|
||
<li><code class="docutils literal notranslate"><span class="pre">yum-metalink</span></code> is a URL for a metalink.</li>
|
||
</ul>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">check_ssl</span></code> is true the https certificates must be valid. If they are self-signed you can either set
|
||
this to false, or add your Certificate Authority to the host system.</p>
|
||
<p>If <code class="docutils literal notranslate"><span class="pre">check_gpg</span></code> is true the GPG key must either be installed on the host system, or <code class="docutils literal notranslate"><span class="pre">gpgkey_urls</span></code>
|
||
should point to it.</p>
|
||
<p>You can edit an existing source (other than system sources), by doing a POST
|
||
of the new version of the source. It will overwrite the previous one.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"custom-source-1"</span><span class="p">,</span>
|
||
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://url/path/to/repository/"</span><span class="p">,</span>
|
||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"yum-baseurl"</span><span class="p">,</span>
|
||
<span class="s2">"check_ssl"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"check_gpg"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"gpgkey_urls"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="s2">"https://url/path/to/gpg-key"</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="delete-api-v0-projects-source-delete-source-name">
|
||
<h4>DELETE <cite>/api/v0/projects/source/delete/<source-name></cite><a class="headerlink" href="#delete-api-v0-projects-source-delete-source-name" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Delete a user added source. This will fail if a system source is passed to
|
||
it.</p>
|
||
<p>The response will be a status response with <cite>status</cite> set to true, or an
|
||
error response with it set to false and an error message included.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-modules-list-offset-0-limit-20">
|
||
<h4><cite>/api/v0/modules/list[?offset=0&limit=20]</cite><a class="headerlink" href="#api-v0-modules-list-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return a list of all of the available modules. This includes the name and the
|
||
group_type, which is always “rpm” for lorax-composer. By default this returns
|
||
the first 20 items. This can be changed by setting the <cite>offset</cite> and <cite>limit</cite>
|
||
arguments.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"limit"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
|
||
<span class="s2">"modules"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"group_type"</span><span class="p">:</span> <span class="s2">"rpm"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"0ad"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"group_type"</span><span class="p">:</span> <span class="s2">"rpm"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"0ad-data"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"group_type"</span><span class="p">:</span> <span class="s2">"rpm"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"0install"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"group_type"</span><span class="p">:</span> <span class="s2">"rpm"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"2048-cli"</span>
|
||
<span class="p">},</span>
|
||
<span class="o">...</span>
|
||
<span class="p">]</span>
|
||
<span class="s2">"total"</span><span class="p">:</span> <span class="mi">21770</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-modules-list-module-names-offset-0-limit-20">
|
||
<h4><cite>/api/v0/modules/list/<module_names>[?offset=0&limit=20]</cite><a class="headerlink" href="#api-v0-modules-list-module-names-offset-0-limit-20" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the list of comma-separated modules. Output is the same as <cite>/modules/list</cite></p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"limit"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
|
||
<span class="s2">"modules"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"group_type"</span><span class="p">:</span> <span class="s2">"rpm"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"tar"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||
<span class="s2">"total"</span><span class="p">:</span> <span class="mi">1</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-modules-info-module-names">
|
||
<h4><cite>/api/v0/modules/info/<module_names></cite><a class="headerlink" href="#api-v0-modules-info-module-names" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the module’s dependencies, and the information about the module.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"modules"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"dependencies"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"noarch"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"basesystem"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"7.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"10.0"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bash"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"28.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"4.2.46"</span>
|
||
<span class="p">},</span>
|
||
<span class="o">...</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"The GNU tar program saves ..."</span><span class="p">,</span>
|
||
<span class="s2">"homepage"</span><span class="p">:</span> <span class="s2">"http://www.gnu.org/software/tar/"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"tar"</span><span class="p">,</span>
|
||
<span class="s2">"summary"</span><span class="p">:</span> <span class="s2">"A GNU file archiving program"</span><span class="p">,</span>
|
||
<span class="s2">"upstream_vcs"</span><span class="p">:</span> <span class="s2">"UPSTREAM_VCS"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="post-api-v0-compose">
|
||
<h4>POST <cite>/api/v0/compose</cite><a class="headerlink" href="#post-api-v0-compose" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Start a compose. The content type should be ‘application/json’ and the body of the POST
|
||
should look like this:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"blueprint_name"</span><span class="p">:</span> <span class="s2">"http-server"</span><span class="p">,</span>
|
||
<span class="s2">"compose_type"</span><span class="p">:</span> <span class="s2">"tar"</span><span class="p">,</span>
|
||
<span class="s2">"branch"</span><span class="p">:</span> <span class="s2">"master"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Pass it the name of the blueprint, the type of output (from ‘/api/v0/compose/types’), and the
|
||
blueprint branch to use. ‘branch’ is optional and will default to master. It will create a new
|
||
build and add it to the queue. It returns the build uuid and a status if it succeeds:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"build_id"</span><span class="p">:</span> <span class="s2">"e6fa6db4-9c81-4b70-870f-a697ca405cdf"</span><span class="p">,</span>
|
||
<span class="s2">"status"</span><span class="p">:</span> <span class="n">true</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-types">
|
||
<h4><cite>/api/v0/compose/types</cite><a class="headerlink" href="#api-v0-compose-types" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Returns the list of supported output types that are valid for use with ‘POST /api/v0/compose’</p>
|
||
<blockquote>
|
||
<div><dl class="docutils">
|
||
<dt>{</dt>
|
||
<dd><dl class="first docutils">
|
||
<dt>“types”: [</dt>
|
||
<dd><dl class="first docutils">
|
||
<dt>{</dt>
|
||
<dd>“enabled”: true,
|
||
“name”: “tar”</dd>
|
||
</dl>
|
||
<p class="last">}</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="last">]</p>
|
||
</dd>
|
||
</dl>
|
||
<p>}</p>
|
||
</div></blockquote>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-queue">
|
||
<h4><cite>/api/v0/compose/queue</cite><a class="headerlink" href="#api-v0-compose-queue" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the status of the build queue. It includes information about the builds waiting,
|
||
and the build that is running.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"new"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"45502a6d-06e8-48a5-a215-2b4174b3614b"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"WAITING"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517362647.4570868</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6d292bd0-bec7-4825-8d7d-41ef9c3e4b73"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"kubernetes"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"WAITING"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517362659.0034983</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.1"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">],</span>
|
||
<span class="s2">"run"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"745712b2-96db-44c0-8014-fe925c35e795"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"RUNNING"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517362633.7965999</span><span class="p">,</span>
|
||
<span class="s2">"job_started"</span><span class="p">:</span> <span class="mf">1517362633.8001345</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-finished">
|
||
<h4><cite>/api/v0/compose/finished</cite><a class="headerlink" href="#api-v0-compose-finished" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the details on all of the finished composes on the system.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"finished"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"70b84195-9817-4b8a-af92-45e380f39894"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"FINISHED"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517351003.8210032</span><span class="p">,</span>
|
||
<span class="s2">"job_started"</span><span class="p">:</span> <span class="mf">1517351003.8230415</span><span class="p">,</span>
|
||
<span class="s2">"job_finished"</span><span class="p">:</span> <span class="mf">1517359234.1003145</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"e695affd-397f-4af9-9022-add2636e7459"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"FINISHED"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517362289.7193348</span><span class="p">,</span>
|
||
<span class="s2">"job_started"</span><span class="p">:</span> <span class="mf">1517362289.9751132</span><span class="p">,</span>
|
||
<span class="s2">"job_finished"</span><span class="p">:</span> <span class="mf">1517363500.1234567</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-failed">
|
||
<h4><cite>/api/v0/compose/failed</cite><a class="headerlink" href="#api-v0-compose-failed" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the details on all of the failed composes on the system.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"failed"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8c8435ef-d6bd-4c68-9bf1-a2ef832e6b1a"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"http-server"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"FAILED"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517523249.9301329</span><span class="p">,</span>
|
||
<span class="s2">"job_started"</span><span class="p">:</span> <span class="mf">1517523249.9314211</span><span class="p">,</span>
|
||
<span class="s2">"job_finished"</span><span class="p">:</span> <span class="mf">1517523255.5623411</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.2"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-status-uuids-blueprint-blueprint-name-status-compose-status-type-compose-type">
|
||
<h4><cite>/api/v0/compose/status/<uuids>[?blueprint=<blueprint_name>&status=<compose_status>&type=<compose_type>]</cite><a class="headerlink" href="#api-v0-compose-status-uuids-blueprint-blueprint-name-status-compose-status-type-compose-type" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Return the details for each of the comma-separated list of uuids. A uuid of ‘*’ will return
|
||
details for all composes.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"uuids"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8c8435ef-d6bd-4c68-9bf1-a2ef832e6b1a"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"http-server"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"FINISHED"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517523644.2384307</span><span class="p">,</span>
|
||
<span class="s2">"job_started"</span><span class="p">:</span> <span class="mf">1517523644.2551234</span><span class="p">,</span>
|
||
<span class="s2">"job_finished"</span><span class="p">:</span> <span class="mf">1517523689.9864314</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.2"</span>
|
||
<span class="p">},</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"45502a6d-06e8-48a5-a215-2b4174b3614b"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="s2">"glusterfs"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"FINISHED"</span><span class="p">,</span>
|
||
<span class="s2">"job_created"</span><span class="p">:</span> <span class="mf">1517363442.188399</span><span class="p">,</span>
|
||
<span class="s2">"job_started"</span><span class="p">:</span> <span class="mf">1517363442.325324</span><span class="p">,</span>
|
||
<span class="s2">"job_finished"</span><span class="p">:</span> <span class="mf">1517363451.653621</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"0.0.6"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="delete-api-v0-compose-cancel-uuid">
|
||
<h4>DELETE <cite>/api/v0/compose/cancel/<uuid></cite><a class="headerlink" href="#delete-api-v0-compose-cancel-uuid" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Cancel the build, if it is not finished, and delete the results. It will return a
|
||
status of True if it is successful.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"status"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"uuid"</span><span class="p">:</span> <span class="s2">"03397f8d-acff-4cdb-bd31-f629b7a948f5"</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="delete-api-v0-compose-delete-uuids">
|
||
<h4>DELETE <cite>/api/v0/compose/delete/<uuids></cite><a class="headerlink" href="#delete-api-v0-compose-delete-uuids" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Delete the list of comma-separated uuids from the compose results.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"errors"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"uuids"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"status"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
|
||
<span class="s2">"uuid"</span><span class="p">:</span> <span class="s2">"ae1bf7e3-7f16-4c9f-b36e-3726a1093fd0"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-info-uuid">
|
||
<h4><cite>/api/v0/compose/info/<uuid></cite><a class="headerlink" href="#api-v0-compose-info-uuid" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Get detailed information about the compose. The returned JSON string will
|
||
contain the following information:</p>
|
||
<blockquote>
|
||
<div><ul class="simple">
|
||
<li>id - The uuid of the comoposition</li>
|
||
<li>config - containing the configuration settings used to run Anaconda</li>
|
||
<li>blueprint - The depsolved blueprint used to generate the kickstart</li>
|
||
<li>commit - The (local) git commit hash for the blueprint used</li>
|
||
<li>deps - The NEVRA of all of the dependencies used in the composition</li>
|
||
<li>compose_type - The type of output generated (tar, iso, etc.)</li>
|
||
<li>queue_status - The final status of the composition (FINISHED or FAILED)</li>
|
||
</ul>
|
||
</div></blockquote>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
|
||
<span class="s2">"commit"</span><span class="p">:</span> <span class="s2">"7078e521a54b12eae31c3fd028680da7a0815a4d"</span><span class="p">,</span>
|
||
<span class="s2">"compose_type"</span><span class="p">:</span> <span class="s2">"tar"</span><span class="p">,</span>
|
||
<span class="s2">"config"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"anaconda_args"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
<span class="s2">"armplatform"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||
<span class="s2">"compress_args"</span><span class="p">:</span> <span class="p">[],</span>
|
||
<span class="s2">"compression"</span><span class="p">:</span> <span class="s2">"xz"</span><span class="p">,</span>
|
||
<span class="s2">"image_name"</span><span class="p">:</span> <span class="s2">"root.tar.xz"</span><span class="p">,</span>
|
||
<span class="o">...</span>
|
||
<span class="p">},</span>
|
||
<span class="s2">"deps"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"packages"</span><span class="p">:</span> <span class="p">[</span>
|
||
<span class="p">{</span>
|
||
<span class="s2">"arch"</span><span class="p">:</span> <span class="s2">"x86_64"</span><span class="p">,</span>
|
||
<span class="s2">"epoch"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
|
||
<span class="s2">"name"</span><span class="p">:</span> <span class="s2">"acl"</span><span class="p">,</span>
|
||
<span class="s2">"release"</span><span class="p">:</span> <span class="s2">"14.el7"</span><span class="p">,</span>
|
||
<span class="s2">"version"</span><span class="p">:</span> <span class="s2">"2.2.51"</span>
|
||
<span class="p">}</span>
|
||
<span class="p">]</span>
|
||
<span class="p">},</span>
|
||
<span class="s2">"id"</span><span class="p">:</span> <span class="s2">"c30b7d80-523b-4a23-ad52-61b799739ce8"</span><span class="p">,</span>
|
||
<span class="s2">"queue_status"</span><span class="p">:</span> <span class="s2">"FINISHED"</span><span class="p">,</span>
|
||
<span class="s2">"blueprint"</span><span class="p">:</span> <span class="p">{</span>
|
||
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"An example kubernetes master"</span><span class="p">,</span>
|
||
<span class="o">...</span>
|
||
<span class="p">}</span>
|
||
<span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-metadata-uuid">
|
||
<h4><cite>/api/v0/compose/metadata/<uuid></cite><a class="headerlink" href="#api-v0-compose-metadata-uuid" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Returns a .tar of the metadata used for the build. This includes all the
|
||
information needed to reproduce the build, including the final kickstart
|
||
populated with repository and package NEVRA.</p>
|
||
<p>The mime type is set to ‘application/x-tar’ and the filename is set to
|
||
UUID-metadata.tar</p>
|
||
<p>The .tar is uncompressed, but is not large.</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-results-uuid">
|
||
<h4><cite>/api/v0/compose/results/<uuid></cite><a class="headerlink" href="#api-v0-compose-results-uuid" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Returns a .tar of the metadata, logs, and output image of the build. This
|
||
includes all the information needed to reproduce the build, including the
|
||
final kickstart populated with repository and package NEVRA. The output image
|
||
is already in compressed form so the returned tar is not compressed.</p>
|
||
<p>The mime type is set to ‘application/x-tar’ and the filename is set to
|
||
UUID.tar</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-logs-uuid">
|
||
<h4><cite>/api/v0/compose/logs/<uuid></cite><a class="headerlink" href="#api-v0-compose-logs-uuid" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Returns a .tar of the anaconda build logs. The tar is not compressed, but is
|
||
not large.</p>
|
||
<p>The mime type is set to ‘application/x-tar’ and the filename is set to
|
||
UUID-logs.tar</p>
|
||
</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-image-uuid">
|
||
<h4><cite>/api/v0/compose/image/<uuid></cite><a class="headerlink" href="#api-v0-compose-image-uuid" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div>Returns the output image from the build. The filename is set to the filename
|
||
from the build with the UUID as a prefix. eg. UUID-root.tar.xz or UUID-boot.iso.</div></blockquote>
|
||
</div>
|
||
<div class="section" id="api-v0-compose-log-uuid-size-kbytes">
|
||
<h4><cite>/api/v0/compose/log/<uuid>[?size=kbytes]</cite><a class="headerlink" href="#api-v0-compose-log-uuid-size-kbytes" title="Permalink to this headline">¶</a></h4>
|
||
<blockquote>
|
||
<div><p>Returns the end of the anaconda.log. The size parameter is optional and defaults to 1Mbytes
|
||
if it is not included. The returned data is raw text from the end of the logfile, starting on
|
||
a line boundry.</p>
|
||
<p>Example:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">222</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">Thread</span><span class="p">:</span> <span class="n">AnaConfigurationThread</span> <span class="p">(</span><span class="mi">140629395244800</span><span class="p">)</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">223</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">installed</span> <span class="n">system</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">912</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">installed</span> <span class="n">system</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">912</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Creating</span> <span class="n">users</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">24</span><span class="p">,</span><span class="mi">913</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Clearing</span> <span class="n">libuser</span><span class="o">.</span><span class="n">conf</span> <span class="n">at</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">libuser</span><span class="o">.</span><span class="n">Dyy8Gj</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">154</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Creating</span> <span class="n">users</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">addons</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Configuring</span> <span class="n">addons</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">25</span><span class="p">,</span><span class="mi">155</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Generating</span> <span class="n">initramfs</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Generating</span> <span class="n">initramfs</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">post</span><span class="o">-</span><span class="n">installation</span> <span class="n">scripts</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">49</span><span class="p">,</span><span class="mi">467</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">kickstart</span> <span class="o">%%</span><span class="n">post</span> <span class="n">script</span><span class="p">(</span><span class="n">s</span><span class="p">)</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">782</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">All</span> <span class="n">kickstart</span> <span class="o">%%</span><span class="n">post</span> <span class="n">script</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="n">have</span> <span class="n">been</span> <span class="n">run</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">782</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Running</span> <span class="n">post</span><span class="o">-</span><span class="n">installation</span> <span class="n">scripts</span>
|
||
<span class="mi">12</span><span class="p">:</span><span class="mi">59</span><span class="p">:</span><span class="mi">50</span><span class="p">,</span><span class="mi">784</span> <span class="n">INFO</span> <span class="n">anaconda</span><span class="p">:</span> <span class="n">Thread</span> <span class="n">Done</span><span class="p">:</span> <span class="n">AnaConfigurationThread</span> <span class="p">(</span><span class="mi">140629395244800</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
</div></blockquote>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.v0.blueprint_exists">
|
||
<code class="descclassname">pylorax.api.v0.</code><code class="descname">blueprint_exists</code><span class="sig-paren">(</span><em>api</em>, <em>branch</em>, <em>blueprint_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#blueprint_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.v0.blueprint_exists" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.v0.take_limits">
|
||
<code class="descclassname">pylorax.api.v0.</code><code class="descname">take_limits</code><span class="sig-paren">(</span><em>iterable</em>, <em>offset</em>, <em>limit</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#take_limits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.v0.take_limits" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply offset and limit to an iterable object</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"><ul class="first simple">
|
||
<li><strong>iterable</strong> (<em>iter</em>) – The object to limit</li>
|
||
<li><strong>offset</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – The number of items to skip</li>
|
||
<li><strong>limit</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.7)"><em>int</em></a>) – The total number of items to return</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A subset of the iterable</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.v0.v0_api">
|
||
<code class="descclassname">pylorax.api.v0.</code><code class="descname">v0_api</code><span class="sig-paren">(</span><em>api</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/v0.html#v0_api"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.v0.v0_api" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="module-pylorax.api.workspace">
|
||
<span id="pylorax-api-workspace-module"></span><h2>pylorax.api.workspace module<a class="headerlink" href="#module-pylorax.api.workspace" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.workspace.workspace_delete">
|
||
<code class="descclassname">pylorax.api.workspace.</code><code class="descname">workspace_delete</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Delete the recipe from the workspace</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe_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>) – The name of the recipe</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">IO related errors</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.workspace.workspace_dir">
|
||
<code class="descclassname">pylorax.api.workspace.</code><code class="descname">workspace_dir</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_dir" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create the workspace’s path from a Repository and branch</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The path to the branch’s workspace directory</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)">str</a></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.workspace.workspace_read">
|
||
<code class="descclassname">pylorax.api.workspace.</code><code class="descname">workspace_read</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_read" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Read a Recipe from the branch’s workspace</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe_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>) – The name of the recipe</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The workspace copy of the recipe, or None if it doesn’t exist</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe">Recipe</a> or None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">RecipeFileError</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pylorax.api.workspace.workspace_write">
|
||
<code class="descclassname">pylorax.api.workspace.</code><code class="descname">workspace_write</code><span class="sig-paren">(</span><em>repo</em>, <em>branch</em>, <em>recipe</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/workspace.html#workspace_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.workspace.workspace_write" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Write a recipe to the workspace</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"><ul class="first simple">
|
||
<li><strong>repo</strong> (<em>Git.Repository</em>) – Open repository</li>
|
||
<li><strong>branch</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Branch name</li>
|
||
<li><strong>recipe</strong> (<a class="reference internal" href="#pylorax.api.recipes.Recipe" title="pylorax.api.recipes.Recipe"><em>Recipe</em></a>) – The recipe to write to the workspace</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">None</p>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last">IO related errors</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pylorax.api">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pylorax.api" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="pylorax.api.crossdomain">
|
||
<code class="descclassname">pylorax.api.</code><code class="descname">crossdomain</code><span class="sig-paren">(</span><em>origin</em>, <em>methods=None</em>, <em>headers=None</em>, <em>max_age=21600</em>, <em>attach_to_all=True</em>, <em>automatic_options=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pylorax/api/crossdomain.html#crossdomain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylorax.api.crossdomain" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
|
||
<a href="pylorax.html" class="btn btn-neutral" title="pylorax package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2018, Red Hat, Inc..
|
||
|
||
</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">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'./',
|
||
VERSION:'29.14',
|
||
LANGUAGE:'None',
|
||
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.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |